Skip to main content

CodecParams

Struct CodecParams 

Source
pub struct CodecParams {
    pub codec_id: CodecId,
    pub inner: CodecParamsInner,
    pub stream_index: Option<u32>,
    pub language: Option<String>,
}
Expand description

Codec-agnostic parameter descriptor for a single elementary stream.

Combines a CodecId with either VideoParams, AudioParams, or a bare Data marker for subtitle/attachment streams.

Fields§

§codec_id: CodecId

The codec used to encode this stream.

§inner: CodecParamsInner

Type-specific parameters.

§stream_index: Option<u32>

Optional stream index within the container (0-based).

§language: Option<String>

Optional stream language tag (BCP-47, e.g. "en", "ja").

Implementations§

Source§

impl CodecParams

Source

pub fn video(codec_id: CodecId, params: VideoParams) -> Self

Creates a CodecParams for a video stream.

Source

pub fn audio(codec_id: CodecId, params: AudioParams) -> Self

Creates a CodecParams for an audio stream.

Source

pub fn data(codec_id: CodecId) -> Self

Creates a CodecParams for a data/subtitle stream.

Source

pub fn is_video(&self) -> bool

Returns true if these are video codec parameters.

Source

pub fn is_audio(&self) -> bool

Returns true if these are audio codec parameters.

Source

pub fn video_params(&self) -> Option<&VideoParams>

Returns a reference to the VideoParams, if present.

Source

pub fn audio_params(&self) -> Option<&AudioParams>

Returns a reference to the AudioParams, if present.

Source

pub fn with_stream_index(self, index: u32) -> Self

Builder-style setter for stream index.

Source

pub fn with_language(self, lang: impl Into<String>) -> Self

Builder-style setter for language tag.

Trait Implementations§

Source§

impl Clone for CodecParams

Source§

fn clone(&self) -> CodecParams

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CodecParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for CodecParams

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for CodecParams

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.