Struct Stream 

#[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,
}

Specifies a live video stream that has been ingested and distributed.

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.

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

impl Stream

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

Channel ARN for the stream.

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

Unique identifier for a live or previously live stream in the specified channel.

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

URL of the master playlist, required by the video player to play the HLS stream.

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.

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.

pub fn health(&self) -> Option<&StreamHealth>

The stream’s health.

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.

impl Stream

pub fn builder() -> StreamBuilder

Creates a new builder-style object to manufacture Stream.

Trait Implementations

impl Clone for Stream

fn clone(&self) -> Stream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stream

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

Formats the value using the given formatter.

impl PartialEq for Stream

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Stream