JetPlayer

Kotlin |Java

open class JetPlayer

kotlin.Any
↳	android.media.JetPlayer

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:

Playback state
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
abstract	`OnJetEventListener` Handles the notification when the JET engine generates an event.

Public methods
open Boolean	`clearQueue()` Empties the segment queue, and clears all clips that are scheduled for playback.
open Any!	`clone()` Cloning a JetPlayer instance is not supported.
open Boolean	`closeJetFile()` Closes the resource containing the JET content.
open static JetPlayer!	`getJetPlayer()` Factory method for the JetPlayer class.
open static Int	`getMaxTracks()` Gets the maximum number of simultaneous MIDI tracks supported by JetPlayer.
open Boolean	`loadJetFile(path: String!)` Loads a .
open Boolean	`loadJetFile(afd: AssetFileDescriptor!)` Loads a .
open Boolean	`pause()` Pauses the playback of the JET segment queue.
open Boolean	`play()` Starts playing the JET segment queue.
open Boolean	`queueJetSegment(segmentNum: Int, libNum: Int, repeatCount: Int, transpose: Int, muteFlags: Int, userID: Byte)` Queues the specified segment in the JET queue.
open Boolean	`queueJetSegmentMuteArray(segmentNum: Int, libNum: Int, repeatCount: Int, transpose: Int, muteArray: BooleanArray!, userID: Byte)` Queues the specified segment in the JET queue.
open Unit	`release()` Stops the current JET playback, and releases all associated native resources.
open Unit	`setEventListener(listener: JetPlayer.OnJetEventListener!)` Sets the listener JetPlayer notifies when a JET event is generated by the rendering and playback engine.
open Unit	`setEventListener(listener: JetPlayer.OnJetEventListener!, handler: Handler!)` Sets the listener JetPlayer notifies when a JET event is generated by the rendering and playback engine.
open Boolean	`setMuteArray(muteArray: BooleanArray!, sync: Boolean)` Modifies the mute flags for the current active segment.
open Boolean	`setMuteFlag(trackId: Int, muteFlag: Boolean, sync: Boolean)` Mutes or unmutes a single track.
open Boolean	`setMuteFlags(muteFlags: Int, sync: Boolean)` Modifies the mute flags.
open Boolean	`triggerClip(clipId: Int)` Schedules the playback of a clip.

Protected methods
open Unit	`finalize()`

Parameters
`segmentNum`	Int: the identifier of the segment.
`libNum`	Int: 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`	Int: 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`	Int: the amount of pitch transposition. Set to 0 for normal playback. Range is -12 to +12.
`muteFlags`	Int: a bitmask to specify which MIDI tracks will be muted during playback. Bit 0 affects track 0, bit 1 affects track 1 etc.
`userID`	Byte: a value specified by the application that uniquely identifies the segment. this value is received in the `OnJetEventListener#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.

Parameters
`listener`	JetPlayer.OnJetEventListener!: the listener that will be notified when a JET event is generated.
`handler`	Handler!: the Handler that will receive the event notification messages.

Parameters
`muteArray`	BooleanArray!: 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`	Boolean: 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.

Parameters
`trackId`	Int: the index of the track to mute.
`muteFlag`	Boolean: set to true to mute, false to unmute.
`sync`	Boolean: 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.

JetPlayer

Summary

Public methods

clearQueue

clone

closeJetFile

getJetPlayer

getMaxTracks

loadJetFile

loadJetFile

pause

play

queueJetSegment

queueJetSegmentMuteArray

release

setEventListener

setEventListener

setMuteArray

setMuteFlag

setMuteFlags

triggerClip

Protected methods

finalize