Struct aws_sdk_ivs::model::Channel

#[non_exhaustive]
pub struct Channel {
    pub arn: Option<String>,
    pub name: Option<String>,
    pub latency_mode: Option<ChannelLatencyMode>,
    pub type: Option<ChannelType>,
    pub recording_configuration_arn: Option<String>,
    pub ingest_endpoint: Option<String>,
    pub playback_url: Option<String>,
    pub authorized: bool,
    pub tags: Option<HashMap<String, String>>,
}

Object specifying a channel.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

arn: Option<String>

Channel ARN.

name: Option<String>

Channel name.

latency_mode: Option<ChannelLatencyMode>

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

type: Option<ChannelType>

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.

recording_configuration_arn: Option<String>

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

ingest_endpoint: Option<String>

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

playback_url: Option<String>

Channel playback URL.

authorized: bool

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

tags: Option<HashMap<String, String>>

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

Implementations

impl Channel

pub fn arn(&self) -> Option<&str>

Channel ARN.

pub fn name(&self) -> Option<&str>

Channel name.

pub fn latency_mode(&self) -> Option<&ChannelLatencyMode>

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

pub fn type(&self) -> Option<&ChannelType>

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 recording_configuration_arn(&self) -> Option<&str>

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

pub fn ingest_endpoint(&self) -> Option<&str>

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

pub fn playback_url(&self) -> Option<&str>

Channel playback URL.

pub fn authorized(&self) -> bool

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

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

impl Channel

pub fn builder() -> Builder

Creates a new builder-style object to manufacture Channel

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Channel

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

Formats the value using the given formatter.

impl PartialEq<Channel> for Channel

fn eq(&self, other: &Channel) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Channel) -> bool

This method tests for !=.

impl StructuralPartialEq for Channel