Struct hls_m3u8::MediaSegment

pub struct MediaSegment {
    pub keys: Vec<ExtXKey>,
    pub map: Option<ExtXMap>,
    pub byte_range: Option<ExtXByteRange>,
    pub date_range: Option<ExtXDateRange>,
    pub has_discontinuity: bool,
    pub program_date_time: Option<ExtXProgramDateTime>,
    pub duration: ExtInf,
    // some fields omitted
}

A video is split into smaller chunks called MediaSegments, which are specified by a uri and optionally a byte range.

Each MediaSegment must carry the continuation of the encoded bitstream from the end of the segment with the previous MediaSegment::number, where values in a series such as timestamps and continuity counters must continue uninterrupted. The only exceptions are the first MediaSegment ever to appear in a MediaPlaylist and MediaSegments that are explicitly signaled as discontinuities. Unmarked media discontinuities can trigger playback errors.

Any MediaSegment that contains video should include enough information to initialize a video decoder and decode a continuous set of frames that includes the final frame in the segment; network efficiency is optimized if there is enough information in the segment to decode all frames in the segment.

For example, any MediaSegment containing H.264 video should contain an Instantaneous Decoding Refresh (IDR); frames prior to the first IDR will be downloaded but possibly discarded.

Fields

keys: Vec<ExtXKey>

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.

map: Option<ExtXMap>

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.

byte_range: Option<ExtXByteRange>

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

Note

This field is optional.

date_range: Option<ExtXDateRange>

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.

has_discontinuity: bool

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

program_date_time: Option<ExtXProgramDateTime>

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

Note

This field is optional.

duration: ExtInf

This field indicates the duration of a media segment.

Note

This field is required.

Methods

impl MediaSegment

#[must_use]pub fn number(&self) -> usize

Each MediaSegment has a number, which allows synchronization between different variants.

Note

This number must not be specified, because it will be assigned automatically by MediaPlaylistBuilder::segments. The first MediaSegment::number in a MediaPlaylist will either be 0 or the number returned by the ExtXDiscontinuitySequence if one is provided. The following segments will be the previous segment number + 1.

#[must_use]pub fn uri(&self) -> &String

The URI of a media segment.

Note

This field is required.

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

The URI of a media segment.

Note

This field is required.

impl MediaSegment

#[must_use]pub fn builder() -> MediaSegmentBuilder

Returns a builder for a MediaSegment.

Example

use hls_m3u8::tags::ExtXMap;
use std::time::Duration;

let segment = MediaSegment::builder()
    .map(ExtXMap::new("https://www.example.com/"))
    .byte_range(5..25)
    .has_discontinuity(true)
    .duration(Duration::from_secs(4))
    .uri("http://www.uri.com/")
    .build()?;

Trait Implementations

impl Clone for MediaSegment

fn clone(&self) -> MediaSegment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MediaSegment

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

Formats the value using the given formatter.

impl Decryptable for MediaSegment

fn keys(&self) -> Vec<&DecryptionKey>

Returns all keys, associated with the type.

#[must_use]fn first_key(&self) -> Option<&DecryptionKey>

Most of the time only a single key is provided, so instead of iterating through all keys, one might as well just get the first key.

#[must_use]fn len(&self) -> usize

Returns the number of keys.

#[must_use]fn is_empty(&self) -> bool

Returns true, if the number of keys is zero.

impl Display for MediaSegment

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

Formats the value using the given formatter.

impl Eq for MediaSegment

impl Hash for MediaSegment

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for MediaSegment

fn cmp(&self, other: &MediaSegment) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<MediaSegment> for MediaSegment

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<MediaSegment> for MediaSegment

fn partial_cmp(&self, other: &MediaSegment) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &MediaSegment) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &MediaSegment) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &MediaSegment) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &MediaSegment) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for MediaSegment

impl StructuralPartialEq for MediaSegment