Struct ValidChannels 

pub struct ValidChannels<'a> { /* private fields */ }

Describes a CHANNELS attribute value that has at least a valid count.

The format described in HLS is a slash separated list of parameters. At the time of writing there were 3 defined parameters:

• The count of audio channels
• An indicator of spatial audio of some kind
• Supplementary indication of special channel usage

Implementations

impl<'a> ValidChannels<'a>

pub fn new( count: u32, spatial_audio: impl Into<EnumeratedStringList<'a, AudioCodingIdentifier>>, special_usage: impl Into<EnumeratedStringList<'a, ChannelSpecialUsageIdentifier>>, ) -> Self

Construct a new ValidChannels.

Note that AudioCodingIdentifier and ChannelSpecialUsageIdentifier can be used directly here. For example:

let channels = ValidChannels::new(
    16,
    EnumeratedStringList::from([AudioCodingIdentifier::JointObjectCoding]),
    EnumeratedStringList::from([ChannelSpecialUsageIdentifier::Binaural])
);

Since &str implements Into<EnumeratedStringList> we can also use string slice directly, but care should be taken to follow the correct format:

let channels = ValidChannels::new(16, "JOC", "BINAURAL");

impl ValidChannels<'_>

pub fn count(&self) -> u32

Incicates a count of audio, incicating the maximum number of independent, simultaneous audio channels present in any Media Segment in the Rendition. For example, an AC-3 5.1 Rendition would have a value of 6.

pub fn spatial_audio(&self) -> EnumeratedStringList<'_, AudioCodingIdentifier>

Identifies the presence of spatial audio of some kind, for example, object-based audio, in the Rendition. This is described as a list of audio coding identifiers (which can be codec specific).

pub fn special_usage( &self, ) -> EnumeratedStringList<'_, ChannelSpecialUsageIdentifier>

Provides supplementary indications of special channel usage that are necessary for informed selection and processing.

pub fn unknown_parameters(&self) -> Split<'_, char>

At the time of writing the HLS specification only defined 3 parameters (described here via Self::count, Self::spatial_audio, and Self::special_usage). In case more parameters are added later, this method will expose those as a split on '/'.

Trait Implementations

impl AsRef<str> for ValidChannels<'_>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for ValidChannels<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ValidChannels<'a>

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

Formats the value using the given formatter.

impl Display for ValidChannels<'_>

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

Formats the value using the given formatter.

impl<'a> From<ValidChannels<'a>> for Cow<'a, str>

fn from(value: ValidChannels<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for ValidChannels<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> TryFrom<&'a str> for ValidChannels<'a>

type Error = UnrecognizedEnumerationError<'a>

The type returned in the event of a conversion error.

fn try_from(value: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> StructuralPartialEq for ValidChannels<'a>