Struct aws_sdk_ivs::client::fluent_builders::CreateChannel

pub struct CreateChannel<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateChannel.

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

Implementations

impl<C, M, R> CreateChannel<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateChannelOutput, SdkError<CreateChannelError>> where
    R::Policy: SmithyRetryPolicy<CreateChannelInputOperationOutputAlias, CreateChannelOutput, CreateChannelError, CreateChannelInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, inp: impl Into<String>) -> Self

Channel name.

pub fn set_name(self, input: Option<String>) -> Self

Channel name.

pub fn latency_mode(self, inp: ChannelLatencyMode) -> Self

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.

pub fn set_latency_mode(self, input: Option<ChannelLatencyMode>) -> Self

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.

pub fn type(self, inp: ChannelType) -> Self

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.

pub fn set_type(self, input: Option<ChannelType>) -> Self

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.

pub fn authorized(self, inp: bool) -> Self

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

pub fn set_authorized(self, input: Option<bool>) -> Self

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

pub fn recording_configuration_arn(self, inp: impl Into<String>) -> Self

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

pub fn set_recording_configuration_arn(self, input: Option<String>) -> Self

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

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

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

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

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

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreateChannel<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.