Struct hls_m3u8::builder::MediaSegmentBuilder

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

Builder for MediaSegment.

Implementations

impl<'a> MediaSegmentBuilder<'a>

pub fn keys<VALUE: Into<Vec<ExtXKey<'a>>>>(&mut self, value: VALUE) -> &mut Self

This field specifies how to decrypt a MediaSegment, which can only be encrypted with one EncryptionMethod, using one DecryptionKey and DecryptionKey::iv.

However, a server may offer multiple ways to retrieve that key by providing multiple keys with different DecryptionKey::formats.

Any unencrypted segment that is preceded by an encrypted segment must have an ExtXKey::empty. Otherwise, the client will misinterpret those segments as encrypted.

The server may set the HTTP Expires header in the key response to indicate the duration for which the key can be cached.

Note

This field is optional and a missing value or an ExtXKey::empty() indicates an unencrypted media segment.

pub fn map(&mut self, value: ExtXMap<'a>) -> &mut Self

This field specifies how to obtain the Media Initialization Section required to parse the applicable MediaSegments.

Note

This field is optional, but should be specified for media segments in playlists with an ExtXIFramesOnly tag when the first MediaSegment in the playlist (or the first segment following a segment marked with MediaSegment::has_discontinuity) does not immediately follow the Media Initialization Section at the beginning of its resource.

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

This field indicates that a MediaSegment is a sub-range of the resource identified by its URI.

Note

This field is optional.

pub fn date_range(&mut self, value: ExtXDateRange<'a>) -> &mut Self

This field associates a date-range (i.e., a range of time defined by a starting and ending date) with a set of attribute/value pairs.

Note

This field is optional.

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

This field indicates a discontinuity between the MediaSegment that follows it and the one that preceded it.

Note

This field is required if any of the following characteristics change:

• file format
• number, type, and identifiers of tracks
• timestamp, sequence

This field should be present if any of the following characteristics change:

• encoding parameters
• encoding sequence

pub fn program_date_time(&mut self, value: ExtXProgramDateTime<'a>) -> &mut Self

This field associates the first sample of a media segment with an absolute date and/or time.

Note

This field is optional.

pub fn duration<VALUE: Into<ExtInf<'a>>>(&mut self, value: VALUE) -> &mut Self

This field indicates the duration of a media segment.

Note

This field is required.

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

The URI of a media segment.

Note

This field is required.

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

Builds a new MediaSegment.

Errors

If a required field has not been initialized.

impl<'a> MediaSegmentBuilder<'a>

pub fn push_key<VALUE: Into<ExtXKey<'a>>>(&mut self, value: VALUE) -> &mut Self

Pushes an ExtXKey tag.

pub fn number(&mut self, value: Option<usize>) -> &mut Self

The number of a MediaSegment. Normally this should not be set explicitly, because the MediaPlaylist::builder will automatically apply the correct number.

Trait Implementations

impl<'a> Clone for MediaSegmentBuilder<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for MediaSegmentBuilder<'a>

fn default() -> MediaSegmentBuilder<'a>

Returns the “default value” for a type.