Struct VTMultiPassStorage 

pub struct VTMultiPassStorage { /* private fields */ }

Available on crate feature VTMultiPassStorage only.

A mechanism for storing information for each frame of a multi-pass compression session.

VTMultiPassStorageRef is a CF type, so call CFRelease and CFRetain to manage objects of this type. The data stored in the VTMultiPassStorage is private to the video encoder.

See also Apple’s documentation

Implementations

impl VTMultiPassStorage

pub unsafe fn create( allocator: Option<&CFAllocator>, file_url: Option<&CFURL>, time_range: CMTimeRange, options: Option<&CFDictionary>, multi_pass_storage_out: NonNull<*mut VTMultiPassStorage>, ) -> i32

Available on crate feature objc2-core-media only.

Creates a VTMultiPassStorage object using a temporary file.

The returned VTMultiPassStorage object may be used to perform multi-pass encoding; see kVTCompressionPropertyKey_MultiPassStorage. Call CFRelease to release your retain on the created VTMultiPassStorage object when you are done with it.

Parameter fileURL: Specifies where to put the backing file for the VTMultiPassStorage object. If you pass NULL for fileURL, the video toolbox will pick a unique temporary file name.

Parameter timeRange: Gives a hint to the multi pass storage about valid time stamps for data.

Parameter options: If the file did not exist when the storage was created, the file will be deleted when the VTMultiPassStorage object is finalized, unless you set the kVTMultiPassStorageCreationOption_DoNotDelete option to kCFBooleanTrue in the options dictionary.

Safety

• options generics must be of the correct type.
• multi_pass_storage_out must be a valid pointer.

impl VTMultiPassStorage

pub unsafe fn close(&self) -> i32

Ensures that any pending data is written to the multipass storage file and closes the file.

After this function is called, all methods on the multipass storage object will fail. It is still necessary to release the object by calling CFRelease.

Methods from Deref<Target = CFType>

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: ConcreteType,

Available on crate feature VTSession only.

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Available on crate feature VTSession only.

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for VTMultiPassStorage

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for VTMultiPassStorage

fn as_ref(&self) -> &CFType

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

impl AsRef<VTMultiPassStorage> for VTMultiPassStorage

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for VTMultiPassStorage

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for VTMultiPassStorage

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for VTMultiPassStorage

fn type_id() -> CFTypeID

Get the unique CFTypeID identifier for the type.

impl Debug for VTMultiPassStorage

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

Formats the value using the given formatter.

impl Deref for VTMultiPassStorage

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for VTMultiPassStorage

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 Message for VTMultiPassStorage

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for VTMultiPassStorage

fn eq(&self, other: &Self) -> 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 RefEncode for VTMultiPassStorage

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Type for VTMultiPassStorage

fn retain(&self) -> CFRetained<Self>

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for VTMultiPassStorage