Struct Mpd 

#[non_exhaustive]
pub struct Mpd {

    pub id: Option<String>,
    pub profiles: Vec<String>,
    pub kind: PresentationType,
    pub availability_start_time_us: Option<i64>,
    pub availability_end_time_us: Option<i64>,
    pub publish_time_us: Option<i64>,
    pub media_presentation_duration: Option<Duration>,
    pub minimum_update_period: Option<Duration>,
    pub min_buffer_time: Option<Duration>,
    pub time_shift_buffer_depth: Option<Duration>,
    pub suggested_presentation_delay: Option<Duration>,
    pub max_segment_duration: Option<Duration>,
    pub max_subsegment_duration: Option<Duration>,
    pub base_urls: Vec<BaseUrl>,
    pub locations: Vec<String>,
    pub patch_locations: Vec<PatchLocation>,
    pub service_descriptions: Vec<ServiceDescription>,
    pub utc_timings: Vec<UtcTiming>,
    pub essential_properties: Vec<Descriptor>,
    pub supplemental_properties: Vec<Descriptor>,
    pub content_steering: Option<ContentSteering>,
    pub periods: Vec<Period>,
    pub features: MpdFeatures,
}

An MPD (5.3.1).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

@id.

profiles: Vec<String>

@profiles, split on ,.

kind: PresentationType

@type.

availability_start_time_us: Option<i64>

@availabilityStartTime, Unix microseconds.

availability_end_time_us: Option<i64>

@availabilityEndTime, Unix microseconds.

publish_time_us: Option<i64>

@publishTime, Unix microseconds.

media_presentation_duration: Option<Duration>

@mediaPresentationDuration.

minimum_update_period: Option<Duration>

@minimumUpdatePeriod.

min_buffer_time: Option<Duration>

@minBufferTime.

time_shift_buffer_depth: Option<Duration>

@timeShiftBufferDepth.

suggested_presentation_delay: Option<Duration>

@suggestedPresentationDelay.

max_segment_duration: Option<Duration>

@maxSegmentDuration.

max_subsegment_duration: Option<Duration>

@maxSubsegmentDuration.

base_urls: Vec<BaseUrl>

BaseURL alternates.

locations: Vec<String>

Location texts.

patch_locations: Vec<PatchLocation>

PatchLocation.

service_descriptions: Vec<ServiceDescription>

ServiceDescription.

utc_timings: Vec<UtcTiming>

UTCTiming elements in document order (alternatives, in preference order).

essential_properties: Vec<Descriptor>

EssentialProperty.

supplemental_properties: Vec<Descriptor>

SupplementalProperty.

content_steering: Option<ContentSteering>

ContentSteering.

periods: Vec<Period>

The Periods.

features: MpdFeatures

Constructs seen but not acted on.

Implementations

impl Mpd

pub fn has_event_streams(&self) -> bool

Whether the MPD declares an EventStream in a Period or an InbandEventStream anywhere.

pub fn has_preselections(&self) -> bool

Whether any Period declares a Preselection.

pub fn has_patch_location(&self) -> bool

Whether the MPD declares a PatchLocation.

impl Mpd

pub fn parse(bytes: &[u8]) -> Result<Self, MpdError>

Parse an MPD document with the default Limits.

Errors

MpdError for malformed XML, a non-MPD root, a schema violation the core relies on, an exceeded bound, or an out-of-scope presentation type.

Examples found in repository

examples/build_mpd.rs (line 70)

fn main() {
    let mut video = Representation::default();
    video.id = "v0".to_string();
    video.bandwidth = 2_000_000;
    let mut vc = CommonAttributes::default();
    vc.codecs = Some("avc1.42E01E".to_string());
    vc.mime_type = Some("video/mp4".to_string());
    vc.width = Some(1280);
    vc.height = Some(720);
    vc.frame_rate = Some("30".to_string());
    video.common = vc;
    let mut tmpl = SegmentTemplate::default();
    tmpl.media = Some("chunk-$Number$.m4s".to_string());
    tmpl.initialization = Some("init.mp4".to_string());
    tmpl.multi.base.timescale = Some(90000);
    tmpl.multi.duration = Some(90000);
    tmpl.multi.start_number = Some(1);
    video.segment.template = Some(tmpl);

    let mut audio = Representation::default();
    audio.id = "a0".to_string();
    audio.bandwidth = 128_000;
    let mut ac = CommonAttributes::default();
    ac.codecs = Some("mp4a.40.2".to_string());
    ac.mime_type = Some("audio/mp4".to_string());
    ac.audio_sampling_rate = Some("48000".to_string());
    audio.common = ac;
    let mut atmpl = SegmentTemplate::default();
    atmpl.media = Some("audio-chunk-$Number$.m4s".to_string());
    atmpl.initialization = Some("audio-init.mp4".to_string());
    atmpl.multi.base.timescale = Some(48000);
    atmpl.multi.duration = Some(48000);
    atmpl.multi.start_number = Some(1);
    audio.segment.template = Some(atmpl);

    let mut video_set = AdaptationSet::default();
    video_set.id = Some(0);
    video_set.content_type = Some("video".to_string());
    video_set.representations.push(video);

    let mut audio_set = AdaptationSet::default();
    audio_set.id = Some(1);
    audio_set.content_type = Some("audio".to_string());
    audio_set.representations.push(audio);

    let mut period = Period::default();
    period.id = Some("p0".to_string());
    period.adaptation_sets.push(video_set);
    period.adaptation_sets.push(audio_set);

    let mut mpd = Mpd::default();
    mpd.id = Some("demo".to_string());
    mpd.profiles = vec!["urn:mpeg:dash:profile:isoff-on-demand:2011".to_string()];
    mpd.kind = PresentationType::Static;
    mpd.media_presentation_duration = Some(std::time::Duration::from_secs(60));
    mpd.min_buffer_time = Some(std::time::Duration::from_secs(2));
    mpd.periods.push(period);

    let xml = mpd.to_xml().expect("render");
    print!("{xml}");
    assert_eq!(Mpd::parse(xml.as_bytes()).expect("re-parse"), mpd);
}

pub fn parse_with(bytes: &[u8], limits: &Limits) -> Result<Self, MpdError>

Parse an MPD document under explicit Limits.

Errors

See Mpd::parse.

impl Mpd

pub fn to_xml(&self) -> Result<String, MpdError>

Render the model as an MPD XML document.

Errors

MpdError::Write if the in-memory writer fails (it cannot in practice) and MpdError::Invalid if a stored instant cannot be formatted.

Examples found in repository

examples/build_mpd.rs (line 68)

fn main() {
    let mut video = Representation::default();
    video.id = "v0".to_string();
    video.bandwidth = 2_000_000;
    let mut vc = CommonAttributes::default();
    vc.codecs = Some("avc1.42E01E".to_string());
    vc.mime_type = Some("video/mp4".to_string());
    vc.width = Some(1280);
    vc.height = Some(720);
    vc.frame_rate = Some("30".to_string());
    video.common = vc;
    let mut tmpl = SegmentTemplate::default();
    tmpl.media = Some("chunk-$Number$.m4s".to_string());
    tmpl.initialization = Some("init.mp4".to_string());
    tmpl.multi.base.timescale = Some(90000);
    tmpl.multi.duration = Some(90000);
    tmpl.multi.start_number = Some(1);
    video.segment.template = Some(tmpl);

    let mut audio = Representation::default();
    audio.id = "a0".to_string();
    audio.bandwidth = 128_000;
    let mut ac = CommonAttributes::default();
    ac.codecs = Some("mp4a.40.2".to_string());
    ac.mime_type = Some("audio/mp4".to_string());
    ac.audio_sampling_rate = Some("48000".to_string());
    audio.common = ac;
    let mut atmpl = SegmentTemplate::default();
    atmpl.media = Some("audio-chunk-$Number$.m4s".to_string());
    atmpl.initialization = Some("audio-init.mp4".to_string());
    atmpl.multi.base.timescale = Some(48000);
    atmpl.multi.duration = Some(48000);
    atmpl.multi.start_number = Some(1);
    audio.segment.template = Some(atmpl);

    let mut video_set = AdaptationSet::default();
    video_set.id = Some(0);
    video_set.content_type = Some("video".to_string());
    video_set.representations.push(video);

    let mut audio_set = AdaptationSet::default();
    audio_set.id = Some(1);
    audio_set.content_type = Some("audio".to_string());
    audio_set.representations.push(audio);

    let mut period = Period::default();
    period.id = Some("p0".to_string());
    period.adaptation_sets.push(video_set);
    period.adaptation_sets.push(audio_set);

    let mut mpd = Mpd::default();
    mpd.id = Some("demo".to_string());
    mpd.profiles = vec!["urn:mpeg:dash:profile:isoff-on-demand:2011".to_string()];
    mpd.kind = PresentationType::Static;
    mpd.media_presentation_duration = Some(std::time::Duration::from_secs(60));
    mpd.min_buffer_time = Some(std::time::Duration::from_secs(2));
    mpd.periods.push(period);

    let xml = mpd.to_xml().expect("render");
    print!("{xml}");
    assert_eq!(Mpd::parse(xml.as_bytes()).expect("re-parse"), mpd);
}

Trait Implementations

impl Clone for Mpd

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 Mpd

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

Formats the value using the given formatter.

impl Default for Mpd

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Mpd

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Mpd