Struct aws_sdk_ivs::types::ChannelSummary
source · #[non_exhaustive]pub struct ChannelSummary {
pub arn: Option<String>,
pub name: Option<String>,
pub latency_mode: Option<ChannelLatencyMode>,
pub authorized: bool,
pub recording_configuration_arn: Option<String>,
pub tags: Option<HashMap<String, String>>,
pub insecure_ingest: bool,
pub type: Option<ChannelType>,
pub preset: Option<TranscodePreset>,
pub playback_restriction_policy_arn: Option<String>,
}
Expand description
Summary information about a channel.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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
.
Whether the channel is private (enabled for playback authorization). Default: false
.
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).
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
.
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.
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 (""
).
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§
source§impl ChannelSummary
impl ChannelSummary
sourcepub fn latency_mode(&self) -> Option<&ChannelLatencyMode>
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
.
Whether the channel is private (enabled for playback authorization). Default: false
.
sourcepub fn recording_configuration_arn(&self) -> Option<&str>
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).
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.
sourcepub fn insecure_ingest(&self) -> bool
pub fn insecure_ingest(&self) -> bool
Whether the channel allows insecure RTMP ingest. Default: false
.
sourcepub fn type(&self) -> Option<&ChannelType>
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.
sourcepub fn preset(&self) -> Option<&TranscodePreset>
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 (""
).
sourcepub fn playback_restriction_policy_arn(&self) -> Option<&str>
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).
source§impl ChannelSummary
impl ChannelSummary
sourcepub fn builder() -> ChannelSummaryBuilder
pub fn builder() -> ChannelSummaryBuilder
Creates a new builder-style object to manufacture ChannelSummary
.
Trait Implementations§
source§impl Clone for ChannelSummary
impl Clone for ChannelSummary
source§fn clone(&self) -> ChannelSummary
fn clone(&self) -> ChannelSummary
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ChannelSummary
impl Debug for ChannelSummary
source§impl PartialEq for ChannelSummary
impl PartialEq for ChannelSummary
source§fn eq(&self, other: &ChannelSummary) -> bool
fn eq(&self, other: &ChannelSummary) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ChannelSummary
Auto Trait Implementations§
impl Freeze for ChannelSummary
impl RefUnwindSafe for ChannelSummary
impl Send for ChannelSummary
impl Sync for ChannelSummary
impl Unpin for ChannelSummary
impl UnwindSafe for ChannelSummary
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more