Wwise SDK
_ak_sound_engine_8h_source
Version
menu
|
Wwise SDK 2023.1.18
|
AkSoundEngine.h
Go to the documentation of this file.
134Â AkOutputSettings(const char* in_szDeviceShareSet, AkUniqueID in_idDevice = AK_INVALID_UNIQUE_ID, AkChannelConfig in_channelConfig = AkChannelConfig(), AkPanningRule in_ePanning = AkPanningRule_Speakers);
137Â AkOutputSettings(const wchar_t* in_szDeviceShareSet, AkUniqueID in_idDevice = AK_INVALID_UNIQUE_ID, AkChannelConfig in_channelConfig = AkChannelConfig(), AkPanningRule in_ePanning = AkPanningRule_Speakers);
159Â /// Define the orientation of the the floor plane with respect to the X,Y,Z axes, and which axes represent the side, front and up vectors as a basis for rotations in Wwise.
160Â /// AkFloorPlane is used in to orient the Game Object 3D Viewer in Wwise, and in the transformation of geometry instances in Wwise Spatial Audio.
167Â };
171Â // in_uExecutionTimeUsec is the number of microseconds that the function should execute for before terminating.
172Â // Note that the deadline is only checked after each individual job completes execution, so the function may run slightly
173Â // longer than intended. The "in_uExecutionTimeUsec" should be considered a suggestion or guideline, not a strict rule.
174Â // A value of 0 means that the function will run until there are no more jobs ready to be immediately executed.
183Â /// Callback function prototype definition used for handling requests from JobMgr for new workers to perform work.
201Â /// External (optional) callback for tracking performance of the sound engine that is called when a timer starts. (only called in Debug and Profile binaries; this is not called in Release)
202Â /// in_uPluginID may be non-zero when this function is called, to provide extra data about what context this Timer was started in.
203Â /// in_pszZoneName will point to a static string, so the pointer can be stored for later use, not just the contents of the string itself.
209Â /// External (optional) function for tracking performance of the sound engine that is called when a timer stops. (only called in Debug and Profile binaries; this is not called in Release)
213Â /// in_uPluginID may be non-zero when this function is called, to provide extra data about what context this Marker was posted in.
214Â /// in_pszMarkerName will point to a static string, so the pointer can be stored for later use, not just the contents of the string itself.
305Â /// \warning This function is not thread-safe. It should not be called at the same time as \c SoundEngine::Init() or \c SoundEngine::Term().
315Â /// \remark The initial settings should be initialized using AK::SoundEngine::GetDefaultInitSettings()
317Â /// default settings. This is not mandatory, but it helps avoid backward compatibility problems.
321Â /// - \c AK_MemManagerNotInitialized if the memory manager is not available or not properly initialized
322Â /// - \c AK_StreamMgrNotInitialized if the stream manager is not available or not properly initialized
323Â /// - \c AK_SSEInstructionsNotSupported if the machine does not support SSE instruction (only on the PC)
324Â /// - \c AK_InsufficientMemory if there is not enough memory available to initialize the sound engine properly
326Â /// - \c AK_AlreadyInitialized if the sound engine is already initialized, or if the provided settings result in insufficient
356Â /// the moment of the initialization of the sound engine and might not be the correct one for your game.
372Â /// \warning Before calling Term, you must ensure that no other thread is accessing the sound engine.
391Â /// Call this function to get the speaker configuration of the output (which may not correspond
392Â /// to the physical output format of the platform, in the case of downmixing provided by the platform itself).
396Â /// If the speaker configuration of the output is object-based, the speaker configuration of the
397Â /// main mix is returned. To query more information on object-based output devices, see AK::SoundEngine::GetOutputDeviceConfiguration.
399Â /// It is recommended to call GetSpeakerConfiguration anytime after receiving a callback from RegisterAudioDeviceStatusCallback to know if the channel configuration has changed.
402Â /// If you are initializing the sound engine with AkInitSettings::bUseLEngineThread to false, it is required to call RenderAudio() at least once before calling this function to complete the sound engine initialization.
404Â /// \return The output configuration. An empty AkChannelConfig not AkChannelConfig::IsValid() if device does not exist or if the Init.bnk was not loaded yet.
414Â /// Call this function to get the channel configuration of the output device as well as its 3D audio capabilities.
415Â /// If the configuration of the output device is object-based (io_channelConfig.eConfigType == AK_ChannelConfigType_Objects),
416Â /// io_capabilities can be inspected to determine the channel configuration of the main mix (Ak3DAudioSinkCapabilities::channelConfig),
417Â /// whether or not the output device uses a passthrough mix (Ak3DAudioSinkCapabilities::bPassthrough) and the maximum number of objects
418Â /// that can play simultaneously on this output device (Ak3DAudioSinkCapabilities::uMax3DAudioObjects). Note that if
419Â /// Ak3DAudioSinkCapabilities::bMultiChannelObjects is false, multi-channel objects will be split into multiple mono objects
422Â /// \warning Call this function only after the sound engine has been properly initialized. If you are initializing the sound engine with AkInitSettings::bUseLEngineThread to false, it is required to call RenderAudio() at least once before calling this function to complete the sound engine initialization.
455Â /// \warning This function posts a message through the sound engine's internal message queue, whereas GetPanningRule() queries the current panning rule directly.
457Â /// The specified panning rule will only impact the sound if the processing format is downmixing to Stereo in the mixing process. It
465Â /// Gets speaker angles of the specified device. Speaker angles are used for 3D positioning of sounds over standard configurations.
467Â /// The speaker angles are expressed as an array of loudspeaker pairs, in degrees, relative to azimuth ]0,180].
468Â /// Supported loudspeaker setups are always symmetric; the center speaker is always in the middle and thus not specified by angles.
470Â /// You may call this function with io_pfSpeakerAngles set to NULL to get the expected number of angle values in io_uNumAngles,
481Â /// - When panning to stereo (speaker mode, see AK::SoundEngine::SetPanningRule()), only angle[0] is used, and 3D sounds in the back of the listener are mirrored to the front.
482Â /// - When panning to 5.1, the front speakers use angle[0], and the surround speakers use (angle[2] + angle[1]) / 2.
494Â /// Sets speaker angles of the specified device. Speaker angles are used for 3D positioning of sounds over standard configurations.
496Â /// The speaker angles are expressed as an array of loudspeaker pairs, in degrees, relative to azimuth ]0,180], for a 7.1 speaker configuration.
497Â /// Supported loudspeaker setups are always symmetric; the center speaker is always in the middle and thus not specified by angles.
500Â /// - This function requires the minimum speaker angle between any pair of speakers to be at least 5 degrees.
501Â /// - When setting angles for a 5.1 speaker layout, we recommend that you select an angle for the SL and SR channels, then subtract 15 degrees for in_pfSpeakerAngles[1] and add 15 degrees for in_pfSpeakerAngles[2] to set the arc appropriately.
507Â /// This function posts a message to the audio thread through the command queue, so it is thread safe. However the result may not be immediately read with GetSpeakerAngles().
508Â /// \warning This function only applies to configurations (or subset of these configurations) that are standard and whose speakers are on the plane (2D).
522Â /// Allows the game to set the volume threshold to be used by the sound engine to determine if a voice must go virtual.
524Â /// If this function is not called, the used value will be the value specified in the platform specific project settings.
533Â /// Allows the game to set the maximum number of non virtual voices to be played simultaneously.
535Â /// If this function is not called, the used value will be the value specified in the platform specific project settings.
545Â /// This function may only be used if a worker function has been set via \ref AkJobMgrSettings.
547Â /// - \c AK_InvalidParameter in_jobType is not a valid jobtype, or in_uNewMaxActiveWorkers is not greater than 0
548Â /// - \c AK_NotInitialized JobMgr system was not already initialized with a function to request for workers
585Â /// This function is deprecated. Registration is now automatic if you link plug-ins statically. If plug-ins are dynamic libraries (such as DLLs or SOs), use \c RegisterPluginDLL.
596Â /// Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
597Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
598Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
611Â /// The plug-in DLL must be in the OS-specific library path or in the same location as the executable. If not, set AkInitSettings.szPluginDLLPath.
614Â /// - \c AK_FileNotFound if the DLL is not found in the OS path or if it has extraneous dependencies not found.
615Â /// - \c AK_InsufficientMemory if the system ran out of resources while loading the dynamic library
616Â /// - \c AK_NotCompatible if the file was found but is not binary-compatible with the system's expected executable format
635Â /// This function is deprecated. Registration is now automatic if you link plugins statically. If plugins are dynamic libraries (such as DLLs or SOs), use RegisterPluginDLL.
645Â /// Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
646Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
647Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
656Â /// Registers a global callback function. This function will be called from the audio rendering thread, at the
657Â /// location specified by in_eLocation. This function will also be called from the thread calling
659Â /// For example, in order to be called at every audio rendering pass, and once during teardown for releasing resources, you would call
660Â /// RegisterGlobalCallback(myCallback, AkGlobalCallbackLocation_BeginRender | AkGlobalCallbackLocation_Term, myCookie, AkPluginTypeNone, 0, 0);
662Â /// A Plugin Type, Company ID and Plugin ID can be provided to this function to enable timing in the performance monitor.
663Â /// If the callback is being timed, it will contribute to the Total Plug-in CPU measurement, and also appear in the Plug-ins tab of the Advanced Profiler by plug-in type and ID.
668Â /// - \c AK_InvalidParameter if parameters are out of range (check debug console or Wwise Profiler)
682Â /// Unregisters a global callback function, previously registered using RegisterGlobalCallback.
684Â /// It is legal to call this function while already inside of a global callback, If it is unregistering itself and not
689Â /// - \c AK_InvalidParameter if parameters are out of range (check debug console or Wwise Profiler)
699Â /// Registers a resource monitor callback function that gets all of the resource usage data contained in the
700Â /// AkResourceMonitorDataSummary structure. This includes general information about the system, such as CPU usage,
701Â /// active Voices, and Events. This function will be called from the audio rendering thread at the end of each frame.
703Â /// If the callback is being timed, it will contribute to the Total Plug-in CPU measurement, and also appear in the Plug-ins tab of the Advanced Profiler by plug-in type and ID.
714Â /// Unregisters a resource monitor callback function, previously registered using RegisterResourceMonitorCallback.
716Â /// It is legal to call this function while already inside of a resource monitor callback, If it is unregistering itself and not
734Â /// Unregisters the callback for the Audio Device status changes, registered by RegisterAudioDeviceStatusCallback
744Â /// This function will hash the name based on a algorithm ( provided at : /AK/Tools/Common/AkFNVHash.h )
747Â /// AkUniqueID, AkStateGroupID, AkStateID, AkSwitchGroupID, AkSwitchStateID, AkRtpcID, and so on...
763Â /// This function will hash the name based on a algorithm ( provided at : /AK/Tools/Common/AkFNVHash.h )
766Â /// AkUniqueID, AkStateGroupID, AkStateID, AkSwitchGroupID, AkSwitchStateID, AkRtpcID, and so on...
787Â /// The callback function can be used to be noticed when markers are reached or when the event is finished.
788Â /// An array of wave file sources can be provided to resolve External Sources triggered by the event.
789Â /// \return The playing ID of the event launched, or AK_INVALID_PLAYING_ID if posting the event failed and an error will be displayed in the debug console and the Wwise Profiler.
791Â /// If used, the array of external sources should contain the information for each external source triggered by the
792Â /// event. When triggering an event with multiple external sources, you need to differentiate each source
793Â /// by using the cookie property in the External Source in the Wwise project and in AkExternalSourceInfo.
794Â /// \aknote If an event triggers the playback of more than one external source, they must be named uniquely in the project
795Â /// (therefore have a unique cookie) in order to tell them apart when filling the AkExternalSourceInfo structures.
816Â /// The callback function can be used to be noticed when markers are reached or when the event is finished.
817Â /// An array of wave file sources can be provided to resolve External Sources triggered by the event.
818Â /// \return The playing ID of the event launched, or AK_INVALID_PLAYING_ID if posting the event failed and an error will be displayed in the debug console and the Wwise Profiler.
820Â /// If used, the array of external sources should contain the information for each external source triggered by the
821Â /// event. When triggering an event with multiple external sources, you need to differentiate each source
822Â /// by using the cookie property in the External Source in the Wwise project and in AkExternalSourceInfo.
823Â /// \aknote If an event triggers the playback of more than one external source, they must be named uniquely in the project
824Â /// (therefore have a unique cookie) in order to tell them appart when filling the AkExternalSourceInfo structures.
845Â /// The callback function can be used to be noticed when markers are reached or when the event is finished.
846Â /// An array of Wave file sources can be provided to resolve External Sources triggered by the event. P
847Â /// \return The playing ID of the event launched, or AK_INVALID_PLAYING_ID if posting the event failed and an error will be displayed in the debug console and the Wwise Profiler.
849Â /// If used, the array of external sources should contain the information for each external source triggered by the
850Â /// event. When triggering an Event with multiple external sources, you need to differentiate each source
851Â /// by using the cookie property in the External Source in the Wwise project and in AkExternalSourceInfo.
852Â /// \aknote If an event triggers the playback of more than one external source, they must be named uniquely in the project
853Â /// (therefore have a unique cookie) in order to tell them apart when filling the AkExternalSourceInfo structures.
872Â // If you modify AkActionOnEventType, don't forget to modify the WAAPI validation schema accordingly.
884Â };
886Â /// Executes an action on all nodes that are referenced in the specified event in an action of type play.
902Â /// Executes an action on all nodes that are referenced in the specified event in an action of type play.
918Â /// Executes an Action on all nodes that are referenced in the specified Event in an Action of type Play.
934Â /// Executes a number of MIDI Events on all nodes that are referenced in the specified Event in an Action of type Play.
935Â /// The time at which a MIDI Event is posted is determined by in_bAbsoluteOffsets. If false, each MIDI event will be
936Â /// posted in AkMIDIPost::uOffset samples from the start of the current frame. If true, each MIDI event will be posted
939Â /// The duration of a sample can be determined from the sound engine's audio settings, via a call to AK::SoundEngine::GetAudioSettings.
940Â /// If a playing ID is specified then that playing ID must be active. Otherwise a new playing ID will be assigned.
941Â /// \return The playing ID of the event launched, or AK_INVALID_PLAYING_ID if posting the event failed and an error will be displayed in the debug console and the Wwise Profiler.
959Â /// Stops MIDI notes on all nodes that are referenced in the specified event in an action of type play,
960Â /// with the specified Game Object. Invalid parameters are interpreted as wildcards. For example, calling
961Â /// this function with in_eventID set to AK_INVALID_UNIQUE_ID will stop all MIDI notes for Game Object
976Â /// Starts streaming the first part of all streamed files referenced by an Event into a cache buffer. Caching streams are serviced when no other streams require the
977Â /// available bandwidth. The files will remain cached until UnpinEventInStreamCache is called, or a higher priority pinned file needs the space and the limit set by
979Â /// \remarks The amount of data from the start of the file that will be pinned to cache is determined by the prefetch size. The prefetch size is set via the authoring tool and stored in the sound banks.
980Â /// \remarks It is possible to override the prefetch size stored in the sound bank via the low level IO. For more information see AK::StreamMgr::IAkLowLevelIOHook::BatchOpen() and AkFileSystemFlags.
981Â /// \remarks If this function is called additional times with the same event, then the priority of the caching streams are updated. Note however that priority is passed down to the stream manager
982Â /// on a file-by-file basis, and if another event is pinned to cache that references the same file but with a different priority, then the first priority will be updated with the most recent value.
983Â /// \remarks If the event references files that are chosen based on a State Group (via a switch container), all files in all states will be cached. Those in the current active state
984Â /// will get cached with active priority, while all other files will get cached with inactive priority.
985Â /// \remarks in_uInactivePriority is only relevant for events that reference switch containers that are assigned to State Groups. This parameter is ignored for all other events, including events that only reference
986Â /// switch containers that are assigned to Switch Groups. Files that are chosen based on a Switch Group have a different switch value per game object, and are all effectively considered active by the pin-to-cache system.
1002Â /// Starts streaming the first part of all streamed files referenced by an event into a cache buffer. Caching streams are serviced when no other streams require the
1003Â /// available bandwidth. The files will remain cached until UnpinEventInStreamCache is called, or a higher priority pinned file needs the space and the limit set by
1005Â /// \remarks The amount of data from the start of the file that will be pinned to cache is determined by the prefetch size. The prefetch size is set via the authoring tool and stored in the sound banks.
1006Â /// \remarks It is possible to override the prefetch size stored in the sound bank via the low level IO. For more information see AK::StreamMgr::IAkLowLevelIOHook::BatchOpen() and AkFileSystemFlags.
1007Â /// \remarks If this function is called additional times with the same event, then the priority of the caching streams are updated. Note however that priority is passed down to the stream manager
1008Â /// on a file-by-file basis, and if another event is pinned to cache that references the same file but with a different priority, then the first priority will be updated with the most recent value.
1009Â /// \remarks If the event references files that are chosen based on a State Group (via a Switch Container), all files in all states will be cached. Those in the current active state
1010Â /// will get cached with active priority, while all other files will get cached with inactive priority.
1011Â /// \remarks in_uInactivePriority is only relevant for events that reference switch containers that are assigned to State Groups. This parameter is ignored for all other events, including events that only reference
1012Â /// switch containers that are assigned to Switch Groups. Files that are chosen based on a Switch Group have a different switch value per game object, and are all effectively considered active by the pin-to-cache system.
1028Â /// Starts streaming the first part of all streamed files referenced by an event into a cache buffer. Caching streams are serviced when no other streams require the
1029Â /// available bandwidth. The files will remain cached until UnpinEventInStreamCache is called, or a higher priority pinned file needs the space and the limit set by
1031Â /// \remarks The amount of data from the start of the file that will be pinned to cache is determined by the prefetch size. The prefetch size is set via the authoring tool and stored in the sound banks.
1032Â /// \remarks It is possible to override the prefetch size stored in the sound bank via the low level IO. For more information see AK::StreamMgr::IAkLowLevelIOHook::BatchOpen() and AkFileSystemFlags.
1033Â /// \remarks If this function is called additional times with the same event, then the priority of the caching streams are updated. Note however that priority is passed down to the stream manager
1034Â /// on a file-by-file basis, and if another event is pinned to cache that references the same file but with a different priority, then the first priority will be updated with the most recent value.
1035Â /// \remarks If the event references files that are chosen based on a State Group (via a switch container), all files in all states will be cached. Those in the current active state
1036Â /// will get cached with active priority, while all other files will get cached with inactive priority.
1037Â /// \remarks in_uInactivePriority is only relevant for events that reference switch containers that are assigned to State Groups. This parameter is ignored for all other events, including events that only reference
1038Â /// switch containers that are assigned to Switch Groups. Files that are chosen based on a Switch Group have a different switch value per game object, and are all effectively considered active by the pin-to-cache system.
1053Â /// Releases the set of files that were previously requested to be pinned into cache via AK::SoundEngine::PinEventInStreamCache(). The file may still remain in stream cache
1054Â /// after AK::SoundEngine::UnpinEventInStreamCache() is called, until the memory is reused by the streaming memory manager in accordance with to its cache management algorithm.
1066Â /// Releases the set of files that were previously requested to be pinned into cache via AK::SoundEngine::PinEventInStreamCache(). The file may still remain in stream cache
1067Â /// after AK::SoundEngine::UnpinEventInStreamCache() is called, until the memory is reused by the streaming memory manager in accordance with to its cache management algorithm.
1079Â /// Releases the set of files that were previously requested to be pinned into cache via AK::SoundEngine::PinEventInStreamCache(). The file may still remain in stream cache
1080Â /// after AK::SoundEngine::UnpinEventInStreamCache() is called, until the memory is reused by the streaming memory manager in accordance with to its cache management algorithm.
1091Â /// Returns information about an Event that was requested to be pinned into cache via AK::SoundEngine::PinEventInStreamCache().
1092Â /// Retrieves the smallest buffer fill-percentage for each file referenced by the event, and whether
1093Â /// the cache-pinned memory limit is preventing any of the files from filling up their buffer.
1094Â /// \remarks To set the limit for the maximum number of bytes that can be pinned to cache, see \c AkDeviceSettings
1108Â /// Returns information about an Event that was requested to be pinned into cache via \c AK::SoundEngine::PinEventInStreamCache().
1109Â /// Retrieves the smallest buffer fill-percentage for each file referenced by the event, and whether
1110Â /// the cache-pinned memory limit is preventing any of the files from filling up their buffer.
1111Â /// \remarks To set the limit for the maximum number of bytes that can be pinned to cache, see AkDeviceSettings
1126Â /// Returns information about an Event that was requested to be pinned into cache via \c AK::SoundEngine::PinEventInStreamCache().
1127Â /// Retrieves the smallest buffer fill-percentage for each file referenced by the event, and whether
1128Â /// the cache-pinned memory limit is preventing any of the files from filling up their buffer.
1129Â /// \remarks To set the limit for the maximum number of bytes that can be pinned to cache, see AkDeviceSettings
1144Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1147Â /// - This works with all objects of the actor-mixer hierarchy, and also with Music Segments and Music Switch Containers.
1148Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1149Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1150Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1155Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1156Â /// With objects of the actor-mixer hierarchy, markers are embedded in wave files by an external wave editor.
1157Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1158Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1159Â /// to nearest marker. In the case of objects of the interactive music hierarchy, user (wave) markers are ignored:
1160Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1161Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1165Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1167Â /// - Music segments cannot be looped. You may want to listen to the AK_EndOfEvent notification
1169Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1171Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1172Â /// value that was passed to the method. Use AK::MusicEngine::GetPlayingSegmentInfo() to query
1174Â /// (so that it restarts precisely at the position that you specified). AK::MusicEngine::GetPlayingSegmentInfo()
1179Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1180Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1181Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1182Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1201Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1204Â /// - This works with all objects of the actor-mixer hierarchy, and also with Music Segments and Music Switch Containers.
1205Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1206Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1207Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1210Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1214Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1215Â /// With objects of the actor-mixer hierarchy, markers are embedded in wave files by an external wave editor.
1216Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1217Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1218Â /// to nearest marker. In the case of objects of the interactive music hierarchy, user (wave) markers are ignored:
1219Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1220Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1224Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1226Â /// - Music segments cannot be looped. You may want to listen to the AK_EndOfEvent notification
1228Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1230Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1231Â /// value that was passed to the method. Use AK::MusicEngine::GetPlayingSegmentInfo() to query
1233Â /// (so that it restarts precisely at the position that you specified). AK::MusicEngine::GetPlayingSegmentInfo()
1238Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1239Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1240Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1241Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1259Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1262Â /// - This works with all objects of the actor-mixer hierarchy, and also with Music Segments and Music Switch Containers.
1263Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1264Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1265Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1268Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1272Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1273Â /// With objects of the actor-mixer hierarchy, markers are embedded in wave files by an external wave editor.
1274Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1275Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1276Â /// to nearest marker. In the case of objects of the interactive music hierarchy, user (wave) markers are ignored:
1277Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1278Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1282Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1284Â /// - Music segments cannot be looped. You may want to listen to the AK_EndOfEvent notification
1286Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1288Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1289Â /// value that was passed to the method. Use AK::MusicEngine::GetPlayingSegmentInfo() to query
1291Â /// (so that it restarts precisely at the position that you specified). AK::MusicEngine::GetPlayingSegmentInfo()
1296Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1297Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1298Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1299Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1317Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1318Â /// Seek position is specified as a percentage of the sound's total duration, and takes looping into account.
1321Â /// - This works with all objects of the actor-mixer hierarchy, and also with Music Segments and Music Switch Containers.
1322Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1323Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1324Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1328Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1329Â /// With objects of the actor-mixer hierarchy, markers are embedded in wave files by an external wave editor.
1330Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1331Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1332Â /// to nearest marker. In the case of objects of the interactive music hierarchy, user (wave) markers are ignored:
1333Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1334Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1338Â /// - With Music Segments, \c in_fPercent is relative to the Entry Cue, and the segment's duration is the
1339Â /// duration between its entry and exit cues. Consequently, you cannot seek within the pre-entry or
1341Â /// - Music Segments cannot be looped. You may want to listen to the \c AK_EndOfEvent notification
1343Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1345Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1346Â /// value that was passed to the method. Use AK::MusicEngine::GetPlayingSegmentInfo() to query
1347Â /// the exact position of a segment. Also, the segment will be silent during the time that period
1348Â /// (so that it restarts precisely at the position that you specified). AK::MusicEngine::GetPlayingSegmentInfo()
1353Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1354Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1355Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1356Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1372Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1373Â /// Seek position is specified as a percentage of the sound's total duration, and takes looping into account.
1376Â /// - This works with all objects of the actor-mixer hierarchy, and also with Music Segments and Music Switch Containers.
1377Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1378Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1379Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1382Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1383Â /// With objects of the actor-mixer hierarchy, markers are embedded in wave files by an external wave editor.
1384Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1385Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1386Â /// to nearest marker. In the case of objects of the interactive music hierarchy, user (wave) markers are ignored:
1387Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1388Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1392Â /// - With Music Segments, \c in_fPercent is relative to the Entry Cue, and the segment's duration is the
1393Â /// duration between its entry and exit cues. Consequently, you cannot seek within the pre-entry or
1395Â /// - Music Segments cannot be looped. You may want to listen to the \c AK_EndOfEvent notification
1397Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1399Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1400Â /// value that was passed to the method. Use AK::MusicEngine::GetPlayingSegmentInfo() to query
1401Â /// the exact position of a segment. Also, the segment will be silent during the time that period
1402Â /// (so that it restarts precisely at the position that you specified). AK::MusicEngine::GetPlayingSegmentInfo()
1407Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1408Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1409Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1410Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1426Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1427Â /// Seek position is specified as a percentage of the sound's total duration, and takes looping into account.
1430Â /// - This works with all objects of the actor-mixer hierarchy, and also with Music Segments and Music Switch Containers.
1431Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1432Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1433Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1436Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1437Â /// With objects of the actor-mixer hierarchy, markers are embedded in wave files by an external wave editor.
1438Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1439Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1440Â /// to nearest marker. In the case of objects of the interactive music hierarchy, user (wave) markers are ignored:
1441Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1442Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1446Â /// - With Music Segments, in_fPercent is relative to the Entry Cue, and the segment's duration is the
1447Â /// duration between its entry and exit cues. Consequently, you cannot seek within the pre-entry or
1449Â /// - Music segments cannot be looped. You may want to listen to the AK_EndOfEvent notification
1451Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1453Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1454Â /// value that was passed to the method. Use AK::MusicEngine::GetPlayingSegmentInfo() to query
1455Â /// the exact position of a segment. Also, the segment will be silent during the time that period
1456Â /// (so that it restarts precisely at the position that you specified). AK::MusicEngine::GetPlayingSegmentInfo()
1461Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1462Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1463Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1464Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1500Â /// Gets the current position of the source associated with this playing ID, obtained from PostEvent(). If more than one source is playing,
1503Â /// - You need to pass AK_EnableGetSourcePlayPosition to PostEvent() in order to use this function, otherwise
1505Â /// - The source's position is updated at every audio frame, and the time at which this occurs is stored.
1506Â /// When you call this function from your thread, you therefore query the position that was updated in the previous audio frame.
1507Â /// If in_bExtrapolate is true (default), the returned position is extrapolated using the elapsed time since last
1512Â /// - \c AK_PlayingIDNotFound if the playing ID is invalid (not playing yet, or finished playing).
1522Â /// Gets the current position of the sources associated with this playing ID, obtained from PostEvent().
1524Â /// - You need to pass AK_EnableGetSourcePlayPosition to PostEvent() in order to use this function, otherwise
1526Â /// - The source's position is updated at every audio frame, and the time at which this occurs is stored.
1527Â /// When you call this function from your thread, you therefore query the position that was updated in the previous audio frame.
1528Â /// If in_bExtrapolate is true (default), the returned position is extrapolated using the elapsed time since last
1530Â /// - If 0 is passed in for the number of entries (*in_pcPositions == 0) then only the number of positions will be returned and the
1537Â /// - \c AK_PlayingIDNotFound if the playing ID is invalid (not playing yet, or finished playing).
1548Â /// Gets the stream buffering of the sources associated with this playing ID, obtained from PostEvent().
1550Â /// - You need to pass AK_EnableGetSourceStreamBuffering to PostEvent() in order to use this function, otherwise
1552Â /// - The sources stream buffering is updated at every audio frame. If there are multiple sources associated with this playing ID,
1554Â /// - The returned buffering status out_bIsBuffering will be true If any of the sources associated with the playing ID are actively being buffered.
1555Â /// It will be false if all of them have reached the end of file, or have reached a state where they are buffered enough and streaming is temporarily idle.
1556Â /// - Purely in-memory sources are excluded from this database. If all sources are in-memory, GetSourceStreamBuffering() will return AK_PlayingIDNotFound.
1557Â /// - The returned buffering amount and state is not completely accurate with some hardware-accelerated codecs. In such cases, the amount of stream buffering is generally underestimated.
1558Â /// On the other hand, it is not guaranteed that the source will be ready to produce data at the next audio frame even if out_bIsBuffering has turned to false.
1561Â /// - \c AK_PlayingIDNotFound if the source data associated with this playing ID is not found, for example if PostEvent() was not called with AK_EnableGetSourceStreamBuffering, or if the header was not parsed.
1612Â /// This function is provided to give the same behavior on platforms that don't have user-music support.
1625Â /// Sends custom game data to a plug-in that resides on a bus (insert Effect or mixer plug-in).
1629Â /// \aknote The plug-in type and ID are passed and matched with plugins set on the desired bus.
1630Â /// This means that you cannot send different data to various instances of a plug-in on the same bus.\endaknote
1650Â /// - \c AK_InvalidParameter if the specified AkGameObjectID is invalid. Range 0xFFFFFFFFFFFFFFE0 (-32) to 0xFFFFFFFFFFFFFFFF (-1) are invalid inclusively.
1651Â /// \remark Registering a game object twice does nothing. Unregistering it once unregisters it no
1664Â /// - \c AK_InvalidParameter if the specified AkGameObjectID is invalid. Range 0xFFFFFFFFFFFFFFE0 (-32) to 0xFFFFFFFFFFFFFFFF (-1) are invalid inclusively.
1665Â /// \remark Registering a game object twice does nothing. Unregistering it once unregisters it no
1679Â /// - \c AK_InvalidParameter if the specified AkGameObjectID is invalid. Range 0xFFFFFFFFFFFFFFE0 (-32) to 0xFFFFFFFFFFFFFFFF (-1) are invalid inclusively.
1680Â /// \remark Registering a game object twice does nothing. Unregistering it once unregisters it no
1683Â /// For example, say a sound associated with this game object is a 3D moving sound. This sound will
1684Â /// stop moving when the game object is unregistered, and there will be no way to regain control over the game object.
1694Â /// Unregister all game objects, or all game objects with a particular matching set of property flags.
1698Â /// \remark Registering a game object twice does nothing. Unregistering it once unregisters it no
1728Â /// Setting multiple positions on a single game object is a way to simulate multiple emission sources while using the resources of only one voice.
1729Â /// This can be used to simulate wall openings, area sounds, or multiple objects emitting the same sound in the same area.
1731Â /// - Calling AK::SoundEngine::SetMultiplePositions() with only one position is the same as calling AK::SoundEngine::SetPosition()
1732Â /// - If a sound has diffraction enabled, it is treated as MultiPositionType_MultiDirections. MultiPositionType_MultiSources is not supported in this case.
1736Â /// - \c AK_CommandTooLarge if the number of positions is too large for the command queue. Reduce the number of positions.
1753Â /// Sets multiple positions to a single game object, with flexible assignment of input channels.
1754Â /// Setting multiple positions on a single game object is a way to simulate multiple emission sources while using the resources of only one voice.
1755Â /// This can be used to simulate wall openings, area sounds, or multiple objects emitting the same sound in the same area.
1756Â /// \aknote Calling AK::SoundEngine::SetMultiplePositions() with only one position is the same as calling AK::SoundEngine::SetPosition() \endaknote
1759Â /// - \c AK_CommandTooLarge if the number of positions is too large for the command queue. Reduce the number of positions.
1774Â /// Modify the attenuation computations on this Game Object to simulate sounds with a larger or smaller area of effect.
1784Â /// Use the position of a separate game object for distance calculations for a specified listener.
1785Â /// When AK::SoundEngine::SetDistanceProbe() is called, Wwise calculates distance attenuation and filtering
1786Â /// based on the distance between the distance probe Game Object (\c in_distanceProbeGameObjectID) and the emitter Game Object's position.
1787Â /// In third-person perspective applications, the distance probe Game Object may be set to the player character's position,
1788Â /// and the listener Game Object's position to that of the camera. In this scenario, attenuation is based on
1789Â /// the distance between the character and the sound, whereas panning, spatialization, and spread and focus calculations are base on the camera.
1790Â /// Both Game Objects, \c in_listenerGameObjectID and \c in_distanceProbeGameObjectID must have been previously registered using AK::SoundEngine::RegisterGameObj.
1791Â /// This funciton is optional. if AK::SoundEngine::SetDistanceProbe() is never called, distance calculations are based on the listener Game Object position.
1792Â /// To clear the distance probe, and revert to using the listener position for distance calculations, pass \c AK_INVALID_GAME_OBJECT to \c in_distanceProbeGameObjectID.
1793Â /// \aknote If the distance probe Game Object is assigned multiple positions, then the first position is used for distance calculations by the listener. \endaknote
1810Â /// It also internally calls ClearPreparedEvents() since at least one bank must have been loaded to allow preparing events.
1813Â /// - \c AK_NotInitialized if the sound engine was not correctly initialized or if there is not enough memory to handle the command
1848Â /// - \c AK_WrongBankVersion: Invalid bank version: make sure the version of Wwise that you used to generate the SoundBanks matches that of the SDK you are currently using.
1854Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure, check the debug console)
1862Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
1863Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
1864Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
1866Â /// - The sound engine internally calls GetIDFromString(in_pszString) to return the correct bank ID.
1867Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
1868Â /// not the name of the file (if you changed it), nor the full path of the file. The path should be resolved in
1869Â /// your implementation of the Stream Manager, or in the Low-Level I/O module if you use the default Stream Manager's implementation.
1904Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
1912Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
1913Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
1914Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
1916Â /// - The sound engine internally calls GetIDFromString(in_pszString) to return the correct bank ID.
1917Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
1918Â /// not the name of the file (if you changed it), nor the full path of the file. The path should be resolved in
1919Â /// your implementation of the Stream Manager, or in the Low-Level I/O module if you use the default Stream Manager's implementation.
1936Â /// \aknote Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings. \endaknote
1945Â /// - \c AK_BankReadError: I/O error. The bank is either shorter than expected or its data corrupted.
1950Â /// - \c AK_InvalidParameter if some parameters are invalid, check the debug console or Wwise Profiler
1954Â /// - \c AK_Fail: Load or unload failed for any other reason. , check the debug console or Wwise Profiler
1962Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
1963Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
1964Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
1979Â /// IMPORTANT: Banks loaded from memory with in-place data MUST be unloaded using the UnloadBank function
1980Â /// providing the same memory pointer. Make sure you are using the correct UnloadBank(...) overload
1984Â /// In-memory loading is in-place: *** the memory must be valid until the bank is unloaded. ***
2001Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2009Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2010Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2011Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2013Â /// - The memory must be aligned on platform-specific AK_BANK_PLATFORM_DATA_ALIGNMENT bytes (see AkTypes.h).
2014Â /// - (XboxOne only): If the bank may contain XMA in memory data, the memory must be allocated using the Device memory allocator.
2015Â /// - Avoid using this function for banks containing a lot of events or structure data: this data will be unpacked into the sound engine heap,
2016Â /// making the supplied bank memory redundant. For event/structure-only banks, prefer LoadBankMemoryCopy().
2031Â /// IMPORTANT: Banks loaded from memory with in-place data MUST be unloaded using the UnloadBank function
2032Â /// providing the same memory pointer. Make sure you are using the correct UnloadBank(...) overload
2036Â /// In-memory loading is in-place: *** the memory must be valid until the bank is unloaded. ***
2052Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2060Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2061Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2062Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2064Â /// - The memory must be aligned on platform-specific AK_BANK_PLATFORM_DATA_ALIGNMENT bytes (see AkTypes.h).
2065Â /// - (XboxOne only): If the bank may contain XMA in memory data, the memory must be allocated using the Device memory allocator.
2066Â /// - Avoid using this function for banks containing a lot of events or structure data: this data will be unpacked into the sound engine heap,
2067Â /// making the supplied bank memory redundant. For event/structure-only banks, prefer LoadBankMemoryCopy().
2083Â /// NOTE: Banks loaded from in-memory with out-of-place data must be unloaded using the standard UnloadBank function
2087Â /// in a buffer and pass its address to the sound engine, the media section of the bank will be copied into newly
2089Â /// In-memory loading is out-of-place: the buffer can be release as soon as the function returns. The advantage of using this
2107Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2115Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2116Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2117Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2133Â /// NOTE: Banks loaded from in-memory with out-of-place data must be unloaded using the standard UnloadBank function
2137Â /// in a buffer and pass its address to the sound engine, the media section of the bank will be copied into newly
2139Â /// In-memory loading is out-of-place: the buffer can be release as soon as the function returns. The advantage of using this
2156Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2164Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2165Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2166Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2181Â /// Synchronously decodes Vorbis-encoded and Opus-encoded (Software version) media in a SoundBank. The file should already be read in memory before the decode operation. The out_pDecodedBankPtr can then be used with variants of LoadBank that load from in-memory data.
2183Â /// CPU usage, RAM size, storage size and Internet bandwidth must be accounted for when developing a game, especially when it is aimed at mobile platforms. The DecodeBank function makes it possible to decode media at load time instead of decoding them every time they are played.
2210Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2211Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2212Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2214Â /// - The sound engine internally calls GetIDFromString(in_pszString) to return the correct bank ID.
2215Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2216Â /// not the name of the file (if you changed it), nor the full path of the file. The path should be resolved in
2217Â /// your implementation of the Stream Manager (AK::IAkStreamMgr::CreateStd()), or in the Low-Level I/O module
2218Â /// (AK::StreamMgr::IAkLowLevelIOHook::BatchOpen()) if you use the default Stream Manager's implementation.
2219Â /// - The cookie (in_pCookie) is passed to the Low-Level I/O module for your convenience, in AK::StreamMgr::IAkLowLevelIOHook::BatchOpen()
2233Â void * in_pCookie, ///AK::StreamMgr::IAkLowLevelIOHook::BatchOpen() as AkFileSystemFlags::pCustomParam)
2257Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2258Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2259Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2261Â /// - The sound engine internally calls GetIDFromString(in_pszString) to return the correct bank ID.
2262Â /// Therefore, \c in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2263Â /// not the name of the file (if you changed it), nor the full path of the file. The path should be resolved in
2264Â /// your implementation of the Stream Manager (AK::IAkStreamMgr::CreateStd()), or in the Low-Level I/O module
2265Â /// (AK::StreamMgr::IAkLowLevelIOHook::BatchOpen()) if you use the default Stream Manager's implementation.
2266Â /// - The cookie (in_pCookie) is passed to the Low-Level I/O module for your convenience, in AK::StreamMgr::IAkLowLevelIOHook::BatchOpen()
2280Â void * in_pCookie, ///AK::StreamMgr::IAkLowLevelIOHook::BatchOpen() as AkFileSystemFlags::pCustomParam)
2286Â /// \aknote Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings. \endaknote
2304Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2305Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2306Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2308Â /// - The file path should be resolved in your implementation of the Stream Manager, or in the Low-Level I/O module if
2309Â /// you use the default Stream Manager's implementation. The ID overload of AK::IAkStreamMgr::CreateStd() and AK::StreamMgr::IAkLowLevelIOHook::BatchOpen() are called.
2310Â /// - The cookie (in_pCookie) is passed to the Low-Level I/O module for your convenience, in AK::StreamMgr::IAkLowLevelIOHook::BatchOpen()
2322Â void * in_pCookie, ///AK::StreamMgr::IAkLowLevelIOHook::BatchOpen() as AkFileSystemFlags::pCustomParam)
2328Â /// IMPORTANT: Banks loaded from memory with in-place data MUST be unloaded using the UnloadBank function
2329Â /// providing the same memory pointer. Make sure you are using the correct UnloadBank(...) overload
2333Â /// In-memory loading is in-place: *** the memory must be valid until the bank is unloaded. ***
2350Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2351Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2352Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2354Â /// - The memory must be aligned on platform-specific AK_BANK_PLATFORM_DATA_ALIGNMENT bytes (see AkTypes.h).
2355Â /// - (XboxOne only): If the bank may contain XMA in memory data, the memory must be allocated using the Device memory allocator.
2356Â /// - Avoid using this function for banks containing a lot of events or structure data: this data will be unpacked into the sound engine heap,
2357Â /// making the supplied bank memory redundant. For event/structure-only banks, prefer LoadBankMemoryCopy().
2375Â /// IMPORTANT: Banks loaded from memory with in-place data MUST be unloaded using the UnloadBank function
2376Â /// providing the same memory pointer. Make sure you are using the correct UnloadBank(...) overload
2380Â /// In-memory loading is in-place: *** the memory must be valid until the bank is unloaded. ***
2396Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2397Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2398Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2400Â /// - The memory must be aligned on platform-specific AK_BANK_PLATFORM_DATA_ALIGNMENT bytes (see AkTypes.h).
2401Â /// - (XboxOne only): If the bank may contain XMA in memory data, the memory must be allocated using the Device memory allocator.
2402Â /// - Avoid using this function for banks containing a lot of events or structure data: this data will be unpacked into the sound engine heap,
2403Â /// making the supplied bank memory redundant. For event/structure-only banks, prefer LoadBankMemoryCopy().
2422Â /// NOTE: Banks loaded from in-memory with out-of-place data must be unloaded using the standard UnloadBank function
2426Â /// in a buffer and pass its address to the sound engine, the media section of the bank will be copied into newly allocated
2428Â /// In-memory loading is out-of-place: the buffer can be released after the callback function is called. The advantage of using this
2446Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2447Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2448Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2467Â /// NOTE: Banks loaded from in-memory with out-of-place data must be unloaded using the standard UnloadBank function
2471Â /// in a buffer and pass its address to the sound engine, the media section of the bank will be copied into newly allocated
2473Â /// In-memory loading is out-of-place: the buffer can be released after the callback function is called. The advantage of using this
2491Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2492Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2493Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2514Â /// \return AK_Success if successful, AK_Fail otherwise. AK_Success is returned when the bank was not loaded.
2516Â /// - The sound engine internally calls GetIDFromString(in_pszString) to retrieve the bank ID,
2518Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2520Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2535Â /// \return AK_Success if successful, AK_Fail otherwise. AK_Success is returned when the bank was not loaded.
2537Â /// - The sound engine internally calls GetIDFromString(in_pszString) to retrieve the bank ID,
2539Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2541Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2554Â /// \return AK_Success if successful, AK_Fail otherwise. AK_Success is returned when the bank was not loaded.
2556Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2571Â /// \return AK_Success if scheduling successful (use a callback to be notified when completed)
2575Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2577Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2595Â /// \return AK_Success if scheduling successful (use a callback to be notified when completed)
2599Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2601Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2618Â /// \return AK_Success if scheduling successful (use a callback to be notified when completed)
2620Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2635Â /// Cancels all Event callbacks associated with a specific callback cookie specified while loading Banks of preparing Events.\n
2656Â };
2660Â /// Use AkBankContent_StructureOnly to load only the structural content, including events, from the bank and then later use the PrepareEvent() functions to load media on demand from loose files on the disk.
2668Â };
2671Â /// This function will load the Events, structural content, and optionally, the media content from the SoundBank. If the flag AkBankContent_All is specified, PrepareBank() will load the media content from
2672Â /// the bank; but, as opposed to LoadBank(), the media will be loaded one media item at a time instead of in one contiguous memory block. Using PrepareBank(), alone or in combination with PrepareEvent(),
2674Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2681Â /// PrepareBank(), when called with the flag AkBankContent_StructureOnly, requires additional calls to PrepareEvent() to load the media for each event. PrepareEvent(), however, is unable to
2682Â /// access media content contained within SoundBanks and requires that the media be available as loose files in the file system. This flag may be useful to implement multiple loading configurations;
2683Â /// for example, a game may have a tool mode that uses PrepareEvent() to load loose files on-demand and, also, a game mode that uses LoadBank() to load the bank in entirety.
2692Â /// This function will load the Events, structural content, and optionally, the media content from the SoundBank. If the flag AkBankContent_All is specified, PrepareBank() will load the media content from
2693Â /// the bank; but, as opposed to LoadBank(), the media will be loaded one media item at a time instead of in one contiguous memory block. Using PrepareBank(), alone or in combination with PrepareEvent(),
2695Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2702Â /// \c PrepareBank(), when called with the flag \c AkBankContent_StructureOnly, requires additional calls to \c PrepareEvent() to load the media for each event. \c PrepareEvent(), however, is unable to
2703Â /// access media content contained within SoundBanks and requires that the media be available as loose files in the file system. This flag may be useful to implement multiple loading configurations;
2704Â /// for example, a game may have a tool mode that uses PrepareEvent() to load loose files on-demand and, also, a game mode that uses \c LoadBank() to load the bank in entirety.
2712Â /// \n\aknote Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings. \endaknote
2713Â /// This function will load the events, structural content, and optionally, the media content from the SoundBank. If the flag AkBankContent_All is specified, PrepareBank() will load the media content from
2714Â /// the bank, but as opposed to LoadBank(), the media will be loaded one media item at a time instead of in one contiguous memory block. Using PrepareBank(), alone or in combination with PrepareEvent(),
2716Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2723Â /// \c PrepareBank(), when called with the flag AkBankContent_StructureOnly, requires additional calls to PrepareEvent() to load the media for each event. PrepareEvent(), however, is unable to
2724Â /// access media content contained within SoundBanks and requires that the media be available as loose files in the file system. This flag may be useful to implement multiple loading configurations;
2725Â /// for example, a game may have a tool mode that uses PrepareEvent() to load loose files on-demand and, also, a game mode that uses LoadBank() to load the bank in entirety.
2734Â /// This function will load the Events, structural content, and optionally, the media content from the SoundBank. If the flag AkBankContent_All is specified, PrepareBank() will load the media content from
2735Â /// the bank, but as opposed to LoadBank(), the media will be loaded one media item at a time instead of in one contiguous memory block. Using PrepareBank(), alone or in combination with PrepareEvent(),
2737Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2744Â /// PrepareBank(), when called with the flag AkBankContent_StructureOnly, requires additional calls to PrepareEvent() to load the media for each event. PrepareEvent(), however, is unable to
2745Â /// access media content contained within SoundBanks and requires that the media be available as loose files in the file system. This flag may be useful to implement multiple loading configurations;
2746Â /// for example, a game may have a tool mode that uses PrepareEvent() to load loose files on-demand and, also, a game mode that uses LoadBank() to load the bank in entirety.
2757Â /// This function will load the events, structural content, and optionally, the media content from the SoundBank. If the flag \c AkBankContent_All is specified, \c PrepareBank() will load the media content from
2758Â /// the bank, but as opposed to \c LoadBank(), the media will be loaded one media item at a time instead of in one contiguous memory block. Using \c PrepareBank(), alone or in combination with PrepareEvent(),
2760Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2767Â /// PrepareBank(), when called with the flag AkBankContent_StructureOnly, requires additional calls to PrepareEvent() to load the media for each event. PrepareEvent(), however, is unable to
2768Â /// access media content contained within SoundBanks and requires that the media be available as loose files in the file system. This flag may be useful to implement multiple loading configurations;
2769Â /// for example, a game may have a tool mode that uses PrepareEvent() to load loose files on-demand and, also, a game mode that uses LoadBank() to load the bank in entirety.
2779Â /// \n\aknote Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings. \endaknote
2780Â /// This function will load the events, structural content, and optionally, the media content from the SoundBank. If the flag AkBankContent_All is specified, \c PrepareBank() will load the media content from
2781Â /// the bank, but as opposed to \c LoadBank(), the media will be loaded one media item at a time instead of in one contiguous memory block. Using \c PrepareBank(), alone or in combination with \c PrepareEvent(),
2783Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2790Â /// \c PrepareBank(), when called with the flag AkBankContent_StructureOnly, requires additional calls to PrepareEvent() to load the media for each event. \c PrepareEvent(), however, is unable to
2791Â /// access media content contained within SoundBanks and requires that the media be available as loose files in the file system. This flag may be useful to implement multiple loading configurations;
2792Â /// for example, a game may have a tool mode that uses \c PrepareEvent() to load loose files on-demand and, also, a game mode that uses \c LoadBank() to load the bank in entirety.
2805Â /// - \c AK_Fail if the sound engine was not correctly initialized or if there is not enough memory to handle the command.
2828Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareEvent() does not exist.
2835Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2867Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareEvent() does not exist.
2874Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2894Â /// The Events are identified by their ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
2906Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareEvent() does not exist.
2913Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2932Â /// The Events are identified by string (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
2941Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
2964Â /// The Events are identified by string (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
2973Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
2995Â /// The Events are identified by their ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3004Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3026Â /// The sources are identified by their ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3027Â /// \return AK_Success if operation was successful, AK_InvalidParameter if in_pSourceSettings is invalid or media sizes are 0.
3033Â /// Removes the specified source from the list of loaded media, even if this media is already in use.
3034Â /// The sources are identified by their ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3037Â /// If the media is still in use, this function will attempt to forcibly kill all sounds and effects referencing this media,
3038Â /// and then return AK_ResourceInUse. The client should NOT presume that the memory can be safely released at this point.
3039Â /// The moment at which the memory can be safely released is unknown, and the only safe course of action is to keep the memory
3043Â /// - \c AK_Success: Operation was successful, and the memory can be released on the client side.
3044Â /// - \c AK_ResourceInUse: Specified media is still in use by the sound engine, the client should not release the memory.
3051Â /// Removes the specified source from the list of loaded media, only if this media is not already in use.
3052Â /// The sources are identified by their ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3053Â /// \aknote Media that is still in use by the sound engine should not be unset. It is marked for removal to prevent additional use.
3054Â /// If this function returns AK_ResourceInUse, then the client must not release memory for this media.
3055Â /// Instead, the client should retry the TryUnsetMedia operation later with the same parameters and check for AK_Success.
3057Â /// If out_pUnsetResults is not null, then it is assumed to point to an array of result codes of the same length as in_pSourceSettings.
3058Â /// out_pUnsetResults will be filled with either AK_Success or AK_ResourceInUse, indicating which media was still in use and not unset.
3060Â /// - \c AK_Success: Operation was successful, and the memory can be released on the client side.
3061Â /// - \c AK_ResourceInUse: Specified media is still in use by the sound engine, and the media was not unset. Do not release memory, and try again later.
3071Â /// The group and game syncs are specified by string (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3080Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareGameSyncs() does not exist.
3087Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
3089Â /// You need to call PrepareGameSyncs() if the sound engine was initialized with AkInitSettings::bEnableGameSyncPreparation
3090Â /// set to true. When set to false, the sound engine automatically prepares all game syncs when preparing events,
3109Â /// The group and game syncs are specified by string (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3118Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareGameSyncs() does not exist.
3125Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
3127Â /// You need to call PrepareGameSyncs() if the sound engine was initialized with AkInitSettings::bEnableGameSyncPreparation
3128Â /// set to true. When set to false, the sound engine automatically prepares all game syncs when preparing events,
3146Â /// The group and game syncs are specified by ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3155Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareGameSyncs() does not exist.
3162Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
3164Â /// You need to call \c PrepareGameSyncs() if the sound engine was initialized with \c AkInitSettings::bEnableGameSyncPreparation
3165Â /// set to \c true. When set to \c false, the sound engine automatically prepares all game syncs when preparing Events,
3184Â /// The group and game syncs are specified by string (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3190Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3193Â /// You need to call \c PrepareGameSyncs() if the sound engine was initialized with \c AkInitSettings::bEnableGameSyncPreparation
3194Â /// set to \c true. When set to \c false, the sound engine automatically prepares all game syncs when preparing Events,
3216Â /// The group and game syncs are specified by string (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3222Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3225Â /// You need to call PrepareGameSyncs() if the sound engine was initialized with AkInitSettings::bEnableGameSyncPreparation
3226Â /// set to true. When set to false, the sound engine automatically prepares all game syncs when preparing events,
3247Â /// The group and game syncs are specified by ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3253Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3256Â /// You need to call PrepareGameSyncs() if the sound engine was initialized with AkInitSettings::bEnableGameSyncPreparation
3257Â /// set to true. When set to false, the sound engine automatically prepares all Game Syncs when preparing Events,
3285Â /// All listeners that have previously been added via AddListener or set via SetListeners will be removed and replaced with the listeners in the array in_pListenerGameObjs.
3286Â /// Calling this function will override the default set of listeners and in_emitterGameObj will now reference its own, unique set of listeners.
3289Â /// - \c AK_CommandTooLarge if the number of positions is too large for the command queue. Reduce the number of positions.
3302Â /// Any listeners that have previously been added or set via AddListener or SetListeners will remain as listeners and in_listenerGameObj will be added as an additional listener.
3303Â /// Calling this function will override the default set of listeners and in_emitterGameObj will now reference its own, unique set of listeners.
3315Â /// Calling this function will override the default set of listeners and in_emitterGameObj will now reference its own, unique set of listeners.
3326Â /// Sets the default set of associated listeners for game objects that have not explicitly overridden their listener sets. Upon registration, all game objects reference the default listener set, until
3327Â /// a call to AddListener, RemoveListener, SetListeners or SetGameObjectOutputBusVolume is made on that game object.
3328Â /// All default listeners that have previously been added via AddDefaultListener or set via SetDefaultListeners will be removed and replaced with the listeners in the array in_pListenerGameObjs.
3337Â /// Add a single listener to the default set of listeners. Upon registration, all game objects reference the default listener set, until
3338Â /// a call to AddListener, RemoveListener, SetListeners or SetGameObjectOutputBusVolume is made on that game object.
3347Â /// Remove a single listener from the default set of listeners. Upon registration, all game objects reference the default listener set, until
3348Â /// a call to AddListener, RemoveListener, SetListeners or SetGameObjectOutputBusVolume is made on that game object.
3357Â /// Resets the listener associations to the default listener(s), as set by SetDefaultListeners. This will also reset per-listener gains that have been set using SetGameObjectOutputBusVolume.
3370Â /// If \c in_bSpatialized is false, only \c in_pVolumeOffsets is used for this listener (3D positions
3371Â /// have no effect on the speaker distribution). Otherwise, \c in_pVolumeOffsets is added to the speaker
3373Â /// Use helper functions of \c AK::SpeakerVolumes to manipulate the vector of volume offsets in_pVolumeOffsets.
3376Â /// - If a sound is mixed into a bus that has a different speaker configuration than in_channelConfig,
3400Â /// With this function, you may set a game parameter value with global scope or with game object scope.
3401Â /// Game object scope supersedes global scope. (Once a value is set for the game object scope, it will not be affected by changes to the global scope value.) Game parameter values set with a global scope are applied to all
3402Â /// game objects that not yet registered, or already registered but not overridden with a value with game object scope.
3403Â /// To set a game parameter value with global scope, pass \c AK_INVALID_GAME_OBJECT as the game object.
3404Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3405Â /// value for \c in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3406Â /// according to the interpolation curve. If you call \c SetRTPCValue() with in_uValueChangeDuration = 0 in the
3407Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3408Â /// function at every game frame, you should not use \c in_uValueChangeDuration, as it would have no effect and it is less efficient.
3429Â /// With this function, you may set a game parameter value to global scope or to game object scope.
3430Â /// Game object scope supersedes global scope. (Once a value is set for the game object scope, it will not be affected by changes to the global scope value.) Game parameter values set with global scope are applied to all
3431Â /// game objects that not yet registered, or already registered but not overridden with a value with game object scope.
3432Â /// To set a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3433Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3434Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3435Â /// according to the interpolation curve. If you call SetRTPCValue() with in_uValueChangeDuration = 0 in the
3436Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3437Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3458Â /// With this function, you may set a game parameter value with global scope or with game object scope.
3459Â /// Game object scope supersedes global scope. (Once a value is set for the game object scope, it will not be affected by changes to the global scope value.) Game parameter values set with global scope are applied to all
3460Â /// game objects that not yet registered, or already registered but not overridden with a value with game object scope.
3461Â /// To set a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3462Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3463Â /// value for \c in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3464Â /// according to the interpolation curve. If you call SetRTPCValue() with in_uValueChangeDuration = 0 in the
3465Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3466Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3488Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3489Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3490Â /// according to the interpolation curve. If you call SetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3491Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3492Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3515Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3516Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3517Â /// according to the interpolation curve. If you call SetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3518Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3519Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3542Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3543Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3544Â /// according to the interpolation curve. If you call SetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3545Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3546Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3565Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3566Â /// With this function, you may reset a game parameter to its default value with global scope or with game object scope.
3567Â /// Game object scope supersedes global scope. Game parameter values reset with global scope are applied to all
3569Â /// To reset a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3570Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3571Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3572Â /// according to the interpolation curve. If you call SetRTPCValue() or ResetRTPCValue() with in_uValueChangeDuration = 0 in the
3592Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3593Â /// With this function, you may reset a game parameter to its default value with global scope or with game object scope.
3594Â /// Game object scope supersedes global scope. Game parameter values reset with global scope are applied to all
3596Â /// To reset a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3597Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3598Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3599Â /// according to the interpolation curve. If you call SetRTPCValue() or ResetRTPCValue() with in_uValueChangeDuration = 0 in the
3619Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3620Â /// With this function, you may reset a game parameter to its default value with global scope or with game object scope.
3621Â /// Game object scope supersedes global scope. Game parameter values reset with global scope are applied to all
3623Â /// To reset a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3624Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3625Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3626Â /// according to the interpolation curve. If you call SetRTPCValue() or ResetRTPCValue() with in_uValueChangeDuration = 0 in the
3645Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3646Â /// With this function, you may reset a game parameter to its default value on playing id scope.
3648Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3649Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3651Â /// If you call SetRTPCValueByPlayingID() or ReetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3670Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3671Â /// With this function, you may reset a game parameter to its default value on playing id scope.
3673Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3674Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3676Â /// If you call SetRTPCValueByPlayingID() or ReetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3682Â /// - \c AK_InvalidID if in_playingID is AK_INVALID_PLAYING_ID (0) or if if in_pszParamName is NULL.
3697Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3698Â /// With this function, you may reset a game parameter to its default value on playing id scope.
3700Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3701Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3703Â /// If you call SetRTPCValueByPlayingID() or ReetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3709Â /// - \c AK_InvalidID if in_playingID is AK_INVALID_PLAYING_ID (0) or if if in_pszParamName is NULL.
3867Â /// Registers a callback to allow the game to modify or override the volume to be applied at the output of an audio bus.
3871Â /// \aknote The callback function will not be called for the Master Audio Bus, since the output of this bus is not a bus, but is instead an Audio Device.\endaknote
3889Â /// Registers a callback to be called to allow the game to access metering data from any mixing bus. You may use this to monitor loudness at any point of the mixing hierarchy
3890Â /// by accessing the peak, RMS, True Peak and K-weighted power (according to loudness standard ITU BS.1770). See \ref goingfurther_speakermatrixcallback for an example.
3910Â /// Registers a callback to be called to allow the game to access metering data from any output device. You may use this to monitor loudness as sound leaves the Wwise sound engine
3911Â /// by accessing the peak, RMS, True Peak and K-weighted power (according to loudness standard ITU BS.1770). See \ref goingfurther_speakermatrixcallback for an example.
3932Â /// Output Bus Volumes are stored per listener association, so calling this function will override the default set of listeners. The game object in_emitterObjID will now reference its own set of listeners which will
3933Â /// be the same as the old set of listeners, but with the new associated gain. Future changes to the default listener set will not be picked up by this game object unless ResetListenersToDefault() is called.
3955Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's effect will
3971Â /// \aknote This function has unspecified behavior when adding an Effect to a currently playing
3972Â /// Bus which does not have any Effects, or removing the last Effect on a currently playing bus.
3974Â /// \aknote This function will replace existing Effects on the node. If the target node is not at
3975Â /// the top of the hierarchy and is in the actor-mixer hierarchy, the option "Override Parent" in
3976Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's Effect will
3996Â /// \aknote This function has unspecified behavior when adding an Effect to a currently playing
3997Â /// bus which does not have any Effects, or removing the last Effect on a currently playing Bus.
3999Â /// \aknote This function will replace existing Effects on the node. If the target node is not at
4000Â /// the top of the hierarchy and is in the Actor-Mixer Hierarchy, the option "Override Parent" in
4001Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's Effect will
4022Â /// \aknote This function has unspecified behavior when adding an Effect to a currently playing
4023Â /// Bus which does not have any effects, or removing the last Effect on a currently playing bus.
4025Â /// \aknote Make sure the new effect shareset is included in a soundbank, and that sound bank is loaded. Otherwise you will see errors in the Capture Log.\endaknote
4026Â /// \aknote This function will replace existing Effects on the node. If the target node is not at
4027Â /// the top of the hierarchy and is in the Actor-Mixer Hierarchy, the option "Override Parent" in
4028Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's Effect will
4042Â /// Sets an audio device effect shareset on the specified output device and effect slot index.
4046Â /// \aknote Make sure the new effect shareset is included in a soundbank, and that sound bank is loaded. Otherwise you will see errors in the Capture Log.\endaknote
4047Â /// \aknote This function will replace existing effects of the audio device shareset. \endaknote
4048Â /// \aknote Audio device effects support is limited to one shareset per plug-in type at any time. \endaknote
4049Â /// \aknote Errors are reported in the Wwise Capture Log if the effect cannot be set on the output device. \endaknote
4060Â /// Bus which does not have any Effects or mixer, or removing the last mixer on a currently playing Bus.
4062Â /// \aknote Make sure the new mixer shareset is included in a soundbank, and that sound bank is loaded. Otherwise you will see errors in the Capture Log.\endaknote
4074Â /// bus which does not have any effects nor mixer, or removing the last mixer on a currently playing bus.
4076Â /// \aknote Make sure the new mixer shareset is included in a soundbank, and that sound bank is loaded. Otherwise you will see errors in the Capture Log.\endaknote
4090Â /// bus which does not have any effects nor mixer, or removing the last mixer on a currently playing bus.
4092Â /// \aknote Make sure the new mixer shareset is included in a soundbank, and that sound bank is loaded. Otherwise you will see errors in the Capture Log.\endaknote
4136Â /// Sets a game object's obstruction and occlusion levels. If SetMultiplePositions were used, values are set for all positions.
4137Â /// To assign a unique obstruction and occlusion value to each sound position, instead use AK::SoundEngine::SetMultipleObstructionAndOcclusion.
4150Â /// Sets a game object's obstruction and occlusion value for each position defined by AK::SoundEngine::SetMultiplePositions.
4151Â /// This function differs from AK::SoundEngine::SetObjectObstructionAndOcclusion as a list of obstruction/occlusion pair is provided
4152Â /// and each obstruction/occlusion pair will affect the corresponding position defined at the same index.
4153Â /// \aknote In the case the number of obstruction/occlusion pairs is smaller than the number of positions, remaining positions'
4157Â /// - \c AK_CommandTooLarge if the number of obstruction values is too large for the command queue.
4158Â /// - \c AK_InvalidParameter if one of the parameter is out of range (check the debug console)
4163Â /// \return AK_Success if occlusion/obstruction values are successfully stored for this emitter
4174Â /// This function will write history data for all currently loaded containers and instantiated game
4175Â /// objects (for example, current position in Sequence Containers and previously played elements in
4178Â /// This function acquires the main audio lock, and may block the caller for several milliseconds.
4189Â /// This function will read history data from the passed-in stream reader interface, and apply it to all
4193Â /// This function acquires the main audio lock, and may block the caller for several milliseconds.
4211Â /// If more than one device is active, the system will create multiple files in the same output
4214Â /// If no device is running yet, the system will return success AK_Success despite doing nothing.
4215Â /// Use RegisterAudioDeviceStatusCallback to get notified when devices are created/destructed.
4217Â /// \return AK_Success if successful, AK_Fail if there was a problem starting the output capture.
4219Â /// - The sound engine opens a stream for writing using AK::IAkStreamMgr::CreateStd(). If you are using the
4220Â /// default implementation of the Stream Manager, file opening is executed in your implementation of
4222Â /// AkFileSystemFlags are passed: uCompanyID = AKCOMPANYID_AUDIOKINETIC and uCodecID = AKCODECID_PCM,
4223Â /// and the AkOpenMode is AK_OpenModeWriteOvrwr. Refer to \ref streamingmanager_lowlevel_location for
4240Â /// \return AK_Success if successful, AK_Fail if there was a problem stopping the output capture.
4273Â /// The callback will be called from the audio thread during real-time rendering and from the main thread during offline rendering.
4305Â /// Starts recording the sound engine profiling information into a file. This file can be read
4306Â /// by Wwise Authoring. The file is created at the base path. If you have integrated Wwise I/O,
4307Â /// you can use CAkDefaultIOHookDeferred::SetBasePath() (or CAkDefaultIOHookDeferred::AddBasePath())
4308Â /// to change the location where the file is saved. The profiling session records all data types possible.
4329Â /// When offline rendering is enabled, every call to \ref RenderAudio() will generate sample data as if this much time has elapsed. If the frame time argument is less than or equal to zero, every call to RenderAudio() will generate one audio buffer.
4347Â /// Adds an output to the sound engine. Use this to add controller-attached headphones, controller speakers, DVR output, etc.
4348Â /// The in_Settings parameter contains an Audio Device shareset to specify the output plugin to use and a device ID to specify the instance, if necessary (e.g. which game controller).
4350Â /// Like most functions of AK::SoundEngine, AddOutput is asynchronous. A successful return code merely indicates that the request is properly queued.
4351Â /// Error codes returned by this function indicate various invalid parameters. To know if this function succeeds or not, and the failure code,
4360Â /// The following codes are returned directly from the function, as opposed to the AkDeviceStatusCallback
4362Â /// - \c AK_InvalidParameter: Out of range parameters or unsupported parameter combinations (see parameter list below).
4363Â /// - \c AK_IDNotFound: The audioDeviceShareset on in_settings doesn't exist. Possibly, the Init bank isn't loaded yet or was not updated with latest changes.
4364Â /// - \c AK_DeviceNotReady: The idDevice on in_settings doesn't match with a valid hardware device. Either the device doesn't exist or is disabled. Disconnected devices (headphones) are not considered "not ready" therefore won't cause this error.
4365Â /// - \c AK_NotInitialized: If AK::SoundEngine::Init was not called or if the Init.bnk was not loaded before the call.
4370Â /// - \c AK_IDNotFound: The audioDeviceShareset on in_settings doesn't exist. Possibly, the Init bank isn't loaded yet or was not updated with latest changes.
4371Â /// - \c AK_PluginNotRegistered: The audioDeviceShareset exists but the plug-in it refers to is not installed or statically linked with the game.
4372Â /// - \c AK_NotCompatible: The hardware does not support this type of output. Wwise will try to use the System output instead, and a separate callback will fire when that completes.
4373Â /// - \c AK_DeviceNotCompatible: The hardware does not support this type of output. Wwise will NOT fallback to any other type of output.
4374Â /// - \c AK_Fail: Generic code for any non-permanent conditions (e.g. disconnection) that prevent the use of the output. Wwise has created the output and sounds will be routed to it, but this output is currently silent until the temporary condition resolves.
4375Â /// - \c AK_NoDistinctListener: Outputs of the same type (same ShareSet, like controller speakers) must have distinct Listeners to make a proper routing. This doesn't happen if there is only one output of that type.
4387Â /// If a listener was associated with the device, you should consider unregistering the listener prior to call RemoveOutput
4396Â /// Replaces an output device previously created during engine initialization or from AddOutput, with a new output device.
4397Â /// In addition to simply removing one output device and adding a new one, the new output device will also be used on all of the master buses
4398Â /// that the old output device was associated with, and preserve all listeners that were attached to the old output device.
4400Â /// Like most functions of AK::SoundEngine, AddOutput is asynchronous. A successful return code merely indicates that the request is properly queued.
4401Â /// Error codes returned by this function indicate various invalid parameters. To know if this function succeeds or not, and the failure code,
4409Â /// - \c AK_IDNotFound: The audioDeviceShareset on in_settings doesn't exist. Possibly, the Init bank isn't loaded yet or was not updated with latest changes.
4410Â /// - \c AK_DeviceNotReady: The idDevice on in_settings doesn't match with a valid hardware device. Either the device doesn't exist or is disabled. Disconnected devices (headphones) are not considered "not ready" therefore won't cause this error.
4411Â /// - \c AK_DeviceNotFound: The in_outputDeviceId provided does not match with any of the output devices that the sound engine is currently using.
4412Â /// - \c AK_InvalidParameter: Out of range parameters or unsupported parameter combinations on in_settings
4421Â /// Outputs are defined by their type (Audio Device shareset) and their specific system ID. A system ID could be reused for other device types on some OS or platforms, hence the compounded ID.
4422Â /// Use 0 for in_idShareset & in_idDevice to get the Main Output ID (the one usually initialized during AK::SoundEngine::Init)
4444Â /// Sets the Audio Device to which a master bus outputs. This overrides the setting in the Wwise project.
4445Â /// Can only be set on top-level busses. The Init bank should be successfully loaded prior to this call.
4446Â /// \aknote This function is useful only if used before the creation of an output, at the beginning of the sound engine setup.
4447Â /// Once active outputs using this Bus have been created, it is imperative to use AK::SoundEngine:ReplaceOutput instead to change the type of output.
4449Â /// AK_IDNotFound when either the Bus ID or the Device ID are not present in the Init bank or the bank was not loaded
4450Â /// AK_InvalidParameter when the specified bus is not a Master Bus. This function can be called only on busses that have no parent bus.
4456Â /// Sets the Audio Device to which a master bus outputs. This overrides the setting in the Wwise project.
4457Â /// Can only be set on top-level busses. The Init bank should be successfully loaded prior to this call.
4458Â /// \aknote This function is useful only if used before the creation of an output, at the beginning of the sound engine setup.
4459Â /// Once active outputs using this Bus have been created, it is imperative to use AK::SoundEngine:ReplaceOutput instead to change the type of output.
4461Â /// AK_IDNotFound when either the Bus ID or the Device ID are not present in the Init bank or the bank was not loaded
4462Â /// AK_InvalidParameter when the specified bus is not a Master Bus. This function can be called only on busses that have no parent bus.
4469Â /// Sets the Audio Device to which a master bus outputs. This overrides the setting in the Wwise project.
4470Â /// Can only be set on top-level busses. The Init bank should be successfully loaded prior to this call.
4471Â /// SetBusDevice must be preceded by a call to AddOutput for the new device shareset to be registered as an output.
4473Â /// AK_IDNotFound when either the Bus ID or the Device ID are not present in the Init bank or the bank was not loaded
4474Â /// AK_InvalidParameter when the specified bus is not a Master Bus. This function can be called only on busses that have no parent bus.
4481Â /// Returns a listing of the current devices for a given sink plug-in, including Device ID, friendly name, and state.
4485Â /// * The plug-in must have been initialized by loading the init bank or by calling \ref AK::SoundEngine::RegisterPlugin.
4488Â /// The built-in audio devices (System, Communication, Headphones, Personal, Pad Speaker) all support enumeration, on all platforms.
4489Â /// The only Wwise plug-in that support device enumeration is Motion, for the Windows platform only.
4493Â /// - \c AK_PluginNotRegistered if the plug-in has not been registered yet either by loading the init bank or by calling RegisterPluginDLL.
4504Â /// Returns a listing of the current devices for a given sink plug-in, including Device ID, friendly name, and state.
4508Â /// * The plug-in must have been initialized by loading the init bank or by calling \ref AK::SoundEngine::RegisterPlugin.
4509Â /// * The audio device shareset must have been loaded from a soundbank, and a physical device recognized by this plug-in must exist in the system.
4511Â /// The built-in audio devices (System, Communication, Headphones, Personal, Pad Speaker) all support enumeration, on all platforms.
4512Â /// The only Wwise plug-in that support device enumeration is Motion, for the Windows platform only.
4516Â /// AK_PluginNotRegistered if the plug-in has not been registered yet either by loading the init bank or by calling RegisterPluginDLL.
4532Â /// Returns whether or not the audio device matching the device ID provided supports spatial audio (i.e. the functionality is enabled, and more than 0 dynamic objects are supported).
4533Â /// If Spatial Audio is supported, then you can call Init, AddOutput, or ReplaceOutput with an Audio Device Shareset corresponding to the respective platform-specific plug-in that
4534Â /// provides spatial audio, such as the Microsoft Spatial Sound Platform for Windows. Note that on Xbox One, you need to call EnableSpatialAudio() before the sound engine is
4535Â /// initialized, or initialize the sound engine with AkPlatformInitSettings::bEnableSpatialAudio set to true if you want spatial audio support; otherwise this will always return AK_NotCompatible.
4537Â /// AK_NotCompatible when the device ID provided does not support spatial audio, or the platform does not support spatial audio
4538Â /// AK_Fail when there is some other miscellaneous failure, or the device ID provided does not match a device that the system knows about
4548Â /// This function should be called to put the sound engine in background mode, where audio isn't processed anymore. This needs to be called if the console has a background mode or some suspended state.
4549Â /// Call \c WakeupFromSuspend when your application receives the message from the OS that the process is back in foreground.
4550Â /// When suspended, the sound engine will process API messages (like PostEvent and SetSwitch) only when \ref RenderAudio() is called.
4551Â /// It is recommended to match the in_bRenderAnyway parameter with the behavior of the rest of your game:
4552Â /// if your game still runs in background and you must keep some kind of coherent state between the audio engine and game, then allow rendering.
4553Â /// If you want to minimize CPU when in background, then don't allow rendering and never call RenderAudio from the game.
4555Â /// Consult \ref workingwithsdks_system_calls to learn when it is appropriate to call this function for each platform.
4563Â /// This function should be called to wake up the sound engine and start processing audio again. This needs to be called if the console has a background mode or some suspended state.
4565Â /// Consult \ref workingwithsdks_system_calls to learn when it is appropriate to call this function for each platform.
4569Â AkUInt32 in_uDelayMs = 0 /// Delay (in milliseconds) before the wake up occurs. Rounded up to audio frame granularity. Adding a delay is useful if there is a possibility that another OS event may override the wake-up in the near future.
4572Â /// Obtains the current audio output buffer tick. This corresponds to the number of buffers produced by
AKSOUNDENGINE_API AKRESULT RegisterPluginDLL(const AkOSChar *in_DllName, const AkOSChar *in_DllPath=NULL)
AkUInt32 uMonitorQueuePoolSize
Size of the monitoring queue, in bytes. This parameter is not used in Release build.
Definition: AkSoundEngine.h:237
AKSOUNDENGINE_API AKRESULT RemoveDefaultListener(AkGameObjectID in_listenerGameObj)
AKSOUNDENGINE_API AKRESULT PrepareEvent(PreparationType in_PreparationType, const char **in_ppszString, AkUInt32 in_uNumEvent)
AKSOUNDENGINE_API AkUInt32 GetSampleRate()
void(* AkProfilerPostMarkerFunc)(AkPluginID in_uPluginID, const char *in_pszMarkerName)
Definition: AkSoundEngine.h:215
AKSOUNDENGINE_API AKRESULT SetRTPCValue(AkRtpcID in_rtpcID, AkRtpcValue in_value, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
AKSOUNDENGINE_API AKRESULT SetOutputDeviceEffect(AkOutputDeviceID in_outputDeviceID, AkUInt32 in_uFXIndex, AkUniqueID in_FXShareSetID)
AKSOUNDENGINE_API AKRESULT SetSpeakerAngles(const AkReal32 *in_pfSpeakerAngles, AkUInt32 in_uNumAngles, AkReal32 in_fHeightAngle, AkOutputDeviceID in_idOutput=0)
AkBackgroundMusicChangeCallbackFunc BGMCallback
Application-defined audio source change event callback function.
Definition: AkSoundEngine.h:248
Auxiliary bus sends information per game object per given auxiliary bus.
Definition: AkTypes.h:876
Definition: AkCommonDefs.h:431
AKSOUNDENGINE_API void ExecuteActionOnPlayingID(AkActionOnEventType in_ActionType, AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
AKSOUNDENGINE_API AKRESULT LoadBankMemoryView(const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankID &out_bankID)
AKSOUNDENGINE_API AKRESULT PrepareGameSyncs(PreparationType in_PreparationType, AkGroupType in_eGameSyncType, const char *in_pszGroupName, const char **in_ppszGameSyncName, AkUInt32 in_uNumGameSyncs)
AKSOUNDENGINE_API AKRESULT GetSourcePlayPositions(AkPlayingID in_PlayingID, AkSourcePosition *out_puPositions, AkUInt32 *io_pcPositions, bool in_bExtrapolate=true)
AKSOUNDENGINE_API AKRESULT Init(AkInitSettings *in_pSettings, AkPlatformInitSettings *in_pPlatformSettings)
AKSOUNDENGINE_API AKRESULT SetSwitch(AkSwitchGroupID in_switchGroup, AkSwitchStateID in_switchState, AkGameObjectID in_gameObjectID)
AKSOUNDENGINE_API bool IsPluginRegistered(AkPluginType in_eType, AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID)
void(* AkResourceMonitorCallbackFunc)(const AkResourceMonitorDataSummary *in_pdataSummary)
Definition: AkCallback.h:376
void(* AkJobWorkerFunc)(AkJobType in_jobType, AkUInt32 in_uExecutionTimeUsec)
Definition: AkSoundEngine.h:175
AKSOUNDENGINE_API AKRESULT StopMIDIOnEvent(AkUniqueID in_eventID=AK_INVALID_UNIQUE_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID)
AKSOUNDENGINE_API AKRESULT GetSourceStreamBuffering(AkPlayingID in_PlayingID, AkTimeMs &out_buffering, bool &out_bIsBuffering)
@ AkBankContent_StructureOnly
Use AkBankContent_StructureOnly to load only the structural content, including Events,...
Definition: AkSoundEngine.h:2666
IAkSoftwareCodec *(* AkCreateFileSourceCallback)(void *in_pCtx)
Registered file source creation function prototype.
Definition: AkTypes.h:1055
AKSOUNDENGINE_API AKRESULT StartOutputCapture(const AkOSChar *in_CaptureFileName)
AkProfilerPopTimerFunc fnProfilerPopTimer
External (optional) function for tracking performance of the sound engine that is called when a timer...
Definition: AkSoundEngine.h:268
AKSOUNDENGINE_API AKRESULT SetMaxNumVoicesLimit(AkUInt16 in_maxNumberVoices)
AKSOUNDENGINE_API AKRESULT RegisterOutputDeviceMeteringCallback(AkOutputDeviceID in_idOutput, AkOutputDeviceMeteringCallbackFunc in_pfnCallback, AkMeteringFlags in_eMeteringFlags, void *in_pCookie=NULL)
AkUInt32 uNumSamplesPerFrame
Number of samples per audio frame (256, 512, 1024, or 2048).
Definition: AkSoundEngine.h:235
Definition: AkAndroidSoundEngine.h:55
AKSOUNDENGINE_API AKRESULT SetDefaultListeners(const AkGameObjectID *in_pListenerObjs, AkUInt32 in_uNumListeners)
AKSOUNDENGINE_API AKRESULT RegisterBusVolumeCallback(AkUniqueID in_busID, AkBusCallbackFunc in_pfnCallback, void *in_pCookie=NULL)
AKSOUNDENGINE_API AKRESULT UnregisterAllGameObj()
AKSOUNDENGINE_API AKRESULT ResetRTPCValue(AkRtpcID in_rtpcID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
@ AkFloorPlane_XY
The floor is oriented along the XY-plane. The front vector points towards +X, the up vector towards +...
Definition: AkSoundEngine.h:164
AkReal32 fDebugOutOfRangeLimit
Debug setting: Only used when bDebugOutOfRangeCheckEnabled is true. This defines the maximum values s...
Definition: AkSoundEngine.h:263
Definition: AkSpeakerConfig.h:497
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)
AKSOUNDENGINE_API void CancelEventCallbackCookie(void *in_pCookie)
AkUInt32 updateBufferTick
Value of GetBufferTick() at the time the position was updated.
Definition: AkSoundEngine.h:287
AKRESULT(* AkGetDeviceListCallback)(AkUInt32 &io_maxNumDevices, AkDeviceDescription *out_deviceDescriptions)
Registered plugin device enumeration function prototype, used for providing lists of devices by plug-...
Definition: IAkPlugin.h:1309
AKSOUNDENGINE_API AKRESULT RegisterGameObj(AkGameObjectID in_gameObjectID)
void(* AkGlobalCallbackFunc)(AK::IAkGlobalPluginContext *in_pContext, AkGlobalCallbackLocation in_eLocation, void *in_pCookie)
Definition: AkCallback.h:369
@ Preparation_LoadAndDecode
Vorbis media is decoded when loading, and an uncompressed PCM version is used for playback.
Definition: AkSoundEngine.h:2655
AkMeteringFlags
Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback(...
Definition: AkTypes.h:1164
AKSOUNDENGINE_API AKRESULT GetContainerHistory(AK::IWriteBytes *in_pBytes)
AKSOUNDENGINE_API AKRESULT LoadBank(const char *in_pszString, AkBankID &out_bankID, AkBankType in_bankType=AkBankType_User)
AKSOUNDENGINE_API AKRESULT SetState(AkStateGroupID in_stateGroup, AkStateID in_state)
Platform-independent initialization settings of output devices.
Definition: AkSoundEngine.h:127
AKSOUNDENGINE_API bool IsInitialized()
@ Preparation_Unload
PrepareEvent() will unload required information to play the specified event.
Definition: AkSoundEngine.h:2654
@ AkBankContent_All
Use AkBankContent_All to load both the media and structural content.
Definition: AkSoundEngine.h:2667
void(* AkBusMeteringCallbackFunc)(AkBusMeteringCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:287
AKSOUNDENGINE_API AKRESULT SetOfflineRenderingFrameTime(AkReal32 in_fFrameTimeInSeconds)
AKSOUNDENGINE_API AKRESULT ClearBanks()
AKSOUNDENGINE_API AKRESULT UnregisterAudioDeviceStatusCallback()
Unregisters the callback for the Audio Device status changes, registered by RegisterAudioDeviceStatus...
Definition: IBytes.h:43
AKSOUNDENGINE_API AKRESULT WakeupFromSuspend(AkUInt32 in_uDelayMs=0)
AKSOUNDENGINE_API AKRESULT SetMultipleObstructionAndOcclusion(AkGameObjectID in_EmitterID, AkGameObjectID in_uListenerID, AkObstructionOcclusionValues *in_fObstructionOcclusionValues, AkUInt32 in_uNumOcclusionObstruction)
AkUInt32 samplePosition
Position of the source (in samples) associated with that playing item.
Definition: AkSoundEngine.h:286
AKSOUNDENGINE_API AKRESULT SetOutputVolume(AkOutputDeviceID in_idOutput, AkReal32 in_fVolume)
AKSOUNDENGINE_API AKRESULT GetPanningRule(AkPanningRule &out_ePanningRule, AkOutputDeviceID in_idOutput=0)
void(* AkOutputDeviceMeteringCallbackFunc)(AkOutputDeviceMeteringCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:297
AKSOUNDENGINE_API AKRESULT ResetRTPCValueByPlayingID(AkRtpcID in_rtpcID, AkPlayingID in_playingID, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
AKSOUNDENGINE_API AKRESULT SetBankLoadIOSettings(AkReal32 in_fThroughput, AkPriority in_priority)
AKSOUNDENGINE_API AKRESULT AddOutputCaptureMarker(const char *in_MarkerText)
AKSOUNDENGINE_API AKRESULT RegisterAudioDeviceStatusCallback(AK::AkDeviceStatusCallbackFunc in_pCallback)
AKSOUNDENGINE_API AKRESULT PostTrigger(AkTriggerID in_triggerID, AkGameObjectID in_gameObjectID)
AKSOUNDENGINE_API AKRESULT PinEventInStreamCache(AkUniqueID in_eventID, AkPriority in_uActivePriority, AkPriority in_uInactivePriority)
AKSOUNDENGINE_API void CancelEventCallbackGameObject(AkGameObjectID in_gameObjectID)
Position and orientation of game objects in the world (i.e. supports 64-bit-precision position)
Definition: AkTypes.h:422
AKSOUNDENGINE_API AKRESULT ReplaceOutput(const AkOutputSettings &in_Settings, AkOutputDeviceID in_outputDeviceId, AkOutputDeviceID *out_pOutputDeviceId=NULL)
AKSOUNDENGINE_API void GetDefaultInitSettings(AkInitSettings &out_settings)
AKSOUNDENGINE_API AKRESULT RegisterPlugin(AkPluginType in_eType, AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkCreatePluginCallback in_pCreateFunc, AkCreateParamCallback in_pCreateParamFunc, AkGetDeviceListCallback in_pGetDeviceList=NULL)
FuncRequestJobWorker fnRequestJobWorker
Function called by the job manager when a new worker needs to be requested. When null,...
Definition: AkSoundEngine.h:191
AKSOUNDENGINE_API AKRESULT SetActorMixerEffect(AkUniqueID in_audioNodeID, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
AkSetPositionFlags
Flags to independently set the position of the emitter or listener component on a game object.
Definition: AkTypes.h:1129
AKSOUNDENGINE_API AKRESULT RegisterCodec(AkUInt32 in_ulCompanyID, AkUInt32 in_ulCodecID, AkCreateFileSourceCallback in_pFileCreateFunc, AkCreateBankSourceCallback in_pBankCreateFunc)
@ MultiPositionType_MultiDirections
Simulate one sound coming from multiple directions. Useful for repositionning sounds based on wall op...
Definition: AkTypes.h:1104
bool bUseLEngineThread
Use a separate thread for processing audio. If set to false, audio processing will occur in RenderAud...
Definition: AkSoundEngine.h:246
AKSOUNDENGINE_API AKRESULT StopProfilerCapture()
AKSOUNDENGINE_API AKRESULT SetObjectObstructionAndOcclusion(AkGameObjectID in_EmitterID, AkGameObjectID in_ListenerID, AkReal32 in_fObstructionLevel, AkReal32 in_fOcclusionLevel)
AKSOUNDENGINE_API AkOutputDeviceID GetOutputID(AkUniqueID in_idShareset, AkUInt32 in_idDevice)
AkOutputSettings(const char *in_szDeviceShareSet, AkUniqueID in_idDevice=AK_INVALID_UNIQUE_ID, AkChannelConfig in_channelConfig=AkChannelConfig(), AkPanningRule in_ePanning=AkPanningRule_Speakers)
AkUInt32 uMaxActiveWorkers[AK_NUM_JOB_TYPES]
The maximum number of concurrent workers that will be requested. Must be >= 1 for each jobType.
Definition: AkSoundEngine.h:193
AkReal32 * VectorPtr
Volume vector. Access each element with the standard bracket [] operator.
Definition: AkSpeakerVolumes.h:49
AKSOUNDENGINE_API AKRESULT DecodeBank(const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkMemPoolId in_uPoolForDecodedBank, void *&out_pDecodedBankPtr, AkUInt32 &out_uDecodedBankSize)
Definition: AkTypes.h:258
AKSOUNDENGINE_API AKRESULT StartProfilerCapture(const AkOSChar *in_CaptureFileName)
void(* AkProfilerPopTimerFunc)()
External (optional) function for tracking performance of the sound engine that is called when a timer...
Definition: AkSoundEngine.h:210
@ AkFloorPlane_XZ
The floor is oriented along the ZX-plane. The front vector points towards +Z, the up vector towards +...
Definition: AkSoundEngine.h:163
AkUInt32 uContinuousPlaybackLookAhead
Default is 1 audio quantum, also known as an audio frame. Its size is equal to AkInitSettings::uNumSa...
Definition: AkSoundEngine.h:232
AKSOUNDENGINE_API AKRESULT RemoveOutput(AkOutputDeviceID in_idOutput)
bool bEnableGameSyncPreparation
Sets to true to enable AK::SoundEngine::PrepareGameSync usage.
Definition: AkSoundEngine.h:231
AKSOUNDENGINE_API AkUInt32 GetBufferTick()
AKSOUNDENGINE_API AKRESULT RegisterResourceMonitorCallback(AkResourceMonitorCallbackFunc in_pCallback)
void * pClientData
Arbitrary data that will be passed back to the client when calling FuncRequestJobWorker.
Definition: AkSoundEngine.h:198
AKSOUNDENGINE_API AKRESULT GetOutputDeviceConfiguration(AkOutputDeviceID in_idOutput, AkChannelConfig &io_channelConfig, Ak3DAudioSinkCapabilities &io_capabilities)
AKSOUNDENGINE_API AKRESULT GetDeviceSpatialAudioSupport(AkUInt32 in_idDevice)
AKSOUNDENGINE_API AKRESULT AddListener(AkGameObjectID in_emitterGameObj, AkGameObjectID in_listenerGameObj)
AkAssertHook pfnAssertHook
External assertion handling function (optional)
Definition: AkSoundEngine.h:227
Necessary settings for setting externally-loaded sources.
Definition: AkSoundEngine.h:274
AkUInt32 uMemorySlabSize
Size of each memory slab used for job manager memory. Must be a power of two. Default is 8K.
Definition: AkSoundEngine.h:196
AKSOUNDENGINE_API AKRESULT SeekOnEvent(AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkTimeMs in_iPosition, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
AkUInt32 uMaxHardwareTimeoutMs
Amount of time to wait for HW devices to trigger an audio interrupt. If there is no interrupt after t...
Definition: AkSoundEngine.h:243
AKSOUNDENGINE_API AKRESULT SetScalingFactor(AkGameObjectID in_GameObjectID, AkReal32 in_fAttenuationScalingFactor)
AKSOUNDENGINE_API AKRESULT RegisterCaptureCallback(AkCaptureCallbackFunc in_pfnCallback, AkOutputDeviceID in_idOutput=AK_INVALID_OUTPUT_DEVICE_ID, void *in_pCookie=NULL)
@ Preparation_Load
PrepareEvent() will load required information to play the specified event.
Definition: AkSoundEngine.h:2653
AKSOUNDENGINE_API AKRESULT UnregisterGameObj(AkGameObjectID in_gameObjectID)
AKSOUNDENGINE_API AKRESULT SetJobMgrMaxActiveWorkers(AkJobType in_jobType, AkUInt32 in_uNewMaxActiveWorkers)
AKSOUNDENGINE_API AKRESULT RenderAudio(bool in_bAllowSyncRender=true)
AkJobMgrSettings settingsJobManager
Settings to configure the behavior of the Sound Engine's internal job manager.
Definition: AkSoundEngine.h:241
void(* AkCaptureCallbackFunc)(AkAudioBuffer &in_CaptureBuffer, AkOutputDeviceID in_idOutput, void *in_pCookie)
Definition: AkCallback.h:409
Positioning information for a sound, with specified subset of its channels.
Definition: AkTypes.h:724
AKSOUNDENGINE_API AKRESULT SetListenerSpatialization(AkGameObjectID in_uListenerID, bool in_bSpatialized, AkChannelConfig in_channelConfig, AK::SpeakerVolumes::VectorPtr in_pVolumeOffsets=NULL)
AKSOUNDENGINE_API AKRESULT SetGameObjectAuxSendValues(AkGameObjectID in_gameObjectID, AkAuxSendValue *in_aAuxSendValues, AkUInt32 in_uNumSendValues)
Settings for the Sound Engine's internal job manager.
Definition: AkSoundEngine.h:182
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)
static const AkUInt32 AK_NUM_JOB_TYPES
Number of possible job types recognized by the Sound Engine.
Definition: AkTypes.h:127
void(* AkCallbackFunc)(AkCallbackType in_eType, AkCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:267
AKRESULT(* AkBackgroundMusicChangeCallbackFunc)(bool in_bBackgroundMusicMuted, void *in_pCookie)
Definition: AkSoundEngine.h:120
AKSOUNDENGINE_API AKRESULT UnregisterCaptureCallback(AkCaptureCallbackFunc in_pfnCallback, AkOutputDeviceID in_idOutput=AK_INVALID_OUTPUT_DEVICE_ID, void *in_pCookie=NULL)
AKSOUNDENGINE_API AKRESULT AddOutputCaptureBinaryMarker(void *in_pMarkerData, AkUInt32 in_uMarkerDataSize)
AKSOUNDENGINE_API AkChannelConfig GetSpeakerConfiguration(AkOutputDeviceID in_idOutput=0)
AKSOUNDENGINE_API AKRESULT GetAudioSettings(AkAudioSettings &out_audioSettings)
AkUInt32 uMediaSize
Size, in bytes, of the data to be set for the source.
Definition: AkSoundEngine.h:277
AKSOUNDENGINE_API AKRESULT UnloadBank(const char *in_pszString, const void *in_pInMemoryBankPtr, AkBankType in_bankType=AkBankType_User)
AKSOUNDENGINE_API AKRESULT RegisterBusMeteringCallback(AkUniqueID in_busID, AkBusMeteringCallbackFunc in_pfnCallback, AkMeteringFlags in_eMeteringFlags, void *in_pCookie=NULL)
AKSOUNDENGINE_API void SetRandomSeed(AkUInt32 in_uSeed)
const AkOSChar * szPluginDLLPath
When using DLLs for plugins, specify their path. Leave NULL if DLLs are in the same folder as the gam...
Definition: AkSoundEngine.h:250
Definition: IAkPlugin.h:1340
void(* AkBusCallbackFunc)(AkSpeakerVolumeMatrixCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:277
AkUInt32 uNumMemorySlabs
Number of memory slabs to pre-allocate for job manager memory. At least one slab per worker thread sh...
Definition: AkSoundEngine.h:195
AKSOUNDENGINE_API void GetDefaultPlatformInitSettings(AkPlatformInitSettings &out_platformSettings)
AKSOUNDENGINE_API AKRESULT TryUnsetMedia(AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings, AKRESULT *out_pUnsetResults)
AKSOUNDENGINE_API AKRESULT SetMultiplePositions(AkGameObjectID in_GameObjectID, const AkSoundPosition *in_pPositions, AkUInt16 in_NumPositions, MultiPositionType in_eMultiPositionType=MultiPositionType_MultiDirections, AkSetPositionFlags in_eFlags=AkSetPositionFlags_Default)
AKSOUNDENGINE_API AKRESULT GetSourcePlayPosition(AkPlayingID in_PlayingID, AkTimeMs *out_puPosition, bool in_bExtrapolate=true)
Definition: IBytes.h:152
AKSOUNDENGINE_API AKRESULT SetDistanceProbe(AkGameObjectID in_listenerGameObjectID, AkGameObjectID in_distanceProbeGameObjectID)
AKSOUNDENGINE_API AKRESULT SetListeners(AkGameObjectID in_emitterGameObj, const AkGameObjectID *in_pListenerGameObjs, AkUInt32 in_uNumListeners)
AKSOUNDENGINE_API AKRESULT SetPosition(AkGameObjectID in_GameObjectID, const AkSoundPosition &in_Position, AkSetPositionFlags in_eFlags=AkSetPositionFlags_Default)
AKSOUNDENGINE_API AKRESULT SendPluginCustomGameData(AkUniqueID in_busID, AkGameObjectID in_busObjectID, AkPluginType in_eType, AkUInt32 in_uCompanyID, AkUInt32 in_uPluginID, const void *in_pData, AkUInt32 in_uSizeInBytes)
@ AkPanningRule_Speakers
Left and right positioned 60 degrees apart (by default - see AK::SoundEngine::GetSpeakerAngles()).
Definition: AkTypes.h:1139
AKSOUNDENGINE_API AKRESULT SetBusEffect(AkUniqueID in_audioNodeID, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
void(* AkBankCallbackFunc)(AkUInt32 in_bankID, const void *in_pInMemoryBankPtr, AKRESULT in_eLoadResult, void *in_pCookie)
Definition: AkCallback.h:327
AKSOUNDENGINE_API void MuteBackgroundMusic(bool in_bMute)
AKSOUNDENGINE_API AKRESULT SetContainerHistory(AK::IReadBytes *in_pBytes)
void(* AkAssertHook)(const char *in_pszExpression, const char *in_pszFileName, int in_lineNumber)
Definition: AkSoundEngine.h:104
AKSOUNDENGINE_API AKRESULT SetMixer(AkUniqueID in_audioNodeID, AkUniqueID in_shareSetID)
AKSOUNDENGINE_API AkUInt32 GetIDFromString(const char *in_pszString)
AKSOUNDENGINE_API AKRESULT PrepareBank(AK::SoundEngine::PreparationType in_PreparationType, const char *in_pszString, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All, AkBankType in_bankType=AkBankType_User)
AKSOUNDENGINE_API AKRESULT SetOfflineRendering(bool in_bEnableOfflineRendering)
AKSOUNDENGINE_API AKRESULT LoadBankMemoryCopy(const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankID &out_bankID)
AKSOUNDENGINE_API AKRESULT SetPanningRule(AkPanningRule in_ePanningRule, AkOutputDeviceID in_idOutput=0)
AKSOUNDENGINE_API AKRESULT AddDefaultListener(AkGameObjectID in_listenerGameObj)
AKSOUNDENGINE_API AKRESULT SetGameObjectOutputBusVolume(AkGameObjectID in_emitterObjID, AkGameObjectID in_listenerObjID, AkReal32 in_fControlValue)
AKSOUNDENGINE_API AKRESULT AddOutput(const AkOutputSettings &in_Settings, AkOutputDeviceID *out_pDeviceID=NULL, const AkGameObjectID *in_pListenerIDs=NULL, AkUInt32 in_uNumListeners=0)
AKSOUNDENGINE_API AKRESULT Suspend(bool in_bRenderAnyway=false, bool in_bFadeOut=true)
Definition: AkTypes.h:238
AKSOUNDENGINE_API AKRESULT StopOutputCapture()
AkUInt32 uCpuMonitorQueueMaxSize
Maximum size of the CPU monitoring queue, per thread, in bytes. This parameter is not used in Release...
Definition: AkSoundEngine.h:238
AK::IAkPluginParam *(* AkCreateParamCallback)(AK::IAkPluginMemAlloc *in_pAllocator)
Registered plugin parameter node creation function prototype.
Definition: IAkPlugin.h:1307
AKSOUNDENGINE_API AKRESULT ResetListenersToDefault(AkGameObjectID in_emitterGameObj)
AKSOUNDENGINE_API AKRESULT SetBusDevice(AkUniqueID in_idBus, AkUniqueID in_idNewDevice)
AKSOUNDENGINE_API AKRESULT ExecuteActionOnEvent(AkUniqueID in_eventID, AkActionOnEventType in_ActionType, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
AKSOUNDENGINE_API AKRESULT SetMedia(AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings)
AKSOUNDENGINE_API void CancelBankCallbackCookie(void *in_pCookie)
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:94
@ AkFloorPlane_YZ
The floor is oriented along the YZ-plane. The front vector points towards +Y, the up vector towards +...
Definition: AkSoundEngine.h:165
AkTimeMs msTime
Position of the source (in ms) associated with that playing item.
Definition: AkSoundEngine.h:285
void * BGMCallbackCookie
Application-defined user data for the audio source change event callback function.
Definition: AkSoundEngine.h:249
AkUniqueID sourceID
Source ID (available in the SoundBank content files)
Definition: AkSoundEngine.h:275
bool bUseSoundBankMgrThread
Use a separate thread for loading sound banks. Allows asynchronous operations.
Definition: AkSoundEngine.h:245
void(* AkDeviceStatusCallbackFunc)(AK::IAkGlobalPluginContext *in_pContext, AkUniqueID in_idAudioDeviceShareset, AkUInt32 in_idDeviceID, AkAudioDeviceEvent in_idEvent, AKRESULT in_AkResult)
Definition: AkCallback.h:391
AkUniqueID mediaID
Media ID of playing item. (corresponds to 'ID' attribute of 'File' element in SoundBank metadata file...
Definition: AkSoundEngine.h:284
Definition: AkMidiTypes.h:237
bool bDebugOutOfRangeCheckEnabled
Debug setting: Enable checks for out-of-range (and NAN) floats in the processing code....
Definition: AkSoundEngine.h:265
Definition: AkSoundEngine.h:226
AKSOUNDENGINE_API AKRESULT UnpinEventInStreamCache(AkUniqueID in_eventID)
AKSOUNDENGINE_API AKRESULT SetRTPCValueByPlayingID(AkRtpcID in_rtpcID, AkRtpcValue in_value, AkPlayingID in_playingID, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
AKSOUNDENGINE_API AKRESULT UnregisterResourceMonitorCallback(AkResourceMonitorCallbackFunc in_pCallback)
AKSOUNDENGINE_API AKRESULT UnregisterGlobalCallback(AkGlobalCallbackFunc in_pCallback, AkUInt32 in_eLocation=AkGlobalCallbackLocation_BeginRender)
AkProfilerPostMarkerFunc fnProfilerPostMarker
External (optional) function for tracking significant events in the sound engine, to act as a marker ...
Definition: AkSoundEngine.h:269
AKSOUNDENGINE_API AKRESULT ClearPreparedEvents()
AKSOUNDENGINE_API AKRESULT SetVolumeThreshold(AkReal32 in_fVolumeThresholdDB)
AKSOUNDENGINE_API AkPlayingID PostEvent(AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkUInt32 in_uFlags=0, AkCallbackFunc in_pfnCallback=NULL, void *in_pCookie=NULL, AkUInt32 in_cExternals=0, AkExternalSourceInfo *in_pExternalSources=NULL, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
AKSOUNDENGINE_API void Term()
AKSOUNDENGINE_API AKRESULT GetDeviceList(AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkUInt32 &io_maxNumDevices, AkDeviceDescription *out_deviceDescriptions)
AKSOUNDENGINE_API void StopAll(AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
AK::IAkPlugin *(* AkCreatePluginCallback)(AK::IAkPluginMemAlloc *in_pAllocator)
Registered plugin creation function prototype.
Definition: IAkPlugin.h:1305
IAkSoftwareCodec *(* AkCreateBankSourceCallback)(void *in_pCtx)
Registered bank source node creation function prototype.
Definition: AkTypes.h:1057
AKSOUNDENGINE_API AkUInt64 GetSampleTick()
AKSOUNDENGINE_API AK::IAkGlobalPluginContext * GetGlobalPluginContext()
AKSOUNDENGINE_API AKRESULT UnsetMedia(AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings)
AKSOUNDENGINE_API AKRESULT SetBusConfig(AkUniqueID in_audioNodeID, AkChannelConfig in_channelConfig)
AkUInt32 AkPlayingID
A unique identifier generated whenever a PostEvent is called (or when a Dynamic Sequence is created)....
Definition: AkTypes.h:55
AKSOUNDENGINE_API bool GetBackgroundMusicMute()
void(* AkProfilerPushTimerFunc)(AkPluginID in_uPluginID, const char *in_pszZoneName)
Definition: AkSoundEngine.h:204
AkProfilerPushTimerFunc fnProfilerPushTimer
External (optional) function for tracking performance of the sound engine that is called when a timer...
Definition: AkSoundEngine.h:267
AKSOUNDENGINE_API void StopPlayingID(AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
@ AkGlobalCallbackLocation_BeginRender
Start of frame rendering, after having processed game messages.
Definition: AkCallback.h:343
void(* FuncRequestJobWorker)(AkJobWorkerFunc in_fnJobWorker, AkJobType in_jobType, AkUInt32 in_uNumWorkers, void *in_pClientData)
Callback function prototype definition used for handling requests from JobMgr for new workers to perf...
Definition: AkSoundEngine.h:184
AkUInt32 uBankReadBufferSize
The number of bytes read by the BankReader when new data needs to be loaded from disk during serializ...
Definition: AkSoundEngine.h:261
AKSOUNDENGINE_API AKRESULT RemoveListener(AkGameObjectID in_emitterGameObj, AkGameObjectID in_listenerGameObj)
AKSOUNDENGINE_API AKRESULT GetBufferStatusForPinnedEvent(AkUniqueID in_eventID, AkReal32 &out_fPercentBuffered, bool &out_bCachePinnedMemoryFull)
AKSOUNDENGINE_API AKRESULT GetSpeakerAngles(AkReal32 *io_pfSpeakerAngles, AkUInt32 &io_uNumAngles, AkReal32 &out_fHeightAngle, AkOutputDeviceID in_idOutput=0)
AKSOUNDENGINE_API void CancelEventCallback(AkPlayingID in_playingID)
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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