software.amazon.awscdk.services.ivs

Interface ChannelProps

All Known Implementing Classes:

ChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:22.763Z")
public interface ChannelProps

(experimental) Properties for creating a new Channel.

Example:

 Channel myChannel = Channel.Builder.create(this, "Channel")
         .authorized(true)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ChannelProps.Builder A builder for ChannelProps
static class	ChannelProps.Jsii$Proxy An implementation for ChannelProps

Method Summary

Modifier and Type	Method and Description
static ChannelProps.Builder	builder()
default java.lang.Boolean	getAuthorized() (experimental) Whether the channel is authorized.
default LatencyMode	getLatencyMode() (experimental) Channel latency mode.
default java.lang.String	getName() (experimental) Channel name.
default ChannelType	getType() (experimental) The channel type, which determines the allowable resolution and bitrate.

Method Detail

getAuthorized

default java.lang.Boolean getAuthorized()

(experimental) Whether the channel is authorized.

If you wish to make an authorized channel, you will need to ensure that a PlaybackKeyPair has been uploaded to your account as this is used to validate the signed JWT that is required for authorization

Default: false

getLatencyMode

default LatencyMode getLatencyMode()

(experimental) Channel latency mode.

Default: LatencyMode.LOW

getName

default java.lang.String getName()

(experimental) Channel name.

Default: - None

getType

default ChannelType getType()

(experimental) The channel type, which determines the allowable resolution and bitrate.

If you exceed the allowable resolution or bitrate, the stream will disconnect immediately

Default: ChannelType.STANDARD

builder

static ChannelProps.Builder builder()

Returns:

a ChannelProps.Builder of ChannelProps