Struct StreamSession 

#[non_exhaustive]
pub struct StreamSession {
    pub stream_id: Option<String>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub channel: Option<Channel>,
    pub ingest_configuration: Option<IngestConfiguration>,
    pub ingest_configurations: Option<IngestConfigurations>,
    pub recording_configuration: Option<RecordingConfiguration>,
    pub truncated_events: Option<Vec<StreamEvent>>,
}

Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.

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.

stream_id: Option<String>

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

start_time: Option<DateTime>

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

end_time: Option<DateTime>

Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.

channel: Option<Channel>

The properties of the channel at the time of going live.

ingest_configuration: Option<IngestConfiguration>

The properties of the incoming RTMP stream.

Note: ingestConfiguration is deprecated in favor of ingestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, ingestConfiguration and ingestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, ingestConfiguration contains data for only the first track (track0) and ingestConfigurations contains data for all tracks.

ingest_configurations: Option<IngestConfigurations>

The properties of the incoming RTMP stream. If multitrack is enabled, ingestConfigurations contains data for all tracks; otherwise, it contains data only for track0 (the sole track).

recording_configuration: Option<RecordingConfiguration>

The properties of recording the live stream.

truncated_events: Option<Vec<StreamEvent>>

List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

Implementations

impl StreamSession

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

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

pub fn start_time(&self) -> Option<&DateTime>

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

pub fn end_time(&self) -> Option<&DateTime>

Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.

pub fn channel(&self) -> Option<&Channel>

The properties of the channel at the time of going live.

pub fn ingest_configuration(&self) -> Option<&IngestConfiguration>

The properties of the incoming RTMP stream.

Note: ingestConfiguration is deprecated in favor of ingestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, ingestConfiguration and ingestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, ingestConfiguration contains data for only the first track (track0) and ingestConfigurations contains data for all tracks.

pub fn ingest_configurations(&self) -> Option<&IngestConfigurations>

The properties of the incoming RTMP stream. If multitrack is enabled, ingestConfigurations contains data for all tracks; otherwise, it contains data only for track0 (the sole track).

pub fn recording_configuration(&self) -> Option<&RecordingConfiguration>

The properties of recording the live stream.

pub fn truncated_events(&self) -> &[StreamEvent]

List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .truncated_events.is_none().

impl StreamSession

pub fn builder() -> StreamSessionBuilder

Creates a new builder-style object to manufacture StreamSession.

Trait Implementations

impl Clone for StreamSession

fn clone(&self) -> StreamSession

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamSession

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

Formats the value using the given formatter.

impl PartialEq for StreamSession

fn eq(&self, other: &StreamSession) -> 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 StreamSession