Struct CMMetadataFormatDescription 

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

Available on crate feature cm only.

Metadata-specific wrapper around CMFormatDescriptionRef.

Implementations

impl CMMetadataFormatDescription

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

Wraps a +1 retained raw metadata format-description pointer and returns None for null.

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

Wraps a raw metadata CMFormatDescriptionRef by taking ownership without retaining it.

Safety

The caller must ensure ptr is a valid +1 retained metadata CMFormatDescriptionRef.

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

Returns the wrapped raw metadata format-description pointer.

pub const fn as_format_description(&self) -> &CMFormatDescription

Access the metadata description as a plain CMFormatDescription.

pub fn into_format_description(self) -> CMFormatDescription

Consume the metadata wrapper and return the underlying CMFormatDescription.

pub fn create_with_keys( metadata_type: FourCharCode, keys: Option<&CFArray>, ) -> Result<Self, i32>

Create a metadata format description from an optional array of key dictionaries.

Errors

Returns the OSStatus reported by Core Media if the description could not be created.

pub fn create_with_metadata_specifications( metadata_type: FourCharCode, metadata_specifications: &CFArray, ) -> Result<Self, i32>

Create a boxed metadata format description from metadata specification dictionaries.

Errors

Returns the OSStatus reported by Core Media if the description could not be created.

pub fn extend_with_metadata_specifications( &self, metadata_specifications: &CFArray, ) -> Result<Self, i32>

Extend an existing metadata description with additional metadata specifications.

Errors

Returns the OSStatus reported by Core Media if the extended description could not be created.

pub fn merge(&self, other: &Self) -> Result<Self, i32>

Merge two metadata format descriptions into a new description.

Errors

Returns the OSStatus reported by Core Media if the merged description could not be created.

pub fn identifiers(&self) -> Option<CFArray>

Copy the metadata identifiers declared by this description.

pub fn key_with_local_id(&self, local_id: u32) -> Option<CFDictionary>

Copy the metadata key dictionary for local_id, if present.

Methods from Deref<Target = CMFormatDescription>

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

Returns the wrapped raw CMFormatDescriptionRef.

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 CMMetadataFormatDescription

fn clone(&self) -> CMMetadataFormatDescription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CMMetadataFormatDescription

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

Formats the value using the given formatter.

impl Deref for CMMetadataFormatDescription

type Target = CMFormatDescription

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for CMMetadataFormatDescription

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

Formats the value using the given formatter.

impl From<CMMetadataFormatDescription> for CMFormatDescription

fn from(value: CMMetadataFormatDescription) -> Self

Converts to this type from the input type.

impl Hash for CMMetadataFormatDescription

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 CMMetadataFormatDescription

fn eq(&self, other: &CMMetadataFormatDescription) -> 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 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.

impl Eq for CMMetadataFormatDescription

impl StructuralPartialEq for CMMetadataFormatDescription