Edit

Share via


AVAudioPlayerNode Class

Definition

A AVAudioNode that plays segments of audio files.

[Foundation.Register("AVAudioPlayerNode", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 10, ObjCRuntime.PlatformArchitecture.All, null)]
public class AVAudioPlayerNode : AVFoundation.AVAudioNode, AVFoundation.IAVAudioMixing, IDisposable
type AVAudioPlayerNode = class
    inherit AVAudioNode
    interface IAVAudio3DMixing
    interface INativeObject
    interface IDisposable
    interface IAVAudioMixing
    interface IAVAudioStereoMixing
Inheritance
AVAudioPlayerNode
Attributes
Implements

Constructors

AVAudioPlayerNode()

Default constructor, initializes a new instance of this class.

AVAudioPlayerNode(IntPtr)

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

AVAudioPlayerNode(NSObjectFlag)

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

Properties

AUAudioUnit (Inherited from AVAudioNode)
Class (Inherited from NSObject)
ClassHandle

The handle for this class.

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

Gets the AVAudioEngine for the node, or null.

(Inherited from AVAudioNode)
Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
LastRenderTime

If not null, the AVAudioTime for which the node last rendered.

(Inherited from AVAudioNode)
Latency (Inherited from AVAudioNode)
NumberOfInputs

Gets the number of input busses of this node.

(Inherited from AVAudioNode)
NumberOfOutputs

Gets the number of output busses of this node.

(Inherited from AVAudioNode)
Obstruction
Occlusion
OutputPresentationLatency (Inherited from AVAudioNode)
Pan
Playing

Gets whether the player is currently playing.

Position
Rate
RenderingAlgorithm
RetainCount

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

(Inherited from NSObject)
ReverbBlend
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)
Volume
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)
Obsolete.
(Inherited from NSObject)
BindingInfo(String)
Obsolete.
(Inherited from NSObject)
BindingOptionDescriptions(String)
Obsolete.
(Inherited from NSObject)
BindingValueClass(String)
Obsolete.
(Inherited from NSObject)
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)
DestinationForMixer(AVAudioNode, nuint)
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)
GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetBusInputFormat(nuint) (Inherited from AVAudioNode)
GetBusOutputFormat(nuint) (Inherited from AVAudioNode)
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)
GetNameForInputBus(nuint) (Inherited from AVAudioNode)
GetNameForOutputBus(nuint) (Inherited from AVAudioNode)
GetNativeField(String)
Obsolete.
(Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
GetNodeTimeFromPlayerTime(AVAudioTime)
GetPlayerTimeFromNodeTime(AVAudioTime)
Init() (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InstallTapOnBus(nuint, UInt32, AVAudioFormat, AVAudioNodeTapBlock) (Inherited from AVAudioNode)
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)
Pause()

Pauses playback.

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)
Play()
PlayAtTime(AVAudioTime)
PrepareForInterfaceBuilder() (Inherited from NSObject)
PrepareWithFrameCount(UInt32)
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)
RemoveTapOnBus(nuint) (Inherited from AVAudioNode)
Reset()

Clears the processing state of this node.

(Inherited from AVAudioNode)
RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
ScheduleBuffer(AVAudioPcmBuffer, Action)

Schedules playback from buffer.

ScheduleBuffer(AVAudioPcmBuffer, AVAudioPlayerNodeCompletionCallbackType, Action<AVAudioPlayerNodeCompletionCallbackType>)
ScheduleBuffer(AVAudioPcmBuffer, AVAudioTime, AVAudioPlayerNodeBufferOptions, Action)

Schedules playback from buffer.

ScheduleBuffer(AVAudioPcmBuffer, AVAudioTime, AVAudioPlayerNodeBufferOptions, AVAudioPlayerNodeCompletionCallbackType, Action<AVAudioPlayerNodeCompletionCallbackType>)
ScheduleBufferAsync(AVAudioPcmBuffer, AVAudioPlayerNodeCompletionCallbackType)
ScheduleBufferAsync(AVAudioPcmBuffer, AVAudioTime, AVAudioPlayerNodeBufferOptions, AVAudioPlayerNodeCompletionCallbackType)
ScheduleBufferAsync(AVAudioPcmBuffer, AVAudioTime, AVAudioPlayerNodeBufferOptions)

Asynchronously schedules playback from buffer, returning a task that indicates success or failure.

ScheduleBufferAsync(AVAudioPcmBuffer)
ScheduleFile(AVAudioFile, AVAudioTime, Action)

Schedules the playing of the specified audio file.

ScheduleFile(AVAudioFile, AVAudioTime, AVAudioPlayerNodeCompletionCallbackType, Action<AVAudioPlayerNodeCompletionCallbackType>)
ScheduleFileAsync(AVAudioFile, AVAudioTime, AVAudioPlayerNodeCompletionCallbackType)
ScheduleFileAsync(AVAudioFile, AVAudioTime)
ScheduleSegment(AVAudioFile, Int64, UInt32, AVAudioTime, Action)

Schedules the playing of a portion of the audio file.

ScheduleSegment(AVAudioFile, Int64, UInt32, AVAudioTime, AVAudioPlayerNodeCompletionCallbackType, Action<AVAudioPlayerNodeCompletionCallbackType>)
ScheduleSegmentAsync(AVAudioFile, Int64, UInt32, AVAudioTime, AVAudioPlayerNodeCompletionCallbackType)
ScheduleSegmentAsync(AVAudioFile, Int64, UInt32, AVAudioTime)
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)
Stop()

Stops playback and clears all scheduled events.

ToString()

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

(Inherited from NSObject)
Unbind(NSString) (Inherited from NSObject)
Unbind(String)
Obsolete.
(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)
DestinationForMixer(IAVAudioMixing, AVAudioNode, nuint)
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