Enum rrise::AkCallbackInfo

source · [−]

pub enum AkCallbackInfo {
    Default {
        game_obj_id: AkGameObjectID,
    },
    MusicSync {
        game_obj_id: AkGameObjectID,
        playing_id: AkPlayingID,
        segment_info: AkSegmentInfo,
        music_sync_type: AkCallbackType,
        user_cue_name: String,
    },
    DynamicSequenceItem {
        game_obj_id: AkGameObjectID,
        playing_id: AkPlayingID,
        audio_node_id: AkUniqueID,
    },
    Event {
        game_obj_id: AkGameObjectID,
        playing_id: AkPlayingID,
        event_id: AkUniqueID,
    },
    Duration {
        game_obj_id: AkGameObjectID,
        playing_id: AkPlayingID,
        event_id: AkUniqueID,
        duration: AkReal32,
        estimated_duration: AkReal32,
        audio_node_id: AkUniqueID,
        media_id: AkUniqueID,
        streaming: bool,
    },
    Marker {
        game_obj_id: AkGameObjectID,
        playing_id: AkPlayingID,
        event_id: AkUniqueID,
        identifier: AkUniqueID,
        position: AkUInt32,
        label: String,
    },
    Midi {
        game_obj_id: AkGameObjectID,
        playing_id: AkPlayingID,
        event_id: AkUniqueID,
        midi_event: AkMIDIEvent,
    },
    MusicPlaylist {
        game_obj_id: AkGameObjectID,
        playing_id: AkPlayingID,
        event_id: AkUniqueID,
        playlist_id: AkUniqueID,
        num_playlist_items: AkUInt32,
        playlist_selection: AkUInt32,
        playlist_item_done: AkUInt32,
    },
    SpeakerMatrixVolume {
        game_obj_id: AkGameObjectID,
        playing_id: AkPlayingID,
        event_id: AkUniqueID,
        input_config: AkChannelConfig,
        output_config: AkChannelConfig,
    },
}

Expand description

Callback information used for all notifications sent from Wwise.

Variants

`Default`

Fields

game_obj_id: AkGameObjectID

Basic information structure returned for notifications that are not handled by another variant.

`MusicSync`

Fields

game_obj_id: AkGameObjectID

playing_id: AkPlayingID

Playing ID of Event, returned by PostEvent::post()

segment_info: AkSegmentInfo

Segment information corresponding to the segment triggering this callback

music_sync_type: AkCallbackType

Would be either AkCallbackType::AK_MusicSyncEntry, AkCallbackType::AK_MusicSyncBeat, AkCallbackType::AK_MusicSyncBar, AkCallbackType::AK_MusicSyncExit, AkCallbackType::AK_MusicSyncGrid, AkCallbackType::AK_MusicSyncPoint or AkCallbackType::AK_MusicSyncUserCue

user_cue_name: String

Cue name. Set for notifications AkCallbackType::AK_MusicSyncUserCue. Empty if cue has no name.

Callback information structure corresponding to AkCallbackType::AK_MusicSyncEntry, AkCallbackType::AK_MusicSyncBeat, AkCallbackType::AK_MusicSyncBar, AkCallbackType::AK_MusicSyncExit, AkCallbackType::AK_MusicSyncGrid, AkCallbackType::AK_MusicSyncPoint and AkCallbackType::AK_MusicSyncUserCue.

If you need the Tempo, you can compute it using the fBeatDuration: Tempo (beats per minute) = 60/fBeatDuration

`DynamicSequenceItem`

Fields

This variant is marked as non-exhaustive

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

game_obj_id: AkGameObjectID

playing_id: AkPlayingID

Playing ID of Dynamic Sequence, returned by DynamicSequence::Open()

audio_node_id: AkUniqueID

Audio Node ID of finished item

Callback information structure corresponding to AkCallbackType::AK_EndOfDynamicSequenceItem.

`Event`

Fields

game_obj_id: AkGameObjectID

playing_id: AkPlayingID

Playing ID of Event, returned by PostEvent::post()

event_id: AkUniqueID

Unique ID of Event, passed to PostEvent::new()

Callback information structure corresponding to AkCallbackType::AK_EndOfEvent, AkCallbackType::AK_MusicPlayStarted and AkCallbackType::AK_Starvation.

`Duration`

Fields

game_obj_id: AkGameObjectID

playing_id: AkPlayingID

Playing ID of Event, returned by PostEvent::post()

event_id: AkUniqueID

Unique ID of Event, passed to PostEvent::new()

duration: AkReal32

Duration of the sound (unit: milliseconds)

estimated_duration: AkReal32

Estimated duration of the sound depending on source settings such as pitch. (unit: milliseconds)

audio_node_id: AkUniqueID

Audio Node ID of playing item

media_id: AkUniqueID

Media ID of playing item. (corresponds to ‘ID’ attribute of ‘File’ element in SoundBank metadata file)

streaming: bool

True if source is streaming, false otherwise

Callback information structure corresponding to AkCallbackType::AK_Duration.

`Marker`

Fields

game_obj_id: AkGameObjectID

playing_id: AkPlayingID

Playing ID of Event, returned by PostEvent::post()

event_id: AkUniqueID

Unique ID of Event, passed to PostEvent::new()

identifier: AkUniqueID

Cue point identifier

position: AkUInt32

Position in the cue point (unit: sample frames)

label: String

Label of the marker, read from the file

Callback information structure corresponding to AkCallbackType::AK_Marker.

`Midi`

Fields

game_obj_id: AkGameObjectID

playing_id: AkPlayingID

Playing ID of Event, returned by PostEvent::post()

event_id: AkUniqueID

Unique ID of Event, passed to PostEvent::new()

midi_event: AkMIDIEvent

MIDI event triggered by event

Callback information structure corresponding to AkCallbackType::AK_MIDIEvent.

`MusicPlaylist`

Fields

game_obj_id: AkGameObjectID

playing_id: AkPlayingID

Playing ID of Event, returned by PostEvent::post()

event_id: AkUniqueID

Unique ID of Event, passed to PostEvent::new()

playlist_id: AkUniqueID

ID of playlist node

num_playlist_items: AkUInt32

Number of items in playlist node (may be segments or other playlists)

playlist_selection: AkUInt32

Selection: set by sound engine

playlist_item_done: AkUInt32

Playlist node done: set by sound engine

Callback information structure corresponding to AkCallbackType::AK_MusicPlaylistSelect.

Called when a music playlist container must select its next item to play. The members playlist_selection and playlist_item_done are set by the sound engine before the callback function call. They are set to the next item selected by the sound engine.

`SpeakerMatrixVolume`

Fields

This variant is marked as non-exhaustive

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

game_obj_id: AkGameObjectID

playing_id: AkPlayingID

Playing ID of Event, returned by PostEvent::post()

event_id: AkUniqueID

Unique ID of Event, passed to PostEvent::new()

input_config: AkChannelConfig

Channel configuration of the voice/bus

output_config: AkChannelConfig

Channel configuration of the output bus

Callback information structure corresponding to AkCallbackType::AK_SpeakerVolumeMatrix, and passed to callbacks registered in [RegisterBusVolumeCallback()] or PostEvent with AkCallbackType::AK_SpeakerVolumeMatrix.

These callbacks are called at every audio frame for every connection from an input (voice or bus) to an output bus (standard or auxiliary), at the point when an input signal is about to be mixed into a mixing bus, but just before having been scaled in accordance to volumes authored in Wwise. The volumes are passed via this structure as pointers because they can be modified in the callbacks. They are factored into two linear values ([0..1]): a common base value (pfBaseVolume), that is channel-agnostic and represents the collapsed gain of all volume changes in Wwise (sliders, actions, RTPC, attenuations, …), and a matrix of gains per input/output channel, which depends on spatialization. Use the methods of AK::SpeakerVolumes::Matrix, defined in AkCommonDefs.h, to perform operations on them. Access each input channel of the volumes matrix with AK::SpeakerVolumes::Matrix::GetChannel(), passing it the input and output channel configuration. Then, you may access each element of the output vector using the standard bracket [] operator. See AK::SpeakerVolumes for more details. It is crucial that the processing done in the callback be lightweight and non-blocking.