Platforms to show: All Mac Windows Linux Cross-Platform

AVAssetMBS class

Type Topic Plugin Version macOS Windows Linux iOS Targets
class AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
AVAsset is an abstract class to represent timed audiovisual media such as videos and sounds.

Each asset contains a collection of tracks that are intended to be presented or processed together, each of a uniform media type, including but not limited to audio, video, text, closed captions, and subtitles.

An AVAsset object defines the collective properties of the tracks that comprise the asset. (You can access the instances of AVAssetTrack representing tracks of the collection, so you can examine each of these independently if you need to.) You often instantiate an asset using a concrete subclass of AVAsset; for example, you can initialize an instance of AVURLAsset using an URL that refers to an audiovisual media file, such as a QuickTime movie file or an MP3 files (amongst other types). You can also instantiate an asset using other concrete subclasses that extend the basic model for audiovisual media in useful ways, as AVComposition does for temporal editing. To assemble audiovisual constructs from one or more source assets, you can insert assets into instances of AVMutableComposition.

You often instantiate an asset using AVURLAsset—a concrete subclass of AVAsset—with URLs that refer to audiovisual media resources, such as streams (including HTTP live streams), QuickTime movie files, MP3 files, and files of other types. You can also instantiate an asset using other concrete subclasses that extend the basic model for audiovisual media in useful ways, as AVComposition does for temporal editing.

Properties of assets as a whole are defined by AVAsset. Additionally, references to instances of AVAssetTrack representing tracks of the collection can be obtained, so that each of these can be examined independently.

Because of the nature of timed audiovisual media, upon successful initialization of an asset some or all of the values for its keys may not be immediately available. The value of any key can be requested at any time, and asset will always return its value synchronously, although it may have to block the calling thread in order to do so. In order to avoid blocking, you can register your interest in particular keys and to become notified when their values become available. For further details, see AVAsynchronousKeyValueLoading.

To play an instance of AVAsset, initialize an instance of AVPlayerItem with it, use the player item tem to set up its presentation state (such as whether only a limited timeRange of the asset should be played, etc.), and provide the player item to an AVPlayer object according to whether the items is to be played by itself or together with a collection of other items.

You can insert AVAsset objects can also be inserted into an AVMutableComposition object in order to assemble audiovisual constructs from one or more source assets.

Subclassing Notes
It is not currently possible to subclass AVAsset to handle streaming protocols or file formats that are not supported by the framework.
This is an abstract class. You can't create an instance, but you can get one from various plugin functions.

Reference Restriction Modes

Constant Value Description
AVAssetReferenceRestrictionForbidAll &hFFFF Indicates that only references to media data stored within the asset's container file should be allowed.
AVAssetReferenceRestrictionForbidCrossSiteReference 4 Indicates that references from a remote asset to remote media data stored at a different site should not be followed.
AVAssetReferenceRestrictionForbidLocalReferenceToLocal 8 Indicates that references from a local asset to local media data stored outside the asset's container file should not be followed.
AVAssetReferenceRestrictionForbidLocalReferenceToRemote 2 Indicates that references from a local asset to remote media data should not be followed.
AVAssetReferenceRestrictionForbidNone 0 Indicates that all types of references should be followed.
AVAssetReferenceRestrictionForbidRemoteReferenceToLocal 1 Indicates that references from a remote asset (for example, referenced via http URL) to local media data (for example, stored in a local file) should not be followed.

Load Status Constants

Constant Value Description
AVKeyValueStatusCancelled 4 Indicates that the attempt to load the property was cancelled.
AVKeyValueStatusFailed 3 Indicates that the attempt to load the property failed.
AVKeyValueStatusLoaded 2 Indicates that the property is ready for use.
Example
AVKeyValueStatusLoading 1 Indicates that the property is not fully loaded.
AVKeyValueStatusUnknown 0 Indicates that the property status is unknown.

Sub classes:

Some methods using this class:

Some properties using for this class:

Some events using this class:

Some examples using this class:

Blog Entries

Xojo Developer Magazine

Release notes


The items on this page are in the following plugins: MBS AVFoundation Plugin.


AVAssetImageGeneratorMBS   -   AVAssetReaderAudioMixOutputMBS


The biggest plugin in space...