Struct hls_m3u8::builder::MediaPlaylistBuilder

pub struct MediaPlaylistBuilder<'a> { /* fields omitted */ }

Builder for MediaPlaylist.

Implementations

impl<'a> MediaPlaylistBuilder<'a>

pub fn target_duration(&mut self, value: Duration) -> &mut Self

Specifies the maximum MediaSegment::duration. A typical target duration is 10 seconds.

Note

This field is required.

pub fn media_sequence(&mut self, value: usize) -> &mut Self

The MediaSegment::number of the first MediaSegment that appears in a MediaPlaylist.

Note

This field is optional and by default a value of 0 is assumed.

pub fn discontinuity_sequence(&mut self, value: usize) -> &mut Self

Allows synchronization between different renditions of the same VariantStream.

Note

This field is optional and by default a vaule of 0 is assumed.

pub fn playlist_type<VALUE: Into<PlaylistType>>(
    &mut self,
    value: VALUE
) -> &mut Self

Provides mutability information about a MediaPlaylist.

• PlaylistType::Vod indicates that the playlist must not change.

• PlaylistType::Event indicates that the server does not change or delete any part of the playlist, but may append new lines to it.

Note

This field is optional.

pub fn has_i_frames_only(&mut self, value: bool) -> &mut Self

Indicates that each MediaSegment in the playlist describes a single I-frame. I-frames are encoded video frames, whose decoding does not depend on any other frame. I-frame Playlists can be used for trick play, such as fast forward, rapid reverse, and scrubbing.

Note

This field is optional.

pub fn has_independent_segments(&mut self, value: bool) -> &mut Self

This indicates that all media samples in a MediaSegment can be decoded without information from other segments.

Note

This field is optional and by default false. If the value is true it applies to every MediaSegment in this MediaPlaylist.

pub fn start<VALUE: Into<ExtXStart>>(&mut self, value: VALUE) -> &mut Self

Indicates a preferred point at which to start playing a playlist. By default, clients should start playback at this point when beginning a playback session.

Note

This field is optional.

pub fn has_end_list(&mut self, value: bool) -> &mut Self

Indicates that no more MediaSegments will be added to the MediaPlaylist file.

Note

This field is optional and by default false. A false indicates that the client should reload the MediaPlaylist from the server, until a playlist is encountered, where this field is true.

pub fn allowable_excess_duration(&mut self, value: Duration) -> &mut Self

The allowable excess duration of each media segment in the associated playlist.

Error

If there is a media segment of which duration exceeds #EXT-X-TARGETDURATION + allowable_excess_duration, the invocation of MediaPlaylistBuilder::build() method will fail.

Note

This field is optional and the default value is Duration::from_secs(0).

pub fn unknown<VALUE: Into<Vec<Cow<'a, str>>>>(
    &mut self,
    value: VALUE
) -> &mut Self

A list of unknown tags.

Note

This field is optional.

impl<'a> MediaPlaylistBuilder<'a>

pub fn push_segment(&mut self, segment: MediaSegment<'a>) -> &mut Self

Adds a media segment to the resulting playlist and assigns the next free MediaSegment::number to the segment.

pub fn parse(&mut self, input: &'a str) -> Result<MediaPlaylist<'a>>

Parse the rest of the MediaPlaylist from an m3u8 file.

pub fn segments(&mut self, segments: Vec<MediaSegment<'a>>) -> &mut Self

Adds segments to the resulting playlist and assigns a MediaSegment::number to each segment.

Note

The MediaSegment::number will be assigned based on the order of the input (e.g. the first element will be 0, second element 1, ..) or if a number has been set explicitly. This function assumes, that all segments will be present in the final media playlist and the following is only possible if the segment is marked with ExtXDiscontinuity.

pub fn build(&self) -> Result<MediaPlaylist<'a>, String>

Builds a new MediaPlaylist.

Errors

If a required field has not been initialized.

Trait Implementations

impl<'a> Clone for MediaPlaylistBuilder<'a>

fn clone(&self) -> MediaPlaylistBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for MediaPlaylistBuilder<'a>

fn default() -> MediaPlaylistBuilder<'a>

Returns the “default value” for a type.