Struct gstreamer_audio::AudioInfo

pub struct AudioInfo(_, _);

Information describing audio properties. This information can be filled in from GstCaps with from_caps().

Use the provided macros to access the info in this structure.

Implementations

impl AudioInfo

pub fn builder<'a>(
    format: AudioFormat,
    rate: u32,
    channels: u32
) -> AudioInfoBuilder<'a>

pub fn is_valid(&self) -> bool

pub fn from_caps(caps: &CapsRef) -> Result<Self, BoolError>

Parse caps and update info.

caps

a gst::Caps

Returns

TRUE if caps could be parsed

info

a AudioInfo

pub fn to_caps(&self) -> Result<Caps, BoolError>

Convert the values of self into a gst::Caps.

Returns

the new gst::Caps containing the info of self.

pub fn convert<V: Into<GenericFormattedValue>, U: SpecificFormattedValue>(
    &self,
    src_val: V
) -> Option<U>

Converts among various gst::Format types. This function handles GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For raw audio, GST_FORMAT_DEFAULT corresponds to audio frames. This function can be used to handle pad queries of the type GST_QUERY_CONVERT.

src_fmt

gst::Format of the src_val

src_val

value to convert

dest_fmt

gst::Format of the dest_val

Returns

TRUE if the conversion was successful.

dest_val

pointer to destination value

pub fn convert_generic<V: Into<GenericFormattedValue>>(
    &self,
    src_val: V,
    dest_fmt: Format
) -> Option<GenericFormattedValue>

pub fn format(&self) -> AudioFormat

pub fn format_info(&self) -> AudioFormatInfo

pub fn layout(&self) -> AudioLayout

pub fn flags(&self) -> AudioFlags

pub fn rate(&self) -> u32

pub fn channels(&self) -> u32

pub fn bpf(&self) -> u32

pub fn bps(&self) -> u32

pub fn depth(&self) -> u32

pub fn width(&self) -> u32

pub fn endianness(&self) -> AudioEndianness

pub fn is_big_endian(&self) -> bool

pub fn is_little_endian(&self) -> bool

pub fn is_float(&self) -> bool

pub fn is_integer(&self) -> bool

pub fn is_signed(&self) -> bool

pub fn positions(&self) -> Option<&[AudioChannelPosition]>

pub fn is_unpositioned(&self) -> bool

Trait Implementations

impl Clone for AudioInfo

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioInfo

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

Formats the value using the given formatter.

impl PartialEq<AudioInfo> for AudioInfo

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

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

#[must_use]

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

This method tests for !=.

impl StaticType for AudioInfo

fn static_type() -> Type

Returns the type identifier of Self.

impl ValueType for AudioInfo

type Type = Self

Type to get the Type from.

impl Eq for AudioInfo

impl Send for AudioInfo

impl Sync for AudioInfo