public class

JetPlayer

extends Object
java.lang.Object
   ↳ android.media.JetPlayer

Class Overview

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:

  • 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 getJetPlayer() to construct a JetPlayer instance. JetPlayer is a singleton class.

Summary

Nested Classes
interface JetPlayer.OnJetEventListener Handles the notification when the JET engine generates an event. 
Public Methods
boolean clearQueue()
Empties the segment queue, and clears all clips that are scheduled for playback.
Object clone()
Cloning a JetPlayer instance is not supported.
boolean closeJetFile()
Closes the resource containing the JET content.
static JetPlayer getJetPlayer()
Factory method for the JetPlayer class.
static int getMaxTracks()
Returns the maximum number of simultaneous MIDI tracks supported by JetPlayer
boolean loadJetFile(String path)
Loads a .jet file from a given path.
boolean loadJetFile(AssetFileDescriptor afd)
Loads a .jet file from an asset file descriptor.
boolean pause()
Pauses the playback of the JET segment queue.
boolean play()
Starts playing the JET segment queue.
boolean queueJetSegment(int segmentNum, int libNum, int repeatCount, int transpose, int muteFlags, byte userID)
Queues the specified segment in the JET queue.
boolean queueJetSegmentMuteArray(int segmentNum, int libNum, int repeatCount, int transpose, boolean[] muteArray, byte userID)
Queues the specified segment in the JET queue.
void release()
Stops the current JET playback, and releases all associated native resources.
void setEventListener(JetPlayer.OnJetEventListener listener, Handler handler)
Sets the listener JetPlayer notifies when a JET event is generated by the rendering and playback engine.
void setEventListener(JetPlayer.OnJetEventListener listener)
Sets the listener JetPlayer notifies when a JET event is generated by the rendering and playback engine.
boolean setMuteArray(boolean[] muteArray, boolean sync)
Modifies the mute flags for the current active segment.
boolean setMuteFlag(int trackId, boolean muteFlag, boolean sync)
Mutes or unmutes a single track.
boolean setMuteFlags(int muteFlags, boolean sync)
Modifies the mute flags.
boolean triggerClip(int clipId)
Schedules the playback of a clip.
Protected Methods
void finalize()
Is called before the object's memory is being reclaimed by the VM.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public boolean clearQueue ()

Since: API Level 3

Empties the segment queue, and clears all clips that are scheduled for playback.

Returns
  • true if the queue was successfully cleared, false otherwise.

public Object clone ()

Since: API Level 3

Cloning a JetPlayer instance is not supported. Calling clone() will generate an exception.

Returns
  • a copy of this object.
Throws
CloneNotSupportedException

public boolean closeJetFile ()

Since: API Level 3

Closes the resource containing the JET content.

Returns
  • true if successfully closed, false otherwise.

public static JetPlayer getJetPlayer ()

Since: API Level 3

Factory method for the JetPlayer class.

Returns
  • the singleton JetPlayer instance

public static int getMaxTracks ()

Since: API Level 3

Returns the maximum number of simultaneous MIDI tracks supported by JetPlayer

public boolean loadJetFile (String path)

Since: API Level 3

Loads a .jet file from a given path.

Parameters
path the path to the .jet file, for instance "/sdcard/mygame/music.jet".
Returns
  • true if loading the .jet file was successful, false if loading failed.

public boolean loadJetFile (AssetFileDescriptor afd)

Since: API Level 3

Loads a .jet file from an asset file descriptor.

Parameters
afd the asset file descriptor.
Returns
  • true if loading the .jet file was successful, false if loading failed.

public boolean pause ()

Since: API Level 3

Pauses the playback of the JET segment queue.

Returns
  • true if rendering and playback is successfully paused, false otherwise.

public boolean play ()

Since: API Level 3

Starts playing the JET segment queue.

Returns
  • true if rendering and playback is successfully started, false otherwise.

public boolean queueJetSegment (int segmentNum, int libNum, int repeatCount, int transpose, int muteFlags, byte userID)

Since: API Level 3

Queues the specified segment in the JET queue.

Parameters
segmentNum the identifier of the segment.
libNum the index of the sound bank associated with the segment. Use -1 to indicate that no sound bank (DLS file) is associated with this segment, in which case JET will use the General MIDI library.
repeatCount the number of times the segment will be repeated. 0 means the segment will only play once. -1 means the segment will repeat indefinitely.
transpose the amount of pitch transposition. Set to 0 for normal playback. Range is -12 to +12.
muteFlags a bitmask to specify which MIDI tracks will be muted during playback. Bit 0 affects track 0, bit 1 affects track 1 etc.
userID a value specified by the application that uniquely identifies the segment. this value is received in the onJetUserIdUpdate(JetPlayer, int, int) event listener method. Normally, the application will keep a byte value that is incremented each time a new segment is queued up. This can be used to look up any special characteristics of that track including trigger clips and mute flags.
Returns
  • true if the segment was successfully queued, false if the queue is full or if the parameters are invalid.

public boolean queueJetSegmentMuteArray (int segmentNum, int libNum, int repeatCount, int transpose, boolean[] muteArray, byte userID)

Since: API Level 3

Queues the specified segment in the JET queue.

Parameters
segmentNum the identifier of the segment.
libNum the index of the soundbank associated with the segment. Use -1 to indicate that no sound bank (DLS file) is associated with this segment, in which case JET will use the General MIDI library.
repeatCount the number of times the segment will be repeated. 0 means the segment will only play once. -1 means the segment will repeat indefinitely.
transpose the amount of pitch transposition. Set to 0 for normal playback. Range is -12 to +12.
muteArray an array of booleans to specify which MIDI tracks will be muted during playback. The value at index 0 affects track 0, value at index 1 affects track 1 etc. The length of the array must be getMaxTracks() for the call to succeed.
userID a value specified by the application that uniquely identifies the segment. this value is received in the onJetUserIdUpdate(JetPlayer, int, int) event listener method. Normally, the application will keep a byte value that is incremented each time a new segment is queued up. This can be used to look up any special characteristics of that track including trigger clips and mute flags.
Returns
  • true if the segment was successfully queued, false if the queue is full or if the parameters are invalid.

public void release ()

Since: API Level 3

Stops the current JET playback, and releases all associated native resources. The object can no longer be used and the reference should be set to null after a call to release().

public void setEventListener (JetPlayer.OnJetEventListener listener, Handler handler)

Since: API Level 3

Sets the listener JetPlayer notifies when a JET event is generated by the rendering and playback engine. Use this method to receive JET events in the Handler associated with another thread than the one in which you created the JetPlayer instance.

Parameters
handler the Handler that will receive the event notification messages.

public void setEventListener (JetPlayer.OnJetEventListener listener)

Since: API Level 3

Sets the listener JetPlayer notifies when a JET event is generated by the rendering and playback engine. Notifications will be received in the same thread as the one in which the JetPlayer instance was created.

public boolean setMuteArray (boolean[] muteArray, boolean sync)

Since: API Level 3

Modifies the mute flags for the current active segment.

Parameters
muteArray an array of booleans to specify which MIDI tracks are muted. The value at index 0 affects track 0, value at index 1 affects track 1 etc. The length of the array must be getMaxTracks() for the call to succeed.
sync if false, the new mute flags will be applied as soon as possible by the JET render and playback engine. If true, the mute flags will be updated at the start of the next segment. If the segment is repeated, the flags will take effect the next time segment is repeated.
Returns
  • true if the mute flags were successfully updated, false otherwise.

public boolean setMuteFlag (int trackId, boolean muteFlag, boolean sync)

Since: API Level 3

Mutes or unmutes a single track.

Parameters
trackId the index of the track to mute.
muteFlag set to true to mute, false to unmute.
sync if false, the new mute flags will be applied as soon as possible by the JET render and playback engine. If true, the mute flag will be updated at the start of the next segment. If the segment is repeated, the flag will take effect the next time segment is repeated.
Returns
  • true if the mute flag was successfully updated, false otherwise.

public boolean setMuteFlags (int muteFlags, boolean sync)

Since: API Level 3

Modifies the mute flags.

Parameters
muteFlags a bitmask to specify which MIDI tracks are muted. Bit 0 affects track 0, bit 1 affects track 1 etc.
sync if false, the new mute flags will be applied as soon as possible by the JET render and playback engine. If true, the mute flags will be updated at the start of the next segment. If the segment is repeated, the flags will take effect the next time segment is repeated.
Returns
  • true if the mute flags were successfully updated, false otherwise.

public boolean triggerClip (int clipId)

Since: API Level 3

Schedules the playback of a clip. This will automatically update the mute flags in sync with the JET Clip Marker (controller 103). The parameter clipID must be in the range of 0-63. After the call to triggerClip, when JET next encounters a controller event 103 with bits 0-5 of the value equal to clipID and bit 6 set to 1, it will automatically unmute the track containing the controller event. When JET encounters the complementary controller event 103 with bits 0-5 of the value equal to clipID and bit 6 set to 0, it will mute the track again.

Parameters
clipId the identifier of the clip to trigger.
Returns
  • true if the clip was successfully triggered, false otherwise.

Protected Methods

protected void finalize ()

Since: API Level 3

Is called before the object's memory is being reclaimed by the VM. This can only happen once the VM has detected, during a run of the garbage collector, that the object is no longer reachable by any thread of the running application.

The method can be used to free system resources or perform other cleanup before the object is garbage collected. The default implementation of the method is empty, which is also expected by the VM, but subclasses can override finalize() as required. Uncaught exceptions which are thrown during the execution of this method cause it to terminate immediately but are otherwise ignored.

Note that the VM does guarantee that finalize() is called at most once for any object, but it doesn't guarantee when (if at all) finalize() will be called. For example, object B's finalize() can delay the execution of object A's finalize() method and therefore it can delay the reclamation of A's memory. To be safe, use a ReferenceQueue, because it provides more control over the way the VM deals with references during garbage collection.