AVAsset Class

Definition

Base class for timed video and audio.

[Foundation.Register("AVAsset", true)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.WatchOS, ObjCRuntime.PlatformArchitecture.All, null)]
public class AVAsset : Foundation.NSObject, Foundation.INSCopying, IDisposable
type AVAsset = class
    inherit NSObject
    interface INSCopying
    interface INativeObject
    interface IDisposable
Inheritance
AVAsset
Derived
Attributes
Implements

Remarks

An AVAsset represents one or more media assets. These are held in its Tracks property. Additionally, AVAssets include metadata, track grouping, and preferences about the media.

Because media assets such as movies are large, instantiating an AVAsset will not automatically load the file. Properties are loaded when they are queried or via explicit calls to LoadValuesTaskAsync(String[]) or LoadValuesAsynchronously(String[], Action).

During playback, the current presentation state of an AVAsset is represented by an AVPlayerItem object, and the playback is controlled by a AVPlayer:

Constructors

AVAsset(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

AVAsset(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AllMediaSelections
AvailableChapterLocales

The NSLocales available from ChapterMetadataGroups(NSLocale, AVMetadataItem[]).

AvailableMediaCharacteristicsWithMediaSelectionOptions

A set of media characteristics for which a media selection option is available.

AvailableMetadataFormats

Metadata formats available for the asset.

CanContainFragments

Gets a Boolean value that tells whether the asset can be extended by fragments.

ChapterMetadataGroupsDidChangeNotification

Notification constant for ChapterMetadataGroupsDidChange

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

CommonMetadata

Metadata keys that are available.

CompatibleWithAirPlayVideo

Gets a Boolean value that tells whether the asset works with AirPlay Video.

CompatibleWithSavedPhotosAlbum

Whether the asset can be saved to the "Saved Photos" album.

Composable

Whether the asset can be used within a segment of a AVCompositionTrack.

ContainsFragments

Gets a Boolean value that tells whether the asset has been extended by one or more fragments.

ContainsFragmentsDidChangeNotification

Notification constant for ContainsFragmentsDidChange

CreationDate

The date the asset was created.

DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Duration

The duration of the asset in CMTime.

DurationDidChangeNotification

Notification constant for DurationDidChange

Exportable

Whether the asset can be exported using a AVAssetExportSession.

Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
Lyrics

The lyrics of the asset, in the current locale.

MediaSelectionGroupsDidChangeNotification

Notification constant for MediaSelectionGroupsDidChange

Metadata

Gets an array that contains all the metadata for the asset.

NaturalSize

Developers should not use this deprecated property. Developers should use 'NaturalSize/PreferredTransform' as appropriate on the video track instead.

OverallDurationHint

Gets the combined duration of all existing fragments and those that may be added.

Playable

Whether the asset or its URL can be used with a AVPlayerItem.

PreferredMediaSelection

Gets the default media selections.

PreferredRate

The rate at which this asset should be played.

PreferredTransform

Preferred affine transformation to apply to the visual content of the asset for rendering.

PreferredVolume

Preferred asset volume.

ProtectedContent

Whether the asset has protected content.

ProvidesPreciseDurationAndTiming

Whether the asset provides precise duration and timing information.

Readable

Whether the asset's media data is compatible with AVAssetReader.

ReferenceRestrictions

Whether external references (such as external URLs) should be followed or not.

RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self (Inherited from NSObject)
Superclass (Inherited from NSObject)
SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
TrackGroups

The AVAssetTrackGroups comprising the asset.

Tracks

The tracks contained in the asset.

UnusedTrackId

Gets a track ID that is not used by any of the asset's tracks.

WasDefragmentedNotification

Notification constant for WasDefragmented

Zone (Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) (Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) (Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary) (Inherited from NSObject)
BindingInfo(String) (Inherited from NSObject)
BindingOptionDescriptions(String) (Inherited from NSObject)
BindingValueClass(String) (Inherited from NSObject)
CancelLoading()

Cancels loading.

ChapterMetadataGroups(NSLocale, AVMetadataItem[])

Retrieves chapter title information.

CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
Copy(NSZone)

Performs a copy of the underlying Objective-C object.

DangerousAutorelease() (Inherited from NSObject)
DangerousRelease() (Inherited from NSObject)
DangerousRetain() (Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
ExposedBindings() (Inherited from NSObject)
FromUrl(NSUrl)

Factory method that returns a AVUrlAsset.

GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetChapterMetadataGroups(NSLocale, AVMetadataItem[])

Returns an array that contains IETF BCP 47 language identifiers that indicate the preferred language order for a chapter.

GetChapterMetadataGroupsBestMatchingPreferredLanguages(String[])

Retrieves chapter metadata for the locale that best matches the IETF BCP 47 language identifers.

GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMediaSelectionGroupForMediaCharacteristic(AVMediaCharacteristics)

Returns a media selection group whose options have the indicated avMediaCharacteristic.

GetMetadataForFormat(AVMetadataFormat)

Returns an array that contains a metadata item for each item in the container that is specified by format.

GetMetadataForFormat(NSString)

Returns an array that contains a metadata item for each item in the container that is specified by format.

GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String) (Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
GetTracks(AVMediaCharacteristics)

Returns an array of tracks that have the specified characteristic.

GetTracks(AVMediaTypes)

Returns an array of tracks of the specified media type.

Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
Invoke(Action, Double) (Inherited from NSObject)
Invoke(Action, TimeSpan) (Inherited from NSObject)
InvokeOnMainThread(Action) (Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) (Inherited from NSObject)
IsKindOfClass(Class) (Inherited from NSObject)
IsMemberOfClass(Class) (Inherited from NSObject)
LoadValuesAsynchronously(String[], Action)

Asks the asset to load the specified keys (unless they're already loaded).

LoadValuesTaskAsync(String[])

Asks the asset to load the specified keys (unless they're already loaded).

MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MediaSelectionGroupForMediaCharacteristic(String)

Returns options for the passed in avMediaCharacteristic.

MetadataForFormat(String)

Returns the metadata items available for the specified format.

MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) (Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PrepareForInterfaceBuilder() (Inherited from NSObject)
RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) (Inherited from NSObject)
SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
StatusOfValue(String, NSError)

Returns the loading status for the specified key.

ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
TracksWithMediaCharacteristic(String)

The tracks in the asset that match the given media characteristic.

TracksWithMediaType(String)

The tracks in the asset that match the given media type.

TrackWithTrackID(Int32)

The track which has the associated Track ID.

Unbind(NSString) (Inherited from NSObject)
Unbind(String) (Inherited from NSObject)
ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also