PlaybackState Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Playback state for a MediaSession.
[Android.Runtime.Register("android/media/session/PlaybackState", DoNotGenerateAcw=true)]
public sealed class PlaybackState : Java.Lang.Object, Android.OS.IParcelable, IDisposable, Java.Interop.IJavaPeerable[<Android.Runtime.Register("android/media/session/PlaybackState", DoNotGenerateAcw=true)>]
type PlaybackState = class
inherit Object
interface IParcelable
interface IJavaObject
interface IDisposable
interface IJavaPeerable- Inheritance
- Attributes
- Implements
Remarks
Playback state for a MediaSession. This includes a state like PlaybackState#STATE_PLAYING, the current playback position, and the current control capabilities.
Java documentation for android.media.session.PlaybackState.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Fields
| ActionFastForward |
Indicates this session supports the fast forward command. |
| ActionPause |
Indicates this session supports the pause command. |
| ActionPlay |
Indicates this session supports the play command. |
| ActionPlayFromMediaId |
Indicates this session supports the play from media id command. |
| ActionPlayFromSearch |
Indicates this session supports the play from search command. |
| ActionPlayFromUri |
Indicates this session supports the play from URI command. |
| ActionPlayPause |
Indicates this session supports the play/pause toggle command. |
| ActionPrepare |
Indicates this session supports the prepare command. |
| ActionPrepareFromMediaId |
Indicates this session supports the prepare from media id command. |
| ActionPrepareFromSearch |
Indicates this session supports the prepare from search command. |
| ActionPrepareFromUri |
Indicates this session supports the prepare from URI command. |
| ActionRewind |
Indicates this session supports the rewind command. |
| ActionSeekTo |
Indicates this session supports the seek to command. |
| ActionSetPlaybackSpeed |
Indicates this session supports the set playback speed command. |
| ActionSetRating |
Indicates this session supports the set rating command. |
| ActionSkipToNext |
Indicates this session supports the next command. |
| ActionSkipToPrevious |
Indicates this session supports the previous command. |
| ActionSkipToQueueItem |
Indicates this session supports the skip to queue item command. |
| ActionStop |
Indicates this session supports the stop command. |
| PlaybackPositionUnknown |
Use this value for the position to indicate the position is not known. |
| StateBuffering |
Obsolete.
State indicating this item is currently buffering and will begin playing when enough data has buffered. |
| StateConnecting |
Obsolete.
State indicating the class doing playback is currently connecting to a new destination. |
| StateError |
Obsolete.
State indicating this item is currently in an error state. |
| StateFastForwarding |
Obsolete.
State indicating this item is currently fast forwarding. |
| StateNone |
Obsolete.
This is the default playback state and indicates that no media has been added yet, or the performer has been reset and has no content to play. |
| StatePaused |
Obsolete.
State indicating this item is currently paused. |
| StatePlaying |
Obsolete.
State indicating this item is currently playing. |
| StateRewinding |
Obsolete.
State indicating this item is currently rewinding. |
| StateSkippingToNext |
Obsolete.
State indicating the player is currently skipping to the next item. |
| StateSkippingToPrevious |
Obsolete.
State indicating the player is currently skipping to the previous item. |
| StateSkippingToQueueItem |
Obsolete.
State indicating the player is currently skipping to a specific item in the queue. |
| StateStopped |
Obsolete.
State indicating this item is currently stopped. |
Properties
| Actions |
Get the current actions available on this session. |
| ActiveQueueItemId |
Get the id of the currently active item in the queue. |
| BufferedPosition |
Get the current buffered position in ms. |
| Class |
Returns the runtime class of this |
| Creator | |
| CustomActions |
Get the list of custom actions. |
| ErrorMessage | |
| ErrorMessageFormatted |
Get a user readable error message. |
| Extras |
Get any custom extras that were set on this playback state. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| IsActive |
Returns whether this is considered as an active playback state. |
| JniIdentityHashCode | (Inherited from Object) |
| JniPeerMembers | |
| LastPositionUpdateTime |
Get the elapsed real time at which position was last updated. |
| PeerReference | (Inherited from Object) |
| PlaybackSpeed |
Get the current playback speed as a multiple of normal playback. |
| Position |
Get the current playback position in ms. |
| State |
Get the current state of playback. |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
Methods
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| DescribeContents() |
Describe the kinds of special objects contained in this Parcelable's marshalled representation. |
| Dispose() | (Inherited from Object) |
| Dispose(Boolean) | (Inherited from Object) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| ToArray<T>() | (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() | (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| WriteToParcel(Parcel, ParcelableWriteFlags) |
Flatten this object in to a Parcel. |
Explicit Interface Implementations
| IJavaPeerable.Disposed() | (Inherited from Object) |
| IJavaPeerable.DisposeUnlessReferenced() | (Inherited from Object) |
| IJavaPeerable.Finalized() | (Inherited from Object) |
| IJavaPeerable.JniManagedPeerState | (Inherited from Object) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from Object) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from Object) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from Object) |
Extension Methods
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| GetJniTypeName(IJavaPeerable) | |