Android Guides | Samples

Android.Media.JetPlayer Class

JetPlayer provides access to JET content playback and control.

See Also: JetPlayer

Syntax

[Android.Runtime.Register("android/media/JetPlayer", DoNotGenerateAcw=true)]
public class JetPlayer : Object

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.

Developer Guides

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:

  • 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)
  • 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.
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:
  • the playback state,
  • the number of segments left to play in the queue,
  • application controller events (CC80-83) to mark points in the MIDI segments.
Use JetPlayer.GetJetPlayer to construct a JetPlayer instance. JetPlayer is a singleton class.

For more information about how to use JetPlayer, read the JetPlayer developer guide.

[Android Documentation]

Requirements

Namespace: Android.Media
Assembly: Mono.Android (in Mono.Android.dll)
Assembly Versions: 0.0.0.0
Since: Added in API level 3

The members of Android.Media.JetPlayer are listed below.

See Also: Object

Protected Constructors

A constructor used when creating managed representations of JNI objects; called by the runtime.

Public Properties

[read-only]
static
MaxTracksInt32. Returns the maximum number of simultaneous MIDI tracks supported by JetPlayer

Protected Properties

[read-only]
override
ThresholdClassIntPtr. This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
[read-only]
override
ThresholdTypeType. This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Public Methods

ClearQueue() : Boolean
Empties the segment queue, and clears all clips that are scheduled for playback.
Clone() : Object
Cloning a JetPlayer instance is not supported.
CloseJetFile() : Boolean
Closes the resource containing the JET content.
static
GetJetPlayer() : JetPlayer
Factory method for the JetPlayer class.
LoadJetFile(AssetFileDescriptor) : Boolean
Loads a .jet file from an asset file descriptor.
LoadJetFile(String) : Boolean
Loads a .jet file from a given path.
LoadJetFileAsync(AssetFileDescriptor) : System.Threading.Tasks.Task<bool>
LoadJetFileAsync(String) : System.Threading.Tasks.Task<bool>
Pause() : Boolean
Pauses the playback of the JET segment queue.
Play() : Boolean
Starts playing the JET segment queue.
QueueJetSegment(Int32, Int32, Int32, Int32, Int32, SByte) : Boolean
Queues the specified segment in the JET queue.
QueueJetSegmentMuteArray(Int32, Int32, Int32, Int32, Boolean[], SByte) : Boolean
Queues the specified segment in the JET queue.
Release()
Stops the current JET playback, and releases all associated native resources.
SetEventListener(JetPlayer+IOnJetEventListener)
Sets the listener JetPlayer notifies when a JET event is generated by the rendering and playback engine.
SetEventListener(JetPlayer+IOnJetEventListener, Handler)
Sets the listener JetPlayer notifies when a JET event is generated by the rendering and playback engine.
SetMuteArray(Boolean[], Boolean) : Boolean
Modifies the mute flags for the current active segment.
SetMuteFlag(Int32, Boolean, Boolean) : Boolean
Mutes or unmutes a single track.
SetMuteFlags(Int32, Boolean) : Boolean
Modifies the mute flags.
TriggerClip(Int32) : Boolean
Schedules the playback of a clip.

Public Events