AVPlayerItem Class

Definition

Namespace:

AVFoundation

Assembly:

Xamarin.iOS.dll

A class that encapsulates the presentation state of an AVAsset being played by a AVPlayer object.

[Foundation.Register("AVPlayerItem", true)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.WatchOS, ObjCRuntime.PlatformArchitecture.All, null)]
public class AVPlayerItem : Foundation.NSObject, Foundation.INSCopying, IDisposable

type AVPlayerItem = class
    inherit NSObject
    interface INSCopying
    interface INativeObject
    interface IDisposable

Inheritance

Object

NSObject

AVPlayerItem

Attributes

RegisterAttribute UnavailableAttribute

Implements

INSCopying INativeObject IDisposable

Remarks

The AVPlayerItem holds the dynamic presentation state of an AVAsset being played by a AVPlayer.

Constructors

AVPlayerItem(AVAsset, NSString[])	Creates a new T:AVFoundation.AVAVPlayerItem suitable for playing asset with the provided keys automatically loaded.
AVPlayerItem(AVAsset)	Creates a new T:AVFoundation.AVAVPlayerItem suitable for playing asset.
AVPlayerItem(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
AVPlayerItem(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.
AVPlayerItem(NSUrl)	Creates a new T:AVFoundation.AVAVPlayerItem suitable for playing the content at the specified URL.

Properties

AccessLog	The network access log.
Asset	The AVAsset being played.
AudioMix	The AVAudioMix to be applied during playback.
AudioTimePitchAlgorithm	The algorithm used to manage audio pitch.
AutomaticallyLoadedAssetKeys	The properties that must be loaded successfully for Status to be set to Loaded.
CanPlayFastForward	Whether the AVAsset can be played with a Rate greater than 1.0.
CanPlayFastReverse	Whether the AVAsset can be played with a Rate less than -1.0.
CanPlayReverse	Whether the AVAsset can be played with a Rate less than 0.0.
CanPlaySlowForward	Whether the AVAsset can be played with a Rate between 0 and 1.
CanPlaySlowReverse	Whether the AVAsset can be played with a Rate between -1 and 0.
CanStepBackward	Whether the AVAsset supports backward stepping.
CanStepForward	Whether the AVAsset supports forward stepping.
CanUseNetworkResourcesForLiveStreamingWhilePaused	Gets or sets a Boolean value that controls whether the player can buffer content while it is paused.
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
CurrentDate	The current time of the item as an NSDate, or null.
CurrentMediaSelection	Gets the current media selection.
CurrentTime	The current time of the item.
CustomVideoCompositor	The custom AVVideoCompositing, if any, of the item.
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)
DidPlayToEndTimeNotification	Notification constant for DidPlayToEndTime
Duration	The duration, in seconds, of the item. Asynchronously loaded.
Error	Indicates the current error status, if any.
ErrorLog	A snapshot of the error log, if it exists.
ForwardPlaybackEndTime	The time at which forward playback should end.
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IsDirectBinding	(Inherited from NSObject)
IsProxy	(Inherited from NSObject)
ItemFailedToPlayToEndTimeErrorKey	Represents the value associated with the constant AVPlayerItemFailedToPlayToEndTimeErrorKey
ItemFailedToPlayToEndTimeNotification	Notification constant for ItemFailedToPlayToEndTime
LoadedTimeRanges	An array of CMTimeRanges that have been loaded.
MediaDataCollectors	Gets an array of the AVPlayerItemMediaDataCollector objects for this AV player item.
NewAccessLogEntryNotification	Notification constant for NewAccessLogEntry
NewErrorLogEntryNotification	Notification constant for NewErrorLogEntry
Outputs	The array of AVPlayerItemOutputs that are the outputs of this AVPlayerItem.
PlaybackBufferEmpty	Whether the playback buffer is currently empty.
PlaybackBufferFull	Whether the playback buffer is currently full.
PlaybackLikelyToKeepUp	Predicts whether the current loading rate and playback buffer status is sufficient to play from the CurrentTime to the end without requiring a buffering pause.
PlaybackStalledNotification	Notification constant for PlaybackStalled
PreferredForwardBufferDuration	Gets or sets the preferred minimum amount of forward buffer to maintain.
PreferredMaximumResolution
PreferredPeakBitRate	Gets or sets the preferred maximum bitrate for downloading content for the media item.
PresentationSize	The size of the visual element of the AVPlayerItem in the AVPlayer.
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
ReversePlaybackEndTime	The time at which reverse playback should end.
SeekableTimeRanges	The time ranges within which it is possible to SeekAsync(CMTime, CMTime, CMTime).
SeekingWaitsForVideoCompositionRendering	Whether the item's timing is only updated after the frame is rendered during a seek.
Self	(Inherited from NSObject)
Status	The current status of the AVPlayerItem.
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
TextStyleRules	An array of AVTextStyleRules to be applied to subtitles and other displayed text.
Timebase	The timebase for the AVPlayerItem.
TimedMetadata	The most-recent timed metadata of the item. Array contains AVMetadata items.
TimeJumpedNotification	Notification constant for TimeJumped
Tracks	The tracks of the item. Asynchronously loaded.
VideoApertureMode
VideoComposition	The AVVideoComposition settings to be applied during playback.
Zone	(Inherited from NSObject)

Methods

AddMediaDataCollector(AVPlayerItemMediaDataCollector)	Adds the specified collector to the array of AVPlayerItemMediaDataCollector items that belong to this AV player item..
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)
AddOutput(AVPlayerItemOutput)	Adds an AVPlayerItemOutput.
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)
CancelPendingSeeks()	Cancels any pending SeekAsync(CMTime, CMTime, CMTime) calls.
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)
FromAsset(AVAsset, NSString[])	Factory method that creates an AVPlayerItem for the given asset and loads the specified automaticallyLoadedAssetKeys.
FromAsset(AVAsset)	Factory method that creates an AVPlayerItem for the given asset.
FromUrl(NSUrl)	Factory method that creates an AVPlayerItem for the asset at the given 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)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
InitializeHandle(IntPtr)	(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)
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, NSObject, Double, NSString[])	(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, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
RemoveMediaDataCollector(AVPlayerItemMediaDataCollector)	Removes the specified collector from the array of AVPlayerItemMediaDataCollector items that belong to this AV player item..
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, NSString)	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)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveOutput(AVPlayerItemOutput)	Removes output from Outputs.
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
Seek(CMTime, AVCompletion)	Seeks the player to the specified time.
Seek(CMTime, CMTime, CMTime, AVCompletion)	Seeks to a specific location in the playback stream
Seek(CMTime, CMTime, CMTime)	Seeks to the specified time, within the specified tolerances.
Seek(CMTime)	Seeks to the specified time.
Seek(NSDate, AVCompletion)	Seeks the player to the specified date.
Seek(NSDate)	Seeks date target.
SeekAsync(CMTime, CMTime, CMTime)	Asynchronously seeks to the specified time, within the specified tolerances..
SeekAsync(CMTime)	Seeks to a specific location in the playback stream
SeekAsync(NSDate, Boolean)	Asynchronously seeks to the specified time and indicates if it succeeded.
SeekAsync(NSDate)	Seeks the player to the specified date.
SelectedMediaOption(AVMediaSelectionGroup)	Get the current selected AVMediaSelectionOption in a AVMediaSelectionGroup.
SelectMediaOption(AVMediaSelectionOption, AVMediaSelectionGroup)	Selects a AVMediaSelectionOption from the choices in a AVMediaSelectionGroup.
SelectMediaOptionAutomaticallyInMediaSelectionGroup(AVMediaSelectionGroup)	Selects the AVMediaSelectionOption that best matches the item's automatic selection criteria.
SetNativeField(String, NSObject)	Obsolete. (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)
StepByCount(nint)	Moves the playback head by stepCount steps.
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

GetDebugDescription(INSObjectProtocol)
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.

See also

• Apple documentation for AVPlayerItem