Struct AVVideoCompositionLayerInstruction 

pub struct AVVideoCompositionLayerInstruction { /* private fields */ }

Available on crate feature AVVideoComposition only.

An AVVideoCompositionLayerInstruction object represents the transform, opacity, and cropping ramps to apply to a given track. Subclasses of this type that are used from Swift must fulfill the requirements of a Sendable type.

See also Apple’s documentation

Implementations

impl AVVideoCompositionLayerInstruction

pub unsafe fn videoCompositionLayerInstructionWithLayerInstruction( instruction: &AVVideoCompositionLayerInstruction, ) -> Retained<AVVideoCompositionLayerInstruction>

Pass-through initializer, for internal use in AVFoundation only

pub unsafe fn trackID(&self) -> CMPersistentTrackID

Available on crate feature objc2-core-media only.

Indicates the trackID of the source track to which the compositor will apply the instruction.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn getTransformRampForTime_startTransform_endTransform_timeRange( &self, time: CMTime, start_transform: *mut CGAffineTransform, end_transform: *mut CGAffineTransform, time_range: *mut CMTimeRange, ) -> bool

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

Obtains the transform ramp that includes the specified time.

• Parameter time: If a ramp with a timeRange that contains the specified time has been set, information about the effective ramp for that time is supplied. Otherwise, information about the first ramp that starts after the specified time is supplied.

• Parameter startTransform: A pointer to a float to receive the starting transform value for the transform ramp. May be NULL.

• Parameter endTransform: A pointer to a float to receive the ending transform value for the transform ramp. May be NULL.

• Parameter timeRange: A pointer to a CMTimeRange to receive the timeRange of the transform ramp. May be NULL.

• Returns: An indication of success. NO will be returned if the specified time is beyond the duration of the last transform ramp that has been set.

Safety

• start_transform must be a valid pointer or null.
• end_transform must be a valid pointer or null.
• time_range must be a valid pointer or null.

pub unsafe fn getOpacityRampForTime_startOpacity_endOpacity_timeRange( &self, time: CMTime, start_opacity: *mut c_float, end_opacity: *mut c_float, time_range: *mut CMTimeRange, ) -> bool

Available on crate feature objc2-core-media only.

Obtains the opacity ramp that includes the specified time.

• Parameter time: If a ramp with a timeRange that contains the specified time has been set, information about the effective ramp for that time is supplied. Otherwise, information about the first ramp that starts after the specified time is supplied.

• Parameter startOpacity: A pointer to a float to receive the starting opacity value for the opacity ramp. May be NULL.

• Parameter endOpacity: A pointer to a float to receive the ending opacity value for the opacity ramp. May be NULL.

• Parameter timeRange: A pointer to a CMTimeRange to receive the timeRange of the opacity ramp. May be NULL.

• Returns: An indication of success. NO will be returned if the specified time is beyond the duration of the last opacity ramp that has been set.

Safety

• start_opacity must be a valid pointer or null.
• end_opacity must be a valid pointer or null.
• time_range must be a valid pointer or null.

pub unsafe fn getCropRectangleRampForTime_startCropRectangle_endCropRectangle_timeRange( &self, time: CMTime, start_crop_rectangle: *mut CGRect, end_crop_rectangle: *mut CGRect, time_range: *mut CMTimeRange, ) -> bool

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

Obtains the crop rectangle ramp that includes the specified time.

• Parameter time: If a ramp with a timeRange that contains the specified time has been set, information about the effective ramp for that time is supplied. Otherwise, information about the first ramp that starts after the specified time is supplied.

• Parameter startCropRectangle: A pointer to a CGRect to receive the starting crop rectangle value for the crop rectangle ramp. May be NULL.

• Parameter endCropRecrangle: A pointer to a CGRect to receive the ending crop rectangle value for the crop rectangle ramp. May be NULL.

• Parameter timeRange: A pointer to a CMTimeRange to receive the timeRange of the crop rectangle ramp. May be NULL.

• Returns: An indication of success. NO will be returned if the specified time is beyond the duration of the last crop rectangle ramp that has been set.

Safety

• start_crop_rectangle must be a valid pointer or null.
• end_crop_rectangle must be a valid pointer or null.
• time_range must be a valid pointer or null.

impl AVVideoCompositionLayerInstruction

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

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

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AVVideoCompositionLayerInstruction> for AVMutableVideoCompositionLayerInstruction

fn as_ref(&self) -> &AVVideoCompositionLayerInstruction

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

impl AsRef<AVVideoCompositionLayerInstruction> for AVVideoCompositionLayerInstruction

fn as_ref(&self) -> &Self

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

impl AsRef<AnyObject> for AVVideoCompositionLayerInstruction

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for AVVideoCompositionLayerInstruction

fn as_ref(&self) -> &NSObject

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

impl Borrow<AVVideoCompositionLayerInstruction> for AVMutableVideoCompositionLayerInstruction

fn borrow(&self) -> &AVVideoCompositionLayerInstruction

Immutably borrows from an owned value.

impl Borrow<AnyObject> for AVVideoCompositionLayerInstruction

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for AVVideoCompositionLayerInstruction

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for AVVideoCompositionLayerInstruction

const NAME: &'static str = "AVVideoCompositionLayerInstruction"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<AVVideoCompositionLayerInstruction as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for AVVideoCompositionLayerInstruction

type Result = AVVideoCompositionLayerInstruction

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for AVVideoCompositionLayerInstruction

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

Formats the value using the given formatter.

impl Deref for AVVideoCompositionLayerInstruction

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for AVVideoCompositionLayerInstruction

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 AVVideoCompositionLayerInstruction

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

where Self: Sized,

Increment the reference count of the receiver.

impl MutableCopyingHelper for AVVideoCompositionLayerInstruction

type Result = AVMutableVideoCompositionLayerInstruction

The mutable counterpart of the type, or Self if the type has no mutable counterpart.

impl NSCoding for AVVideoCompositionLayerInstruction

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Safety

impl NSCopying for AVVideoCompositionLayerInstruction

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSMutableCopying for AVVideoCompositionLayerInstruction

fn mutableCopy(&self) -> Retained<Self::Result>

where Self: Sized + Message + MutableCopyingHelper,

Returns a new instance that’s a mutable copy of the receiver.

unsafe fn mutableCopyWithZone( &self, zone: *mut NSZone, ) -> Retained<Self::Result>

where Self: Sized + Message + MutableCopyingHelper,

Returns a new instance that’s a mutable copy of the receiver.

impl NSObjectProtocol for AVVideoCompositionLayerInstruction

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for AVVideoCompositionLayerInstruction

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for AVVideoCompositionLayerInstruction

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 AVVideoCompositionLayerInstruction

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

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

impl DowncastTarget for AVVideoCompositionLayerInstruction

impl Eq for AVVideoCompositionLayerInstruction

impl Send for AVVideoCompositionLayerInstruction

impl Sync for AVVideoCompositionLayerInstruction