Struct hls_m3u8::builder::tags::ExtXDateRangeBuilder

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

Builder for ExtXDateRange.

Implementations

impl<'a> ExtXDateRangeBuilder<'a>

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

A string that uniquely identifies an ExtXDateRange in the playlist.

Note

This field is required.

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

A client-defined string that specifies some set of attributes and their associated value semantics. All ExtXDateRanges with the same class attribute value must adhere to these semantics.

Note

This field is optional.

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

The date at which the ExtXDateRange begins.

Note

This field is required by the spec wording, but optional in examples elsewhere in the same document. Some implementations omit it in practise (e.g. for SCTE ‘explicit-IN’ markers) so it is optional here.

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

The date at which the ExtXDateRange ends. It must be equal to or later than the value of the start-date field.

Note

This field is optional.

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

The duration of the ExtXDateRange. A single instant in time (e.g., crossing a finish line) should be represented with a duration of 0.

Note

This field is optional.

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

This field indicates the expected duration of an ExtXDateRange, whose actual duration is not yet known.

Note

This field is optional.

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

SCTE-35 (ANSI/SCTE 35 2013) is a joint ANSI/Society of Cable and Telecommunications Engineers standard that describes the inline insertion of cue tones in mpeg-ts streams.

SCTE-35 was originally used in the US to signal a local ad insertion opportunity in the transport streams, and in Europe to insert local TV programs (e.g. local news transmissions). It is now used to signal all kinds of program and ad events in linear transport streams and in newer ABR delivery formats such as HLS and DASH.

https://en.wikipedia.org/wiki/SCTE-35

Note

This field is optional.

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

SCTE-35 (ANSI/SCTE 35 2013) is a joint ANSI/Society of Cable and Telecommunications Engineers standard that describes the inline insertion of cue tones in mpeg-ts streams.

SCTE-35 was originally used in the US to signal a local ad insertion opportunity in the transport streams, and in Europe to insert local TV programs (e.g. local news transmissions). It is now used to signal all kinds of program and ad events in linear transport streams and in newer ABR delivery formats such as HLS and DASH.

https://en.wikipedia.org/wiki/SCTE-35

Note

This field is optional.

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

SCTE-35 (ANSI/SCTE 35 2013) is a joint ANSI/Society of Cable and Telecommunications Engineers standard that describes the inline insertion of cue tones in mpeg-ts streams.

SCTE-35 was originally used in the US to signal a local ad insertion opportunity in the transport streams, and in Europe to insert local TV programs (e.g. local news transmissions). It is now used to signal all kinds of program and ad events in linear transport streams and in newer ABR delivery formats such as HLS and DASH.

https://en.wikipedia.org/wiki/SCTE-35

Note

This field is optional.

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

This field indicates that the ExtXDateRange::end_date is equal to the ExtXDateRange::start_date of the following range.

The following range is the ExtXDateRange with the same class, that has the earliest start date after the start date of the range in question.

Note

This field is optional.

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

The "X-" prefix defines a namespace reserved for client-defined attributes.

A client-attribute can only consist of uppercase characters (A-Z), numbers (0-9) and -.

Clients should use a reverse-dns naming scheme, when defining their own attribute names to avoid collisions.

An example of a client-defined attribute is X-COM-EXAMPLE-AD-ID="XYZ123".

Note

This field is optional.

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

Builds a new ExtXDateRange.

Errors

If a required field has not been initialized.

impl<'a> ExtXDateRangeBuilder<'a>

pub fn insert_client_attribute<K: Into<Cow<'a, str>>, V: Into<Value<'a>>>(
    &mut self,
    key: K,
    value: V
) -> &mut Self

Inserts a key value pair.

Trait Implementations

impl<'a> Clone for ExtXDateRangeBuilder<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for ExtXDateRangeBuilder<'a>

fn default() -> ExtXDateRangeBuilder<'a>

Returns the “default value” for a type.