Struct CMFormatDescription 

pub struct CMFormatDescription(/* private fields */);

Available on crate feature cm only.

Owned wrapper around CMFormatDescriptionRef.

Implementations

impl CMFormatDescription

pub unsafe fn from_raw(ptr: *mut c_void) -> Option<Self>

Adopts a +1 retained CMFormatDescriptionRef and returns None for null.

Safety

A non-null ptr must be a live CMFormatDescriptionRef of the exact type carrying one retain transferred to this wrapper. The caller must not release or separately adopt that transferred retain.

pub unsafe fn from_raw_borrowed(ptr: *mut c_void) -> Option<Self>

Retains a +0 borrowed CMFormatDescriptionRef and returns an owned wrapper.

Safety

A non-null ptr must be a live CMFormatDescriptionRef of the exact type for the duration of the retain call.

pub const unsafe fn from_ptr(ptr: *mut c_void) -> Self

Wraps a raw CMFormatDescriptionRef by taking ownership without retaining it.

Safety

ptr must be a non-null, live CMFormatDescriptionRef of the exact type carrying one retain transferred to this wrapper.

pub const fn as_ptr(&self) -> *mut c_void

Borrows the raw +0 CMFormatDescriptionRef while self remains alive.

pub fn media_type_raw(&self) -> u32

Get the media type as a raw u32 value

pub fn media_type(&self) -> FourCharCode

Get the media type as FourCharCode

pub fn media_subtype_raw(&self) -> u32

Get the media subtype (codec type) as a raw u32 value

pub fn media_subtype(&self) -> FourCharCode

Get the media subtype as FourCharCode

pub fn extensions(&self) -> Option<*const c_void>

Get format description extensions

pub fn is_video(&self) -> bool

Check if this is a video format description

pub fn is_audio(&self) -> bool

Check if this is an audio format description

pub fn is_muxed(&self) -> bool

Check if this is a muxed format description

pub fn is_text(&self) -> bool

Check if this is a text/subtitle format description

pub fn is_closed_caption(&self) -> bool

Check if this is a closed caption format description

pub fn is_metadata(&self) -> bool

Check if this is a metadata format description

pub fn is_timecode(&self) -> bool

Check if this is a timecode format description

pub fn media_type_string(&self) -> String

Get a human-readable string for the media type

pub fn media_subtype_string(&self) -> String

Get a human-readable string for the media subtype (codec)

pub fn is_h264(&self) -> bool

Check if the codec is H.264

pub fn is_hevc(&self) -> bool

Check if the codec is HEVC/H.265

pub fn is_aac(&self) -> bool

Check if the codec is AAC

pub fn is_pcm(&self) -> bool

Check if the codec is PCM

pub fn is_prores(&self) -> bool

Check if the codec is ProRes

pub fn is_alac(&self) -> bool

Check if the codec is Apple Lossless (ALAC)

pub fn audio_sample_rate(&self) -> Option<f64>

Get the audio sample rate in Hz

Returns None if this is not an audio format description.

pub fn audio_channel_count(&self) -> Option<u32>

Get the number of audio channels

Returns None if this is not an audio format description.

pub fn audio_bits_per_channel(&self) -> Option<u32>

Get the bits per audio channel

Returns None if this is not an audio format description.

pub fn audio_bytes_per_frame(&self) -> Option<u32>

Get the bytes per audio frame

Returns None if this is not an audio format description.

pub fn audio_format_flags(&self) -> Option<u32>

Get the audio format flags

Returns None if this is not an audio format description.

pub fn audio_is_float(&self) -> bool

Check if audio is float format (based on format flags)

pub fn audio_is_big_endian(&self) -> bool

Check if audio is big-endian (based on format flags)

Trait Implementations

impl Clone for CMFormatDescription

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CMFormatDescription

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

Formats the value using the given formatter.

impl Display for CMFormatDescription

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

Formats the value using the given formatter.

impl Drop for CMFormatDescription

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for CMFormatDescription

impl From<CMMetadataFormatDescription> for CMFormatDescription

fn from(value: CMMetadataFormatDescription) -> Self

Converts to this type from the input type.

impl Hash for CMFormatDescription

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CMFormatDescription

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

Equality operator ==.

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

Inequality operator !=.

impl Send for CMFormatDescription

impl Sync for CMFormatDescription

impl TryFrom<CMFormatDescription> for CMMetadataFormatDescription

type Error = CMFormatDescription

The type returned in the event of a conversion error.

fn try_from(value: CMFormatDescription) -> Result<Self, Self::Error>

Performs the conversion.