Struct aws_sdk_ivs::types::Stream
source · #[non_exhaustive]pub struct Stream {
pub channel_arn: Option<String>,
pub stream_id: Option<String>,
pub playback_url: Option<String>,
pub start_time: Option<DateTime>,
pub state: Option<StreamState>,
pub health: Option<StreamHealth>,
pub viewer_count: i64,
}
Expand description
Specifies a live video stream that has been ingested and distributed.
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.channel_arn: Option<String>
Channel ARN for the stream.
stream_id: Option<String>
Unique identifier for a live or previously live stream in the specified channel.
playback_url: Option<String>
URL of the master playlist, required by the video player to play the HLS stream.
start_time: Option<DateTime>
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
state: Option<StreamState>
The stream’s state. Do not rely on the OFFLINE
state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
health: Option<StreamHealth>
The stream’s health.
viewer_count: i64
A count of concurrent views of the stream. Typically, a new view appears in viewerCount
within 15 seconds of when video playback starts and a view is removed from viewerCount
within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
Implementations§
source§impl Stream
impl Stream
sourcepub fn channel_arn(&self) -> Option<&str>
pub fn channel_arn(&self) -> Option<&str>
Channel ARN for the stream.
sourcepub fn stream_id(&self) -> Option<&str>
pub fn stream_id(&self) -> Option<&str>
Unique identifier for a live or previously live stream in the specified channel.
sourcepub fn playback_url(&self) -> Option<&str>
pub fn playback_url(&self) -> Option<&str>
URL of the master playlist, required by the video player to play the HLS stream.
sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
sourcepub fn state(&self) -> Option<&StreamState>
pub fn state(&self) -> Option<&StreamState>
The stream’s state. Do not rely on the OFFLINE
state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
sourcepub fn health(&self) -> Option<&StreamHealth>
pub fn health(&self) -> Option<&StreamHealth>
The stream’s health.
sourcepub fn viewer_count(&self) -> i64
pub fn viewer_count(&self) -> i64
A count of concurrent views of the stream. Typically, a new view appears in viewerCount
within 15 seconds of when video playback starts and a view is removed from viewerCount
within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
Trait Implementations§
source§impl PartialEq for Stream
impl PartialEq for Stream
impl StructuralPartialEq for Stream
Auto Trait Implementations§
impl Freeze for Stream
impl RefUnwindSafe for Stream
impl Send for Stream
impl Sync for Stream
impl Unpin for Stream
impl UnwindSafe for Stream
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