Struct hls_m3u8::builder::types::StreamDataBuilder

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

Builder for StreamData.

Implementations

impl<'a> StreamDataBuilder<'a>

pub fn bandwidth(&mut self, value: u64) -> &mut Self

The peak segment bitrate of the VariantStream in bits per second.

If all the MediaSegments in a VariantStream have already been created, the bandwidth value must be the largest sum of peak segment bitrates that is produced by any playable combination of renditions.

(For a VariantStream with a single MediaPlaylist, this is just the peak segment bit rate of that MediaPlaylist.)

An inaccurate value can cause playback stalls or prevent clients from playing the variant. If the MasterPlaylist is to be made available before all MediaSegments in the presentation have been encoded, the bandwidth value should be the bandwidth value of a representative period of similar content, encoded using the same settings.

Example

let mut stream = StreamData::new(20);

stream.set_bandwidth(5);
assert_eq!(stream.bandwidth(), 5);

Note

This field is required.

pub fn average_bandwidth(&mut self, value: u64) -> &mut Self

The average bandwidth of the stream in bits per second.

It represents the average segment bitrate of the VariantStream. If all the MediaSegments in a VariantStream have already been created, the average bandwidth must be the largest sum of average segment bitrates that is produced by any playable combination of renditions.

(For a VariantStream with a single MediaPlaylist, this is just the average segment bitrate of that MediaPlaylist.)

An inaccurate value can cause playback stalls or prevent clients from playing the variant. If the MasterPlaylist is to be made available before all MediaSegments in the presentation have been encoded, the average bandwidth should be the average bandwidth of a representative period of similar content, encoded using the same settings.

Example

let mut stream = StreamData::new(20);

stream.set_average_bandwidth(Some(300));
assert_eq!(stream.average_bandwidth(), Some(300));

Note

This field is optional.

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

A list of formats, where each format specifies a media sample type that is present in one or more renditions specified by the VariantStream.

Valid format identifiers are those in the ISO Base Media File Format Name Space defined by “The ‘Codecs’ and ‘Profiles’ Parameters for “Bucket” Media Types“ (RFC6381).

For example, a stream containing AAC low complexity (AAC-LC) audio and H.264 Main Profile Level 3.0 video would be

let codecs = Codecs::from(&["mp4a.40.2", "avc1.4d401e"]);

Example

use hls_m3u8::types::Codecs;

let mut stream = StreamData::new(20);

stream.set_codecs(Some(&["mp4a.40.2", "avc1.4d401e"]));
assert_eq!(
    stream.codecs(),
    Some(&Codecs::from(&["mp4a.40.2", "avc1.4d401e"]))
);

Note

This field is optional, but every instance of VariantStream::ExtXStreamInf should include a codecs attribute.

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

The resolution of the stream.

Example

use hls_m3u8::types::Resolution;

let mut stream = StreamData::new(20);

stream.set_resolution(Some((1920, 1080)));
assert_eq!(stream.resolution(), Some(Resolution::new(1920, 1080)));

Note

This field is optional, but it is recommended if the VariantStream includes video.

pub fn hdcp_level(&mut self, value: HdcpLevel) -> &mut Self

High-bandwidth Digital Content Protection level of the VariantStream.

Example

use hls_m3u8::types::HdcpLevel;
let mut stream = StreamData::new(20);

stream.set_hdcp_level(Some(HdcpLevel::None));
assert_eq!(stream.hdcp_level(), Some(HdcpLevel::None));

Note

This field is optional.

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

It indicates the set of video renditions, that should be used when playing the presentation.

It must match the value of the ExtXMedia::group_id attribute ExtXMedia tag elsewhere in the MasterPlaylist whose ExtXMedia::media_type attribute is video. It indicates the set of video renditions that should be used when playing the presentation.

Example

let mut stream = StreamData::new(20);

stream.set_video(Some("video_01"));
assert_eq!(stream.video(), Some(&"video_01".into()));

Note

This field is optional.

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

Builds a new StreamData.

Errors

If a required field has not been initialized.

Trait Implementations

impl<'a> Clone for StreamDataBuilder<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for StreamDataBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for StreamDataBuilder<'a>

fn default() -> StreamDataBuilder<'a>

Returns the “default value” for a type.

impl<'a> Hash for StreamDataBuilder<'a>

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<'a> Ord for StreamDataBuilder<'a>

fn cmp(&self, other: &StreamDataBuilder<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'a> PartialEq<StreamDataBuilder<'a>> for StreamDataBuilder<'a>

fn eq(&self, other: &StreamDataBuilder<'a>) -> bool

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

fn ne(&self, other: &StreamDataBuilder<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<StreamDataBuilder<'a>> for StreamDataBuilder<'a>

fn partial_cmp(&self, other: &StreamDataBuilder<'a>) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<'a> Eq for StreamDataBuilder<'a>

impl<'a> StructuralEq for StreamDataBuilder<'a>

impl<'a> StructuralPartialEq for StreamDataBuilder<'a>