libZSservicesZSamazonka-ivsZSamazonka-ivs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IVS.CreateChannel

Description

Creates a new channel and an associated stream key to start streaming.

Synopsis

Creating a Request

data CreateChannel Source #

See: newCreateChannel smart constructor.

Constructors

CreateChannel' 

Fields

  • authorized :: Maybe Bool

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

  • 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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

  • name :: Maybe Text

    Channel name.

  • recordingConfigurationArn :: Maybe Text

    Recording-configuration ARN. Default: "" (empty string, recording is disabled).

  • 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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. 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.
    • BASIC: 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 480p and bitrate can be up to 1.5 Mbps.
  • tags :: Maybe (HashMap Text Text)

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

Instances

Instances details
Eq CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

Read CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

Show CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

Generic CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

Associated Types

type Rep CreateChannel :: Type -> Type #

NFData CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

Methods

rnf :: CreateChannel -> () #

Hashable CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

ToJSON CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

AWSRequest CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

Associated Types

type AWSResponse CreateChannel #

ToHeaders CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

ToPath CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

ToQuery CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

type Rep CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

type AWSResponse CreateChannel Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

newCreateChannel :: CreateChannel Source #

Create a value of CreateChannel 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:authorized:CreateChannel', createChannel_authorized - Whether the channel is private (enabled for playback authorization). Default: false.

$sel:latencyMode:CreateChannel', createChannel_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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

$sel:name:CreateChannel', createChannel_name - Channel name.

$sel:recordingConfigurationArn:CreateChannel', createChannel_recordingConfigurationArn - Recording-configuration ARN. Default: "" (empty string, recording is disabled).

$sel:type':CreateChannel', createChannel_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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. 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.
  • BASIC: 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 480p and bitrate can be up to 1.5 Mbps.

$sel:tags:CreateChannel', createChannel_tags - Array of 1-50 maps, each of the form string:string (key:value).

Request Lenses

createChannel_authorized :: Lens' CreateChannel (Maybe Bool) Source #

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

createChannel_latencyMode :: Lens' CreateChannel (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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

createChannel_recordingConfigurationArn :: Lens' CreateChannel (Maybe Text) Source #

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

createChannel_type :: Lens' CreateChannel (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: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. 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.
  • BASIC: 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 480p and bitrate can be up to 1.5 Mbps.

createChannel_tags :: Lens' CreateChannel (Maybe (HashMap Text Text)) Source #

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

Destructuring the Response

data CreateChannelResponse Source #

See: newCreateChannelResponse smart constructor.

Constructors

CreateChannelResponse' 

Fields

Instances

Instances details
Eq CreateChannelResponse Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

Show CreateChannelResponse Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

Generic CreateChannelResponse Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

Associated Types

type Rep CreateChannelResponse :: Type -> Type #

NFData CreateChannelResponse Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

Methods

rnf :: CreateChannelResponse -> () #

type Rep CreateChannelResponse Source # 
Instance details

Defined in Amazonka.IVS.CreateChannel

type Rep CreateChannelResponse = D1 ('MetaData "CreateChannelResponse" "Amazonka.IVS.CreateChannel" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "CreateChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Channel)) :*: (S1 ('MetaSel ('Just "streamKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamKey)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateChannelResponse Source #

Create a value of CreateChannelResponse 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:channel:CreateChannelResponse', createChannelResponse_channel -

$sel:streamKey:CreateChannelResponse', createChannelResponse_streamKey -

$sel:httpStatus:CreateChannelResponse', createChannelResponse_httpStatus - The response's http status code.

Response Lenses