The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

AudioPlayerAgent Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

An implementation of a BackgroundAgent specifically designed to play audio in the background.


Namespace:  Microsoft.Phone.BackgroundAudio
Assembly:  Microsoft.Phone (in Microsoft.Phone.dll)
XMLNS for XAML: Not mapped to an xmlns.

Public Class AudioPlayerAgent _
	Inherits BackgroundAgent
<AudioPlayerAgent .../>

The AudioPlayerAgent type exposes the following members.

Public methodAudioPlayerAgentCreates a new instance of AudioPlayerAgent.

Protected methodAbortInforms the operating system that the agent is unable to perform its intended task and that it should not be launched again until the foreground application mitigates the blocking issue and reenables the agent. (Inherited from BackgroundAgent.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodNotifyCompleteInforms the operating system that the agent has completed its intended task for the current invocation of the agent. (Inherited from BackgroundAgent.)
Protected methodNotifyCompleteWithResultInforms the operating system that the agent has completed its intended task for the current invocation of the agent. Call this method after successfully handling an invocation with a result. (Inherited from BackgroundAgent.)
Protected methodOnCancelCalled by the operating system to alert a background agent that it is going to be put into a dormant state or terminated. (Inherited from BackgroundAgent.)
Protected methodOnErrorCalled when there is an error with playback, such as an audio track not downloading correctly.
Protected methodOnPlayStateChangedCalled when the play state changes, except for the error state.
Protected methodOnUserActionCalled when the user requests an action using some application-provided UI or the Universal Volume Control (UVC) and the application has requested notification of the action.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The AudioPlayerAgent is a base class that you can extend to create your own background audio player agent. The only method that you must override is OnUserAction(BackgroundAudioPlayer, AudioTrack, UserAction, Object).

Caution noteCaution:

This API is not supported for Silverlight 8.1 apps.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.