AVAudioPlayer Class

Definition

Namespace:

AVFoundation

Assembly:

Xamarin.iOS.dll

An audio player that can play audio from memory or the local file system.

[Foundation.Register("AVAudioPlayer", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class AVAudioPlayer : Foundation.NSObject

type AVAudioPlayer = class
    inherit NSObject

Inheritance

Object

NSObject

AVAudioPlayer

Attributes

RegisterAttribute IntroducedAttribute

Constructors

AVAudioPlayer(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
AVAudioPlayer(NSData, String, NSError)
AVAudioPlayer(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.
AVAudioPlayer(NSUrl, String, NSError)

Properties

ChannelAssignments	The channel descriptions for the audio player.
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
CurrentTime	The current location, in seconds, of the playback head.
Data	The data defining the sound of the audio player.
DebugDescription	A developer-meaningful description of this object. (Inherited from NSObject)
Delegate	An instance of the AVFoundation.IAVAudioPlayerDelegate model class which acts as the class delegate.
Description	Description of the object, the Objective-C version of ToString. (Inherited from NSObject)
DeviceCurrentTime	A value that increases while the AVAudioPlayer is playing or paused. Used for synchronizing multiple audio players.
Duration	The total time, in seconds, of the sound associated with the AVAudioPlayer.
EnableRate	Whether the AVAudioPlayer can have its playback rate adjusted.
Format
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IsDirectBinding	(Inherited from NSObject)
IsProxy	(Inherited from NSObject)
MeteringEnabled	Whether audio-level metering can be used with the AVAudioPlayer.
NumberOfChannels	The number of audio channels in the sound associated with the AVAudioPlayer.
NumberOfLoops	The number of times the sound should repeat.
Pan	The current stereo pan (left-right) position.
Playing	Whether the AVAudioPlayer is playing sound.
Rate	The playback rate relative to the source sound.
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
Self	(Inherited from NSObject)
SoundSetting	Information about the sound associated with the AVAudioPlayer
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
Url	The source URL for the sound associated with the AVAudioPlayer
Volume	The playback volume of the AVAudioPlayer.
WeakDelegate	An object that can respond to the delegate protocol for this type
WeakSettings
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)
AveragePower(nuint)	The average power for the channelNumber channel, in decibels, of the sound being played.
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)
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 AVAudioPlayer object.
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)
FromData(NSData, NSError)	Creates an audio player that plays music from an NSData source.
FromData(NSData)	Creates an audio player that plays music from an NSData source.
FromUrl(NSUrl, NSError)	Creates a new instance of the AVAudioPlayer.
FromUrl(NSUrl)	Creates a new instance of the AVAudioPlayer.
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)
Pause()	Stops playback, but does not reset the playback position.
PeakPower(nuint)	The peak power, in decibels, of the specified channel.
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()	Plays a sound.
PlayAtTime(Double)	Begins playback at a certain delay, relative to the current playback time.
PrepareForInterfaceBuilder()	(Inherited from NSObject)
PrepareToPlay()	Preloads the playback buffers.
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)
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
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)
SetVolume(Single, Double)
Stop()	Stops sound playback asynchronously.
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)
UpdateMeters()	Determines the average and peak power for the channels in the AVAudioPlayer.
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)

Events

BeginInterruption	Event raised when an interruption begins.
DecoderError	Event indicating that there has been a decoding error.
EndInterruption	Event indicating that an interruption has ended.
FinishedPlaying	Event indicating that playback has completed.

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

• avTouch
• Apple documentation for AVAudioPlayer