amazonka-ivs-2.0: Amazon Interactive Video Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IVS.Types.Channel

Description

 
Synopsis

Documentation

data Channel Source #

Object specifying a channel.

See: newChannel smart constructor.

Constructors

Channel' 

Fields

  • arn :: Maybe Text

    Channel ARN.

  • authorized :: Maybe Bool

    Whether the channel is private (enabled for playback authorization). Default: false.

  • ingestEndpoint :: Maybe Text

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

  • latencyMode :: Maybe ChannelLatencyMode

    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

  • name :: Maybe Text

    Channel name.

  • playbackUrl :: Maybe Text

    Channel playback URL.

  • recordingConfigurationArn :: Maybe Text

    Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

  • tags :: Maybe (HashMap Text Text)

    Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

  • type' :: Maybe ChannelType

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

    • STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
    • BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Instances

Instances details
FromJSON Channel Source # 
Instance details

Defined in Amazonka.IVS.Types.Channel

Generic Channel Source # 
Instance details

Defined in Amazonka.IVS.Types.Channel

Associated Types

type Rep Channel :: Type -> Type #

Methods

from :: Channel -> Rep Channel x #

to :: Rep Channel x -> Channel #

Read Channel Source # 
Instance details

Defined in Amazonka.IVS.Types.Channel

Show Channel Source # 
Instance details

Defined in Amazonka.IVS.Types.Channel

NFData Channel Source # 
Instance details

Defined in Amazonka.IVS.Types.Channel

Methods

rnf :: Channel -> () #

Eq Channel Source # 
Instance details

Defined in Amazonka.IVS.Types.Channel

Methods

(==) :: Channel -> Channel -> Bool #

(/=) :: Channel -> Channel -> Bool #

Hashable Channel Source # 
Instance details

Defined in Amazonka.IVS.Types.Channel

Methods

hashWithSalt :: Int -> Channel -> Int #

hash :: Channel -> Int #

type Rep Channel Source # 
Instance details

Defined in Amazonka.IVS.Types.Channel

newChannel :: Channel Source #

Create a value of Channel with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:Channel', channel_arn - Channel ARN.

$sel:authorized:Channel', channel_authorized - Whether the channel is private (enabled for playback authorization). Default: false.

$sel:ingestEndpoint:Channel', channel_ingestEndpoint - Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

$sel:latencyMode:Channel', channel_latencyMode - Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

$sel:name:Channel', channel_name - Channel name.

$sel:playbackUrl:Channel', channel_playbackUrl - Channel playback URL.

$sel:recordingConfigurationArn:Channel', channel_recordingConfigurationArn - Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

$sel:tags:Channel', channel_tags - Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

$sel:type':Channel', channel_type - Channel type, which determines the allowable resolution and bitrate. /If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately./ Default: STANDARD. Valid values:

  • STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
  • BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

channel_authorized :: Lens' Channel (Maybe Bool) Source #

Whether the channel is private (enabled for playback authorization). Default: false.

channel_ingestEndpoint :: Lens' Channel (Maybe Text) Source #

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

channel_latencyMode :: Lens' Channel (Maybe ChannelLatencyMode) Source #

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

channel_playbackUrl :: Lens' Channel (Maybe Text) Source #

Channel playback URL.

channel_recordingConfigurationArn :: Lens' Channel (Maybe Text) Source #

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

channel_tags :: Lens' Channel (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

channel_type :: Lens' Channel (Maybe ChannelType) Source #

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

  • STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
  • BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.