Copyright © 2005-2018 MultiMedia Soft

MIDI.StreamEventsListApply method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies in one single shot a list of MIDI events to the loaded MIDI stream. After being applied, the list of MIDI stays live in memory so it can be applied more than once. The list can be cleared and removed from memory through the MIDI.StreamEventsListItemRemove method.

 

MIDI events can be added to the list through the MIDI.StreamEventsListItemAdd method. The total number of events added to the list can be obtained through the MIDI.StreamEventsListItemCountGet method.

 

If you should need applying only one single event you could use the MIDI.StreamEventApply method.

Raw MIDI events stored inside a memory buffer can be applied in one single shot through the MIDI.StreamEventsRawApply 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 StreamEventsListApply (

nPlayerIndex as Int16,

bSendEventNotif as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes StreamEventsListApply (

Int16 nPlayerIndex,

bool bSendEventNotif

);


 

[C++]

public: enumErrorCodes StreamEventsListApply (

Int16 nPlayerIndex,

bool bSendEventNotif

);


 

 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

bSendEventNotif

Boolean flag that specifies if the container application must be notified about the applied events through the MidiStreamEventNotification event.

Supported values are the following:

Value

Meaning

false

The MidiStreamEventNotification event is not generated for MIDI events of the list.

true

The MidiStreamEventNotification event is generated for MIDI events of the list.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.