Class ChannelProps
(experimental) Properties for creating a new Channel.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.IVS
Assembly: Amazon.CDK.AWS.IVS.dll
Syntax (csharp)
public class ChannelProps : Object, IChannelProps
Syntax (vb)
Public Class ChannelProps
Inherits Object
Implements IChannelProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
var myChannel = new Channel(this, "Channel", new ChannelProps {
Authorized = true
});
Synopsis
Constructors
ChannelProps() |
Properties
Authorized | (experimental) Whether the channel is authorized. |
LatencyMode | (experimental) Channel latency mode. |
Name | (experimental) Channel name. |
Type | (experimental) The channel type, which determines the allowable resolution and bitrate. |
Constructors
ChannelProps()
public ChannelProps()
Properties
Authorized
(experimental) Whether the channel is authorized.
public Nullable<bool> Authorized { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
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
Stability: Experimental
LatencyMode
(experimental) Channel latency mode.
public Nullable<LatencyMode> LatencyMode { get; set; }
Property Value
System.Nullable<LatencyMode>
Remarks
Default: LatencyMode.LOW
Stability: Experimental
Name
(experimental) Channel name.
public string Name { get; set; }
Property Value
System.String
Remarks
Default: - None
Stability: Experimental
Type
(experimental) The channel type, which determines the allowable resolution and bitrate.
public Nullable<ChannelType> Type { get; set; }
Property Value
System.Nullable<ChannelType>
Remarks
If you exceed the allowable resolution or bitrate, the stream will disconnect immediately
Default: ChannelType.STANDARD
Stability: Experimental