JetPlayer 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.
JetPlayer provides access to JET content playback and control.
[Android.Runtime.Register("android/media/JetPlayer", DoNotGenerateAcw=true)]
public class JetPlayer : Java.Lang.Object
[<Android.Runtime.Register("android/media/JetPlayer", DoNotGenerateAcw=true)>]
type JetPlayer = class
inherit Object
- Inheritance
- Attributes
Remarks
JetPlayer provides access to JET content playback and control.
Please refer to the JET Creator User Manual for a presentation of the JET interactive music concept and how to use the JetCreator tool to create content to be player by JetPlayer.
Use of the JetPlayer class is based around the playback of a number of JET segments sequentially added to a playback FIFO queue. The rendering of the MIDI content stored in each segment can be dynamically affected by two mechanisms: <ul> <li>Tracks in a segment can be muted or unmuted at any moment, individually or through a mask (to change the mute state of multiple tracks at once). <li>Parts of tracks in a segment can be played at predefined points in the segment, in order to maintain synchronization with the other tracks in the segment. This is achieved through the notion of "clips", which can be triggered at any time, but that will play only at the right time, as authored in the corresponding JET file. </ul>
As a result of the rendering and playback of the JET segments, the user of the JetPlayer instance can receive notifications from the JET engine relative to: <ul> <li>Playback state <li>Number of segments left to play in the queue <li>Application controller events (CC80-83) to mark points in the MIDI segments </ul>
Use #getJetPlayer() to construct a JetPlayer instance. JetPlayer is a singleton class.
Java documentation for android.media.JetPlayer.
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.
Constructors
| Name | Description |
|---|---|
| JetPlayer(IntPtr, JniHandleOwnership) |
A constructor used when creating managed representations of JNI objects; called by the runtime. |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState |
Gets the state flags last assigned by the runtime. (Inherited from JavaObject) |
| JniPeerMembers |
Gets the JNI metadata used to access members of this Java binding. |
| MaxTracks |
Gets the maximum number of simultaneous MIDI tracks supported by JetPlayer. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
Methods
| Name | Description |
|---|---|
| ClearQueue() |
Empties the segment queue, and clears all clips that are scheduled for playback. |
| Clone() |
Cloning a JetPlayer instance is not supported. |
| CloseJetFile() |
Closes the resource containing the JET content. |
| Construct(JniObjectReference, JniObjectReferenceOptions) |
Delegates construction of this peer to the runtime's value manager. (Inherited from JavaObject) |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() |
Asks the value manager to dispose this peer unless its mapping retains this same managed instance. (Inherited from JavaObject) |
| Equals(Object) |
Tests whether another managed peer refers to the same Java object. (Inherited from JavaObject) |
| 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) |
| GetJetPlayer() |
Factory method for the JetPlayer class. |
| JavaFinalize() |
Obsolete.
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| LoadJetFile(AssetFileDescriptor) |
Loads a . |
| LoadJetFile(String) |
Loads a . |
| LoadJetFileAsync(AssetFileDescriptor) |
Starts a task that calls the asset-descriptor JET load operation. |
| LoadJetFileAsync(String) |
Starts a task that calls the file-path JET load operation. |
| 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) |
| Pause() |
Pauses the playback of the JET segment queue. |
| Play() |
Starts playing the JET segment queue. |
| QueueJetSegment(Int32, Int32, Int32, Int32, Int32, SByte) |
Queues the specified segment in the JET queue. |
| QueueJetSegmentMuteArray(Int32, Int32, Int32, Int32, Boolean[], SByte) |
Queues the specified segment in the JET queue. |
| Release() |
Stops the current JET playback, and releases all associated native resources. |
| SetEventListener(JetPlayer+IOnJetEventListener, Handler) |
Sets the listener JetPlayer notifies when a JET event is generated by the rendering and playback engine. |
| SetEventListener(JetPlayer+IOnJetEventListener) |
Sets the listener JetPlayer notifies when a JET event is generated by the rendering and playback engine. |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetMuteArray(Boolean[], Boolean) |
Modifies the mute flags for the current active segment. |
| SetMuteFlag(Int32, Boolean, Boolean) |
Mutes or unmutes a single track. |
| SetMuteFlags(Int32, Boolean) |
Modifies the mute flags. |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) |
Stores a reference value in the control block without creating a JNI reference copy. (Inherited from JavaObject) |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| TriggerClip(Int32) |
Schedules the playback of a clip. |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (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, 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) |
| 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) |
Events
| Name | Description |
|---|---|
| JetEvent |
Occurs when a JET engine event is dispatched with its segment, track, channel and controller values. |
| JetNumQueuedSegmentUpdate |
Occurs when the JET player reports an updated count of queued segments. |
| JetPauseUpdate |
Occurs when the JET player reports an updated pause-state code. |
| JetUserIdUpdate |
Occurs when the JET player reports the playing segment's user identifier and repetition count. |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() |
Marks this peer as disposed and calls |
| IJavaPeerable.Finalized() |
Marks this peer as disposed and calls |
| IJavaPeerable.JniObjectReferenceControlBlock |
Gets the native control-block pointer used by this peer. (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) |
Stores the identity hash code supplied by the runtime. (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) |
Replaces the stored managed peer state flags. (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) |
Updates the peer reference and releases a disposed peer's control block when the reference is invalid. (Inherited from JavaObject) |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) |
Reuses a compatible managed peer or obtains a wrapper of the requested type. |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |