/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace IVS { namespace Model { /** *

Object specifying a channel.

See Also:

AWS API * Reference

*/ class AWS_IVS_API Channel { public: Channel(); Channel(Aws::Utils::Json::JsonView jsonValue); Channel& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

Channel ARN.

*/ inline const Aws::String& GetArn() const{ return m_arn; } /** *

Channel ARN.

*/ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** *

Channel ARN.

*/ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** *

Channel ARN.

*/ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** *

Channel ARN.

*/ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** *

Channel ARN.

*/ inline Channel& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** *

Channel ARN.

*/ inline Channel& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** *

Channel ARN.

*/ inline Channel& WithArn(const char* value) { SetArn(value); return *this;} /** *

Channel name.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

Channel name.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

Channel name.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

Channel name.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

Channel name.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

Channel name.

*/ inline Channel& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

Channel name.

*/ inline Channel& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

Channel name.

*/ inline Channel& WithName(const char* value) { SetName(value); return *this;} /** *

Channel latency mode. Default: LOW.

*/ inline const ChannelLatencyMode& GetLatencyMode() const{ return m_latencyMode; } /** *

Channel latency mode. Default: LOW.

*/ inline bool LatencyModeHasBeenSet() const { return m_latencyModeHasBeenSet; } /** *

Channel latency mode. Default: LOW.

*/ inline void SetLatencyMode(const ChannelLatencyMode& value) { m_latencyModeHasBeenSet = true; m_latencyMode = value; } /** *

Channel latency mode. Default: LOW.

*/ inline void SetLatencyMode(ChannelLatencyMode&& value) { m_latencyModeHasBeenSet = true; m_latencyMode = std::move(value); } /** *

Channel latency mode. Default: LOW.

*/ inline Channel& WithLatencyMode(const ChannelLatencyMode& value) { SetLatencyMode(value); return *this;} /** *

Channel latency mode. Default: LOW.

*/ inline Channel& WithLatencyMode(ChannelLatencyMode&& value) { SetLatencyMode(std::move(value)); return *this;} /** *

Channel type, which determines the allowable resolution and bitrate. If * you exceed the allowable resolution or bitrate, the stream probably will * disconnect immediately. Valid values:

  • * STANDARD: Multiple qualities are generated from the original input, * to automatically give viewers the best experience for their devices and network * conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 * Mbps.

  • BASIC: Amazon IVS delivers the original * input to viewers. The viewer’s video-quality choice is limited to the original * input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 * Mbps.

Default: STANDARD.

*/ inline const ChannelType& GetType() const{ return m_type; } /** *

Channel type, which determines the allowable resolution and bitrate. If * you exceed the allowable resolution or bitrate, the stream probably will * disconnect immediately. Valid values:

  • * STANDARD: Multiple qualities are generated from the original input, * to automatically give viewers the best experience for their devices and network * conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 * Mbps.

  • BASIC: Amazon IVS delivers the original * input to viewers. The viewer’s video-quality choice is limited to the original * input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 * Mbps.

Default: STANDARD.

*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

Channel type, which determines the allowable resolution and bitrate. If * you exceed the allowable resolution or bitrate, the stream probably will * disconnect immediately. Valid values:

  • * STANDARD: Multiple qualities are generated from the original input, * to automatically give viewers the best experience for their devices and network * conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 * Mbps.

  • BASIC: Amazon IVS delivers the original * input to viewers. The viewer’s video-quality choice is limited to the original * input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 * Mbps.

Default: STANDARD.

*/ inline void SetType(const ChannelType& value) { m_typeHasBeenSet = true; m_type = value; } /** *

Channel type, which determines the allowable resolution and bitrate. If * you exceed the allowable resolution or bitrate, the stream probably will * disconnect immediately. Valid values:

  • * STANDARD: Multiple qualities are generated from the original input, * to automatically give viewers the best experience for their devices and network * conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 * Mbps.

  • BASIC: Amazon IVS delivers the original * input to viewers. The viewer’s video-quality choice is limited to the original * input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 * Mbps.

Default: STANDARD.

*/ inline void SetType(ChannelType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

Channel type, which determines the allowable resolution and bitrate. If * you exceed the allowable resolution or bitrate, the stream probably will * disconnect immediately. Valid values:

  • * STANDARD: Multiple qualities are generated from the original input, * to automatically give viewers the best experience for their devices and network * conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 * Mbps.

  • BASIC: Amazon IVS delivers the original * input to viewers. The viewer’s video-quality choice is limited to the original * input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 * Mbps.

Default: STANDARD.

*/ inline Channel& WithType(const ChannelType& value) { SetType(value); return *this;} /** *

Channel type, which determines the allowable resolution and bitrate. If * you exceed the allowable resolution or bitrate, the stream probably will * disconnect immediately. Valid values:

  • * STANDARD: Multiple qualities are generated from the original input, * to automatically give viewers the best experience for their devices and network * conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 * Mbps.

  • BASIC: Amazon IVS delivers the original * input to viewers. The viewer’s video-quality choice is limited to the original * input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 * Mbps.

Default: STANDARD.

*/ inline Channel& WithType(ChannelType&& value) { SetType(std::move(value)); return *this;} /** *

Channel ingest endpoint, part of the definition of an ingest server, used * when you set up streaming software.

*/ inline const Aws::String& GetIngestEndpoint() const{ return m_ingestEndpoint; } /** *

Channel ingest endpoint, part of the definition of an ingest server, used * when you set up streaming software.

*/ inline bool IngestEndpointHasBeenSet() const { return m_ingestEndpointHasBeenSet; } /** *

Channel ingest endpoint, part of the definition of an ingest server, used * when you set up streaming software.

*/ inline void SetIngestEndpoint(const Aws::String& value) { m_ingestEndpointHasBeenSet = true; m_ingestEndpoint = value; } /** *

Channel ingest endpoint, part of the definition of an ingest server, used * when you set up streaming software.

*/ inline void SetIngestEndpoint(Aws::String&& value) { m_ingestEndpointHasBeenSet = true; m_ingestEndpoint = std::move(value); } /** *

Channel ingest endpoint, part of the definition of an ingest server, used * when you set up streaming software.

*/ inline void SetIngestEndpoint(const char* value) { m_ingestEndpointHasBeenSet = true; m_ingestEndpoint.assign(value); } /** *

Channel ingest endpoint, part of the definition of an ingest server, used * when you set up streaming software.

*/ inline Channel& WithIngestEndpoint(const Aws::String& value) { SetIngestEndpoint(value); return *this;} /** *

Channel ingest endpoint, part of the definition of an ingest server, used * when you set up streaming software.

*/ inline Channel& WithIngestEndpoint(Aws::String&& value) { SetIngestEndpoint(std::move(value)); return *this;} /** *

Channel ingest endpoint, part of the definition of an ingest server, used * when you set up streaming software.

*/ inline Channel& WithIngestEndpoint(const char* value) { SetIngestEndpoint(value); return *this;} /** *

Channel playback URL.

*/ inline const Aws::String& GetPlaybackUrl() const{ return m_playbackUrl; } /** *

Channel playback URL.

*/ inline bool PlaybackUrlHasBeenSet() const { return m_playbackUrlHasBeenSet; } /** *

Channel playback URL.

*/ inline void SetPlaybackUrl(const Aws::String& value) { m_playbackUrlHasBeenSet = true; m_playbackUrl = value; } /** *

Channel playback URL.

*/ inline void SetPlaybackUrl(Aws::String&& value) { m_playbackUrlHasBeenSet = true; m_playbackUrl = std::move(value); } /** *

Channel playback URL.

*/ inline void SetPlaybackUrl(const char* value) { m_playbackUrlHasBeenSet = true; m_playbackUrl.assign(value); } /** *

Channel playback URL.

*/ inline Channel& WithPlaybackUrl(const Aws::String& value) { SetPlaybackUrl(value); return *this;} /** *

Channel playback URL.

*/ inline Channel& WithPlaybackUrl(Aws::String&& value) { SetPlaybackUrl(std::move(value)); return *this;} /** *

Channel playback URL.

*/ inline Channel& WithPlaybackUrl(const char* value) { SetPlaybackUrl(value); return *this;} /** *

Whether the channel is authorized.

*/ inline bool GetAuthorized() const{ return m_authorized; } /** *

Whether the channel is authorized.

*/ inline bool AuthorizedHasBeenSet() const { return m_authorizedHasBeenSet; } /** *

Whether the channel is authorized.

*/ inline void SetAuthorized(bool value) { m_authorizedHasBeenSet = true; m_authorized = value; } /** *

Whether the channel is authorized.

*/ inline Channel& WithAuthorized(bool value) { SetAuthorized(value); return *this;} /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline const Aws::Map& GetTags() const{ return m_tags; } /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline Channel& WithTags(const Aws::Map& value) { SetTags(value); return *this;} /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline Channel& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline Channel& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline Channel& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline Channel& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline Channel& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline Channel& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline Channel& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

Array of 1-50 maps, each of the form string:string * (key:value).

*/ inline Channel& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } private: Aws::String m_arn; bool m_arnHasBeenSet; Aws::String m_name; bool m_nameHasBeenSet; ChannelLatencyMode m_latencyMode; bool m_latencyModeHasBeenSet; ChannelType m_type; bool m_typeHasBeenSet; Aws::String m_ingestEndpoint; bool m_ingestEndpointHasBeenSet; Aws::String m_playbackUrl; bool m_playbackUrlHasBeenSet; bool m_authorized; bool m_authorizedHasBeenSet; Aws::Map m_tags; bool m_tagsHasBeenSet; }; } // namespace Model } // namespace IVS } // namespace Aws