#[repr(C)]pub struct AVMutableVideoComposition { /* private fields */ }AVVideoComposition only.Expand description
Implementations§
Source§impl AVMutableVideoComposition
impl AVMutableVideoComposition
pub unsafe fn videoComposition() -> Retained<AVMutableVideoComposition>
Sourcepub unsafe fn videoCompositionWithPropertiesOfAsset(
asset: &AVAsset,
) -> Retained<AVMutableVideoComposition>
👎Deprecated: Use videoCompositionWithPropertiesOfAsset:completionHandler: insteadAvailable on crate feature AVAsset only.
pub unsafe fn videoCompositionWithPropertiesOfAsset( asset: &AVAsset, ) -> Retained<AVMutableVideoComposition>
AVAsset only.Returns a new instance of AVMutableVideoComposition with values and instructions suitable for presenting the video tracks of the specified asset according to its temporal and geometric properties and those of its tracks.
Parameter asset: An instance of AVAsset. For best performance, ensure that the duration and tracks properties of the asset are already loaded before invoking this method.
Returns: An instance of AVMutableVideoComposition.
The returned AVMutableVideoComposition will have instructions that respect the spatial properties and timeRanges of the specified asset’s video tracks. The client can set sourceTrackIDForFrameTiming to kCMPersistentTrackID_Invalid and frameDuration to an appropriate value in order to specify the maximum output frame rate independent of the source track timing. It will also have the following values for its properties:
- If the asset has exactly one video track, the original timing of the source video track will be used. If the asset has more than one video track, and the nominal frame rate of any of video tracks is known, the reciprocal of the greatest known nominalFrameRate will be used as the value of frameDuration. Otherwise, a default framerate of 30fps is used.
- If the specified asset is an instance of AVComposition, the renderSize will be set to the naturalSize of the AVComposition; otherwise the renderSize will be set to a value that encompasses all of the asset’s video tracks.
- A renderScale of 1.0.
- A nil animationTool.
If the specified asset has no video tracks, this method will return an AVMutableVideoComposition instance with an empty collection of instructions.
Sourcepub unsafe fn videoCompositionWithPropertiesOfAsset_completionHandler(
asset: &AVAsset,
completion_handler: &Block<dyn Fn(*mut AVMutableVideoComposition, *mut NSError)>,
)
Available on crate features AVAsset and block2 only.
pub unsafe fn videoCompositionWithPropertiesOfAsset_completionHandler( asset: &AVAsset, completion_handler: &Block<dyn Fn(*mut AVMutableVideoComposition, *mut NSError)>, )
AVAsset and block2 only.Vends a new instance of AVMutableVideoComposition with values and instructions suitable for presenting the video tracks of the specified asset according to its temporal and geometric properties and those of its tracks.
Parameter asset: An instance of AVAsset.
Parameter completionHandler: A block that is invoked when the new video composition has finished being created. If the videoComposition parameter is nil, the error parameter describes the failure that occurred.
The new AVMutableVideoComposition will have instructions that respect the spatial properties and timeRanges of the specified asset’s video tracks. The client can set sourceTrackIDForFrameTiming to kCMPersistentTrackID_Invalid and frameDuration to an appropriate value in order to specify the maximum output frame rate independent of the source track timing. It will also have the following values for its properties:
- If the asset has exactly one video track, the original timing of the source video track will be used. If the asset has more than one video track, and the nominal frame rate of any of video tracks is known, the reciprocal of the greatest known nominalFrameRate will be used as the value of frameDuration. Otherwise, a default framerate of 30fps is used.
- If the specified asset is an instance of AVComposition, the renderSize will be set to the naturalSize of the AVComposition; otherwise the renderSize will be set to a value that encompasses all of the asset’s video tracks.
- A renderScale of 1.0.
- A nil animationTool.
If the specified asset has no video tracks, this method will return an AVMutableVideoComposition instance with an empty collection of instructions.
Sourcepub unsafe fn videoCompositionWithPropertiesOfAsset_prototypeInstruction(
asset: &AVAsset,
prototype_instruction: &AVVideoCompositionInstruction,
) -> Retained<AVMutableVideoComposition>
👎Deprecated: Use videoCompositionWithPropertiesOfAsset:prototypeInstruction:completionHandler: insteadAvailable on crate feature AVAsset only.
pub unsafe fn videoCompositionWithPropertiesOfAsset_prototypeInstruction( asset: &AVAsset, prototype_instruction: &AVVideoCompositionInstruction, ) -> Retained<AVMutableVideoComposition>
AVAsset only.Returns a new instance of AVMutableVideoComposition with values and instructions suitable for presenting the video tracks of the specified asset according to its temporal and geometric properties and those of its tracks, and also overrides default properties with those from a prototypeInstruction.
Parameter asset: An instance of AVAsset. For best performance, ensure that the duration and tracks properties of the asset are already loaded before invoking this method.
Parameter prototypeInstruction: Custom instructions that the client can choose to override.
Returns: An instance of AVMutableVideoComposition.
Also see videoCompositionWithPropertiesOfAsset:. The returned AVVideoComposition will have instructions that respect the spatial properties and timeRanges of the specified asset’s video tracks. Anything not pertaining to spatial layout and timing, such as background color for their composition or post-processing behaviors, is eligible to be specified via a prototype instruction. Example: To add a background color, myPrototypeInstruction = [[AVMutableVideoCompositionInstruction alloc] init]; myPrototypeInstruction.backgroundColor = myCGColorRef; // Do not use constant CGColorRef colors here. myVideoComposition = [AVVideoComposition videoCompositionWithPropertiesOfAsset:myAsset prototypeInstruction:myPrototypeInstruction];
Sourcepub unsafe fn videoCompositionWithPropertiesOfAsset_prototypeInstruction_completionHandler(
asset: &AVAsset,
prototype_instruction: &AVVideoCompositionInstruction,
completion_handler: &Block<dyn Fn(*mut AVMutableVideoComposition, *mut NSError)>,
)
Available on crate features AVAsset and block2 only.
pub unsafe fn videoCompositionWithPropertiesOfAsset_prototypeInstruction_completionHandler( asset: &AVAsset, prototype_instruction: &AVVideoCompositionInstruction, completion_handler: &Block<dyn Fn(*mut AVMutableVideoComposition, *mut NSError)>, )
AVAsset and block2 only.Vends a new instance of AVMutableVideoComposition with values and instructions suitable for presenting the video tracks of the specified asset according to its temporal and geometric properties and those of its tracks, and also overrides default properties with those from a prototypeInstruction.
Parameter asset: An instance of AVAsset.
Parameter prototypeInstruction: Custom instructions that the client can choose to override.
Parameter completionHandler: A block that is invoked when the new video composition has finished being created. If the videoComposition parameter is nil, the error parameter describes the failure that occurred.
Also see videoCompositionWithPropertiesOfAsset:completionHandler:. The new AVMutableVideoComposition will have instructions that respect the spatial properties and timeRanges of the specified asset’s video tracks. Anything not pertaining to spatial layout and timing, such as background color for their composition or post-processing behaviors, is eligible to be specified via a prototype instruction. Example: To add a background color, myPrototypeInstruction = [[AVMutableVideoCompositionInstruction alloc] init]; myPrototypeInstruction.backgroundColor = myCGColorRef; // Do not use constant CGColorRef colors here. myVideoComposition = [AVVideoComposition videoCompositionWithPropertiesOfAsset:myAsset prototypeInstruction:myPrototypeInstruction completionHandler:^(AVMutableVideoComposition * _Nullable myVideoComposition, NSError * _Nullable error) { if (myVideoComposition != nil) { // use myVideoComposition } else { // handle error } }];
pub unsafe fn customVideoCompositorClass(&self) -> Option<&'static AnyClass>
AVVideoCompositing only.Sourcepub unsafe fn setCustomVideoCompositorClass(
&self,
custom_video_compositor_class: Option<&AnyClass>,
)
Available on crate feature AVVideoCompositing only.
pub unsafe fn setCustomVideoCompositorClass( &self, custom_video_compositor_class: Option<&AnyClass>, )
AVVideoCompositing only.Setter for customVideoCompositorClass.
pub unsafe fn frameDuration(&self) -> CMTime
objc2-core-media only.Sourcepub unsafe fn setFrameDuration(&self, frame_duration: CMTime)
Available on crate feature objc2-core-media only.
pub unsafe fn setFrameDuration(&self, frame_duration: CMTime)
objc2-core-media only.Setter for frameDuration.
pub unsafe fn sourceTrackIDForFrameTiming(&self) -> CMPersistentTrackID
objc2-core-media only.Sourcepub unsafe fn setSourceTrackIDForFrameTiming(
&self,
source_track_id_for_frame_timing: CMPersistentTrackID,
)
Available on crate feature objc2-core-media only.
pub unsafe fn setSourceTrackIDForFrameTiming( &self, source_track_id_for_frame_timing: CMPersistentTrackID, )
objc2-core-media only.Setter for sourceTrackIDForFrameTiming.
pub unsafe fn renderSize(&self) -> CGSize
objc2-core-foundation only.Sourcepub unsafe fn setRenderSize(&self, render_size: CGSize)
Available on crate feature objc2-core-foundation only.
pub unsafe fn setRenderSize(&self, render_size: CGSize)
objc2-core-foundation only.Setter for renderSize.
pub unsafe fn renderScale(&self) -> c_float
Sourcepub unsafe fn setRenderScale(&self, render_scale: c_float)
pub unsafe fn setRenderScale(&self, render_scale: c_float)
Setter for renderScale.
pub unsafe fn instructions( &self, ) -> Retained<NSArray<ProtocolObject<dyn AVVideoCompositionInstructionProtocol>>>
AVVideoCompositing only.Sourcepub unsafe fn setInstructions(
&self,
instructions: &NSArray<ProtocolObject<dyn AVVideoCompositionInstructionProtocol>>,
)
Available on crate feature AVVideoCompositing only.
pub unsafe fn setInstructions( &self, instructions: &NSArray<ProtocolObject<dyn AVVideoCompositionInstructionProtocol>>, )
AVVideoCompositing only.Setter for instructions.
pub unsafe fn animationTool( &self, ) -> Option<Retained<AVVideoCompositionCoreAnimationTool>>
Sourcepub unsafe fn setAnimationTool(
&self,
animation_tool: Option<&AVVideoCompositionCoreAnimationTool>,
)
pub unsafe fn setAnimationTool( &self, animation_tool: Option<&AVVideoCompositionCoreAnimationTool>, )
Setter for animationTool.
pub unsafe fn sourceSampleDataTrackIDs(&self) -> Retained<NSArray<NSNumber>>
Sourcepub unsafe fn setSourceSampleDataTrackIDs(
&self,
source_sample_data_track_i_ds: &NSArray<NSNumber>,
)
pub unsafe fn setSourceSampleDataTrackIDs( &self, source_sample_data_track_i_ds: &NSArray<NSNumber>, )
Setter for sourceSampleDataTrackIDs.
Source§impl AVMutableVideoComposition
Methods declared on superclass NSObject.
impl AVMutableVideoComposition
Methods declared on superclass NSObject.
Source§impl AVMutableVideoComposition
AVMutableVideoCompositionColorimetery.
impl AVMutableVideoComposition
AVMutableVideoCompositionColorimetery.
pub unsafe fn colorPrimaries(&self) -> Option<Retained<NSString>>
Sourcepub unsafe fn setColorPrimaries(&self, color_primaries: Option<&NSString>)
pub unsafe fn setColorPrimaries(&self, color_primaries: Option<&NSString>)
Setter for colorPrimaries.
pub unsafe fn colorYCbCrMatrix(&self) -> Option<Retained<NSString>>
Sourcepub unsafe fn setColorYCbCrMatrix(
&self,
color_y_cb_cr_matrix: Option<&NSString>,
)
pub unsafe fn setColorYCbCrMatrix( &self, color_y_cb_cr_matrix: Option<&NSString>, )
Setter for colorYCbCrMatrix.
pub unsafe fn colorTransferFunction(&self) -> Option<Retained<NSString>>
Sourcepub unsafe fn setColorTransferFunction(
&self,
color_transfer_function: Option<&NSString>,
)
pub unsafe fn setColorTransferFunction( &self, color_transfer_function: Option<&NSString>, )
Setter for colorTransferFunction.
pub unsafe fn perFrameHDRDisplayMetadataPolicy( &self, ) -> Retained<AVVideoCompositionPerFrameHDRDisplayMetadataPolicy>
Sourcepub unsafe fn setPerFrameHDRDisplayMetadataPolicy(
&self,
per_frame_hdr_display_metadata_policy: &AVVideoCompositionPerFrameHDRDisplayMetadataPolicy,
)
pub unsafe fn setPerFrameHDRDisplayMetadataPolicy( &self, per_frame_hdr_display_metadata_policy: &AVVideoCompositionPerFrameHDRDisplayMetadataPolicy, )
Setter for perFrameHDRDisplayMetadataPolicy.
Source§impl AVMutableVideoComposition
AVMutableVideoCompositionFiltering.
impl AVMutableVideoComposition
AVMutableVideoCompositionFiltering.
Sourcepub unsafe fn videoCompositionWithAsset_applyingCIFiltersWithHandler(
asset: &AVAsset,
applier: &Block<dyn Fn(NonNull<AVAsynchronousCIImageFilteringRequest>)>,
) -> Retained<AVMutableVideoComposition>
👎Deprecated: Use videoCompositionWithAsset:applyingCIFiltersWithHandler:completionHandler: insteadAvailable on crate features AVAsset and AVVideoCompositing and block2 only.
pub unsafe fn videoCompositionWithAsset_applyingCIFiltersWithHandler( asset: &AVAsset, applier: &Block<dyn Fn(NonNull<AVAsynchronousCIImageFilteringRequest>)>, ) -> Retained<AVMutableVideoComposition>
AVAsset and AVVideoCompositing and block2 only.Returns a new instance of AVMutableVideoComposition with values and instructions that will apply the specified handler block to video frames represented as instances of CIImage.
Parameter asset: An instance of AVAsset. For best performance, ensure that the duration and tracks properties of the asset are already loaded before invoking this method.
Returns: An instance of AVMutableVideoComposition.
The returned AVMutableVideoComposition will cause the specified handler block to be called to filter each frame of the asset’s first enabled video track. The handler block should use the properties of the provided AVAsynchronousCIImageFilteringRequest and respond using finishWithImage:context: with a “filtered” new CIImage (or the provided source image for no affect). In the event of an error, respond to the request using finishWithError:. The error can be observed via AVPlayerItemFailedToPlayToEndTimeNotification, see AVPlayerItemFailedToPlayToEndTimeErrorKey in notification payload. The client can set sourceTrackIDForFrameTiming to kCMPersistentTrackID_Invalid and frameDuration to an appropriate value in order to specify the maximum output frame rate independent of the source track timing.
The video composition will also have the following values for its properties:
- The original timing of the asset’s first enabled video track will be used.
- A renderSize that encompasses the asset’s first enabled video track respecting the track’s preferredTransform.
- A renderScale of 1.0.
The default CIContext has the following properties:
- iOS: Device RGB color space
- macOS: sRGB color space
Example usage:
playerItem.videoComposition = [AVMutableVideoComposition videoCompositionWithAsset:srcAsset applyingCIFiltersWithHandler: ^(AVAsynchronousCIImageFilteringRequest *request) { NSError *err = nil; CIImage *filtered = myRenderer(request, &err ); if (filtered) [request finishWithImage:filtered context:nil]; else [request finishWithError:err]; }];
Sourcepub unsafe fn videoCompositionWithAsset_applyingCIFiltersWithHandler_completionHandler(
asset: &AVAsset,
applier: &Block<dyn Fn(NonNull<AVAsynchronousCIImageFilteringRequest>)>,
completion_handler: &Block<dyn Fn(*mut AVMutableVideoComposition, *mut NSError)>,
)
Available on crate features AVAsset and AVVideoCompositing and block2 only.
pub unsafe fn videoCompositionWithAsset_applyingCIFiltersWithHandler_completionHandler( asset: &AVAsset, applier: &Block<dyn Fn(NonNull<AVAsynchronousCIImageFilteringRequest>)>, completion_handler: &Block<dyn Fn(*mut AVMutableVideoComposition, *mut NSError)>, )
AVAsset and AVVideoCompositing and block2 only.Vends a new instance of AVMutableVideoComposition with values and instructions that will apply the specified handler block to video frames represented as instances of CIImage.
Parameter asset: An instance of AVAsset.
Parameter completionHandler: A block that is invoked when the new video composition has finished being created. If the videoComposition parameter is nil, the error parameter describes the failure that occurred.
The new AVMutableVideoComposition will cause the specified handler block to be called to filter each frame of the asset’s first enabled video track. The handler block should use the properties of the provided AVAsynchronousCIImageFilteringRequest and respond using finishWithImage:context: with a “filtered” new CIImage (or the provided source image for no affect). In the event of an error, respond to the request using finishWithError:. The error can be observed via AVPlayerItemFailedToPlayToEndTimeNotification, see AVPlayerItemFailedToPlayToEndTimeErrorKey in notification payload. The client can set sourceTrackIDForFrameTiming to kCMPersistentTrackID_Invalid and frameDuration to an appropriate value in order to specify the maximum output frame rate independent of the source track timing.
The video composition will also have the following values for its properties:
- The original timing of the asset’s first enabled video track will be used.
- A renderSize that encompasses the asset’s first enabled video track respecting the track’s preferredTransform.
- A renderScale of 1.0.
The default CIContext has the following properties:
- iOS: Device RGB color space
- macOS: sRGB color space
Example usage:
[AVMutableVideoComposition videoCompositionWithAsset:srcAsset applyingCIFiltersWithHandler: ^(AVAsynchronousCIImageFilteringRequest *request) { NSError *err = nil; CIImage *filtered = myRenderer(request, &err ); if (filtered) [request finishWithImage:filtered context:nil]; else [request finishWithError:err]; } completionHandler: ^(AVMutableVideoComposition * _Nullable videoComposition, NSError * _Nullable error) { if (videoComposition != nil) { playerItem.videoComposition = videoComposition else { // handle error }];
Methods from Deref<Target = AVVideoComposition>§
pub unsafe fn customVideoCompositorClass(&self) -> Option<&'static AnyClass>
AVVideoCompositing only.pub unsafe fn frameDuration(&self) -> CMTime
objc2-core-media only.pub unsafe fn sourceTrackIDForFrameTiming(&self) -> CMPersistentTrackID
objc2-core-media only.pub unsafe fn renderSize(&self) -> CGSize
objc2-core-foundation only.pub unsafe fn renderScale(&self) -> c_float
pub unsafe fn instructions( &self, ) -> Retained<NSArray<ProtocolObject<dyn AVVideoCompositionInstructionProtocol>>>
AVVideoCompositing only.pub unsafe fn animationTool( &self, ) -> Option<Retained<AVVideoCompositionCoreAnimationTool>>
pub unsafe fn sourceSampleDataTrackIDs(&self) -> Retained<NSArray<NSNumber>>
pub unsafe fn colorPrimaries(&self) -> Option<Retained<NSString>>
pub unsafe fn colorYCbCrMatrix(&self) -> Option<Retained<NSString>>
pub unsafe fn colorTransferFunction(&self) -> Option<Retained<NSString>>
pub unsafe fn perFrameHDRDisplayMetadataPolicy( &self, ) -> Retained<AVVideoCompositionPerFrameHDRDisplayMetadataPolicy>
Sourcepub unsafe fn isValidForAsset_timeRange_validationDelegate(
&self,
asset: Option<&AVAsset>,
time_range: CMTimeRange,
validation_delegate: Option<&ProtocolObject<dyn AVVideoCompositionValidationHandling>>,
) -> bool
👎Deprecated: Use isValidForTracks:assetDuration:timeRange:validationDelegate: insteadAvailable on crate features AVAsset and objc2-core-media only.
pub unsafe fn isValidForAsset_timeRange_validationDelegate( &self, asset: Option<&AVAsset>, time_range: CMTimeRange, validation_delegate: Option<&ProtocolObject<dyn AVVideoCompositionValidationHandling>>, ) -> bool
AVAsset and objc2-core-media only.Indicates whether the timeRanges of the receiver’s instructions conform to the requirements described for them immediately above (in connection with the instructions property) and also whether all of the layer instructions have a value for trackID that corresponds either to a track of the specified asset or to the receiver’s animationTool.
Parameter asset: Pass a reference to an AVAsset if you wish to validate the timeRanges of the instructions against the duration of the asset and the trackIDs of the layer instructions against the asset’s tracks. Pass nil to skip that validation. Clients should ensure that the keys
“
tracks“ and @“duration” are already loaded on the AVAsset before validation is attempted.
Parameter timeRange: A CMTimeRange. Only those instructions with timeRanges that overlap with the specified timeRange will be validated. To validate all instructions that may be used for playback or other processing, regardless of timeRange, pass CMTimeRangeMake(kCMTimeZero, kCMTimePositiveInfinity).
Parameter validationDelegate: Indicates an object implementing the AVVideoCompositionValidationHandling protocol to receive information about troublesome portions of a video composition during processing of -isValidForAsset:. May be nil.
In the course of validation, the receiver will invoke its validationDelegate with reference to any trouble spots in the video composition. An exception will be raised if the delegate modifies the receiver’s array of instructions or the array of layerInstructions of any AVVideoCompositionInstruction contained therein during validation.
Sourcepub unsafe fn determineValidityForAsset_timeRange_validationDelegate_completionHandler(
&self,
asset: Option<&AVAsset>,
time_range: CMTimeRange,
validation_delegate: Option<&ProtocolObject<dyn AVVideoCompositionValidationHandling>>,
completion_handler: &Block<dyn Fn(Bool, *mut NSError)>,
)
👎DeprecatedAvailable on crate features AVAsset and block2 and objc2-core-media only.
pub unsafe fn determineValidityForAsset_timeRange_validationDelegate_completionHandler( &self, asset: Option<&AVAsset>, time_range: CMTimeRange, validation_delegate: Option<&ProtocolObject<dyn AVVideoCompositionValidationHandling>>, completion_handler: &Block<dyn Fn(Bool, *mut NSError)>, )
AVAsset and block2 and objc2-core-media only.Determines whether the timeRanges of the receiver’s instructions conform to the requirements described for them immediately above (in connection with the instructions property) and also whether all of the layer instructions have a value for trackID that corresponds either to a track of the specified asset or to the receiver’s animationTool.
Parameter asset: Pass a reference to an AVAsset if you wish to validate the timeRanges of the instructions against the duration of the asset and the trackIDs of the layer instructions against the asset’s tracks. Pass nil to skip that validation.
Parameter timeRange: A CMTimeRange. Only those instructions with timeRanges that overlap with the specified timeRange will be validated. To validate all instructions that may be used for playback or other processing, regardless of timeRange, pass CMTimeRangeMake(kCMTimeZero, kCMTimePositiveInfinity).
Parameter validationDelegate: Indicates an object implementing the AVVideoCompositionValidationHandling protocol to receive information about troublesome portions of a video composition during processing of -determineValidityForAsset:. May be nil.
Parameter completionHandler: A block that is invoked when a determination is made about whether the video composition is valid. If the isValid parameter is NO, either the video composition is not valid, in which case the error parameter will be nil, or the answer could not be determined, in which case the error parameter will be non-nil and describe the failure that occurred.
In the course of validation, the receiver will invoke its validationDelegate with reference to any trouble spots in the video composition. An exception will be raised if the delegate modifies the receiver’s array of instructions or the array of layerInstructions of any AVVideoCompositionInstruction contained therein during validation.
Sourcepub unsafe fn isValidForTracks_assetDuration_timeRange_validationDelegate(
&self,
tracks: &NSArray<AVAssetTrack>,
duration: CMTime,
time_range: CMTimeRange,
validation_delegate: Option<&ProtocolObject<dyn AVVideoCompositionValidationHandling>>,
) -> bool
Available on crate features AVAssetTrack and objc2-core-media only.
pub unsafe fn isValidForTracks_assetDuration_timeRange_validationDelegate( &self, tracks: &NSArray<AVAssetTrack>, duration: CMTime, time_range: CMTimeRange, validation_delegate: Option<&ProtocolObject<dyn AVVideoCompositionValidationHandling>>, ) -> bool
AVAssetTrack and objc2-core-media only.Indicates whether the timeRanges of the receiver’s instructions conform to the requirements described for them immediately above (in connection with the instructions property) and also whether all of the layer instructions have a value for trackID that corresponds either to a track of the specified asset or to the receiver’s animationTool.
Parameter tracks: Pass a reference to an AVAsset’s tracks if you wish to validate the trackIDs of the layer instructions against the asset’s tracks. Pass nil to skip that validation. This method throws an exception if the tracks are not all from the same asset.
Parameter duration: Pass an AVAsset if you wish to validate the timeRanges of the instructions against the duration of the asset. Pass kCMTimeInvalid to skip that validation.
Parameter timeRange: A CMTimeRange. Only those instructions with timeRanges that overlap with the specified timeRange will be validated. To validate all instructions that may be used for playback or other processing, regardless of timeRange, pass CMTimeRangeMake(kCMTimeZero, kCMTimePositiveInfinity).
Parameter validationDelegate: Indicates an object implementing the AVVideoCompositionValidationHandling protocol to receive information about troublesome portions of a video composition during processing of -isValidForAsset:. May be nil.
In the course of validation, the receiver will invoke its validationDelegate with reference to any trouble spots in the video composition. An exception will be raised if the delegate modifies the receiver’s array of instructions or the array of layerInstructions of any AVVideoCompositionInstruction contained therein during validation.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
pub fn class(&self) -> &'static AnyClass
Dynamically find the class of this object.
§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());Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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§
Source§impl AsRef<AVVideoComposition> for AVMutableVideoComposition
impl AsRef<AVVideoComposition> for AVMutableVideoComposition
Source§fn as_ref(&self) -> &AVVideoComposition
fn as_ref(&self) -> &AVVideoComposition
Source§impl AsRef<AnyObject> for AVMutableVideoComposition
impl AsRef<AnyObject> for AVMutableVideoComposition
Source§impl AsRef<NSObject> for AVMutableVideoComposition
impl AsRef<NSObject> for AVMutableVideoComposition
Source§impl Borrow<AVVideoComposition> for AVMutableVideoComposition
impl Borrow<AVVideoComposition> for AVMutableVideoComposition
Source§fn borrow(&self) -> &AVVideoComposition
fn borrow(&self) -> &AVVideoComposition
Source§impl Borrow<AnyObject> for AVMutableVideoComposition
impl Borrow<AnyObject> for AVMutableVideoComposition
Source§impl Borrow<NSObject> for AVMutableVideoComposition
impl Borrow<NSObject> for AVMutableVideoComposition
Source§impl ClassType for AVMutableVideoComposition
impl ClassType for AVMutableVideoComposition
Source§const NAME: &'static str = "AVMutableVideoComposition"
const NAME: &'static str = "AVMutableVideoComposition"
Source§type Super = AVVideoComposition
type Super = AVVideoComposition
Source§type ThreadKind = <<AVMutableVideoComposition as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<AVMutableVideoComposition as ClassType>::Super as ClassType>::ThreadKind
Source§impl CopyingHelper for AVMutableVideoComposition
impl CopyingHelper for AVMutableVideoComposition
Source§type Result = AVVideoComposition
type Result = AVVideoComposition
Self if the type has no
immutable counterpart. Read moreSource§impl Debug for AVMutableVideoComposition
impl Debug for AVMutableVideoComposition
Source§impl Deref for AVMutableVideoComposition
impl Deref for AVMutableVideoComposition
Source§impl Hash for AVMutableVideoComposition
impl Hash for AVMutableVideoComposition
Source§impl Message for AVMutableVideoComposition
impl Message for AVMutableVideoComposition
Source§impl MutableCopyingHelper for AVMutableVideoComposition
impl MutableCopyingHelper for AVMutableVideoComposition
Source§type Result = AVMutableVideoComposition
type Result = AVMutableVideoComposition
Self if the type has no
mutable counterpart. Read moreSource§impl NSCopying for AVMutableVideoComposition
impl NSCopying for AVMutableVideoComposition
Source§impl NSMutableCopying for AVMutableVideoComposition
impl NSMutableCopying for AVMutableVideoComposition
Source§impl NSObjectProtocol for AVMutableVideoComposition
impl NSObjectProtocol for AVMutableVideoComposition
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass directly, or cast your objects with AnyObject::downcast_ref