|
MIDI.StreamEventsListItemRemove method |
  
|
|
MIDI.StreamEventsListItemRemove method |
|
Remarks
Removes a specific single MIDI event from the list of MIDI events that will be applied to the loaded MIDI stream in one single shot through a call to the MIDI.StreamEventsListApply method.
For further details about the use of MIDI protocol see the MIDIMan class section and the How to deal with MIDI protocol tutorial.
Syntax
[Visual Basic] Public Function StreamEventsListItemRemove ( nPlayerIndex as Int16, nUniqueId as Int32 ) as Int32 |
[C#] public Int32 StreamEventsListItemRemove ( Int16 nPlayerIndex, Int32 nUniqueId ); |
[C++] public: Int32 StreamEventsListItemRemove ( Int16 nPlayerIndex, Int32 nUniqueId ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
nUniqueId |
The unique identifier of the MIDI event inside the list. This unique identifier is generated and returned by the MIDI.StreamEventsListItemAdd method when the MIDI event is added to the list. If this parameter is set to -1, the full list is cleared and removed from memory. |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred, check the LastError property value in order to get the error code |
Value > 0 |
The method call was successful and the returned value is the unique identifier of the event. |
