Struct VTFrameSilo 

pub struct VTFrameSilo { /* private fields */ }

Available on crate feature VTFrameSilo only.

A VTFrameSilo stores a large number of sample buffers, as produced by a multi-pass compression session.

The sample buffers are ordered by decode timestamp. A VTFrameSilo starts out empty and is populated by calls to VTFrameSiloAddSampleBuffer to add sample buffers in ascending decode order. After the first full pass, additional passes may be performed to replace sample buffers. Each such pass must begin with a call to VTFrameSiloSetTimeRangesForNextPass, which takes a list of time ranges. Samples in these time ranges are deleted, and calls to VTFrameSiloAddSampleBuffer can then be made to provide replacements. Call VTFrameSiloCallFunctionForEachSampleBuffer or VTFrameSiloCallBlockForEachSampleBuffer to retrieve sample buffers. The VTFrameSilo may write sample buffers and data to the backing file between addition and retrieval; do not expect to get identical object pointers back.

See also Apple’s documentation

Implementations

impl VTFrameSilo

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

Available on crate feature objc2-core-media only.

Creates a VTFrameSilo object using a temporary file.

The returned VTFrameSilo object may be used to gather frames produced by multi-pass encoding.

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

Parameter options: Reserved, pass NULL.

Parameter timeRange: The valid time range for the frame silo. Must be valid for progress reporting.

Parameter frameSiloOut: Points to a VTFrameSiloRef to receive the newly created object. Call CFRelease to release your retain on the created VTFrameSilo object when you are done with it.

Safety

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

pub unsafe fn add_sample_buffer(&self, sample_buffer: &CMSampleBuffer) -> i32

Available on crate feature objc2-core-media only.

Adds a sample buffer to a VTFrameSilo object.

Within each pass, sample buffers must have strictly increasing decode timestamps. Passes after the first pass are begun with a call to VTFrameSiloSetTimeRangesForNextPass. After a call to VTFrameSiloSetTimeRangesForNextPass, sample buffer decode timestamps must also be within the stated time ranges. Note that CMTimeRanges are considered to contain their start times but not their end times.

Returns: Returns kVTFrameSiloInvalidTimeStampErr if an attempt is made to add a sample buffer with an inappropriate decode timestamp.

pub unsafe fn set_time_ranges_for_next_pass( &self, time_range_count: CMItemCount, time_range_array: NonNull<CMTimeRange>, ) -> i32

Available on crate feature objc2-core-media only.

Begins a new pass of samples to be added to a VTFrameSilo object.

Previously-added sample buffers with decode timestamps within the time ranges will be deleted from the VTFrameSilo. It is not necessary to call VTFrameSiloSetTimeRangesForNextPass before adding the first pass’ sample buffers.

Returns: Returns kVTFrameSiloInvalidTimeRangeErr if any time ranges are non-numeric, overlap or are not in ascending order.

Safety

time_range_array must be a valid pointer.

pub unsafe fn progress_of_current_pass(&self, progress_out: NonNull<f32>) -> i32

Gets the progress of the current pass.

Calculates the current progress based on the most recent sample buffer added and the current pass time ranges.

Returns: Returns kVTFrameSiloInvalidTimeRangeErr if any time ranges are non-numeric, overlap or are not in ascending order.

Safety

progress_out must be a valid pointer.

pub unsafe fn call_function_for_each_sample_buffer( &self, time_range: CMTimeRange, refcon: *mut c_void, callback: unsafe extern "C-unwind" fn(*mut c_void, NonNull<CMSampleBuffer>) -> i32, ) -> i32

Available on crate feature objc2-core-media only.

Retrieves sample buffers from a VTFrameSilo object.

You call this function to retrieve sample buffers at the end of a multi-pass compression session.

Parameter timeRange: The decode time range of sample buffers to retrieve. Pass kCMTimeRangeInvalid to retrieve all sample buffers from the VTFrameSilo.

Parameter callback: A function to be called, in decode order, with each sample buffer that was added. To abort iteration early, return a nonzero status. The VTFrameSilo may write sample buffers and data to the backing file between addition and retrieval; do not expect to get identical object pointers back.

Returns: Returns kVTFrameSiloInvalidTimeRangeErr if any time ranges are non-numeric, overlap or are not in ascending order. Returns any nonzero status returned by the callback function.

Safety

• refcon must be a valid pointer or null.
• callback must be implemented correctly.

pub unsafe fn call_block_for_each_sample_buffer( &self, time_range: CMTimeRange, handler: &DynBlock<dyn Fn(NonNull<CMSampleBuffer>) -> i32>, ) -> i32

Available on crate features block2 and objc2-core-media only.

Retrieves sample buffers from a VTFrameSilo object.

You call this function to retrieve sample buffers at the end of a multi-pass compression session.

Parameter timeRange: The decode time range of sample buffers to retrieve. Pass kCMTimeRangeInvalid to retrieve all sample buffers from the VTFrameSilo.

Parameter handler: A block to be called, in decode order, with each sample buffer that was added. To abort iteration early, return a nonzero status. The VTFrameSilo may write sample buffers and data to the backing file between addition and retrieval; do not expect to get identical object pointers back.

Returns: Returns kVTFrameSiloInvalidTimeRangeErr if any time ranges are non-numeric, overlap or are not in ascending order. Returns any nonzero status returned by the handler block.

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 VTFrameSilo

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for VTFrameSilo

fn as_ref(&self) -> &CFType

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

impl AsRef<VTFrameSilo> for VTFrameSilo

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for VTFrameSilo

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for VTFrameSilo

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for VTFrameSilo

fn type_id() -> CFTypeID

Get the unique CFTypeID identifier for the type.

impl Debug for VTFrameSilo

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

Formats the value using the given formatter.

impl Deref for VTFrameSilo

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for VTFrameSilo

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 VTFrameSilo

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for VTFrameSilo

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 VTFrameSilo

const ENCODING_REF: Encoding

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

impl Type for VTFrameSilo

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 VTFrameSilo