Wwise SDK
_ak_sound_engine_8h_source
Version
menu
|
Wwise SDK 2025.1.4
|
AkSoundEngine.h
Go to the documentation of this file.
125Â /// 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.
126Â /// AkFloorPlane is used in to orient the Game Object 3D Viewer in Wwise, and in the transformation of geometry instances in Wwise Spatial Audio.
134Â };
138Â // in_uExecutionTimeUsec is the number of microseconds that the function should execute for before terminating.
139Â // Note that the deadline is only checked after each individual job completes execution, so the function may run slightly
140Â // longer than intended. The "in_uExecutionTimeUsec" should be considered a suggestion or guideline, not a strict rule.
141Â // A value of 0 means that the function will run until there are no more jobs ready to be immediately executed.
150Â /// Callback function prototype definition used for handling requests from JobMgr for new workers to perform work.
168Â /// 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)
169Â /// in_uPluginID may be non-zero when this function is called, to provide extra data about what context this Timer was started in.
170Â /// 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.
176Â /// 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)
180Â /// in_uPluginID may be non-zero when this function is called, to provide extra data about what context this Marker was posted in.
181Â /// 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.
275Â /// \warning This function is not thread-safe. It should not be called at the same time as \c SoundEngine::Init() or \c SoundEngine::Term().
285Â /// \remark The initial settings should be initialized using AK::SoundEngine::GetDefaultInitSettings()
287Â /// default settings. This is not mandatory, but it helps avoid backward compatibility problems.
291Â /// - \c AK_MemManagerNotInitialized if the memory manager is not available or not properly initialized
292Â /// - \c AK_StreamMgrNotInitialized if the stream manager is not available or not properly initialized
293Â /// - \c AK_SSEInstructionsNotSupported if the machine does not support SSE instruction (only on the PC)
294Â /// - \c AK_InsufficientMemory if there is not enough memory available to initialize the sound engine properly
296Â /// - \c AK_AlreadyInitialized if the sound engine is already initialized, or if the provided settings result in insufficient
335Â /// \warning Before calling Term, you must ensure that no other thread is accessing the sound engine.
354Â /// Call this function to get the speaker configuration of the output (which may not correspond
355Â /// to the physical output format of the platform, in the case of downmixing provided by the platform itself).
359Â /// If the speaker configuration of the output is object-based, the speaker configuration of the
360Â /// main mix is returned. To query more information on object-based output devices, see AK::SoundEngine::GetOutputDeviceConfiguration.
362Â /// It is recommended to call GetSpeakerConfiguration anytime after receiving a callback from RegisterAudioDeviceStatusCallback to know if the channel configuration has changed.
365Â /// 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.
367Â /// \return The output configuration. An empty AkChannelConfig not AkChannelConfig::IsValid() if device does not exist or if the Init.bnk was not loaded yet.
377Â /// Call this function to get the channel configuration of the output device as well as its 3D audio capabilities.
378Â /// If the configuration of the output device is object-based (io_channelConfig.eConfigType == AK_ChannelConfigType_Objects),
379Â /// io_capabilities can be inspected to determine the channel configuration of the main mix (Ak3DAudioSinkCapabilities::channelConfig),
380Â /// whether or not the output device uses a passthrough mix (Ak3DAudioSinkCapabilities::bPassthrough) and the maximum number of objects
381Â /// that can play simultaneously on this output device (Ak3DAudioSinkCapabilities::uMax3DAudioObjects). Note that if
382Â /// Ak3DAudioSinkCapabilities::bMultiChannelObjects is false, multi-channel objects will be split into multiple mono objects
385Â /// \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.
418Â /// \warning This function posts a message through the sound engine's internal message queue, whereas GetPanningRule() queries the current panning rule directly.
420Â /// The specified panning rule will only impact the sound if the processing format is downmixing to Stereo in the mixing process. It
428Â /// Gets speaker angles of the specified device. Speaker angles are used for 3D positioning of sounds over standard configurations.
430Â /// The speaker angles are expressed as an array of loudspeaker pairs, in degrees, relative to azimuth ]0,180].
431Â /// Supported loudspeaker setups are always symmetric; the center speaker is always in the middle and thus not specified by angles.
433Â /// You may call this function with io_pfSpeakerAngles set to NULL to get the expected number of angle values in io_uNumAngles,
444Â /// - 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.
445Â /// - When panning to 5.1, the front speakers use angle[0], and the surround speakers use (angle[2] + angle[1]) / 2.
457Â /// Sets speaker angles of the specified device. Speaker angles are used for 3D positioning of sounds over standard configurations.
459Â /// The speaker angles are expressed as an array of loudspeaker pairs, in degrees, relative to azimuth ]0,180], for a 7.1 speaker configuration.
460Â /// Supported loudspeaker setups are always symmetric; the center speaker is always in the middle and thus not specified by angles.
463Â /// - This function requires the minimum speaker angle between any pair of speakers to be at least 5 degrees.
464Â /// - 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.
470Â /// 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().
471Â /// \warning This function only applies to configurations (or subset of these configurations) that are standard and whose speakers are on the plane (2D).
476Â /// - \c AK_InvalidParameter one of the parameter is invalid, check the debug log. Speaker angles must be [0, 180] and height angle must be [-90, 90]. Height angle must not be 0, regardless if height channels are used.
485Â /// Allows the game to set the volume threshold to be used by the sound engine to determine if a voice must go virtual.
487Â /// If this function is not called, the used value will be the value specified in the platform specific project settings.
496Â /// Allows the game to set the maximum number of non virtual voices to be played simultaneously.
498Â /// If this function is not called, the used value will be the value specified in the platform specific project settings.
508Â /// This function may only be used if a worker function has been set via \ref AkJobMgrSettings.
510Â /// - \c AK_InvalidParameter in_jobType is not a valid jobtype, or in_uNewMaxActiveWorkers is not greater than 0
511Â /// - \c AK_NotInitialized JobMgr system was not already initialized with a function to request for workers
548Â /// 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.
559Â /// Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
560Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
561Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
574Â /// 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.
577Â /// - \c AK_FileNotFound if the DLL is not found in the OS path or if it has extraneous dependencies not found.
578Â /// - \c AK_InsufficientMemory if the system ran out of resources while loading the dynamic library
579Â /// - \c AK_NotCompatible if the file was found but is not binary-compatible with the system's expected executable format
598Â /// 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.
608Â /// Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
609Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
610Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
619Â /// Registers a global callback function. This function will be called from the audio rendering thread, at the
620Â /// location specified by in_eLocation. This function will also be called from the thread calling
622Â /// For example, in order to be called at every audio rendering pass, and once during teardown for releasing resources, you would call
623Â /// RegisterGlobalCallback(myCallback, AkGlobalCallbackLocation_BeginRender | AkGlobalCallbackLocation_Term, myCookie, AkPluginTypeNone, 0, 0);
625Â /// A Plugin Type, Company ID and Plugin ID can be provided to this function to enable timing in the performance monitor.
626Â /// 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.
631Â /// - \c AK_InvalidParameter if parameters are out of range (check debug console or Wwise Profiler)
645Â /// Unregisters a global callback function, previously registered using RegisterGlobalCallback.
647Â /// It is legal to call this function while already inside of a global callback, If it is unregistering itself and not
652Â /// - \c AK_InvalidParameter if parameters are out of range (check debug console or Wwise Profiler)
662Â /// Registers a resource monitor callback function that gets all of the resource usage data contained in the
663Â /// AkResourceMonitorDataSummary structure. This includes general information about the system, such as CPU usage,
664Â /// active Voices, and Events. This function will be called from the audio rendering thread at the end of each frame.
666Â /// 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.
677Â /// Unregisters a resource monitor callback function, previously registered using RegisterResourceMonitorCallback.
679Â /// It is legal to call this function while already inside of a resource monitor callback, If it is unregistering itself and not
697Â /// Unregisters the callback for the Audio Device status changes, registered by RegisterAudioDeviceStatusCallback
707Â /// This function will hash the name based on a algorithm ( provided at : /AK/Tools/Common/AkFNVHash.h )
710Â /// AkUniqueID, AkStateGroupID, AkStateID, AkSwitchGroupID, AkSwitchStateID, AkRtpcID, and so on...
726Â /// This function will hash the name based on a algorithm ( provided at : /AK/Tools/Common/AkFNVHash.h )
729Â /// AkUniqueID, AkStateGroupID, AkStateID, AkSwitchGroupID, AkSwitchStateID, AkRtpcID, and so on...
751Â /// The callback function can be used to be notified when markers are reached or when the event is finished (see \ref AkCallbackType).
752Â /// An array of wave file sources can be provided to resolve External Sources triggered by the event.
753Â /// \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.
755Â /// If used, the array of external sources should contain the information for each external source triggered by the
756Â /// event. When triggering an event with multiple external sources, you need to differentiate each source
757Â /// by using the cookie property in the External Source in the Wwise project and in AkExternalSourceInfo.
758Â /// \aknote If an event triggers the playback of more than one external source, they must be named uniquely in the project
759Â /// (therefore have a unique cookie) in order to tell them apart when filling the AkExternalSourceInfo structures.
762Â /// If Wwise Authoring is connected to the game and "Profile And Edit (Sync All)" is used, the required Event doesn't have to be loaded before this function is called.
763Â /// If the Event is missing, it will be requested from Wwise Authoring directly, which might cause additional latency.
785Â /// The callback function can be used to be notified when markers are reached or when the event is finished (see \ref AkCallbackType).
786Â /// An array of wave file sources can be provided to resolve External Sources triggered by the event.
787Â /// \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.
789Â /// If used, the array of external sources should contain the information for each external source triggered by the
790Â /// event. When triggering an event with multiple external sources, you need to differentiate each source
791Â /// by using the cookie property in the External Source in the Wwise project and in AkExternalSourceInfo.
792Â /// \aknote If an event triggers the playback of more than one external source, they must be named uniquely in the project
793Â /// (therefore have a unique cookie) in order to tell them apart when filling the AkExternalSourceInfo structures.
796Â /// If Wwise Authoring is connected to the game and "Profile And Edit (Sync All)" is used, the required Event doesn't have to be loaded before this function is called.
797Â /// If the Event is missing, it will be requested from Wwise Authoring directly, which might cause additional latency.
819Â /// The callback function can be used to be notified when markers are reached or when the event is finished (see \ref AkCallbackType).
820Â /// An array of wave file sources can be provided to resolve External Sources triggered by the event.
821Â /// \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.
823Â /// If used, the array of external sources should contain the information for each external source triggered by the
824Â /// event. When triggering an event with multiple external sources, you need to differentiate each source
825Â /// by using the cookie property in the External Source in the Wwise project and in AkExternalSourceInfo.
826Â /// \aknote If an event triggers the playback of more than one external source, they must be named uniquely in the project
827Â /// (therefore have a unique cookie) in order to tell them apart when filling the AkExternalSourceInfo structures.
830Â /// If Wwise Authoring is connected to the game and "Profile And Edit (Sync All)" is used, the required Event doesn't have to be loaded before this function is called.
831Â /// If the Event is missing, it will be requested from Wwise Authoring directly, which might cause additional latency.
856Â const ::AkActionOnEventType AkActionOnEventType_ReleaseEnvelope = ::AkActionOnEventType_ReleaseEnvelope;
859Â /// Executes an Action on all nodes that are referenced in the specified Event in an Action of type play.
875Â /// Executes an Action on all nodes that are referenced in the specified Event in an Action of type play.
891Â /// Executes an Action on all nodes that are referenced in the specified Event in an Action of type play.
907Â /// Executes a number of MIDI Events on all nodes that are referenced in the specified Event in an Action of type Play.
908Â /// The time at which a MIDI Event is posted is determined by in_bAbsoluteOffsets. If false, each MIDI event will be
909Â /// posted in AkMIDIPost::uOffset samples from the start of the current frame. If true, each MIDI event will be posted
912Â /// The duration of a sample can be determined from the sound engine's audio settings, via a call to AK::SoundEngine::GetAudioSettings.
913Â /// If a playing ID is specified then that playing ID must be active. Otherwise a new playing ID will be assigned.
914Â /// \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.
932Â /// Stops MIDI notes on all nodes that are referenced in the specified event in an action of type play,
933Â /// with the specified Game Object. Invalid parameters are interpreted as wildcards. For example, calling
934Â /// this function with in_eventID set to AK_INVALID_UNIQUE_ID will stop all MIDI notes for Game Object
949Â /// 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
950Â /// 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
952Â /// \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.
953Â /// \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.
954Â /// \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
955Â /// 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.
956Â /// \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
957Â /// will get cached with active priority, while all other files will get cached with inactive priority.
958Â /// \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
959Â /// 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.
975Â /// 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
976Â /// 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
978Â /// \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.
979Â /// \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.
980Â /// \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
981Â /// 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.
982Â /// \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
983Â /// will get cached with active priority, while all other files will get cached with inactive priority.
984Â /// \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
985Â /// 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.
1001Â /// 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
1002Â /// 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
1004Â /// \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.
1005Â /// \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.
1006Â /// \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
1007Â /// 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.
1008Â /// \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
1009Â /// will get cached with active priority, while all other files will get cached with inactive priority.
1010Â /// \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
1011Â /// 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.
1026Â /// 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
1027Â /// after AK::SoundEngine::UnpinEventInStreamCache() is called, until the memory is reused by the streaming memory manager in accordance with to its cache management algorithm.
1039Â /// 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
1040Â /// after AK::SoundEngine::UnpinEventInStreamCache() is called, until the memory is reused by the streaming memory manager in accordance with to its cache management algorithm.
1052Â /// 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
1053Â /// after AK::SoundEngine::UnpinEventInStreamCache() is called, until the memory is reused by the streaming memory manager in accordance with to its cache management algorithm.
1064Â /// Returns information about an Event that was requested to be pinned into cache via AK::SoundEngine::PinEventInStreamCache().
1065Â /// Retrieves the smallest buffer fill-percentage for each file referenced by the event, and whether
1066Â /// the cache-pinned memory limit is preventing any of the files from filling up their buffer.
1067Â /// \remarks To set the limit for the maximum number of bytes that can be pinned to cache, see \c AkDeviceSettings
1081Â /// Returns information about an Event that was requested to be pinned into cache via AK::SoundEngine::PinEventInStreamCache().
1082Â /// Retrieves the smallest buffer fill-percentage for each file referenced by the event, and whether
1083Â /// the cache-pinned memory limit is preventing any of the files from filling up their buffer.
1084Â /// \remarks To set the limit for the maximum number of bytes that can be pinned to cache, see AkDeviceSettings
1099Â /// Returns information about an Event that was requested to be pinned into cache via AK::SoundEngine::PinEventInStreamCache().
1100Â /// Retrieves the smallest buffer fill-percentage for each file referenced by the event, and whether
1101Â /// the cache-pinned memory limit is preventing any of the files from filling up their buffer.
1102Â /// \remarks To set the limit for the maximum number of bytes that can be pinned to cache, see AkDeviceSettings
1117Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1120Â /// - This works with all objects of the Containers hierarchy, including Music Segments and Music Switch Containers.
1121Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1122Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1123Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1128Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1129Â /// With objects of the Containers hierarchy, markers are embedded in wave files by an external wave editor.
1130Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1131Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1132Â /// to nearest marker. In the case of interactive music objects (Music Segments, Music Switch Containers, and Music Playlist Containers), user (wave) markers are ignored:
1133Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1134Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1138Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1140Â /// - Music segments cannot be looped. You may want to listen to the AK_EndOfEvent notification
1142Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1144Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1145Â /// value that was passed to the method. Use AK::SoundEngine::GetPlayingSegmentInfo() to query
1147Â /// (so that it restarts precisely at the position that you specified). AK::SoundEngine::GetPlayingSegmentInfo()
1152Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1153Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1154Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1155Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1174Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1177Â /// - This works with all objects of the Containers hierarchy, and also with Music Segments and Music Switch Containers.
1178Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1179Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1180Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1183Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1187Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1188Â /// With objects of the Containers hierarchy, markers are embedded in wave files by an external wave editor.
1189Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1190Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1191Â /// to nearest marker. In the case of interactive music objects (Music Segments, Music Switch Containers, and Music Playlist Containers), user (wave) markers are ignored:
1192Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1193Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1197Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1199Â /// - Music segments cannot be looped. You may want to listen to the AK_EndOfEvent notification
1201Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1203Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1204Â /// value that was passed to the method. Use AK::SoundEngine::GetPlayingSegmentInfo() to query
1206Â /// (so that it restarts precisely at the position that you specified). AK::SoundEngine::GetPlayingSegmentInfo()
1211Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1212Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1213Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1214Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1232Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1235Â /// - This works with all objects of the Containers hierarchy, and also with Music Segments and Music Switch Containers.
1236Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1237Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1238Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1241Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1245Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1246Â /// With objects of the Containers hierarchy, markers are embedded in wave files by an external wave editor.
1247Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1248Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1249Â /// to nearest marker. In the case of interactive music objects (Music Segments, Music Switch Containers, and Music Playlist Containers), user (wave) markers are ignored:
1250Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1251Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1255Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1257Â /// - Music segments cannot be looped. You may want to listen to the AK_EndOfEvent notification
1259Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1261Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1262Â /// value that was passed to the method. Use AK::SoundEngine::GetPlayingSegmentInfo() to query
1264Â /// (so that it restarts precisely at the position that you specified). AK::SoundEngine::GetPlayingSegmentInfo()
1269Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1270Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1271Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1272Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1290Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1291Â /// Seek position is specified as a percentage of the sound's total duration, and takes looping into account.
1294Â /// - This works with all objects of the Containers hierarchy, and also with Music Segments and Music Switch Containers.
1295Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1296Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1297Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1301Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1302Â /// With objects of the Containers hierarchy, markers are embedded in wave files by an external wave editor.
1303Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1304Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1305Â /// to nearest marker. In the case of interactive music objects (Music Segments, Music Switch Containers, and Music Playlist Containers), user (wave) markers are ignored:
1306Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1307Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1311Â /// - With Music Segments, \c in_fPercent is relative to the Entry Cue, and the segment's duration is the
1312Â /// duration between its entry and exit cues. Consequently, you cannot seek within the pre-entry or
1314Â /// - Music Segments cannot be looped. You may want to listen to the \c AK_EndOfEvent notification
1316Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1318Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1319Â /// value that was passed to the method. Use AK::SoundEngine::GetPlayingSegmentInfo() to query
1320Â /// the exact position of a segment. Also, the segment will be silent during the time that period
1321Â /// (so that it restarts precisely at the position that you specified). AK::SoundEngine::GetPlayingSegmentInfo()
1326Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1327Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1328Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1329Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1345Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1346Â /// Seek position is specified as a percentage of the sound's total duration, and takes looping into account.
1349Â /// - This works with all objects of the Containers hierarchy, and also with Music Segments and Music Switch Containers.
1350Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1351Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1352Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1355Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1356Â /// With objects of the Containers hierarchy, markers are embedded in wave files by an external wave editor.
1357Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1358Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1359Â /// to nearest marker. In the case of interactive music objects (Music Segments, Music Switch Containers, and Music Playlist Containers), user (wave) markers are ignored:
1360Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1361Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1365Â /// - With Music Segments, \c in_fPercent is relative to the Entry Cue, and the segment's duration is the
1366Â /// duration between its entry and exit cues. Consequently, you cannot seek within the pre-entry or
1368Â /// - Music Segments cannot be looped. You may want to listen to the \c AK_EndOfEvent notification
1370Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1372Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1373Â /// value that was passed to the method. Use AK::SoundEngine::GetPlayingSegmentInfo() to query
1374Â /// the exact position of a segment. Also, the segment will be silent during the time that period
1375Â /// (so that it restarts precisely at the position that you specified). AK::SoundEngine::GetPlayingSegmentInfo()
1380Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1381Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1382Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1383Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1399Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1400Â /// Seek position is specified as a percentage of the sound's total duration, and takes looping into account.
1403Â /// - This works with all objects of the Containers hierarchy, and also with Music Segments and Music Switch Containers.
1404Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1405Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1406Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1409Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1410Â /// With objects of the Containers hierarchy, markers are embedded in wave files by an external wave editor.
1411Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1412Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1413Â /// to nearest marker. In the case of interactive music objects (Music Segments, Music Switch Containers, and Music Playlist Containers), user (wave) markers are ignored:
1414Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1415Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1419Â /// - With Music Segments, \c in_fPercent is relative to the Entry Cue, and the segment's duration is the
1420Â /// duration between its entry and exit cues. Consequently, you cannot seek within the pre-entry or
1422Â /// - Music segments cannot be looped. You may want to listen to the \c AK_EndOfEvent notification
1424Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1426Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1427Â /// value that was passed to the method. Use AK::SoundEngine::GetPlayingSegmentInfo() to query
1428Â /// the exact position of a segment. Also, the segment will be silent during the time that period
1429Â /// (so that it restarts precisely at the position that you specified). AK::SoundEngine::GetPlayingSegmentInfo()
1434Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1435Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1436Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1437Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1473Â /// Gets the current position of the source associated with this playing ID, obtained from PostEvent(). If more than one source is playing,
1476Â /// - The source's position is updated at every audio frame, and the time at which this occurs is stored.
1477Â /// When you call this function from your thread, you therefore query the position that was updated in the previous audio frame.
1478Â /// If in_bExtrapolate is true (default), the returned position is extrapolated using the elapsed time since last
1483Â /// - \c AK_PlayingIDNotFound if the playing ID is invalid (not playing yet, or finished playing).
1493Â /// Gets the current position of the sources associated with this playing ID, obtained from PostEvent().
1495Â /// - The source's position is updated at every audio frame, and the time at which this occurs is stored.
1496Â /// When you call this function from your thread, you therefore query the position that was updated in the previous audio frame.
1497Â /// If in_bExtrapolate is true (default), the returned position is extrapolated using the elapsed time since last
1499Â /// - If 0 is passed in for the number of entries (*in_pcPositions == 0) then only the number of positions will be returned and the
1507Â /// - \c AK_PlayingIDNotFound if the playing ID is invalid (not playing yet, or finished playing).
1518Â /// Query information on the active segment of a music object that is playing. Use the playing ID
1519Â /// that was returned from AK::SoundEngine::PostEvent(), provided that the event contained a play
1520Â /// action that was targeting a music object. For any interactive music object (Music Segments, Music Switch Containers, and Music Playlist Containers),
1522Â /// To be able to query segment information, you must pass the AK_EnableGetMusicPlayPosition flag
1523Â /// to the AK::SoundEngine::PostEvent() method. This informs the sound engine that the source associated
1524Â /// with this event should be given special consideration because GetPlayingSegmentInfo() can be called
1527Â /// - If the music object is a single segment, you will get negative values for AkSegmentInfo::iCurrentPosition
1530Â /// - The active segment during the pre-entry of the first segment of a Playlist Container or a Music Switch
1531Â /// Container is "nothing", as well as during the post-exit of the last segment of a Playlist (and beyond).
1533Â /// - If in_bExtrapolate is true (default), AkSegmentInfo::iCurrentPosition is corrected by the amount of time elapsed
1534Â /// since the beginning of the audio frame. It is thus possible that it slightly overshoots the total segment length.
1535Â /// \return AK_Success if there is a playing music structure associated with the specified playing ID.
1545Â /// Gets the stream buffering of the sources associated with this playing ID, obtained from PostEvent().
1547Â /// - You need to pass AK_EnableGetSourceStreamBuffering to PostEvent() in order to use this function, otherwise
1549Â /// - The sources stream buffering is updated at every audio frame. If there are multiple sources associated with this playing ID,
1551Â /// - The returned buffering status out_bIsBuffering will be true If any of the sources associated with the playing ID are actively being buffered.
1552Â /// 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.
1553Â /// - Purely in-memory sources are excluded from this database. If all sources are in-memory, GetSourceStreamBuffering() will return AK_PlayingIDNotFound.
1554Â /// - 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.
1555Â /// 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.
1558Â /// - \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.
1575Â /// This function is deprecated. It is functionally identical to ExecuteActionOnPlayingID() using AkActionOnEventType_Stop.
1576Â /// API call in Wwise Capture Log will show ExecuteActionOnPlayingID when calling this function.
1611Â /// This function is provided to give the same behavior on platforms that don't have user-music support.
1624Â /// Sends custom game data to a plug-in that resides on a bus (effect plug-in) or a voice (source plug-in).
1628Â /// \aknote The plug-in type and ID are passed and matched with plugins set on the desired bus.
1629Â /// This means that multiple instances of the same plug-in on a given bus' effect chain will always receive the same data.
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 AkMultiPositionType_MultiDirections. AkMultiPositionType_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 function 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Â /// This function must be called periodically (once per game frame, for example) when using asynchronous bank-loading functions. Its purpose is to
1811Â /// process all queued asynchronous LoadBank, UnloadBank, PrepareBank, etc (functions using a callback). The work done in this function can be slow or blocking.
1812Â /// Therefore, the calling thread must not be a critical thread. It is recommended to have a dedicated thread for this, or a job/task if such a system exists.
1814Â /// When AkInitSettings::bUseSoundBankMgrThread is false, this function processes all pending operations immediately on the calling thread.
1818Â /// Synchronous Bank and Prepare (functions without callbacks) calls implicitely call this function. Therefore, synchronous Bank and Prepare
1819Â /// calls should always be called from the same thread that is calling AK::SoundEngine::ProcessBanks.
1829Â /// It also internally calls ClearPreparedEvents() since at least one bank must have been loaded to allow preparing events.
1832Â /// - \c AK_NotInitialized if the sound engine was not correctly initialized or if there is not enough memory to handle the command
1867Â /// - \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.
1873Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure, check the debug console)
1881Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
1882Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
1883Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
1885Â /// - The sound engine internally calls GetIDFromString(in_pszString) to return the correct bank ID.
1886Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
1887Â /// not the name of the file (if you changed it), nor the full path of the file. The path should be resolved in
1888Â /// your implementation of the Stream Manager, or in the Low-Level I/O module if you use the default Stream Manager's implementation.
1890Â /// When Wwise Authoring is connected to the game in "Profile And Edit (Sync All)" mode, LoadBank will return AK_Success even if the file is not found.
1891Â /// The Capture Log will still report the missing file. For example, this will be the case when SoundBanks were not generated.
1892Â /// If this option is selected, you can work without SoundBanks as long as Wwise Authoring is connected.
1929Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
1937Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
1938Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
1939Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
1941Â /// - The sound engine internally calls GetIDFromString(in_pszString) to return the correct bank ID.
1942Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
1943Â /// not the name of the file (if you changed it), nor the full path of the file. The path should be resolved in
1944Â /// your implementation of the Stream Manager, or in the Low-Level I/O module if you use the default Stream Manager's implementation.
1946Â /// When Wwise Authoring is connected to the game in "Profile And Edit (Sync All)" mode, LoadBank will return AK_Success even if the file is not found.
1947Â /// The Capture Log will still report the missing file. For example, this will be the case when SoundBanks were not generated.
1948Â /// If this option is selected, you can work without SoundBanks as long as Wwise Authoring is connected.
1967Â /// \aknote Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings. \endaknote
1976Â /// - \c AK_BankReadError: I/O error. The bank is either shorter than expected or its data corrupted.
1981Â /// - \c AK_InvalidParameter if some parameters are invalid, check the debug console or Wwise Profiler
1985Â /// - \c AK_Fail: Load or unload failed for any other reason. , check the debug console or Wwise Profiler
1993Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
1994Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
1995Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
1998Â /// When Wwise Authoring is connected to the game in "Profile And Edit (Sync All)" mode, LoadBank will return AK_Success even if the file is not found.
1999Â /// The Capture Log will still report the missing file. For example, this will be the case when SoundBanks were not generated.
2000Â /// If this option is selected, you can work without SoundBanks as long as Wwise Authoring is connected.
2016Â /// IMPORTANT: Banks loaded from memory with in-place data MUST be unloaded using the UnloadBank function
2017Â /// providing the same memory pointer. Make sure you are using the correct UnloadBank(...) overload
2021Â /// In-memory loading is in-place: *** the memory must be valid until the bank is unloaded. ***
2038Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2046Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2047Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2048Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2050Â /// - The memory must be aligned on platform-specific AK_BANK_PLATFORM_DATA_ALIGNMENT bytes (see AkTypes.h).
2051Â /// - Avoid using this function for banks containing a lot of events or structure data: this data will be unpacked into the sound engine heap,
2052Â /// making the supplied bank memory redundant. For event/structure-only banks, prefer LoadBankMemoryCopy().
2067Â /// IMPORTANT: Banks loaded from memory with in-place data MUST be unloaded using the UnloadBank function
2068Â /// providing the same memory pointer. Make sure you are using the correct UnloadBank(...) overload
2072Â /// In-memory loading is in-place: *** the memory must be valid until the bank is unloaded. ***
2088Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2096Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2097Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2098Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2100Â /// - The memory must be aligned on platform-specific AK_BANK_PLATFORM_DATA_ALIGNMENT bytes (see AkTypes.h).
2101Â /// - Avoid using this function for banks containing a lot of events or structure data: this data will be unpacked into the sound engine heap,
2102Â /// making the supplied bank memory redundant. For event/structure-only banks, prefer LoadBankMemoryCopy().
2118Â /// NOTE: Banks loaded from in-memory with out-of-place data must be unloaded using the standard UnloadBank function
2122Â /// in a buffer and pass its address to the sound engine, the media section of the bank will be copied into newly
2124Â /// In-memory loading is out-of-place: the buffer can be release as soon as the function returns. The advantage of using this
2142Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2150Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2151Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2152Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2168Â /// NOTE: Banks loaded from in-memory with out-of-place data must be unloaded using the standard UnloadBank function
2172Â /// in a buffer and pass its address to the sound engine, the media section of the bank will be copied into newly
2174Â /// In-memory loading is out-of-place: the buffer can be release as soon as the function returns. The advantage of using this
2191Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2199Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2200Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2201Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2216Â /// 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.
2218Â /// 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.
2246Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2247Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2248Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2250Â /// - The sound engine internally calls GetIDFromString(in_pszString) to return the correct bank ID.
2251Â /// Therefore, \c in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2252Â /// not the name of the file (if you changed it), nor the full path of the file. The path should be resolved in
2253Â /// your implementation of the Stream Manager (AK::IAkStreamMgr::CreateStd()), or in the Low-Level I/O module
2254Â /// (AK::StreamMgr::IAkLowLevelIOHook::BatchOpen()) if you use the default Stream Manager's implementation.
2255Â /// - The cookie (in_pCookie) is passed to the Low-Level I/O module for your convenience, in AK::StreamMgr::IAkLowLevelIOHook::BatchOpen()
2258Â /// When Wwise Authoring is connected to the game in "Profile And Edit (Sync All)" mode, LoadBank will succeed even if the file is not found.
2259Â /// This might be the case when sound banks were not generated, for example. The Capture Log will still report the missing file.
2275Â void * in_pCookie, ///AK::StreamMgr::IAkLowLevelIOHook::BatchOpen() as AkFileSystemFlags::pCustomParam)
2299Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2300Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2301Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2303Â /// - The sound engine internally calls GetIDFromString(in_pszString) to return the correct bank ID.
2304Â /// Therefore, \c in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2305Â /// not the name of the file (if you changed it), nor the full path of the file. The path should be resolved in
2306Â /// your implementation of the Stream Manager (AK::IAkStreamMgr::CreateStd()), or in the Low-Level I/O module
2307Â /// (AK::StreamMgr::IAkLowLevelIOHook::BatchOpen()) if you use the default Stream Manager's implementation.
2308Â /// - The cookie (in_pCookie) is passed to the Low-Level I/O module for your convenience, in AK::StreamMgr::IAkLowLevelIOHook::BatchOpen()
2311Â /// When Wwise Authoring is connected to the game in "Profile And Edit (Sync All)" mode, LoadBank will succeed even if the file is not found.
2312Â /// This might be the case when sound banks were not generated, for example. The Capture Log will still report the missing file.
2328Â void * in_pCookie, ///AK::StreamMgr::IAkLowLevelIOHook::BatchOpen() as AkFileSystemFlags::pCustomParam)
2334Â /// \aknote Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings. \endaknote
2352Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2353Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2354Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2356Â /// - The file path should be resolved in your implementation of the Stream Manager, or in the Low-Level I/O module if
2357Â /// you use the default Stream Manager's implementation. The ID overload of AK::IAkStreamMgr::CreateStd() and AK::StreamMgr::IAkLowLevelIOHook::BatchOpen() are called.
2358Â /// - The cookie (in_pCookie) is passed to the Low-Level I/O module for your convenience, in AK::StreamMgr::IAkLowLevelIOHook::BatchOpen()
2361Â /// When Wwise Authoring is connected to the game in "Profile And Edit (Sync All)" mode, LoadBank will succeed even if the file is not found.
2362Â /// This might be the case when sound banks were not generated, for example. The Capture Log will still report the missing file.
2376Â void * in_pCookie, ///AK::StreamMgr::IAkLowLevelIOHook::BatchOpen() as AkFileSystemFlags::pCustomParam)
2382Â /// IMPORTANT: Banks loaded from memory with in-place data MUST be unloaded using the UnloadBank function
2383Â /// providing the same memory pointer. Make sure you are using the correct UnloadBank(...) overload
2387Â /// In-memory loading is in-place: *** the memory must be valid until the bank is unloaded. ***
2404Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2405Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2406Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2408Â /// - The memory must be aligned on platform-specific AK_BANK_PLATFORM_DATA_ALIGNMENT bytes (see AkTypes.h).
2409Â /// - Avoid using this function for banks containing a lot of events or structure data: this data will be unpacked into the sound engine heap,
2410Â /// making the supplied bank memory redundant. For event/structure-only banks, prefer LoadBankMemoryCopy().
2428Â /// IMPORTANT: Banks loaded from memory with in-place data MUST be unloaded using the UnloadBank function
2429Â /// providing the same memory pointer. Make sure you are using the correct UnloadBank(...) overload
2433Â /// In-memory loading is in-place: *** the memory must be valid until the bank is unloaded. ***
2449Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2450Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2451Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2453Â /// - The memory must be aligned on platform-specific AK_BANK_PLATFORM_DATA_ALIGNMENT bytes (see AkTypes.h).
2454Â /// - Avoid using this function for banks containing a lot of events or structure data: this data will be unpacked into the sound engine heap,
2455Â /// making the supplied bank memory redundant. For event/structure-only banks, prefer LoadBankMemoryCopy().
2474Â /// NOTE: Banks loaded from in-memory with out-of-place data must be unloaded using the standard UnloadBank function
2478Â /// in a buffer and pass its address to the sound engine, the media section of the bank will be copied into newly allocated
2480Â /// In-memory loading is out-of-place: the buffer can be released after the callback function is called. The advantage of using this
2498Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2499Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2500Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2519Â /// NOTE: Banks loaded from in-memory with out-of-place data must be unloaded using the standard UnloadBank function
2523Â /// in a buffer and pass its address to the sound engine, the media section of the bank will be copied into newly allocated
2525Â /// In-memory loading is out-of-place: the buffer can be released after the callback function is called. The advantage of using this
2543Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2544Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2545Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2566Â /// \return AK_Success if successful, AK_Fail otherwise. AK_Success is returned when the bank was not loaded.
2568Â /// - The sound engine internally calls GetIDFromString(in_pszString) to retrieve the bank ID,
2570Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2572Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2587Â /// \return AK_Success if successful, AK_Fail otherwise. AK_Success is returned when the bank was not loaded.
2589Â /// - The sound engine internally calls GetIDFromString(in_pszString) to retrieve the bank ID,
2591Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2593Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2606Â /// \return AK_Success if successful, AK_Fail otherwise. AK_Success is returned when the bank was not loaded.
2608Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2623Â /// \return AK_Success if scheduling successful (use a callback to be notified when completed)
2627Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2629Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2647Â /// \return AK_Success if scheduling successful (use a callback to be notified when completed)
2651Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2653Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2670Â /// \return AK_Success if scheduling successful (use a callback to be notified when completed)
2672Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2687Â /// Cancels all Event callbacks associated with a specific callback cookie specified while loading Banks of preparing Events.\n
2713Â /// 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.
2722Â };
2725Â /// 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
2726Â /// 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(),
2728Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2735Â /// \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
2736Â /// 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;
2737Â /// 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.
2746Â /// 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
2747Â /// 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(),
2749Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2756Â /// \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
2757Â /// 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;
2758Â /// 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.
2766Â /// \n\aknote Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings. \endaknote
2767Â /// 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
2768Â /// 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(),
2770Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2777Â /// \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
2778Â /// 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;
2779Â /// 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.
2788Â /// 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
2789Â /// 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(),
2791Â /// Calling this function specifying the flag \c AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2798Â /// \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
2799Â /// 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;
2800Â /// 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.
2811Â /// 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
2812Â /// 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(),
2814Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2821Â /// 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
2822Â /// 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;
2823Â /// 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.
2833Â /// \n\aknote Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings. \endaknote
2834Â /// 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
2835Â /// 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(),
2837Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2844Â /// \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
2845Â /// 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;
2846Â /// 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.
2859Â /// - \c AK_Fail if the sound engine was not correctly initialized or if there is not enough memory to handle the command.
2882Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareEvent() does not exist.
2889Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2893Â /// \aknote The use of \c PrepareEvent() is incompatible with \c LoadBank(), using in-memory data.
2923Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareEvent() does not exist.
2930Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2934Â /// \aknote The use of \c PrepareEvent() is incompatible with \c LoadBank(), using in-memory data.
2950Â /// The Events are identified by their ID (see \ref soundengine_banks_general for a discussion on using strings and IDs).
2962Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareEvent() does not exist.
2969Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2988Â /// The Events are identified by string (see \ref soundengine_banks_general for a discussion on using strings and IDs).
2997Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3020Â /// The Events are identified by string (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3029Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3051Â /// The Events are identified by their ID (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3060Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3152Â /// The Busses are identified by their ID (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3186Â /// The Busses are identified by string (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3191Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3213Â /// The Busses are identified by string (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3218Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3239Â /// The Busses are identified by their ID (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3244Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3265Â /// The sources are identified by their ID (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3266Â /// \return AK_Success if operation was successful, AK_InvalidParameter if in_pSourceSettings is invalid or media sizes are 0.
3272Â /// Removes the specified source from the list of loaded media, only if this media is not already in use.
3273Â /// The sources are identified by their ID (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3274Â /// \aknote Media that is still in use by the sound engine should not be unset. It is marked for removal to prevent additional use.
3275Â /// If this function returns AK_ResourceInUse, then the client must not release memory for this media.
3276Â /// Instead, the client should retry the TryUnsetMedia operation later with the same parameters and check for AK_Success.
3278Â /// 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.
3279Â /// out_pUnsetResults will be filled with either AK_Success or AK_ResourceInUse, indicating which media was still in use and not unset.
3281Â /// - \c AK_Success: Operation was successful, and the memory can be released on the client side.
3282Â /// - \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.
3292Â /// The group and game syncs are specified by string (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3301Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareGameSyncs() does not exist.
3308Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
3310Â /// You need to call PrepareGameSyncs() if the sound engine was initialized with AkInitSettings::bEnableGameSyncPreparation
3311Â /// set to true. When set to false, the sound engine automatically prepares all game syncs when preparing events,
3330Â /// The group and game syncs are specified by string (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3339Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareGameSyncs() does not exist.
3346Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
3348Â /// You need to call PrepareGameSyncs() if the sound engine was initialized with AkInitSettings::bEnableGameSyncPreparation
3349Â /// set to true. When set to false, the sound engine automatically prepares all game syncs when preparing events,
3367Â /// The group and game syncs are specified by ID (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3376Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareGameSyncs() does not exist.
3383Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
3385Â /// You need to call \c PrepareGameSyncs() if the sound engine was initialized with \c AkInitSettings::bEnableGameSyncPreparation
3386Â /// set to \c true. When set to \c false, the sound engine automatically prepares all game syncs when preparing Events,
3405Â /// The group and game syncs are specified by string (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3411Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3414Â /// You need to call \c PrepareGameSyncs() if the sound engine was initialized with \c AkInitSettings::bEnableGameSyncPreparation
3415Â /// set to \c true. When set to \c false, the sound engine automatically prepares all game syncs when preparing Events,
3437Â /// The group and game syncs are specified by string (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3443Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3446Â /// You need to call \c PrepareGameSyncs() if the sound engine was initialized with \c AkInitSettings::bEnableGameSyncPreparation
3447Â /// set to \c true. When set to \c false, the sound engine automatically prepares all game syncs when preparing events,
3468Â /// The group and game syncs are specified by ID (see \ref soundengine_banks_general for a discussion on using strings and IDs).
3474Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3477Â /// You need to call PrepareGameSyncs() if the sound engine was initialized with AkInitSettings::bEnableGameSyncPreparation
3478Â /// set to true. When set to false, the sound engine automatically prepares all Game Syncs when preparing Events,
3506Â /// 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.
3507Â /// Calling this function will override the default set of listeners and in_emitterGameObj will now reference its own, unique set of listeners.
3510Â /// - \c AK_CommandTooLarge if the number of positions is too large for the command queue. Reduce the number of positions.
3523Â /// 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.
3524Â /// Calling this function will override the default set of listeners and in_emitterGameObj will now reference its own, unique set of listeners.
3536Â /// Calling this function will override the default set of listeners and in_emitterGameObj will now reference its own, unique set of listeners.
3547Â /// 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
3548Â /// a call to AddListener, RemoveListener, SetListeners or SetGameObjectOutputBusVolume is made on that game object.
3549Â /// 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.
3558Â /// Add a single listener to the default set of listeners. Upon registration, all game objects reference the default listener set, until
3559Â /// a call to AddListener, RemoveListener, SetListeners or SetGameObjectOutputBusVolume is made on that game object.
3568Â /// Remove a single listener from the default set of listeners. Upon registration, all game objects reference the default listener set, until
3569Â /// a call to AddListener, RemoveListener, SetListeners or SetGameObjectOutputBusVolume is made on that game object.
3578Â /// 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.
3591Â /// If \c in_bSpatialized is false, only \c in_pVolumeOffsets is used for this listener (3D positions
3592Â /// have no effect on the speaker distribution). Otherwise, \c in_pVolumeOffsets is added to the speaker
3594Â /// Use helper functions of \c AK::SpeakerVolumes to manipulate the vector of volume offsets in_pVolumeOffsets.
3597Â /// - If a sound is mixed into a bus that has a different speaker configuration than in_channelConfig,
3621Â /// With this function, you may set a game parameter value with global scope or with game object scope.
3622Â /// 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
3623Â /// game objects that not yet registered, or already registered but not overridden with a value with game object scope.
3624Â /// To set a game parameter value with global scope, pass \c AK_INVALID_GAME_OBJECT as the game object.
3625Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3626Â /// value for \c in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3627Â /// according to the interpolation curve. If you call SetRTPCValue() with in_uValueChangeDuration = 0 in the
3628Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3629Â /// function at every game frame, you should not use \c in_uValueChangeDuration, as it would have no effect and it is less efficient.
3650Â /// With this function, you may set a game parameter value to global scope or to game object scope.
3651Â /// 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
3652Â /// game objects that not yet registered, or already registered but not overridden with a value with game object scope.
3653Â /// To set a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3654Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3655Â /// value for \c in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3656Â /// according to the interpolation curve. If you call SetRTPCValue() with in_uValueChangeDuration = 0 in the
3657Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3658Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3679Â /// With this function, you may set a game parameter value with global scope or with game object scope.
3680Â /// 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
3681Â /// game objects that not yet registered, or already registered but not overridden with a value with game object scope.
3682Â /// To set a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3683Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3684Â /// value for \c in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3685Â /// according to the interpolation curve. If you call SetRTPCValue() with in_uValueChangeDuration = 0 in the
3686Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3687Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3709Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3710Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3711Â /// according to the interpolation curve. If you call SetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3712Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3713Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3736Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3737Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3738Â /// according to the interpolation curve. If you call SetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3739Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3740Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3763Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3764Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3765Â /// according to the interpolation curve. If you call SetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3766Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3767Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3786Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3787Â /// With this function, you may reset a game parameter to its default value with global scope or with game object scope.
3788Â /// Game object scope supersedes global scope. Game parameter values reset with global scope are applied to all
3790Â /// To reset a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3791Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3792Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3793Â /// according to the interpolation curve. If you call SetRTPCValue() or ResetRTPCValue() with in_uValueChangeDuration = 0 in the
3813Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3814Â /// With this function, you may reset a game parameter to its default value with global scope or with game object scope.
3815Â /// Game object scope supersedes global scope. Game parameter values reset with global scope are applied to all
3817Â /// To reset a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3818Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3819Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3820Â /// according to the interpolation curve. If you call SetRTPCValue() or ResetRTPCValue() with in_uValueChangeDuration = 0 in the
3840Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3841Â /// With this function, you may reset a game parameter to its default value with global scope or with game object scope.
3842Â /// Game object scope supersedes global scope. Game parameter values reset with global scope are applied to all
3844Â /// To reset a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3845Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3846Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3847Â /// according to the interpolation curve. If you call SetRTPCValue() or ResetRTPCValue() with in_uValueChangeDuration = 0 in the
3866Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3867Â /// With this function, you may reset a game parameter to its default value on playing id scope.
3869Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3870Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3872Â /// If you call SetRTPCValueByPlayingID() or ReetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3891Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3892Â /// With this function, you may reset a game parameter to its default value on playing id scope.
3894Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3895Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3897Â /// If you call SetRTPCValueByPlayingID() or ReetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3903Â /// - \c AK_InvalidID if in_playingID is AK_INVALID_PLAYING_ID (0) or if if in_pszParamName is NULL.
3918Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3919Â /// With this function, you may reset a game parameter to its default value on playing id scope.
3921Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3922Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3924Â /// If you call SetRTPCValueByPlayingID() or ReetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3930Â /// - \c AK_InvalidID if in_playingID is AK_INVALID_PLAYING_ID (0) or if if in_pszParamName is NULL.
4088Â /// Registers a callback to allow the game to modify or override the volume to be applied at the output of an audio bus.
4092Â /// \aknote The callback function will not be called for the Main Audio Bus, since the output of this bus is not a bus, but is instead an Audio Device.\endaknote
4110Â /// 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
4111Â /// 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.
4131Â /// 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
4132Â /// 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.
4153Â /// 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
4154Â /// 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.
4176Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's effect will
4196Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's effect will
4212Â /// \aknote This function has unspecified behavior when adding an Effect to a currently playing
4213Â /// Bus which does not have any Effects, or removing the last Effect on a currently playing bus.
4215Â /// \aknote This function will replace existing Effects on the node. If the target node is not at
4216Â /// the top of the hierarchy and is in the Containers hierarchy, the option "Override Parent" in
4217Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's Effect will
4237Â /// \aknote This function has unspecified behavior when adding an Effect to a currently playing
4238Â /// bus which does not have any Effects, or removing the last Effect on a currently playing Bus.
4240Â /// \aknote Make sure the new effect shareset is included in a soundbank, and that sound bank is
4243Â /// \aknote This function will replace existing Effects on the node. If the target node is not at
4245Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's Effect will
4266Â /// \aknote This function has unspecified behavior when adding an Effect to a currently playing
4267Â /// Bus which does not have any effects, or removing the last Effect on a currently playing bus.
4269Â /// \aknote Make sure the new effect shareset is included in a soundbank, and that sound bank is
4272Â /// \aknote This function will replace existing Effects on the node. If the target node is not at
4274Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's Effect will
4288Â /// Sets an audio device effect shareset on the specified output device and effect slot index.
4292Â /// \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
4293Â /// \aknote This function will replace existing effects of the audio device shareset. \endaknote
4294Â /// \aknote Audio device effects support is limited to one shareset per plug-in type at any time. \endaknote
4295Â /// \aknote Errors are reported in the Wwise Capture Log if the effect cannot be set on the output device. \endaknote
4337Â /// Resets the channel configuration for the specified bus back to the value loaded from soundbanks.
4347Â /// Resets the channel configuration for the specified bus back to the value loaded from soundbanks.
4359Â /// Resets the channel configuration for the specified bus back to the value loaded from soundbanks.
4373Â /// If a channel config of type AK_ChannelConfigType_UseDeviceMain or AK_ChannelConfigType_UseDevicePassthrough are specified,
4374Â /// then the Primary Device's channel config for its Main Mix or Passthrough Mix is used, as appropriate.
4377Â /// An invalid channel configuration (from default constructor) can be used to clear any previously-set config set via the soundengine API, and revert to what was loaded from soundbanks.
4389Â /// If a channel config of type AK_ChannelConfigType_UseDeviceMain or AK_ChannelConfigType_UseDevicePassthrough are specified,
4390Â /// then the Primary Device's channel config for its Main Mix or Passthrough Mix is used, as appropriate.
4393Â /// An invalid channel configuration (from default constructor) can be used to clear any previously-set config set via the soundengine API, and revert to what was loaded from soundbanks.
4407Â /// If a channel config of type AK_ChannelConfigType_UseDeviceMain or AK_ChannelConfigType_UseDevicePassthrough are specified,
4408Â /// then the Primary Device's channel config for its Main Mix or Passthrough Mix is used, as appropriate.
4411Â /// An invalid channel configuration (from default constructor) can be used to clear any previously-set config set via the soundengine API, and revert to what was loaded from soundbanks.
4421Â /// Sets a game object's obstruction and occlusion levels. If SetMultiplePositions were used, values are set for all positions.
4422Â /// To assign a unique obstruction and occlusion value to each sound position, instead use AK::SoundEngine::SetMultipleObstructionAndOcclusion.
4435Â /// Sets a game object's obstruction and occlusion value for each position defined by AK::SoundEngine::SetMultiplePositions.
4436Â /// This function differs from AK::SoundEngine::SetObjectObstructionAndOcclusion as a list of obstruction/occlusion pair is provided
4437Â /// and each obstruction/occlusion pair will affect the corresponding position defined at the same index.
4438Â /// \aknote In the case the number of obstruction/occlusion pairs is smaller than the number of positions, remaining positions'
4442Â /// - \c AK_CommandTooLarge if the number of obstruction values is too large for the command queue.
4443Â /// - \c AK_InvalidParameter if one of the parameter is out of range (check the debug console)
4448Â /// \return AK_Success if occlusion/obstruction values are successfully stored for this emitter
4459Â /// This function will write history data for all currently loaded containers and instantiated game
4460Â /// objects (for example, current position in Sequence Containers and previously played elements in
4463Â /// This function acquires the main audio lock, and may block the caller for several milliseconds.
4474Â /// This function will read history data from the passed-in stream reader interface, and apply it to all
4478Â /// This function acquires the main audio lock, and may block the caller for several milliseconds.
4496Â /// If more than one device is active, the system will create multiple files in the same output
4499Â /// If no device is running yet, the system will return success AK_Success despite doing nothing.
4500Â /// Use RegisterAudioDeviceStatusCallback to get notified when devices are created/destructed.
4502Â /// \return AK_Success if successful, AK_Fail if there was a problem starting the output capture.
4504Â /// - The sound engine opens a stream for writing using AK::IAkStreamMgr::CreateStd(). If you are using the
4505Â /// default implementation of the Stream Manager, file opening is executed in your implementation of
4507Â /// AkFileSystemFlags are passed: uCompanyID = AKCOMPANYID_AUDIOKINETIC and uCodecID = AKCODECID_PCM,
4508Â /// and the AkOpenMode is AK_OpenModeWriteOvrwr. See \ref streamingmanager_lowlevel_location for
4525Â /// \return AK_Success if successful, AK_Fail if there was a problem stopping the output capture.
4560Â /// The callback will be called from the audio thread during real-time rendering and from the main thread during offline rendering.
4592Â /// Starts recording the sound engine profiling information into a file. This file can be read
4593Â /// by Wwise Authoring. The file is created at the base path. If you have integrated Wwise I/O,
4594Â /// you can use CAkDefaultIOHookDeferred::SetBasePath() (or CAkDefaultIOHookDeferred::AddBasePath())
4595Â /// to change the location where the file is saved. The profiling session records all data types possible.
4616Â /// 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.
4638Â /// Adds an output to the sound engine. Use this to add controller-attached headphones, controller speakers, DVR output, etc.
4639Â /// 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).
4641Â /// Like most functions of AK::SoundEngine, AddOutput is asynchronous. A successful return code merely indicates that the request is properly queued.
4642Â /// Error codes returned by this function indicate various invalid parameters. To know if this function succeeds or not, and the failure code,
4651Â /// The following codes are returned directly from the function, as opposed to the AkDeviceStatusCallback
4653Â /// - \c AK_InvalidParameter: Out of range parameters or unsupported parameter combinations (see parameter list below).
4654Â /// - \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.
4655Â /// - \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.
4656Â /// - \c AK_NotInitialized: If AK::SoundEngine::Init was not called or if the Init.bnk was not loaded before the call.
4661Â /// - \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.
4662Â /// - \c AK_PluginNotRegistered: The audioDeviceShareset exists but the plug-in it refers to is not installed or statically linked with the game.
4663Â /// - \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.
4664Â /// - \c AK_DeviceNotCompatible: The hardware does not support this type of output. Wwise will NOT fallback to any other type of output.
4665Â /// - \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.
4666Â /// - \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.
4678Â /// If a listener was associated with the device, you should consider unregistering the listener prior to call RemoveOutput
4687Â /// Replaces an output device previously created during engine initialization or from AddOutput, with a new output device.
4688Â /// 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
4689Â /// that the old output device was associated with, and preserve all listeners that were attached to the old output device.
4691Â /// Like most functions of AK::SoundEngine, AddOutput is asynchronous. A successful return code merely indicates that the request is properly queued.
4692Â /// Error codes returned by this function indicate various invalid parameters. To know if this function succeeds or not, and the failure code,
4700Â /// - \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.
4701Â /// - \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.
4702Â /// - \c AK_DeviceNotFound: The in_outputDeviceId provided does not match with any of the output devices that the sound engine is currently using.
4703Â /// - \c AK_InvalidParameter: Out of range parameters or unsupported parameter combinations on in_settings
4712Â /// 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.
4713Â /// Use 0 for in_idShareset & in_idDevice to get the Main Output ID (the one usually initialized during AK::SoundEngine::Init)
4735Â /// Sets the Audio Device to which a master bus outputs. This overrides the setting in the Wwise project.
4736Â /// Can only be set on top-level busses. The Init bank should be successfully loaded prior to this call.
4737Â /// \aknote This function is useful only if used before the creation of an output, at the beginning of the sound engine setup.
4738Â /// Once active outputs using this Bus have been created, it is imperative to use AK::SoundEngine:ReplaceOutput instead to change the type of output.
4740Â /// AK_IDNotFound when either the Bus ID or the Device ID are not present in the Init bank or the bank was not loaded
4741Â /// AK_InvalidParameter when the specified bus is not a Master Bus. This function can be called only on busses that have no parent bus.
4747Â /// Sets the Audio Device to which a master bus outputs. This overrides the setting in the Wwise project.
4748Â /// Can only be set on top-level busses. The Init bank should be successfully loaded prior to this call.
4749Â /// \aknote This function is useful only if used before the creation of an output, at the beginning of the sound engine setup.
4750Â /// Once active outputs using this Bus have been created, it is imperative to use AK::SoundEngine:ReplaceOutput instead to change the type of output.
4752Â /// AK_IDNotFound when either the Bus ID or the Device ID are not present in the Init bank or the bank was not loaded
4753Â /// AK_InvalidParameter when the specified bus is not a Master Bus. This function can be called only on busses that have no parent bus.
4760Â /// Sets the Audio Device to which a master bus outputs. This overrides the setting in the Wwise project.
4761Â /// Can only be set on top-level busses. The Init bank should be successfully loaded prior to this call.
4762Â /// SetBusDevice must be preceded by a call to AddOutput for the new device shareset to be registered as an output.
4764Â /// AK_IDNotFound when either the Bus ID or the Device ID are not present in the Init bank or the bank was not loaded
4765Â /// AK_InvalidParameter when the specified bus is not a Master Bus. This function can be called only on busses that have no parent bus.
4772Â /// Returns a listing of the current devices for a given sink plug-in, including Device ID, friendly name, and state.
4776Â /// * The plug-in must have been initialized by loading the init bank or by calling \ref AK::SoundEngine::RegisterPlugin.
4779Â /// The built-in audio devices (System, Communication, Headphones, Personal, Pad Speaker) all support enumeration, on all platforms.
4780Â /// The only Wwise plug-in that support device enumeration is Motion, for the Windows platform only.
4784Â /// - \c AK_PluginNotRegistered if the plug-in has not been registered yet either by loading the init bank or by calling RegisterPluginDLL.
4795Â /// Returns a listing of the current devices for a given sink plug-in, including Device ID, friendly name, and state.
4799Â /// * The plug-in must have been initialized by loading the init bank or by calling \ref AK::SoundEngine::RegisterPlugin.
4800Â /// * 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.
4802Â /// The built-in audio devices (System, Communication, Headphones, Personal, Pad Speaker) all support enumeration, on all platforms.
4803Â /// The only Wwise plug-in that support device enumeration is Motion, for the Windows platform only.
4807Â /// AK_PluginNotRegistered if the plug-in has not been registered yet either by loading the init bank or by calling RegisterPluginDLL.
4823Â /// 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).
4824Â /// 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
4825Â /// 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
4826Â /// 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.
4828Â /// AK_NotCompatible when the device ID provided does not support spatial audio, or the platform does not support spatial audio
4829Â /// AK_Fail when there is some other miscellaneous failure, or the device ID provided does not match a device that the system knows about
4839Â /// 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.
4840Â /// Call \c WakeupFromSuspend when your application receives the message from the OS that the process is back in foreground.
4841Â /// When suspended, the sound engine will process API messages (like PostEvent and SetSwitch) only when \ref RenderAudio() is called.
4842Â /// It is recommended to match the in_bRenderAnyway parameter with the behavior of the rest of your game:
4843Â /// 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.
4844Â /// If you want to minimize CPU when in background, then don't allow rendering and never call RenderAudio from the game.
4846Â /// Consult \ref workingwithsdks_system_calls to learn when it is appropriate to call this function for each platform.
4854Â /// 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.
4856Â /// Consult \ref workingwithsdks_system_calls to learn when it is appropriate to call this function for each platform.
4860Â 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.
4863Â /// Obtains the current audio output buffer tick. This corresponds to the number of buffers produced by
4868Â /// Obtains the current audio output sample tick. This corresponds to the number of samples produced by
4877Â /// - Changes made on sound object by Event Actions like Set Volume, Set Pitch, etc or equivalent API calls.
4882Â /// To reset Game Object specific values, use AK::SoundEngine::UnregisterGameObj or AK::SoundEngine::UnregisterAllGameObj
4887Â /// The assertion hook can be set via this function prior to Sound Engine initialization in order to catch early initialization assertion failures.
4888Â /// However, during Sound Engine initialization, the assertion handler is replaced with the value of AkInitSettings:pfnAssertHook.
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:205
AKSOUNDENGINE_API AKRESULT GetPlayingSegmentInfo(AkPlayingID in_PlayingID, AkSegmentInfo &out_segmentInfo, bool in_bExtrapolate=true)
void(* AkBankCallbackFunc)(AkUInt32 in_bankID, const void *in_pInMemoryBankPtr, enum AKRESULT in_eLoadResult, void *in_pCookie)
Definition: AkCallbackTypes.h:388
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()
AKSOUNDENGINE_API void ProcessBanks()
void(* AkProfilerPostMarkerFunc)(AkPluginID in_uPluginID, const char *in_pszMarkerName)
Definition: AkSoundEngine.h:182
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)
AkBackgroundMusicChangeCallbackFunc BGMCallback
Application-defined audio source change event callback function.
Definition: AkSoundEngine.h:216
Auxiliary bus sends information per game object per given auxiliary bus.
Definition: AkSoundEngineTypes.h:107
Definition: AkSoundEngineTypes.h:77
AKSOUNDENGINE_API void ExecuteActionOnPlayingID(AkActionOnEventType in_ActionType, AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
Obstruction/occlusion pair for a position.
Definition: AkSoundEngineTypes.h:100
AKSOUNDENGINE_API AKRESULT LoadBankMemoryView(const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankID &out_bankID)
void(* AkCaptureCallbackFunc)(AkAudioBuffer &in_CaptureBuffer, AkOutputDeviceID in_idOutput, void *in_pCookie)
Definition: AkCallbackTypes.h:454
void(* AkBusMeteringCallbackFunc)(AkBusMeteringCallbackInfo *in_pCallbackInfo)
Definition: AkCallbackTypes.h:431
AKSOUNDENGINE_API AKRESULT AddOutputCaptureBinaryMarker(void *in_pMarkerData, AkUInt32 in_uMarkerDataSize, AkUInt32 in_uSamplePos=AK_INVALID_SAMPLE_POS)
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(* AkJobWorkerFunc)(AkJobType in_jobType, AkUInt32 in_uExecutionTimeUsec)
Definition: AkSoundEngine.h:142
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:2719
AkMeteringFlags
Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback(...
Definition: AkEnums.h:265
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:238
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:203
Definition: AkAndroidSoundEngine.h:83
const ::AkActionOnEventType AkActionOnEventType_Resume
Definition: AkSoundEngine.h:854
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:130
AkReal32 fDebugOutOfRangeLimit
Debug setting: Only used when bDebugOutOfRangeCheckEnabled is true. This defines the maximum values s...
Definition: AkSoundEngine.h:231
Definition: AkSpeakerConfig.h:436
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:257
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:1407
AKSOUNDENGINE_API AKRESULT RegisterGameObj(AkGameObjectID in_gameObjectID)
@ Preparation_LoadAndDecode
Vorbis media is decoded when loading, and an uncompressed PCM version is used for playback.
Definition: AkSoundEngine.h:2707
AKSOUNDENGINE_API AKRESULT GetContainerHistory(AK::IWriteBytes *in_pBytes)
const ::AkActionOnEventType AkActionOnEventType_Pause
Definition: AkSoundEngine.h:853
const ::AkActionOnEventType AkActionOnEventType_Stop
Definition: AkSoundEngine.h:852
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)
Structure used to query info on active playing segments.
Definition: AkCallbackTypes.h:142
Platform-independent initialization settings of output devices.
Definition: AkSoundEngineTypes.h:219
AKSOUNDENGINE_API bool IsInitialized()
@ Preparation_Unload
PrepareEvent() will unload required information to play the specified event.
Definition: AkSoundEngine.h:2706
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkConstants.h:33
@ AkBankContent_All
Use AkBankContent_All to load both the media and structural content.
Definition: AkSoundEngine.h:2720
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:256
AKSOUNDENGINE_API AKRESULT SetOutputVolume(AkOutputDeviceID in_idOutput, AkReal32 in_fVolume)
AKSOUNDENGINE_API AKRESULT GetPanningRule(AkPanningRule &out_ePanningRule, AkOutputDeviceID in_idOutput=0)
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 RegisterAudioDeviceStatusCallback(AK::AkDeviceStatusCallbackFunc in_pCallback)
void(* AkResourceMonitorCallbackFunc)(const struct AkResourceMonitorDataSummary *in_pdataSummary)
Definition: AkCallbackTypes.h:409
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)
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:158
AKSOUNDENGINE_API AKRESULT SetActorMixerEffect(AkUniqueID in_audioNodeID, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
AKSOUNDENGINE_API AKRESULT RegisterCodec(AkUInt32 in_ulCompanyID, AkUInt32 in_ulCodecID, AkCreateFileSourceCallback in_pFileCreateFunc, AkCreateBankSourceCallback in_pBankCreateFunc)
bool bUseLEngineThread
Use a Wwise-owned thread for processing audio. If set to false, audio processing will occur only insi...
Definition: AkSoundEngine.h:214
void(* AkOutputDeviceMeteringCallbackFunc)(AkOutputDeviceMeteringCallbackInfo *in_pCallbackInfo)
Definition: AkCallbackTypes.h:441
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)
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:160
AKSOUNDENGINE_API AKRESULT DecodeBank(const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkMemPoolId in_uPoolForDecodedBank, void *&out_pDecodedBankPtr, AkUInt32 &out_uDecodedBankSize)
Definition: AkSoundEngineTypes.h:128
const ::AkActionOnEventType AkActionOnEventType_Break
Definition: AkSoundEngine.h:855
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:177
@ AkFloorPlane_XZ
The floor is oriented along the ZX-plane. The front vector points towards +Z, the up vector towards +...
Definition: AkSoundEngine.h:129
AkUInt32 uContinuousPlaybackLookAhead
Default is 1 audio quantum, also known as an audio frame. Its size is equal to AkInitSettings::uNumSa...
Definition: AkSoundEngine.h:199
AKSOUNDENGINE_API AKRESULT RemoveOutput(AkOutputDeviceID in_idOutput)
bool bEnableGameSyncPreparation
Sets to true to enable AK::SoundEngine::PrepareGameSync usage.
Definition: AkSoundEngine.h:198
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:165
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:194
AKSOUNDENGINE_API AKRESULT SetSidechainMixConfig(AkUniqueID in_sidechainMixId, AkChannelConfig in_channelConfig)
Necessary settings for setting externally-loaded sources.
Definition: AkSoundEngine.h:244
AkUInt32 uMemorySlabSize
Size of each memory slab used for job manager memory. Must be a power of two. Default is 8K.
Definition: AkSoundEngine.h:163
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:211
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:2705
const ::AkActionOnEventType AkActionOnEventType_ReleaseEnvelope
Definition: AkSoundEngine.h:856
AKSOUNDENGINE_API AKRESULT UnregisterGameObj(AkGameObjectID in_gameObjectID)
AKSOUNDENGINE_API AKRESULT SetJobMgrMaxActiveWorkers(AkJobType in_jobType, AkUInt32 in_uNewMaxActiveWorkers)
@ AkMultiPositionType_MultiDirections
Simulate one sound coming from multiple directions. Useful for repositionning sounds based on wall op...
Definition: AkEnums.h:319
AKSOUNDENGINE_API AKRESULT SetContainerEffect(AkUniqueID in_audioNodeID, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
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:209
Positioning information for a sound, with specified subset of its channels.
Definition: Ak3DObjects.h:390
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)
AKSOUNDENGINE_API AKRESULT SetMultiplePositions(AkGameObjectID in_GameObjectID, const AkSoundPosition *in_pPositions, AkUInt16 in_NumPositions, AkMultiPositionType in_eMultiPositionType=AkMultiPositionType_MultiDirections, AkSetPositionFlags in_eFlags=AkSetPositionFlags_Default)
Settings for the Sound Engine's internal job manager.
Definition: AkSoundEngine.h:149
AKSOUNDENGINE_API AkPlayingID PostMIDIOnEvent(AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkMIDIPost *in_pPosts, AkUInt16 in_uNumPosts, bool in_bAbsoluteOffsets=false, AkUInt32 in_uFlags=0, AkCallbackFunc in_pfnCallback=NULL, void *in_pCookie=NULL, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID)
AKSOUNDENGINE_API AKRESULT ResetBusConfig(AkUniqueID in_audioNodeID)
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 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:247
AKSOUNDENGINE_API AKRESULT UnloadBank(const char *in_pszString, const void *in_pInMemoryBankPtr, AkBankType in_bankType=AkBankType_User)
AKSOUNDENGINE_API AKRESULT AddOutputCaptureMarker(const char *in_MarkerText, AkUInt32 in_uSamplePos=AK_INVALID_SAMPLE_POS)
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:218
Definition: IAkPlugin.h:1442
AkUInt32 uNumMemorySlabs
Number of memory slabs to pre-allocate for job manager memory. At least one slab per worker thread sh...
Definition: AkSoundEngine.h:162
AKSOUNDENGINE_API void GetDefaultPlatformInitSettings(AkPlatformInitSettings &out_platformSettings)
AKSOUNDENGINE_API AKRESULT TryUnsetMedia(AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings, AKRESULT *out_pUnsetResults)
@ AkGlobalCallbackLocation_BeginRender
Start of frame rendering, after having processed game messages.
Definition: AkCallbackTypes.h:116
AKSOUNDENGINE_API AKRESULT GetSourcePlayPosition(AkPlayingID in_PlayingID, AkTimeMs *out_puPosition, bool in_bExtrapolate=true)
Definition: IBytes.h:111
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 ResetGlobalValues()
AKSOUNDENGINE_API AKRESULT SetBusEffect(AkUniqueID in_audioNodeID, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
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 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)
AkSetPositionFlags
Flags to independently set the position of the emitter or listener component on a game object.
Definition: AkEnums.h:327
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)
static const AkUInt32 AK_NUM_JOB_TYPES
Number of possible job types recognized by the Sound Engine.
Definition: AkConstants.h:70
Definition: AkSoundEngineTypes.h:57
AKSOUNDENGINE_API AKRESULT SetAssertHook(AkAssertHook in_pfnAssertHook)
void(* AkGlobalCallbackFunc)(AkGlobalPluginContextPtr in_pContext, enum AkGlobalCallbackLocation in_eLocation, void *in_pCookie)
Definition: AkCallbackTypes.h:402
AKSOUNDENGINE_API AKRESULT StopOutputCapture()
AKSOUNDENGINE_API AKRESULT SetSpeakerAngles(const AkReal32 *in_pfSpeakerAngles, AkUInt32 in_uNumAngles, AkReal32 in_fHeightAngle=AK_DEFAULT_HEIGHT_ANGLE, AkOutputDeviceID in_idOutput=0)
AkUInt32 uCpuMonitorQueueMaxSize
Maximum size of the CPU monitoring queue, per thread, in bytes. This parameter is not used in Release...
Definition: AkSoundEngine.h:206
AK::IAkPluginParam *(* AkCreateParamCallback)(AK::IAkPluginMemAlloc *in_pAllocator)
Registered plugin parameter node creation function prototype.
Definition: IAkPlugin.h:1405
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)
bool bOfflineRendering
Enables/disables offline rendering. Offline Rendering with Wwise.
Definition: AkSoundEngine.h:235
AKSOUNDENGINE_API AKRESULT SendPluginCustomGameData(AkUniqueID in_busID, AkGameObjectID in_gameObjectID, AkPluginType in_eType, AkUInt32 in_uCompanyID, AkUInt32 in_uPluginID, const void *in_pData, AkUInt32 in_uSizeInBytes)
AKSOUNDENGINE_API AKRESULT SetMedia(AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings)
AKSOUNDENGINE_API void CancelBankCallbackCookie(void *in_pCookie)
const ::AkActionOnEventType AkActionOnEventType_Last
Definition: AkSoundEngine.h:857
@ AkFloorPlane_YZ
The floor is oriented along the YZ-plane. The front vector points towards +Y, the up vector towards +...
Definition: AkSoundEngine.h:131
AkTimeMs msTime
Position of the source (in ms) associated with that playing item.
Definition: AkSoundEngine.h:255
void * BGMCallbackCookie
Application-defined user data for the audio source change event callback function.
Definition: AkSoundEngine.h:217
void(* AkBusCallbackFunc)(struct AkSpeakerVolumeMatrixCallbackInfo *in_pCallbackInfo, void *in_pCookie)
Definition: AkCallbackTypes.h:357
@ AkSetPositionFlags_Default
Default: set both emitter and listener component positions.
Definition: AkEnums.h:331
AkUniqueID sourceID
Source ID (available in the SoundBank content files)
Definition: AkSoundEngine.h:245
bool bUseSoundBankMgrThread
Use a Wwise-owned thread for loading sound banks. If set to false, bank-loading will occur only insid...
Definition: AkSoundEngine.h:213
AkUniqueID mediaID
Media ID of playing item. (corresponds to 'ID' attribute of 'File' element in SoundBank metadata file...
Definition: AkSoundEngine.h:254
Definition: AkMidiTypes.h:235
bool bDebugOutOfRangeCheckEnabled
Debug setting: Enable checks for out-of-range (and NAN) floats in the processing code....
Definition: AkSoundEngine.h:233
Definition: AkSoundEngine.h:193
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:239
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:1403
AKSOUNDENGINE_API AKRESULT PrepareBus(PreparationType in_PreparationType, const char **in_ppszString, AkUInt32 in_uBusses)
AKSOUNDENGINE_API AkUInt64 GetSampleTick()
AKSOUNDENGINE_API AK::IAkGlobalPluginContext * GetGlobalPluginContext()
AkReal32 fStreamingLookAheadRatio
Multiplication factor for all streaming look-ahead heuristic values, for music streams.
Definition: AkSoundEngine.h:201
IAkSoftwareCodec *(* AkCreateBankSourceCallback)(void *in_pCtx)
Registered bank source node creation function prototype.
Definition: AkSoundEngineTypes.h:265
AKSOUNDENGINE_API AKRESULT SetBusConfig(AkUniqueID in_audioNodeID, AkChannelConfig in_channelConfig)
AKSOUNDENGINE_API bool GetBackgroundMusicMute()
AkUInt32 AkPlayingID
A unique identifier generated whenever a PostEvent is called (or when a Dynamic Sequence is created)....
Definition: AkTypedefs.h:34
void(* AkProfilerPushTimerFunc)(AkPluginID in_uPluginID, const char *in_pszZoneName)
Definition: AkSoundEngine.h:171
AkProfilerPushTimerFunc fnProfilerPushTimer
External (optional) function for tracking performance of the sound engine that is called when a timer...
Definition: AkSoundEngine.h:237
AKSOUNDENGINE_API void StopPlayingID(AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
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:151
IAkSoftwareCodec *(* AkCreateFileSourceCallback)(void *in_pCtx)
Registered file source creation function prototype.
Definition: AkSoundEngineTypes.h:263
AkUInt32 uBankReadBufferSize
The number of bytes read by the BankReader when new data needs to be loaded from disk during serializ...
Definition: AkSoundEngine.h:229
AKSOUNDENGINE_API AKRESULT RemoveListener(AkGameObjectID in_emitterGameObj, AkGameObjectID in_listenerGameObj)
void(* AkDeviceStatusCallbackFunc)(AkGlobalPluginContextPtr in_pContext, AkUniqueID in_idAudioDeviceShareset, AkUInt32 in_idDeviceID, enum AkAudioDeviceEvent in_idEvent, enum AKRESULT in_AkResult)
Definition: AkCallbackTypes.h:415
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