Interface ChannelProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
ChannelProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
date="2024-05-08T21:35:15.832Z")
@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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forChannelProps
static final class
An implementation forChannelProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic ChannelProps.Builder
builder()
default Boolean
(experimental) Whether the channel is authorized.default String
(experimental) A name for the channel.default LatencyMode
(experimental) Channel latency mode.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
(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
-
getChannelName
(experimental) A name for the channel.Default: Automatically generated name
-
getLatencyMode
(experimental) Channel latency mode.Default: LatencyMode.LOW
-
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
- Returns:
- a
ChannelProps.Builder
ofChannelProps
-