Package software.amazon.awscdk.services.ivs

Interface ChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:58.046Z")
@Stability(Experimental)
public interface ChannelProps
extends software.amazon.jsii.JsiiSerializable

(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	Description
static final class	ChannelProps.Builder	A builder for ChannelProps
static final class	ChannelProps.Jsii$Proxy	An implementation for ChannelProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorized

@Stability(Experimental)
@Nullable
default 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

@Stability(Experimental)
@Nullable
default LatencyMode getLatencyMode()

(experimental) Channel latency mode.

Default: LatencyMode.LOW

getName

@Stability(Experimental)
@Nullable
default String getName()

(experimental) Channel name.

Default: - None

getType

@Stability(Experimental)
@Nullable
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

@Stability(Experimental)
static ChannelProps.Builder builder()

Returns:

a ChannelProps.Builder of ChannelProps