Struct SegmentPlan 

pub struct SegmentPlan { /* private fields */ }

The ordered Media Segments of one Representation in one Period.

Implementations

impl SegmentPlan

pub fn build(input: &PlanInput<'_>) -> Result<Self, AddressError>

Build the plan.

Errors

AddressError: the Representation is to be dropped (or, for AddressError::IndexRequired, planned again once the sidx is fetched).

pub fn timescale(&self) -> u64

@timescale in effect.

pub fn presentation_time_offset(&self) -> u64

@presentationTimeOffset in ticks.

pub fn period_start_us(&self) -> i128

PeriodStart in microseconds.

pub fn is_dynamic(&self) -> bool

Whether availability data is attached (dynamic MPD).

pub fn len(&self) -> Option<u64>

Number of segments; None when the plan is open-ended (a duration template of a Period with no known end).

pub fn is_empty(&self) -> bool

Whether the plan has no segment.

pub fn get(&self, index: u64) -> Result<Option<SegmentRef>, AddressError>

The segment at zero-based index; Ok(None) past the end.

Errors

AddressError when a media template cannot be rendered (a template naming a value the plan has none for, which SegmentPlan::build already refuses) or the index arithmetic overflows.

pub fn iter(&self) -> impl Iterator<Item = SegmentRef> + '_

The segments in order. For an open-ended plan this never ends; bound it with take.

pub fn init(&self) -> Option<ResourceRef>

The Initialization Segment address, with its availability window.

pub fn index(&self) -> Option<ResourceRef>

The Index Segment address (the sidx of a SegmentBase Representation, or a RepresentationIndex).

pub fn index_at_or_before( &self, period_time_us: i128, ) -> Result<Option<u64>, AddressError>

Index of the last segment whose Period-relative start is at or before period_time_us; None before the first segment.

pub fn available_from_us( &self, index: u64, ) -> Result<Option<i128>, AddressError>

Availability start of the segment at index.

pub fn available_until_us( &self, index: u64, ) -> Result<Option<i128>, AddressError>

Availability end of the segment at index.

Trait Implementations

impl Clone for SegmentPlan

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SegmentPlan

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

Formats the value using the given formatter.