Version

menu_open
Wwise SDK 2023.1.5

◆ StopMIDIOnEvent()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::StopMIDIOnEvent ( AkUniqueID  in_eventID = AK_INVALID_UNIQUE_ID,
AkGameObjectID  in_gameObjectID = AK_INVALID_GAME_OBJECT,
AkPlayingID  in_playingID = AK_INVALID_PLAYING_ID 
)

Stops MIDI notes on all nodes that are referenced in the specified event in an action of type play, with the specified Game Object. Invalid parameters are interpreted as wildcards. For example, calling this function with in_eventID set to AK_INVALID_UNIQUE_ID will stop all MIDI notes for Game Object in_gameObjectID.

Returns
  • AK_Success if the stop command was queued
  • AK_IDNotFound if the Event ID is unknown (not loaded or typo in the ID)
See also
Parameters
in_eventIDUnique ID of the Event
in_gameObjectIDAssociated game object ID
in_playingIDTarget playing ID

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise