Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2023.1.8
Quick Start Sample Integration - MIDI

MIDI Integration Example

MIDI events are posted by calling the AK::SoundEngine::PostMIDIOnEvent() function. The following code shows examples of:

  • setting initial MIDI parameters,
  • posting MIDI events using the event's name (name given to the event by the Wwise user) or the event's ID as defined in "Wwise_IDs.h" (header file generated by Wwise).

Refer to Integration Details - Events for more information regarding events. Refer to Integration Details - MIDI for more information regarding MIDI.

AkUInt8 byType
See AK_MIDI_EVENT_TYPE_* pre-processor definitions.
Definition: AkMidiTypes.h:179
#define AK_MIDI_EVENT_TYPE_NOTE_ON
Definition: AkMidiTypes.h:56
AkMidiChannelNo byChan
Definition: AkMidiTypes.h:180
AKSOUNDENGINE_API AKRESULT RegisterGlobalCallback(AkGlobalCallbackFunc in_pCallback, AkUInt32 in_eLocation=AkGlobalCallbackLocation_BeginRender, void *in_pCookie=NULL, AkPluginType in_eType=AkPluginTypeNone, AkUInt32 in_ulCompanyID=0, AkUInt32 in_ulPluginID=0)
uint8_t AkUInt8
Unsigned 8-bit integer.
tNoteOnOff NoteOnOff
Definition: AkMidiTypes.h:225
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:52
Configured audio settings.
Definition: AkTypes.h:222
AKSOUNDENGINE_API AkPlayingID PostMIDIOnEvent(AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkMIDIPost *in_pPosts, AkUInt16 in_uNumPosts, bool in_bAbsoluteOffsets=false, AkUInt32 in_uFlags=0, AkCallbackFunc in_pfnCallback=NULL, void *in_pCookie=NULL, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID)
AKSOUNDENGINE_API AKRESULT GetAudioSettings(AkAudioSettings &out_audioSettings)
@ AkGlobalCallbackLocation_PreProcessMessageQueueForRender
Start of frame rendering, before having processed game messages.
Definition: AkCallback.h:340
AkUInt32 uNumSamplesPerFrame
Number of samples per audio frame (256, 512, 1024 or 2048).
Definition: AkTypes.h:223
AKSOUNDENGINE_API AkUInt32 GetIDFromString(const char *in_pszString)
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkMidiTypes.h:237
#define AK_MIDI_EVENT_TYPE_NOTE_OFF
Definition: AkMidiTypes.h:55
AkUInt64 uOffset
Frame offset (in samples) for MIDI event post.
Definition: AkMidiTypes.h:238

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