Struct AVMovie

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

Available on crate features AVAsset and AVMovie only.

Apple’s documentation

Implementations

impl AVMovie

pub unsafe fn movieTypes() -> Retained<NSArray<AVFileType>>

Available on crate feature AVMediaFormat only.

Provides the file types the AVMovie class understands.

Returns: An NSArray of UTIs identifying the file types the AVMovie class understands.

pub unsafe fn movieWithURL_options( url: &NSURL, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Retained<Self>

Creates an AVMovie object from a movie header stored in a QuickTime movie file or ISO base media file.

Parameter URL: An NSURL object that specifies a file containing a movie header.

Parameter options: An NSDictionary object that contains keys for specifying options for the initialization of the AVMovie object.

Returns: An AVMovie object

By default, the defaultMediaDataStorage property will be nil and each associated AVMovieTrack’s mediaDataStorage property will be nil. If you want to create an AVMutableMovie from a file and then append sample buffers to any of its tracks, you must first set one of these properties to indicate where the sample data should be written.

pub unsafe fn initWithURL_options( this: Allocated<Self>, url: &NSURL, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Retained<Self>

Creates an AVMovie object from a movie header stored in a QuickTime movie file or ISO base media file.

Parameter URL: An NSURL object that specifies a file containing a movie header.

Parameter options: An NSDictionary object that contains keys for specifying options for the initialization of the AVMovie object.

Returns: An AVMovie object

By default, the defaultMediaDataStorage property will be nil and each associated AVMovieTrack’s mediaDataStorage property will be nil. If you want to create an AVMutableMovie from a file and then append sample buffers to any of its tracks, you must first set one of these properties to indicate where the sample data should be written.

pub unsafe fn movieWithData_options( data: &NSData, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Retained<Self>

Creates an AVMovie object from a movie header stored in an NSData object.

Parameter data: An NSData object containing a movie header.

Parameter options: An NSDictionary object that contains keys for specifying options for the initialization of the AVMovie object.

Returns: An AVMovie object

You can use this method to operate on movie headers that are not stored in files; this might include movie headers on the pasteboard (which do not contain media data). In general you should avoid loading an entire movie file with its media data into an instance of NSData! By default, the defaultMediaDataStorage property will be nil and each associated AVMovieTrack’s mediaDataStorage property will be nil. If you want to create an AVMutableMovie from an NSData object and then append sample buffers to any of its tracks, you must first set one of these properties to indicate where the sample data should be written.

pub unsafe fn initWithData_options( this: Allocated<Self>, data: &NSData, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Retained<Self>

Creates an AVMovie object from a movie header stored in an NSData object.

Parameter data: An NSData object containing a movie header.

Parameter options: An NSDictionary object that contains keys for specifying options for the initialization of the AVMovie object.

Returns: An AVMovie object

You can use this method to operate on movie headers that are not stored in files. In general you should avoid loading an entire movie file with its media data into an instance of NSData!

By default, the defaultMediaDataStorage property will be nil and each associated AVMovieTrack’s mediaDataStorage property will be nil. If you want to create an AVMutableMovie from an NSData object and then append sample buffers to any of its tracks, you must first set one of these properties to indicate where the sample data should be written.

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

The URL with which the instance of AVMovie was initialized; may be nil.

pub unsafe fn data(&self) -> Option<Retained<NSData>>

The data block with which the instance of AVMovie was initialized; may be nil.

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

The default storage container for media data added to a movie.

The value of this property is an AVMediaDataStorage object that indicates where sample data that is added to a movie should be written by default.

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

Available on crate features AVAssetTrack and AVMovieTrack only.

The tracks in a movie.

The value of this property is an array of tracks the movie contains; the tracks are of type AVMovieTrack.

pub unsafe fn canContainMovieFragments(&self) -> bool

Indicates whether the movie file is capable of being extended by fragments.

The value of this property is YES if an ‘mvex’ box is present in the ‘moov’ box. The ‘mvex’ box is necessary in order to signal the possible presence of later ‘moof’ boxes.

pub unsafe fn containsMovieFragments(&self) -> bool

Indicates whether the movie file is extended by at least one movie fragment.

The value of this property is YES if canContainMovieFragments is YES and at least one ‘moof’ box is present after the ‘moov’ box.

impl AVMovie

Methods declared on superclass AVAsset.

pub unsafe fn assetWithURL(url: &NSURL) -> Retained<Self>

Returns an instance of AVAsset for inspection of a media resource.

Parameter URL: An instance of NSURL that references a media resource.

Returns: An instance of AVAsset.

Returns a newly allocated instance of a subclass of AVAsset initialized with the specified URL.

impl AVMovie

Methods declared on superclass NSObject.

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

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

impl AVMovie

AVMovieMovieHeaderSupport.

pub unsafe fn movieHeaderWithFileType_error( &self, file_type: &AVFileType, ) -> Result<Retained<NSData>, Retained<NSError>>

Available on crate feature AVMediaFormat only.

Creates an NSData object containing the movie header of the AVMovie object.

Parameter fileType: A UTI indicating the specific file format of the movie header (e.g. AVFileTypeQuickTimeMovie for a QuickTime movie).

Parameter outError: If an error occurs reading the movie header, describes the nature of the failure.

Returns: An NSData object.

The movie header will be a pure reference movie, with no base URL, suitable for use on the pasteboard.

pub unsafe fn writeMovieHeaderToURL_fileType_options_error( &self, url: &NSURL, file_type: &AVFileType, options: AVMovieWritingOptions, ) -> Result<(), Retained<NSError>>

Available on crate feature AVMediaFormat only.

Writes the movie header to a destination URL.

Parameter URL: An NSURL object indicating where to write the movie header.

Parameter fileType: A UTI indicating the specific file format (e.g. AVFileTypeQuickTimeMovie for a QuickTime movie).

Parameter options: An NSUInteger whose bits specify options for the writing of the movie header. See AVMovieWritingOptions above.

Parameter outError: If an error occurs writing the movie header, describes the nature of the failure.

Note that modifications to instances of AVMutableMovie, to their constituent AVMutableMovieTracks, or to their collections of metadata are committed to storage when their movie headers are written.

pub unsafe fn isCompatibleWithFileType(&self, file_type: &AVFileType) -> bool

Available on crate feature AVMediaFormat only.

Indicates whether a movie header for the AVMovie object can be created for the specified file type.

Parameter fileType: A UTI indicating a movie file format (e.g. AVFileTypeQuickTimeMovie for a QuickTime movie).

This method returns a BOOL that indicates whether a movie header of the specified type can be created for the receiver. For example, this method returns NO if the movie contains tracks whose media types or media subtypes are not allowed by the specified file type.

impl AVMovie

AVMovieTrackInspection.

pub unsafe fn trackWithTrackID( &self, track_id: CMPersistentTrackID, ) -> Option<Retained<AVMovieTrack>>

👎Deprecated: Use loadTrackWithTrackID:completionHandler: instead

Available on crate features AVAssetTrack and AVMovieTrack and objc2-core-media only.

Provides an instance of AVMovieTrack that represents the track of the specified trackID.

Parameter trackID: The trackID of the requested AVMovieTrack.

Returns: An instance of AVMovieTrack; may be nil if no track of the specified trackID is available.

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

pub unsafe fn loadTrackWithTrackID_completionHandler( &self, track_id: CMPersistentTrackID, completion_handler: &Block<dyn Fn(*mut AVMovieTrack, *mut NSError)>, )

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

Loads an instance of AVMovieTrack that represents the track of the specified trackID.

Parameter trackID: The trackID of the requested AVMovieTrack.

Parameter completionHandler: A block that is called when the loading is finished, with either the loaded track (which may be nil if no track of the specified trackID is available) or an error.

pub unsafe fn tracksWithMediaType( &self, media_type: &AVMediaType, ) -> Retained<NSArray<AVMovieTrack>>

👎Deprecated: Use loadTracksWithMediaType:completionHandler: instead

Available on crate features AVAssetTrack and AVMediaFormat and AVMovieTrack only.

Provides an array of AVMovieTracks of the asset that present media of the specified media type.

Parameter mediaType: The media type according to which the receiver filters its AVMovieTracks. (Media types are defined in AVMediaFormat.h)

Returns: An NSArray of AVMovieTracks; may be empty if no tracks of the specified media type are available.

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

pub unsafe fn loadTracksWithMediaType_completionHandler( &self, media_type: &AVMediaType, completion_handler: &Block<dyn Fn(*mut NSArray<AVMovieTrack>, *mut NSError)>, )

Available on crate features AVAssetTrack and AVMediaFormat and AVMovieTrack and block2 only.

Loads an array of AVMovieTracks of the asset that present media of the specified media type.

Parameter mediaType: The media type according to which AVAsset filters its AVMovieTracks. (Media types are defined in AVMediaFormat.h.)

Parameter completionHandler: A block that is called when the loading is finished, with either the loaded tracks (which may be empty if no tracks of the specified media type are available) or an error.

pub unsafe fn tracksWithMediaCharacteristic( &self, media_characteristic: &AVMediaCharacteristic, ) -> Retained<NSArray<AVMovieTrack>>

👎Deprecated: Use loadTracksWithMediaCharacteristic:completionHandler: instead

Available on crate features AVAssetTrack and AVMediaFormat and AVMovieTrack only.

Provides an array of AVMovieTracks of the asset that present media with the specified characteristic.

Parameter mediaCharacteristic: The media characteristic according to which the receiver filters its AVMovieTracks. (Media characteristics are defined in AVMediaFormat.h)

Returns: An NSArray of AVMovieTracks; may be empty if no tracks with the specified characteristic are available.

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

pub unsafe fn loadTracksWithMediaCharacteristic_completionHandler( &self, media_characteristic: &AVMediaCharacteristic, completion_handler: &Block<dyn Fn(*mut NSArray<AVMovieTrack>, *mut NSError)>, )

Available on crate features AVAssetTrack and AVMediaFormat and AVMovieTrack and block2 only.

Loads an array of AVMovieTracks of the asset that present media with the specified characteristic.

Parameter mediaCharacteristic: The media characteristic according to which AVAsset filters its AVMovieTracks. (Media characteristics are defined in AVMediaFormat.h.)

Parameter completionHandler: A block that is called when the loading is finished, with either the loaded tracks (which may be empty if no tracks with the specified characteristic are available) or an error.

Methods from Deref<Target = AVAsset>

pub unsafe fn duration(&self) -> CMTime

Available on crate feature objc2-core-media only.

pub unsafe fn preferredRate(&self) -> c_float

pub unsafe fn preferredVolume(&self) -> c_float

pub unsafe fn preferredTransform(&self) -> CGAffineTransform

Available on crate feature objc2-core-foundation only.

pub unsafe fn naturalSize(&self) -> CGSize

👎Deprecated: Use the naturalSize and preferredTransform, as appropriate, of the receiver’s video tracks. See -tracksWithMediaType:

Available on crate feature objc2-core-foundation only.

pub unsafe fn minimumTimeOffsetFromLive(&self) -> CMTime

Available on crate feature objc2-core-media only.

Indicates how close to the latest content in a live stream playback can be sustained.

For non-live assets this value is kCMTimeInvalid.

pub unsafe fn providesPreciseDurationAndTiming(&self) -> bool

pub unsafe fn cancelLoading(&self)

Cancels the loading of all values for all observers.

Deallocation or finalization of an instance of AVAsset will implicitly cancel loading if any loading requests are still outstanding.

pub unsafe fn referenceRestrictions(&self) -> AVAssetReferenceRestrictions

Indicates the reference restrictions being used by the receiver.

For AVURLAsset, this property reflects the value passed in for AVURLAssetReferenceRestrictionsKey, if any. See AVURLAssetReferenceRestrictionsKey below for a full discussion of reference restrictions. The default value for this property is AVAssetReferenceRestrictionForbidLocalReferenceToRemote.

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

Available on crate feature AVAssetTrack only.

Provides the array of AVAssetTracks contained by the asset

pub unsafe fn trackWithTrackID( &self, track_id: CMPersistentTrackID, ) -> Option<Retained<AVAssetTrack>>

👎Deprecated: Use loadTrackWithTrackID:completionHandler: instead

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

Provides an instance of AVAssetTrack that represents the track of the specified trackID.

Parameter trackID: The trackID of the requested AVAssetTrack.

Returns: An instance of AVAssetTrack; may be nil if no track of the specified trackID is available.

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

pub unsafe fn loadTrackWithTrackID_completionHandler( &self, track_id: CMPersistentTrackID, completion_handler: &Block<dyn Fn(*mut AVAssetTrack, *mut NSError)>, )

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

Loads an instance of AVAssetTrack that represents the track of the specified trackID.

Parameter trackID: The trackID of the requested AVAssetTrack.

Parameter completionHandler: A block that is called when the loading is finished, with either the loaded track (which may be nil if no track of the specified trackID is available) or an error.

pub unsafe fn tracksWithMediaType( &self, media_type: &AVMediaType, ) -> Retained<NSArray<AVAssetTrack>>

👎Deprecated: Use loadTracksWithMediaType:completionHandler: instead

Available on crate features AVAssetTrack and AVMediaFormat only.

Provides an array of AVAssetTracks of the asset that present media of the specified media type.

Parameter mediaType: The media type according to which AVAsset filters its AVAssetTracks. (Media types are defined in AVMediaFormat.h.)

Returns: An NSArray of AVAssetTracks; may be empty if no tracks of the specified media type are available.

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

pub unsafe fn loadTracksWithMediaType_completionHandler( &self, media_type: &AVMediaType, completion_handler: &Block<dyn Fn(*mut NSArray<AVAssetTrack>, *mut NSError)>, )

Available on crate features AVAssetTrack and AVMediaFormat and block2 only.

Loads an array of AVAssetTracks of the asset that present media of the specified media type.

Parameter mediaType: The media type according to which AVAsset filters its AVAssetTracks. (Media types are defined in AVMediaFormat.h.)

Parameter completionHandler: A block that is called when the loading is finished, with either the loaded tracks (which may be empty if no tracks of the specified media type are available) or an error.

pub unsafe fn tracksWithMediaCharacteristic( &self, media_characteristic: &AVMediaCharacteristic, ) -> Retained<NSArray<AVAssetTrack>>

👎Deprecated: Use loadTracksWithMediaCharacteristic:completionHandler: instead

Available on crate features AVAssetTrack and AVMediaFormat only.

Provides an array of AVAssetTracks of the asset that present media with the specified characteristic.

Parameter mediaCharacteristic: The media characteristic according to which AVAsset filters its AVAssetTracks. (Media characteristics are defined in AVMediaFormat.h.)

Returns: An NSArray of AVAssetTracks; may be empty if no tracks with the specified characteristic are available.

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

pub unsafe fn loadTracksWithMediaCharacteristic_completionHandler( &self, media_characteristic: &AVMediaCharacteristic, completion_handler: &Block<dyn Fn(*mut NSArray<AVAssetTrack>, *mut NSError)>, )

Available on crate features AVAssetTrack and AVMediaFormat and block2 only.

Loads an array of AVAssetTracks of the asset that present media with the specified characteristic.

Parameter mediaCharacteristic: The media characteristic according to which AVAsset filters its AVAssetTracks. (Media characteristics are defined in AVMediaFormat.h.)

Parameter completionHandler: A block that is called when the loading is finished, with either the loaded tracks (which may be empty if no tracks with the specified characteristic are available) or an error.

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

Available on crate feature AVAssetTrackGroup only.

All track groups in the receiver.

The value of this property is an NSArray of AVAssetTrackGroups, each representing a different grouping of tracks in the receiver.

pub unsafe fn creationDate(&self) -> Option<Retained<AVMetadataItem>>

Available on crate feature AVMetadataItem only.

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

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; can subsequently be filtered according to language via +[AVMetadataItem metadataItemsFromArray:filteredAndSortedAccordingToPreferredLanguages:], according to locale via +[AVMetadataItem metadataItemsFromArray:withLocale:], or according to key via +[AVMetadataItem metadataItemsFromArray:withKey:keySpace:].

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

Returns: An NSArray containing AVMetadataItems; may be empty if there is no metadata of the specified format.

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; can subsequently be filtered according to language via +[AVMetadataItem metadataItemsFromArray:filteredAndSortedAccordingToPreferredLanguages:], according to locale via +[AVMetadataItem metadataItemsFromArray:withLocale:], or according to key via +[AVMetadataItem metadataItemsFromArray:withKey:keySpace:].

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 availableChapterLocales(&self) -> Retained<NSArray<NSLocale>>

pub unsafe fn chapterMetadataGroupsWithTitleLocale_containingItemsWithCommonKeys( &self, locale: &NSLocale, common_keys: Option<&NSArray<AVMetadataKey>>, ) -> Retained<NSArray<AVTimedMetadataGroup>>

👎Deprecated: Use loadChapterMetadataGroupsWithTitleLocale:containingItemsWithCommonKeys:completionHandler: instead

Available on crate features AVMetadataFormat and AVTimedMetadataGroup only.

Provides an array of chapters.

Parameter locale: Locale of the metadata items carrying chapter titles to be returned (supports the IETF BCP 47 specification).

Parameter commonKeys: Array of common keys of AVMetadataItem to be included; can be nil. AVMetadataCommonKeyArtwork is the only supported key for now.

Returns: An NSArray of AVTimedMetadataGroup.

This method returns an array of AVTimedMetadataGroup objects. Each object in the array always contains an AVMetadataItem representing the chapter title; the timeRange property of the AVTimedMetadataGroup object is equal to the time range of the chapter title item.

An AVMetadataItem with the specified common key will be added to an existing AVTimedMetadataGroup object if the time range (timestamp and duration) of the metadata item and the metadata group overlaps. The locale of items not carrying chapter titles need not match the specified locale parameter.

Further filtering of the metadata items in AVTimedMetadataGroups according to language can be accomplished using +[AVMetadataItem metadataItemsFromArray:filteredAndSortedAccordingToPreferredLanguages:]; filtering of the metadata items according to locale can be accomplished using +[AVMetadataItem metadataItemsFromArray:withLocale:].

pub unsafe fn loadChapterMetadataGroupsWithTitleLocale_containingItemsWithCommonKeys_completionHandler( &self, locale: &NSLocale, common_keys: &NSArray<AVMetadataKey>, completion_handler: &Block<dyn Fn(*mut NSArray<AVTimedMetadataGroup>, *mut NSError)>, )

Available on crate features AVMetadataFormat and AVTimedMetadataGroup and block2 only.

Loads an array of chapters.

Parameter locale: Locale of the metadata items carrying chapter titles to be returned (supports the IETF BCP 47 specification).

Parameter commonKeys: Array of common keys of AVMetadataItem to be included; if no common keys are required, send an empty list. AVMetadataCommonKeyArtwork is the only supported key for now.

Parameter completionHandler: A block that is invoked when loading is complete, vending the array of timed metadata groups or an error.

This method vends an array of AVTimedMetadataGroup objects. Each object in the array always contains an AVMetadataItem representing the chapter title; the timeRange property of the AVTimedMetadataGroup object is equal to the time range of the chapter title item.

An AVMetadataItem with the specified common key will be added to an existing AVTimedMetadataGroup object if the time range (timestamp and duration) of the metadata item and the metadata group overlaps. The locale of items not carrying chapter titles need not match the specified locale parameter.

Further filtering of the metadata items in AVTimedMetadataGroups according to language can be accomplished using +[AVMetadataItem metadataItemsFromArray:filteredAndSortedAccordingToPreferredLanguages:]; filtering of the metadata items according to locale can be accomplished using +[AVMetadataItem metadataItemsFromArray:withLocale:].

pub unsafe fn chapterMetadataGroupsBestMatchingPreferredLanguages( &self, preferred_languages: &NSArray<NSString>, ) -> Retained<NSArray<AVTimedMetadataGroup>>

👎Deprecated: Use loadChapterMetadataGroupsBestMatchingPreferredLanguages:completionHandler: instead

Available on crate feature AVTimedMetadataGroup only.

Tests, in order of preference, for a match between language identifiers in the specified array of preferred languages and the available chapter locales, and returns the array of chapters corresponding to the first match that’s found.

Parameter preferredLanguages: An array of language identifiers in order of preference, each of which is an IETF BCP 47 (RFC 4646) language identifier. Use +[NSLocale preferredLanguages] to obtain the user’s list of preferred languages.

Returns: An NSArray of AVTimedMetadataGroup.

Safe to call without blocking when the AVAsset key availableChapterLocales has status AVKeyValueStatusLoaded.

Returns an array of AVTimedMetadataGroup objects. Each object in the array always contains an AVMetadataItem representing the chapter title; the timeRange property of the AVTimedMetadataGroup object is equal to the time range of the chapter title item.

All of the available chapter metadata is included in the metadata groups, including items with the common key AVMetadataCommonKeyArtwork, if such items are present. Items not carrying chapter titles will be added to an existing AVTimedMetadataGroup object if the time range (timestamp and duration) of the metadata item and that of the metadata group overlaps. The locale of such items need not match the locale of the chapter titles.

Further filtering of the metadata items in AVTimedMetadataGroups according to language can be accomplished using +[AVMetadataItem metadataItemsFromArray:filteredAndSortedAccordingToPreferredLanguages:]; filtering of the metadata items according to locale can be accomplished using +[AVMetadataItem metadataItemsFromArray:withLocale:]. .

pub unsafe fn loadChapterMetadataGroupsBestMatchingPreferredLanguages_completionHandler( &self, preferred_languages: &NSArray<NSString>, completion_handler: &Block<dyn Fn(*mut NSArray<AVTimedMetadataGroup>, *mut NSError)>, )

Available on crate features AVTimedMetadataGroup and block2 only.

Tests, in order of preference, for a match between language identifiers in the specified array of preferred languages and the available chapter locales, and loads the array of chapters corresponding to the first match that’s found.

Parameter preferredLanguages: An array of language identifiers in order of preference, each of which is an IETF BCP 47 (RFC 4646) language identifier. Use +[NSLocale preferredLanguages] to obtain the user’s list of preferred languages.

Parameter completionHandler: A block that is invoked when loading is complete, vending the array of timed metadata groups or an error.

Returns an array of AVTimedMetadataGroup objects. Each object in the array always contains an AVMetadataItem representing the chapter title; the timeRange property of the AVTimedMetadataGroup object is equal to the time range of the chapter title item.

All of the available chapter metadata is included in the metadata groups, including items with the common key AVMetadataCommonKeyArtwork, if such items are present. Items not carrying chapter titles will be added to an existing AVTimedMetadataGroup object if the time range (timestamp and duration) of the metadata item and that of the metadata group overlaps. The locale of such items need not match the locale of the chapter titles.

Further filtering of the metadata items in AVTimedMetadataGroups according to language can be accomplished using +[AVMetadataItem metadataItemsFromArray:filteredAndSortedAccordingToPreferredLanguages:]; filtering of the metadata items according to locale can be accomplished using +[AVMetadataItem metadataItemsFromArray:withLocale:].

pub unsafe fn availableMediaCharacteristicsWithMediaSelectionOptions( &self, ) -> Retained<NSArray<AVMediaCharacteristic>>

Available on crate feature AVMediaFormat only.

pub unsafe fn mediaSelectionGroupForMediaCharacteristic( &self, media_characteristic: &AVMediaCharacteristic, ) -> Option<Retained<AVMediaSelectionGroup>>

👎Deprecated: Use loadMediaSelectionGroupForMediaCharacteristic:completionHandler: instead

Available on crate features AVMediaFormat and AVMediaSelectionGroup only.

Provides an instance of AVMediaSelectionGroup that contains one or more options with the specified media characteristic.

Parameter mediaCharacteristic: A media characteristic for which you wish to obtain the available media selection options. AVMediaCharacteristicAudible, AVMediaCharacteristicLegible, and AVMediaCharacteristicVisual are currently supported.

Pass AVMediaCharacteristicAudible to obtain the group of available options for audio media in various languages and for various purposes, such as descriptive audio. Pass AVMediaCharacteristicLegible to obtain the group of available options for subtitles in various languages and for various purposes. Pass AVMediaCharacteristicVisual to obtain the group of available options for video media.

Returns: An instance of AVMediaSelectionGroup. May be nil.

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

If the asset has no AVMediaSelectionGroup containing options with the specified media characteristic, the return value will be nil.

Filtering of the options in the returned AVMediaSelectionGroup according to playability, locale, and additional media characteristics can be accomplished using the category AVMediaSelectionOptionFiltering defined on AVMediaSelectionGroup.

pub unsafe fn loadMediaSelectionGroupForMediaCharacteristic_completionHandler( &self, media_characteristic: &AVMediaCharacteristic, completion_handler: &Block<dyn Fn(*mut AVMediaSelectionGroup, *mut NSError)>, )

Available on crate features AVMediaFormat and AVMediaSelectionGroup and block2 only.

Loads an instance of AVMediaSelectionGroup that contains one or more options with the specified media characteristic.

Parameter mediaCharacteristic: A media characteristic for which you wish to obtain the available media selection options. AVMediaCharacteristicAudible, AVMediaCharacteristicLegible, and AVMediaCharacteristicVisual are currently supported.

Pass AVMediaCharacteristicAudible to obtain the group of available options for audio media in various languages and for various purposes, such as descriptive audio. Pass AVMediaCharacteristicLegible to obtain the group of available options for subtitles in various languages and for various purposes. Pass AVMediaCharacteristicVisual to obtain the group of available options for video media.

Parameter completionHandler: A block that is invoked when loading is complete, vending an instance of AVMediaSelectionGroup (which may be nil) or an error.

If the asset has no AVMediaSelectionGroup containing options with the specified media characteristic, the return value will be nil.

Filtering of the options in the returned AVMediaSelectionGroup according to playability, locale, and additional media characteristics can be accomplished using the category AVMediaSelectionOptionFiltering defined on AVMediaSelectionGroup.

pub unsafe fn preferredMediaSelection(&self) -> Retained<AVMediaSelection>

Available on crate feature AVMediaSelection only.

Provides an instance of AVMediaSelection with default selections for each of the receiver’s media selection groups.

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

Available on crate feature AVMediaSelection only.

Provides an array of all permutations of AVMediaSelection for this asset.

pub unsafe fn hasProtectedContent(&self) -> bool

Indicates whether or not the asset has protected content.

Assets containing protected content may not be playable without successful authorization, even if the value of the “playable” property is YES. See the properties in the AVAssetUsability category for details on how such an asset may be used. On macOS, clients can use the interfaces in AVPlayerItemProtectedContentAdditions.h to request authorization to play the asset.

pub unsafe fn canContainFragments(&self) -> bool

Indicates whether the asset is capable of being extended by fragments.

For QuickTime movie files and MPEG-4 files, the value of canContainFragments is YES if an ‘mvex’ box is present in the ‘moov’ box. For those types, the ‘mvex’ box signals the possible presence of later ‘moof’ boxes.

pub unsafe fn containsFragments(&self) -> bool

Indicates whether the asset is extended by at least one fragment.

For QuickTime movie files and MPEG-4 files, the value of this property is YES if canContainFragments is YES and at least one ‘moof’ box is present after the ‘moov’ box.

pub unsafe fn overallDurationHint(&self) -> CMTime

Available on crate feature objc2-core-media only.

Indicates the total duration of fragments that either exist now or may be appended in the future in order to extend the duration of the asset.

For QuickTime movie files and MPEG-4 files, the value of this property is obtained from the ‘mehd’ box of the ‘mvex’ box, if present. If no total fragment duration hint is available, the value of this property is kCMTimeInvalid.

pub unsafe fn isPlayable(&self) -> bool

Indicates whether an AVPlayer can play the contents of the asset in a manner that meets user expectations.

A client can attempt playback when playable is NO, this however may lead to a substandard playback experience.

pub unsafe fn isExportable(&self) -> bool

pub unsafe fn isReadable(&self) -> bool

pub unsafe fn isComposable(&self) -> bool

pub unsafe fn isCompatibleWithSavedPhotosAlbum(&self) -> bool

pub unsafe fn isCompatibleWithAirPlayVideo(&self) -> bool

Indicates whether the asset is compatible with AirPlay Video.

YES if an AVPlayerItem initialized with the receiver can be played by an external device via AirPlay Video.

pub unsafe fn unusedTrackID(&self) -> CMPersistentTrackID

👎Deprecated: Use findUnusedTrackIDWithCompletionHandler: instead

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

pub unsafe fn findUnusedTrackIDWithCompletionHandler( &self, completion_handler: &Block<dyn Fn(CMPersistentTrackID, *mut NSError)>, )

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

Loads a track ID that will not collide with any existing track

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

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 AVMovie

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<AVAsset> for AVMovie

fn as_ref(&self) -> &AVAsset

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

impl AsRef<AVMovie> for AVFragmentedMovie

fn as_ref(&self) -> &AVMovie

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

impl AsRef<AVMovie> for AVMovie

fn as_ref(&self) -> &Self

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

impl AsRef<AVMovie> for AVMutableMovie

fn as_ref(&self) -> &AVMovie

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

impl AsRef<AnyObject> for AVMovie

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for AVMovie

fn as_ref(&self) -> &NSObject

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

impl Borrow<AVAsset> for AVMovie

fn borrow(&self) -> &AVAsset

Immutably borrows from an owned value.

impl Borrow<AVMovie> for AVFragmentedMovie

fn borrow(&self) -> &AVMovie

Immutably borrows from an owned value.

impl Borrow<AVMovie> for AVMutableMovie

fn borrow(&self) -> &AVMovie

Immutably borrows from an owned value.

impl Borrow<AnyObject> for AVMovie

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for AVMovie

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for AVMovie

const NAME: &'static str = "AVMovie"

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

type Super = AVAsset

The superclass of this class.

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

type Result = AVMovie

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

impl Debug for AVMovie

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

Formats the value using the given formatter.

impl Deref for AVMovie

type Target = AVAsset

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for AVMovie

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 AVMovie

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

where Self: Sized,

Increment the reference count of the receiver.

impl MutableCopyingHelper for AVMovie

type Result = AVMutableMovie

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

impl NSCopying for AVMovie

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 AVMovie

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 AVMovie

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 AVMovie

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 AVMovie

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

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

impl DowncastTarget for AVMovie

impl Eq for AVMovie