Struct AVMutableMovieTrack

#[repr(C)]
pub struct AVMutableMovieTrack { /* private fields */ }

Available on crate features AVAssetTrack and AVMovieTrack only.

Apple’s documentation

Implementations

impl AVMutableMovieTrack

pub unsafe fn mediaDataStorage(&self) -> Option<Retained<AVMediaDataStorage>>

Available on crate feature AVMovie only.

The storage container for media data added to a track.

The value of this property is an AVMediaDataStorage object that indicates the location at which media data inserted or appended to the track will be written.

pub unsafe fn setMediaDataStorage( &self, media_data_storage: Option<&AVMediaDataStorage>, )

Available on crate feature AVMovie only.

Setter for mediaDataStorage.

pub unsafe fn sampleReferenceBaseURL(&self) -> Option<Retained<NSURL>>

For file types that support writing sample references, such as QuickTime Movie files, specifies the base URL that sample references are relative to; may be nil.

If the value of this property can be resolved as an absolute URL, the sample locations written to the file when appending sample references to this track will be relative to this URL. The URL must point to a location contained by any common parent directory of the locations that will be referenced. For example, setting the sampleReferenceBaseURL property to “file:///Users/johnappleseed/Movies/” and appending sample buffers that refer to “file:///Users/johnappleseed/Movies/data/movie1.mov” will cause the sample reference “data/movie1.mov” to be written to the movie file.

If the value of the property cannot be resolved as an absolute URL or if it points to a location that is not contained by any common parent directory of the locations that will be referenced, the location will be written unmodified.

The default value is nil, which means that the location will be written unmodified.

pub unsafe fn setSampleReferenceBaseURL( &self, sample_reference_base_url: Option<&NSURL>, )

Setter for sampleReferenceBaseURL.

pub unsafe fn isEnabled(&self) -> bool

A BOOL value indicating whether the track is enabled by default for presentation.

pub unsafe fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

pub unsafe fn alternateGroupID(&self) -> NSInteger

An integer indicating the track as a member of a particular alternate group.

pub unsafe fn setAlternateGroupID(&self, alternate_group_id: NSInteger)

Setter for alternateGroupID.

pub unsafe fn isModified(&self) -> bool

Whether a track has been modified.

The value of this property is a BOOL that indicates whether the AVMutableMovieTrack object has been modified since it was created, was last written, or had its modified state cleared via a call to setModified:NO.

pub unsafe fn setModified(&self, modified: bool)

Setter for isModified.

pub unsafe fn hasProtectedContent(&self) -> bool

Whether a track contains protected content.

The value of this property is a BOOL that indicates whether the track contains protected content.

pub unsafe fn timescale(&self) -> CMTimeScale

Available on crate feature objc2-core-media only.

For file types that contain a ‘moov’ atom, such as QuickTime Movie files, specifies the time scale of the track’s media.

The default media time scale is 0.

This property should be set on a new empty track before any edits are performed on the track.

pub unsafe fn setTimescale(&self, timescale: CMTimeScale)

Available on crate feature objc2-core-media only.

Setter for timescale.

impl AVMutableMovieTrack

Methods declared on superclass AVAssetTrack.

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

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

impl AVMutableMovieTrack

AVMutableMovieTrackLanguageProperties.

pub unsafe fn languageCode(&self) -> Option<Retained<NSString>>

The language associated with the track.

The value of this property is an ISO 639-2/T language code indicating the language associated with the track; may be nil if no language is indicated.

pub unsafe fn setLanguageCode(&self, language_code: Option<&NSString>)

Setter for languageCode.

pub unsafe fn extendedLanguageTag(&self) -> Option<Retained<NSString>>

The language tag associated with the track.

The value of this property is an IETF BCP 47 (RFC 4646) language identifier indicating the language tag associated with the track; may be nil if no language tag is indicated.

pub unsafe fn setExtendedLanguageTag( &self, extended_language_tag: Option<&NSString>, )

Setter for extendedLanguageTag.

impl AVMutableMovieTrack

AVMutableMovieTrackVisualProperties.

pub unsafe fn naturalSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

A CGSize indicating the dimensions at which the visual media data of the track should be displayed.

pub unsafe fn setNaturalSize(&self, natural_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for naturalSize.

pub unsafe fn preferredTransform(&self) -> CGAffineTransform

Available on crate feature objc2-core-foundation only.

A CGAffineTransform indicating the transform specified in the track’s storage container as the preferred transformation of the visual media data for display purposes; the value is often but not always CGAffineTransformIdentity.

pub unsafe fn setPreferredTransform( &self, preferred_transform: CGAffineTransform, )

Available on crate feature objc2-core-foundation only.

Setter for preferredTransform.

pub unsafe fn layer(&self) -> NSInteger

The layer level of the visual media data of the track.

pub unsafe fn setLayer(&self, layer: NSInteger)

Setter for layer.

pub unsafe fn cleanApertureDimensions(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

A CGSize indicating the clean aperture dimensions of the track.

pub unsafe fn setCleanApertureDimensions( &self, clean_aperture_dimensions: CGSize, )

Available on crate feature objc2-core-foundation only.

Setter for cleanApertureDimensions.

pub unsafe fn productionApertureDimensions(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

A CGSize indicating the production aperture dimensions of the track.

pub unsafe fn setProductionApertureDimensions( &self, production_aperture_dimensions: CGSize, )

Available on crate feature objc2-core-foundation only.

Setter for productionApertureDimensions.

pub unsafe fn encodedPixelsDimensions(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

A CGSize indicating the dimensions encoded pixels dimensions of the track.

pub unsafe fn setEncodedPixelsDimensions( &self, encoded_pixels_dimensions: CGSize, )

Available on crate feature objc2-core-foundation only.

Setter for encodedPixelsDimensions.

impl AVMutableMovieTrack

AVMutableMovieTrackAudibleProperties.

pub unsafe fn preferredVolume(&self) -> c_float

The preferred volume of the audible media data of the track; often but not always 1.0.

pub unsafe fn setPreferredVolume(&self, preferred_volume: c_float)

Setter for preferredVolume.

impl AVMutableMovieTrack

AVMutableMovieTrackChunkProperties.

pub unsafe fn preferredMediaChunkSize(&self) -> NSInteger

For file types that support media chunk sizes, the maximum size (in bytes) to be used for each chunk of sample data written to the file.

The total size of the samples in a chunk will be no larger than this preferred chunk size, or the size of a single sample if the sample is larger than this preferred chunk size.

The default media chunk size is 1024 * 1024 bytes. It is an error to set a negative chunk size.

pub unsafe fn setPreferredMediaChunkSize( &self, preferred_media_chunk_size: NSInteger, )

Setter for preferredMediaChunkSize.

pub unsafe fn preferredMediaChunkDuration(&self) -> CMTime

Available on crate feature objc2-core-media only.

For file types that support media chunk durations, the maximum duration to be used for each chunk of sample data written to the file.

The total duration of the samples in a chunk will be no greater than this preferred chunk duration, or the duration of a single sample if the sample’s duration is greater than this preferred chunk duration.

The default media chunk duration is 1.0 second. It is an error to set a chunk duration that is negative or non-numeric.

pub unsafe fn setPreferredMediaChunkDuration( &self, preferred_media_chunk_duration: CMTime, )

Available on crate feature objc2-core-media only.

Setter for preferredMediaChunkDuration.

pub unsafe fn preferredMediaChunkAlignment(&self) -> NSInteger

For file types that support media chunk alignment, the boundary for media chunk alignment (in bytes).

The default value is 0, which means that no padding should be used to achieve chunk alignment. It is an error to set a negative value for chunk alignment.

pub unsafe fn setPreferredMediaChunkAlignment( &self, preferred_media_chunk_alignment: NSInteger, )

Setter for preferredMediaChunkAlignment.

impl AVMutableMovieTrack

AVMutableMovieTrackTrackLevelEditing.

pub unsafe fn insertTimeRange_ofTrack_atTime_copySampleData_error( &self, time_range: CMTimeRange, track: &AVAssetTrack, start_time: CMTime, copy_sample_data: bool, ) -> Result<(), Retained<NSError>>

Available on crate feature objc2-core-media only.

Inserts a portion of an AVAssetTrack object into the target movie.

Parameter timeRange: The time range from the track from which media is to be inserted.

Parameter track: An AVAssetTrack object indicating the source of the inserted media. Only AVAssetTracks of AVURLAssets and AVCompositions are supported. Must not be nil.

Parameter startTime: The time in the target track at which the media is to be inserted.

Parameter copySampleData: A BOOL value that indicates whether sample data is to be copied from the source to the destination during edits. If YES, the sample data is written to the file specified by the track property mediaDataStorage if non-nil, or else by the movie property defaultMediaDataStorage if non-nil; if both are nil, the method will fail and return NO. If NO, sample data will not be written and sample references to the samples in their original container will be added as necessary. Note that in this case, this method will fail if the original samples are fragmented.

Parameter outError: If the insertion fails, describes the nature of the failure.

Returns: A BOOL value that indicates the success of the insertion.

pub unsafe fn insertEmptyTimeRange(&self, time_range: CMTimeRange)

Available on crate feature objc2-core-media only.

Adds an empty time range to the target track.

Parameter timeRange: The time range to be made empty. Note that you cannot add empty time ranges to the end of a track.

pub unsafe fn removeTimeRange(&self, time_range: CMTimeRange)

Available on crate feature objc2-core-media only.

Removes a specified time range from a track.

Parameter timeRange: The time range to be removed.

pub unsafe fn scaleTimeRange_toDuration( &self, time_range: CMTimeRange, duration: CMTime, )

Available on crate feature objc2-core-media only.

Changes the duration of a time range of a track.

Parameter timeRange: The time range to be scaled.

Parameter duration: The new duration of the time range.

impl AVMutableMovieTrack

AVMutableMovieTrackMetadataEditing.

pub unsafe fn metadata(&self) -> Retained<NSArray<AVMetadataItem>>

Available on crate feature AVMetadataItem only.

A collection of metadata stored by the track.

The value of this property is an array of AVMetadataItem objects representing the collection of metadata stored by the track.

pub unsafe fn setMetadata(&self, metadata: &NSArray<AVMetadataItem>)

Available on crate feature AVMetadataItem only.

Setter for metadata.

impl AVMutableMovieTrack

AVMutableMovieTrackTrackAssociations.

pub unsafe fn addTrackAssociationToTrack_type( &self, movie_track: &AVMovieTrack, track_association_type: &AVTrackAssociationType, )

Establishes a track association of a specific type between two tracks.

Parameter movieTrack: An AVMovieTrack object that is to be associated with the receiver.

Parameter trackAssociationType: The type of track association to add between the receiver and the specified movieTrack (for instance, AVTrackAssociationTypeChapterList).

This method throws an exception if the movie track belongs to a different movie.

pub unsafe fn removeTrackAssociationToTrack_type( &self, movie_track: &AVMovieTrack, track_association_type: &AVTrackAssociationType, )

Removes a track association of a specific type between two tracks.

Parameter movieTrack: An AVMovieTrack object that is associated with the receiver.

Parameter trackAssociationType: The type of track association to remove between the receiver and the specified movieTrack (for instance, AVTrackAssociationTypeChapterList).

This method throws an exception if the movie track belongs to a different movie.

impl AVMutableMovieTrack

AVMutableMovieTrackFormatDescriptions.

pub unsafe fn replaceFormatDescription_withFormatDescription( &self, format_description: &CMFormatDescription, new_format_description: &CMFormatDescription, )

Available on crate feature objc2-core-media only.

Replaces one of the receiver’s format descriptions with another format description

Parameter formatDescription: A CMFormatDescription occurring in the array returned by the -formatDescriptions method.

Parameter newFormatDescription: A CMFormatDescription to replace the specified format description.

You can use this method to make surgical changes to a track’s format descriptions, such as adding format description extensions to a format description or changing the audio channel layout of an audio track. You should note that a format description can have extensions of type kCMFormatDescriptionExtension_VerbatimSampleDescription and kCMFormatDescriptionExtension_VerbatimISOSampleEntry; if you modify a copy of a format description, you should delete those extensions from the copy or your changes might be ignored.

This method throws an exception if the media type of the new format description does not match the media type of the receiver.

impl AVMutableMovieTrack

AVMutableMovieTrackSampleLevelEditing.

pub unsafe fn appendSampleBuffer_decodeTime_presentationTime_error( &self, sample_buffer: &CMSampleBuffer, out_decode_time: *mut CMTime, out_presentation_time: *mut CMTime, ) -> Result<(), Retained<NSError>>

Available on crate feature objc2-core-media only.

Appends sample data to a media file and adds sample references for the added data to a track’s media sample tables.

Parameter sampleBuffer: The CMSampleBuffer to be appended; this may be obtained from an instance of AVAssetReader.

Parameter outDecodeTime: A pointer to a CMTime structure to receive the decode time in the media of the first sample appended from the sample buffer. Pass NULL if you do not need this information.

Parameter outPresentationTime: A pointer to a CMTime structure to receive the presentation time in the media of the first sample appended from the sample buffer. Pass NULL if you do not need this information.

Parameter outError: If the appending fails, describes the nature of the failure. For example, if the device containing the track’s media data storage is full, AVErrorDiskFull is returned.

Returns: A BOOL value indicating the success of the operation.

If the sample buffer carries sample data, the sample data is written to the container specified by the track property mediaDataStorage if non-nil, or else by the movie property defaultMediaDataStorage if non-nil, and sample references will be appended to the track’s media. If both media data storage properties are nil, the method will fail and return NO. If the sample buffer carries sample references only, sample data will not be written and sample references to the samples in their original container will be appended to the track’s media as necessary.

Note regarding sample timing: in a track’s media, the first sample’s decode timestamp must always be zero. For an audio track, each sample buffer’s duration is used as the sample decode duration. For other track types, difference between a sample’s decode timestamp and the following sample’s decode timestamp is used as the first sample’s decode duration, so as to preserve the relative timing.

Note that this method does not modify the track’s sourceTimeMappings but only appends sample references and sample data to the track’s media. To make the new samples appear in the track’s timeline, invoke -insertMediaTimeRange:intoTimeRange:. You can retrieve the mediaPresentationTimeRange property before and after appending a sequence of samples, using CMTimeRangeGetEnd on each to calculate the media TimeRange for -insertMediaTimeRange:intoTimeRange:.

It’s safe for multiple threads to call this method on different tracks at once.

This method throws an exception for any of the following reasons:

• the sample buffer’s media type does not match the track’s media type
• the sample buffer contains image buffers (must contain encoded video)
• the sample buffer contains caption groups (must contain encoded media data)

pub unsafe fn insertMediaTimeRange_intoTimeRange( &self, media_time_range: CMTimeRange, track_time_range: CMTimeRange, ) -> bool

Available on crate feature objc2-core-media only.

Inserts a reference to a media time range into a track.

Parameter mediaTimeRange: The presentation time range of the media to be inserted.

Parameter trackTimeRange: The time range of the track into which the media is to be inserted.

Returns: A BOOL value indicating the success of the operation.

Use this method after you have appended samples or sample references to a track’s media.

To specify that the media time range be played at its natural rate, pass mediaTimeRange.duration == trackTimeRange.duration; otherwise, the ratio between these is used to determine the playback rate.

Pass kCMTimeInvalid for trackTimeRange.start to indicate that the segment should be appended to the end of the track.

impl AVMutableMovieTrack

SynchronousTrackInterface. Redeclarations of async-only AVAssetTrack interfaces to allow synchronous usage in the synchronous subclass.

See AVAssetTrack’s interface for more information about these interfaces.

pub unsafe fn hasMediaCharacteristic( &self, media_characteristic: &AVMediaCharacteristic, ) -> bool

Available on crate feature AVMediaFormat only.

pub unsafe fn segmentForTrackTime( &self, track_time: CMTime, ) -> Option<Retained<AVAssetTrackSegment>>

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

pub unsafe fn samplePresentationTimeForTrackTime( &self, track_time: CMTime, ) -> CMTime

Available on crate feature objc2-core-media only.

pub unsafe fn metadataForFormat( &self, format: &AVMetadataFormat, ) -> Retained<NSArray<AVMetadataItem>>

Available on crate features AVMetadataFormat and AVMetadataItem only.

pub unsafe fn associatedTracksOfType( &self, track_association_type: &AVTrackAssociationType, ) -> Retained<NSArray<AVAssetTrack>>

Methods from Deref<Target = AVMovieTrack>

pub unsafe fn mediaPresentationTimeRange(&self) -> CMTimeRange

Available on crate feature objc2-core-media only.

A CMTimeRange indicating the range of presentation times for the track’s media.

pub unsafe fn mediaDecodeTimeRange(&self) -> CMTimeRange

Available on crate feature objc2-core-media only.

A CMTimeRange indicating the range of decode times for the track’s media.

pub unsafe fn alternateGroupID(&self) -> NSInteger

pub unsafe fn mediaDataStorage(&self) -> Option<Retained<AVMediaDataStorage>>

Available on crate feature AVMovie only.

The storage container for media data added to a track.

The value of this property is an AVMediaDataStorage object that indicates the location at which media data inserted or appended to the track will be written.

Methods from Deref<Target = AVAssetTrack>

pub unsafe fn asset(&self) -> Option<Retained<AVAsset>>

Available on crate feature AVAsset only.

pub unsafe fn trackID(&self) -> CMPersistentTrackID

Available on crate feature objc2-core-media only.

pub unsafe fn mediaType(&self) -> Retained<AVMediaType>

Available on crate feature AVMediaFormat only.

pub unsafe fn formatDescriptions(&self) -> Retained<NSArray>

pub unsafe fn isPlayable(&self) -> bool

pub unsafe fn isDecodable(&self) -> bool

pub unsafe fn isEnabled(&self) -> bool

pub unsafe fn isSelfContained(&self) -> bool

pub unsafe fn totalSampleDataLength(&self) -> c_longlong

pub unsafe fn hasMediaCharacteristic( &self, media_characteristic: &AVMediaCharacteristic, ) -> bool

Available on crate feature AVMediaFormat only.

Reports whether the track references media with the specified media characteristic.

Parameter mediaCharacteristic: The media characteristic of interest, e.g. AVMediaCharacteristicVisual, AVMediaCharacteristicAudible, AVMediaCharacteristicLegible, etc., as defined above.

Returns: YES if the track references media with the specified characteristic, otherwise NO.

pub unsafe fn timeRange(&self) -> CMTimeRange

Available on crate feature objc2-core-media only.

pub unsafe fn naturalTimeScale(&self) -> CMTimeScale

Available on crate feature objc2-core-media only.

pub unsafe fn estimatedDataRate(&self) -> c_float

pub unsafe fn languageCode(&self) -> Option<Retained<NSString>>

pub unsafe fn extendedLanguageTag(&self) -> Option<Retained<NSString>>

pub unsafe fn naturalSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

pub unsafe fn preferredTransform(&self) -> CGAffineTransform

Available on crate feature objc2-core-foundation only.

pub unsafe fn preferredVolume(&self) -> c_float

pub unsafe fn hasAudioSampleDependencies(&self) -> bool

pub unsafe fn nominalFrameRate(&self) -> c_float

For tracks that carry a full frame per media sample, indicates the frame rate of the track in units of frames per second.

For field-based video tracks that carry one field per media sample, the value of this property is the field rate, not the frame rate.

pub unsafe fn minFrameDuration(&self) -> CMTime

Available on crate feature objc2-core-media only.

pub unsafe fn requiresFrameReordering(&self) -> bool

Indicates whether samples in the track may have different values for their presentation and decode timestamps.

pub unsafe fn segments(&self) -> Retained<NSArray<AVAssetTrackSegment>>

Available on crate feature AVAssetTrackSegment only.

pub unsafe fn segmentForTrackTime( &self, track_time: CMTime, ) -> Option<Retained<AVAssetTrackSegment>>

👎Deprecated: Use loadSegmentForTrackTime:completionHandler: instead

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

Supplies the AVAssetTrackSegment from the segments array with a target timeRange that either contains the specified track time or is the closest to it among the target timeRanges of the track’s segments.

Parameter trackTime: The trackTime for which an AVAssetTrackSegment is requested.

Returns: An AVAssetTrackSegment.

If the trackTime does not map to a sample presentation time (e.g. it’s outside the track’s timeRange), the segment closest in time to the specified trackTime is returned.

pub unsafe fn loadSegmentForTrackTime_completionHandler( &self, track_time: CMTime, completion_handler: &Block<dyn Fn(*mut AVAssetTrackSegment, *mut NSError)>, )

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

Loads the AVAssetTrackSegment from the segments array with a target timeRange that either contains the specified track time or is the closest to it among the target timeRanges of the track’s segments.

Parameter trackTime: The trackTime for which an AVAssetTrackSegment is requested.

Parameter completionHandler: A block that is invoked when loading is complete, vending an AVAssetTrackSegment or an error.

If the trackTime does not map to a sample presentation time (e.g. it’s outside the track’s timeRange), the segment closest in time to the specified trackTime is returned.

pub unsafe fn samplePresentationTimeForTrackTime( &self, track_time: CMTime, ) -> CMTime

👎Deprecated: Use loadSamplePresentationTimeForTrackTime:completionHandler: instead

Available on crate feature objc2-core-media only.

Maps the specified trackTime through the appropriate time mapping and returns the resulting sample presentation time.

Parameter trackTime: The trackTime for which a sample presentation time is requested.

Returns: A CMTime; will be invalid if the trackTime is out of range

pub unsafe fn loadSamplePresentationTimeForTrackTime_completionHandler( &self, track_time: CMTime, completion_handler: &Block<dyn Fn(CMTime, *mut NSError)>, )

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

Maps the specified trackTime through the appropriate time mapping and loads the resulting sample presentation time.

Parameter trackTime: The trackTime for which a sample presentation time is requested.

Parameter completionHandler: A block that is invoked when loading is complete, vending a CMTime (which will be invalid if the trackTime is out of range) or an error.

pub unsafe fn commonMetadata(&self) -> Retained<NSArray<AVMetadataItem>>

Available on crate feature AVMetadataItem only.

pub unsafe fn metadata(&self) -> Retained<NSArray<AVMetadataItem>>

Available on crate feature AVMetadataItem only.

pub unsafe fn availableMetadataFormats( &self, ) -> Retained<NSArray<AVMetadataFormat>>

Available on crate feature AVMetadataFormat only.

pub unsafe fn metadataForFormat( &self, format: &AVMetadataFormat, ) -> Retained<NSArray<AVMetadataItem>>

👎Deprecated: Use loadMetadataForFormat:completionHandler: instead

Available on crate features AVMetadataFormat and AVMetadataItem only.

Provides an NSArray of AVMetadataItems, one for each metadata item in the container of the specified format.

Parameter format: The metadata format for which items are requested.

Returns: An NSArray containing AVMetadataItems.

Becomes callable without blocking when the key “ availableMetadataFormats“ has been loaded

pub unsafe fn loadMetadataForFormat_completionHandler( &self, format: &AVMetadataFormat, completion_handler: &Block<dyn Fn(*mut NSArray<AVMetadataItem>, *mut NSError)>, )

Available on crate features AVMetadataFormat and AVMetadataItem and block2 only.

Loads an NSArray of AVMetadataItems, one for each metadata item in the container of the specified format.

Parameter format: The metadata format for which items are requested.

Parameter completionHandler: A block that is invoked when loading is complete, vending the array of metadata items (which may be empty if there is no metadata of the specified format) or an error.

pub unsafe fn availableTrackAssociationTypes( &self, ) -> Retained<NSArray<AVTrackAssociationType>>

pub unsafe fn associatedTracksOfType( &self, track_association_type: &AVTrackAssociationType, ) -> Retained<NSArray<AVAssetTrack>>

👎Deprecated: Use loadAssociatedTracksOfType:completionHandler: instead

Provides an NSArray of AVAssetTracks, one for each track associated with the receiver with the specified type of track association.

Parameter trackAssociationType: The type of track association for which associated tracks are requested.

Returns: An NSArray containing AVAssetTracks; may be empty if there is no associated tracks of the specified type.

Becomes callable without blocking when the key “ availableTrackAssociationTypes“ has been loaded.

pub unsafe fn loadAssociatedTracksOfType_completionHandler( &self, track_association_type: &AVTrackAssociationType, completion_handler: &Block<dyn Fn(*mut NSArray<AVAssetTrack>, *mut NSError)>, )

Available on crate feature block2 only.

Provides an NSArray of AVAssetTracks, one for each track associated with the receiver with the specified type of track association.

Parameter trackAssociationType: The type of track association for which associated tracks are requested.

Parameter completionHandler: A block that is invoked when loading is comlete, vending an array of tracks (which may be empty if there is no associated tracks of the specified type) or an error. `

pub unsafe fn canProvideSampleCursors(&self) -> bool

pub unsafe fn makeSampleCursorWithPresentationTimeStamp( &self, presentation_time_stamp: CMTime, ) -> Option<Retained<AVSampleCursor>>

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

Creates an instance of AVSampleCursor and positions it at or near the specified presentation timestamp.

Parameter presentationTimeStamp: The desired initial presentation timestamp of the returned AVSampleCursor.

Returns: An instance of AVSampleCursor.

If the receiver’s asset has a value of YES for providesPreciseDurationAndTiming, the sample cursor will be accurately positioned at the receiver’s last media sample with presentation timestamp less than or equal to the desired timestamp, or, if there are no such samples, the first sample in presentation order. If the receiver’s asset has a value of NO for providesPreciseDurationAndTiming, and it is prohibitively expensive to locate the precise sample at the desired timestamp, the sample cursor may be approximately positioned. This method will return nil if there are no samples in the track.

pub unsafe fn makeSampleCursorAtFirstSampleInDecodeOrder( &self, ) -> Option<Retained<AVSampleCursor>>

Available on crate feature AVSampleCursor only.

Creates an instance of AVSampleCursor and positions it at the receiver’s first media sample in decode order.

Returns: An instance of AVSampleCursor.

This method will return nil if there are no samples in the track.

pub unsafe fn makeSampleCursorAtLastSampleInDecodeOrder( &self, ) -> Option<Retained<AVSampleCursor>>

Available on crate feature AVSampleCursor only.

Creates an instance of AVSampleCursor and positions it at the receiver’s last media sample in decode order.

Returns: An instance of AVSampleCursor.

This method will return nil if there are no samples in the track.

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.

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 AVAsynchronousKeyValueLoading for AVMutableMovieTrack

Available on crate feature AVAsynchronousKeyValueLoading only.

unsafe fn loadValuesAsynchronouslyForKeys_completionHandler( &self, keys: &NSArray<NSString>, handler: Option<&Block<dyn Fn()>>, )

where Self: Sized + Message,

Available on crate feature block2 only.

Directs the target to load the values of any of the specified keys that are not already loaded.

impl AsRef<AVAssetTrack> for AVMutableMovieTrack

fn as_ref(&self) -> &AVAssetTrack

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

impl AsRef<AVMovieTrack> for AVMutableMovieTrack

fn as_ref(&self) -> &AVMovieTrack

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

impl AsRef<AVMutableMovieTrack> for AVMutableMovieTrack

fn as_ref(&self) -> &Self

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

impl AsRef<AnyObject> for AVMutableMovieTrack

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for AVMutableMovieTrack

fn as_ref(&self) -> &NSObject

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

impl Borrow<AVAssetTrack> for AVMutableMovieTrack

fn borrow(&self) -> &AVAssetTrack

Immutably borrows from an owned value.

impl Borrow<AVMovieTrack> for AVMutableMovieTrack

fn borrow(&self) -> &AVMovieTrack

Immutably borrows from an owned value.

impl Borrow<AnyObject> for AVMutableMovieTrack

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for AVMutableMovieTrack

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for AVMutableMovieTrack

const NAME: &'static str = "AVMutableMovieTrack"

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

type Super = AVMovieTrack

The superclass of this class.

type ThreadKind = <<AVMutableMovieTrack 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 AVMutableMovieTrack

type Result = AVMutableMovieTrack

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

impl Debug for AVMutableMovieTrack

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

Formats the value using the given formatter.

impl Deref for AVMutableMovieTrack

type Target = AVMovieTrack

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for AVMutableMovieTrack

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 AVMutableMovieTrack

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for AVMutableMovieTrack

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 NSObjectProtocol for AVMutableMovieTrack

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 PartialEq for AVMutableMovieTrack

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 AVMutableMovieTrack

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

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

impl DowncastTarget for AVMutableMovieTrack

impl Eq for AVMutableMovieTrack