Struct aws_sdk_ivs::types::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>>,
    pub insecure_ingest: bool,
    pub preset: Option<TranscodePreset>,
    pub srt: Option<Srt>,
    pub playback_restriction_policy_arn: Option<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.

type: Option<ChannelType>

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

recording_configuration_arn: Option<String>

Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. 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>>

Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

insecure_ingest: bool

Whether the channel allows insecure RTMP ingest. Default: false.

preset: Option<TranscodePreset>

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

srt: Option<Srt>

Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

playback_restriction_policy_arn: Option<String>

Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

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.

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

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

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

Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. 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>>

Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

pub fn insecure_ingest(&self) -> bool

Whether the channel allows insecure RTMP ingest. Default: false.

pub fn preset(&self) -> Option<&TranscodePreset>

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

pub fn srt(&self) -> Option<&Srt>

Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

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

Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

impl Channel

pub fn builder() -> ChannelBuilder

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 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Channel