AVPlayer Class

Definition

Encapsulates the control and UI of a component that plays back single or multiple items.

[Foundation.Register("AVPlayer", true)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.WatchOS, ObjCRuntime.PlatformArchitecture.All, null)]
public class AVPlayer : Foundation.NSObject
type AVPlayer = class
    inherit NSObject
Inheritance
AVPlayer
Derived
Attributes

Remarks

An AVPlayer links the visual presentation, control, and dynamic state of one or more AVAssets.

The visual element of the display is done by a AVPlayerLayer, while it's current state (current time, etc.) is held in an AVPlayerItem, which in turn references an AVAsset.


var asset = AVAsset.FromUrl(NSUrl.FromFilename("sample.m4v"));
var playerItem = new AVPlayerItem(asset);
var player = new AVPlayer(playerItem);
var playerLayer = AVPlayerLayer.FromPlayer(player);
View.Layer.AddSublayer(playerLayer);
player.Play();

Constructors

AVPlayer()

Default constructor that initializes a new instance of this class with no parameters.

AVPlayer(AVPlayerItem)
AVPlayer(IntPtr)

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

AVPlayer(NSObjectFlag)

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

AVPlayer(NSUrl)

Properties

ActionAtItemEnd

An action (advance, pause, or nothing) to be taken when the item stops playing.

AirPlayVideoActive

Developers should not use this deprecated property. Developers should use 'ExternalPlaybackActive' instead.

AllowsAirPlayVideo

Application developers should not use this deprecated method. They should use AllowsExternalPlayback instead.

AllowsExternalPlayback

Whether the player can be switched to external playback mode.

AppliesMediaSelectionCriteriaAutomatically

Whether the player should apply system-specified preferences automatically to its items.

AudioOutputDeviceUniqueID
AutomaticallyWaitsToMinimizeStalling
AvailableHdrModes
AvailableHdrModesDidChangeNotification

Notification constant for AvailableHdrModesDidChange

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

ClosedCaptionDisplayEnabled

Whether the player displays closed captioning.

CurrentItem

The current AVPlayerItem.

CurrentTime

The CurrentTime of the CurrentItem.

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)
Error

null or the error that caused the player to enter the failed state.

ExternalPlaybackActive

Whether the player is currently playing back in external playback mode.

ExternalPlaybackVideoGravity

The technique used to modify the video playback aspect ratio during external playback.

Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
MasterClock

The master clock used for AVPlayerItem timebases.

Muted

Whether the AVPlayer is currently muted.

OutputObscuredDueToInsufficientExternalProtection

Whether DRM is causing output to be obscured.

PreferredVideoDecoderGpuRegistryId
PreventsDisplaySleepDuringVideoPlayback
Rate

The current rate of playback.

ReasonForWaitingToPlay

Gets the reason the player is waiting for play to begin or resume, or null.

RetainCount

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

(Inherited from NSObject)
Self (Inherited from NSObject)
Status

The current status of the AVPlayer.

Superclass (Inherited from NSObject)
SuperHandle

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

(Inherited from NSObject)
TimeControlStatus

Gets the AVPlayerTimeControlStatus describing the state of playback.

UsesAirPlayVideoWhileAirPlayScreenIsActive

Application developers should not use this deprecated method. Instead, they should use UsesExternalPlaybackWhileExternalScreenIsActive.

UsesExternalPlaybackWhileExternalScreenIsActive

Whether the player should automatically switch to external playback mode for video when an external screen is available.

Volume

The current volume, ranging from 0 for silence to 1.0 for full volume.

WaitingToMinimizeStallsReason
WaitingWhileEvaluatingBufferingRateReason
WaitingWithNoItemToPlayReason
WeakExternalPlaybackVideoGravity
Zone (Inherited from NSObject)

Methods

AddBoundaryTimeObserver(NSValue[], DispatchQueue, Action)

The system calls the handler when playback reaches the CMTime objects in times.

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)
AddPeriodicTimeObserver(CMTime, DispatchQueue, Action<CMTime>)

Invokes handler every interval seconds, as well as on playback start, stop, and jump.

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)
CancelPendingPrerolls()

Stops preloading media data.

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)
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)
FromPlayerItem(AVPlayerItem)

A factory method to create an AVPlayer for the specified item.

FromUrl(NSUrl)

A factory method to create an AVPlayer for the media asset located at the specified URL.

GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String) (Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
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)
MarkDirty()

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

(Inherited from NSObject)
MediaSelectionCriteriaForMediaCharacteristic(NSString)

Retrieves the system-specified selection criteria for the avMediaCharacteristic.

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)
Pause()

Asynchronously pauses playback.

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)
Play()

Begins playback of the CurrentItem.

PlayImmediatelyAtRate(Single)
PrepareForInterfaceBuilder() (Inherited from NSObject)
Preroll(Single, AVCompletion)

Starts loading media into the playback buffers.

PrerollAsync(Single)

Starts loading media into the playback buffers.

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)
RemoveTimeObserver(NSObject)

Removes periodic or boundary-time observers.

ReplaceCurrentItemWithPlayerItem(AVPlayerItem)

Replaces the CurrentItem.

RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
Seek(CMTime)

Seeks to a specific location in the playback stream.

Seek(CMTime, AVCompletion)

Seeks to a specific time in the playback stream and invokes the completion handler.

Seek(CMTime, CMTime, CMTime)

Blocking: Seeks to a specific location in the playback stream.

Seek(CMTime, CMTime, CMTime, AVCompletion)

Seeks to a specific location in the playback stream.

Seek(NSDate)

Seeks to a specific location in the playback stream.

Seek(NSDate, AVCompletion)

Seeks to a specific time in the playback stream and invokes the onComplete handler.

SeekAsync(CMTime)

Seeks to a specific location in the playback stream.

SeekAsync(CMTime, CMTime, CMTime)

Seeks to a specific time, with a specified tolerance. May be higher performane than non-tolerant seek.

SeekAsync(NSDate)

Seeks to a specific time in the playback stream and invokes the onComplete handler.

SetMediaSelectionCriteria(AVPlayerMediaSelectionCriteria, NSString)

Sets criteria for media that has the specific avMediaCharacteristic.

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

Sets the value of the specified key to null.

(Inherited from NSObject)
SetRate(Single, CMTime, CMTime)

Synchronizes the rate and playback time of the CurrentItem to the hostClockTime.

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)
ToString()

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

(Inherited from NSObject)
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