#[non_exhaustive]pub struct Channel {Show 15 fields
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>,
pub multitrack_input_configuration: Option<MultitrackInputConfiguration>,
pub container_format: Option<ContainerFormat>,
}
Expand description
Object specifying 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
.
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.
Whether the channel is private (enabled for playback authorization). Default: false
.
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, 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).
multitrack_input_configuration: Option<MultitrackInputConfiguration>
Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
container_format: Option<ContainerFormat>
Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration
is specified and enabled
is true
, then containerFormat
is required and must be set to FRAGMENTED_MP4
. Otherwise, containerFormat
may be set to TS
or FRAGMENTED_MP4
. Default: TS
.
Implementations§
Source§impl Channel
impl Channel
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
.
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 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).
Sourcepub fn ingest_endpoint(&self) -> Option<&str>
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.
Sourcepub fn playback_url(&self) -> Option<&str>
pub fn playback_url(&self) -> Option<&str>
Channel playback URL.
Whether the channel is private (enabled for playback authorization). Default: false
.
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value)
. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, 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 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 srt(&self) -> Option<&Srt>
pub fn srt(&self) -> Option<&Srt>
Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
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).
Sourcepub fn multitrack_input_configuration(
&self,
) -> Option<&MultitrackInputConfiguration>
pub fn multitrack_input_configuration( &self, ) -> Option<&MultitrackInputConfiguration>
Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
Sourcepub fn container_format(&self) -> Option<&ContainerFormat>
pub fn container_format(&self) -> Option<&ContainerFormat>
Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration
is specified and enabled
is true
, then containerFormat
is required and must be set to FRAGMENTED_MP4
. Otherwise, containerFormat
may be set to TS
or FRAGMENTED_MP4
. Default: TS
.
Trait Implementations§
impl StructuralPartialEq for Channel
Auto Trait Implementations§
impl Freeze for Channel
impl RefUnwindSafe for Channel
impl Send for Channel
impl Sync for Channel
impl Unpin for Channel
impl UnwindSafe for Channel
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);