JetPlayer.QueueJetSegmentMuteArray Method
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.
Queues the specified segment in the JET queue.
[Android.Runtime.Register("queueJetSegmentMuteArray", "(IIII[ZB)Z", "GetQueueJetSegmentMuteArray_IIIIarrayZBHandler")]
public virtual bool QueueJetSegmentMuteArray (int segmentNum, int libNum, int repeatCount, int transpose, bool[]? muteArray, sbyte userID);
[<Android.Runtime.Register("queueJetSegmentMuteArray", "(IIII[ZB)Z", "GetQueueJetSegmentMuteArray_IIIIarrayZBHandler")>]
abstract member QueueJetSegmentMuteArray : int * int * int * int * bool[] * sbyte -> bool
override this.QueueJetSegmentMuteArray : int * int * int * int * bool[] * sbyte -> bool
Parameters
- segmentNum
- Int32
the identifier of the segment.
- libNum
- Int32
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
- Int32
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
- Int32
the amount of pitch transposition. Set to 0 for normal playback. Range is -12 to +12.
- muteArray
- Boolean[]
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
- SByte
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.
Returns
true if the segment was successfully queued, false if the queue is full or if the parameters are invalid.
- Attributes
Remarks
Queues the specified segment in the JET queue.
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.