#[non_exhaustive]pub struct GetHlsStreamingSessionUrlInput { /* private fields */ }
Implementations
sourceimpl GetHlsStreamingSessionUrlInput
impl GetHlsStreamingSessionUrlInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetHLSStreamingSessionURL, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetHLSStreamingSessionURL, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<GetHLSStreamingSessionURL
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture GetHlsStreamingSessionUrlInput
.
sourceimpl GetHlsStreamingSessionUrlInput
impl GetHlsStreamingSessionUrlInput
sourcepub fn stream_name(&self) -> Option<&str>
pub fn stream_name(&self) -> Option<&str>
The name of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName
or the StreamARN
.
sourcepub fn stream_arn(&self) -> Option<&str>
pub fn stream_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master playlist URL.
You must specify either the StreamName
or the StreamARN
.
sourcepub fn playback_mode(&self) -> Option<&HlsPlaybackMode>
pub fn playback_mode(&self) -> Option<&HlsPlaybackMode>
Whether to retrieve live, live replay, or archived, on-demand data.
Features of the three types of sessions include the following:
-
LIVE
: For sessions of this type, the HLS media playlist is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new playlist on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.In
LIVE
mode, the newest available fragments are included in an HLS media playlist, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the HLS media playlist if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the playlist, the older fragment is not added, and the gap is not filled. -
LIVE_REPLAY
: For sessions of this type, the HLS media playlist is updated similarly to how it is updated forLIVE
mode except that it starts by including fragments from a given start time. Instead of fragments being added as they are ingested, fragments are added as the duration of the next fragment elapses. For example, if the fragments in the session are two seconds long, then a new fragment is added to the media playlist every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in theON_DEMAND
mode. -
ON_DEMAND
: For sessions of this type, the HLS media playlist contains all the fragments for the session, up to the number that is specified inMaxMediaPlaylistFragmentResults
. The playlist must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.
In all playback modes, if FragmentSelectorType
is PRODUCER_TIMESTAMP
, and if there are multiple fragments with the same start timestamp, the fragment that has the largest fragment number (that is, the newest fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.
The default is LIVE
.
sourcepub fn hls_fragment_selector(&self) -> Option<&HlsFragmentSelector>
pub fn hls_fragment_selector(&self) -> Option<&HlsFragmentSelector>
The time range of the requested fragment and the source of the timestamps.
This parameter is required if PlaybackMode
is ON_DEMAND
or LIVE_REPLAY
. This parameter is optional if PlaybackMode is
LIVE
. If PlaybackMode
is LIVE
, the FragmentSelectorType
can be set, but the TimestampRange
should not be set. If PlaybackMode
is ON_DEMAND
or LIVE_REPLAY
, both FragmentSelectorType
and TimestampRange
must be set.
sourcepub fn container_format(&self) -> Option<&ContainerFormat>
pub fn container_format(&self) -> Option<&ContainerFormat>
Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4
container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging overhead. The other container format option is MPEG_TS
. HLS has supported MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.
The default is FRAGMENTED_MP4
.
sourcepub fn discontinuity_mode(&self) -> Option<&HlsDiscontinuityMode>
pub fn discontinuity_mode(&self) -> Option<&HlsDiscontinuityMode>
Specifies when flags marking discontinuities between fragments are added to the media playlists.
Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This means that if there is any overlap or gap between fragments (as is typical if HLSFragmentSelector
is set to SERVER_TIMESTAMP
), the media player timeline will also have small gaps between fragments in some places, and will overwrite frames in other places. Gaps in the media player timeline can cause playback to stall and overlaps can cause playback to be jittery. When there are discontinuity flags between fragments, the media player is expected to reset the timeline, resulting in the next fragment being played immediately after the previous fragment.
The following modes are supported:
-
ALWAYS
: a discontinuity marker is placed between every fragment in the HLS media playlist. It is recommended to use a value ofALWAYS
if the fragment timestamps are not accurate. -
NEVER
: no discontinuity markers are placed anywhere. It is recommended to use a value ofNEVER
to ensure the media player timeline most accurately maps to the producer timestamps. -
ON_DISCONTINUITY
: a discontinuity marker is placed between fragments that have a gap or overlap of more than 50 milliseconds. For most playback scenarios, it is recommended to use a value ofON_DISCONTINUITY
so that the media player timeline is only reset when there is a significant issue with the media timeline (e.g. a missing fragment).
The default is ALWAYS
when HLSFragmentSelector
is set to SERVER_TIMESTAMP
, and NEVER
when it is set to PRODUCER_TIMESTAMP
.
sourcepub fn display_fragment_timestamp(&self) -> Option<&HlsDisplayFragmentTimestamp>
pub fn display_fragment_timestamp(&self) -> Option<&HlsDisplayFragmentTimestamp>
Specifies when the fragment start timestamps should be included in the HLS media playlist. Typically, media players report the playhead position as a time relative to the start of the first fragment in the playback session. However, when the start timestamps are included in the HLS media playlist, some media players might report the current playhead as an absolute time based on the fragment timestamps. This can be useful for creating a playback experience that shows viewers the wall-clock time of the media.
The default is NEVER
. When HLSFragmentSelector
is SERVER_TIMESTAMP
, the timestamps will be the server start timestamps. Similarly, when HLSFragmentSelector
is PRODUCER_TIMESTAMP
, the timestamps will be the producer start timestamps.
sourcepub fn expires(&self) -> Option<i32>
pub fn expires(&self) -> Option<i32>
The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and 43200 (12 hours).
When a session expires, no new calls to GetHLSMasterPlaylist
, GetHLSMediaPlaylist
, GetMP4InitFragment
, GetMP4MediaFragment
, or GetTSFragment
can be made for that session.
The default is 300 (5 minutes).
sourcepub fn max_media_playlist_fragment_results(&self) -> Option<i64>
pub fn max_media_playlist_fragment_results(&self) -> Option<i64>
The maximum number of fragments that are returned in the HLS media playlists.
When the PlaybackMode
is LIVE
, the most recent fragments are returned up to this value. When the PlaybackMode
is ON_DEMAND
, the oldest fragments are returned, up to this maximum number.
When there are a higher number of fragments available in a live HLS media playlist, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live HLS media playlist have a minimum of 3 fragments and a maximum of 10 fragments.
The default is 5 fragments if PlaybackMode
is LIVE
or LIVE_REPLAY
, and 1,000 if PlaybackMode
is ON_DEMAND
.
The maximum value of 5,000 fragments corresponds to more than 80 minutes of video on streams with 1-second fragments, and more than 13 hours of video on streams with 10-second fragments.
Trait Implementations
sourceimpl Clone for GetHlsStreamingSessionUrlInput
impl Clone for GetHlsStreamingSessionUrlInput
sourcefn clone(&self) -> GetHlsStreamingSessionUrlInput
fn clone(&self) -> GetHlsStreamingSessionUrlInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl PartialEq<GetHlsStreamingSessionUrlInput> for GetHlsStreamingSessionUrlInput
impl PartialEq<GetHlsStreamingSessionUrlInput> for GetHlsStreamingSessionUrlInput
sourcefn eq(&self, other: &GetHlsStreamingSessionUrlInput) -> bool
fn eq(&self, other: &GetHlsStreamingSessionUrlInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
impl StructuralPartialEq for GetHlsStreamingSessionUrlInput
Auto Trait Implementations
impl RefUnwindSafe for GetHlsStreamingSessionUrlInput
impl Send for GetHlsStreamingSessionUrlInput
impl Sync for GetHlsStreamingSessionUrlInput
impl Unpin for GetHlsStreamingSessionUrlInput
impl UnwindSafe for GetHlsStreamingSessionUrlInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more