Wwise SDK
_ak_sound_engine_8h_source
Version
menu_open
|
Wwise SDK 2022.1.15
|
AkSoundEngine.h
Go to the documentation of this file.
126Â bool in_bBackgroundMusicMuted, ///< Flag indicating whether the busses tagged as "background music" in the project are muted or not.
139Â AkOutputSettings(const char* in_szDeviceShareSet, AkUniqueID in_idDevice = AK_INVALID_UNIQUE_ID, AkChannelConfig in_channelConfig = AkChannelConfig(), AkPanningRule in_ePanning = AkPanningRule_Speakers);
142Â AkOutputSettings(const wchar_t* in_szDeviceShareSet, AkUniqueID in_idDevice = AK_INVALID_UNIQUE_ID, AkChannelConfig in_channelConfig = AkChannelConfig(), AkPanningRule in_ePanning = AkPanningRule_Speakers);
145Â AkUniqueID audioDeviceShareset; ///< Unique ID of a custom audio device to be used. Custom audio devices are defined in the Audio Device Shareset section of the Wwise project.
146Â ///< If you want to output normally through the output device defined on the Master Bus in your project, leave this field to its default value (AK_INVALID_UNIQUE_ID, or value 0).
147Â ///< Typical usage: AkInitSettings.eOutputSettings.audioDeviceShareset = AK::SoundEngine::GetIDFromString("InsertYourAudioDeviceSharesetNameHere");
153Â AkUInt32 idDevice; ///< Device specific identifier, when multiple devices of the same type are possible. If only one device is possible, leave to 0.
156Â AkPanningRule ePanningRule; ///< Rule for 3D panning of signals routed to a stereo bus. In AkPanningRule_Speakers mode, the angle of the front loudspeakers
157Â ///< (uSpeakerAngles[0]) is used. In AkPanningRule_Headphones mode, the speaker angles are superseded by constant power panning
160Â AkChannelConfig channelConfig; ///< Channel configuration for this output. Call AkChannelConfig::Clear() to let the engine use the default output configuration.
164Â /// 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.
165Â /// AkFloorPlane is used in to orient the Game Object 3D Viewer in Wwise, and in the transformation of geometry instances in Wwise Spatial Audio.
168Â AkFloorPlane_XZ = 0, ///< The floor is oriented along the ZX-plane. The front vector points towards +Z, the up vector towards +Y, and the side vector towards +X.
169Â AkFloorPlane_XY, ///< The floor is oriented along the XY-plane. The front vector points towards +X, the up vector towards +Z, and the side vector towards +Y.
170Â AkFloorPlane_YZ, ///< The floor is oriented along the YZ-plane. The front vector points towards +Y, the up vector towards +X, and the side vector towards +Z.
172Â };
176Â // in_uExecutionTimeUsec is the number of microseconds that the function should execute for before terminating.
177Â // Note that the deadline is only checked after each individual job completes execution, so the function may run slightly
178Â // longer than intended. The "in_uExecutionTimeUsec" should be considered a suggestion or guideline, not a strict rule.
179Â // A value of 0 means that the function will run until there are no more jobs ready to be immediately executed.
188Â /// Callback function prototype definition used for handling requests from JobMgr for new workers to perform work.
190Â AkJobWorkerFunc in_fnJobWorker, ///< Function passed to host runtime that should be executed. Note that the function provided will exist for as long as the soundengine code is loaded, and will always be the same.
191Â AkJobType in_jobType, ///< The type of job worker that has been requested. This should be passed forward to in_fnJobWorker
196Â FuncRequestJobWorker fnRequestJobWorker; ///< Function called by the job manager when a new worker needs to be requested. When null, all jobs will be executed on the same thread that calls RenderAudio().
198Â AkUInt32 uMaxActiveWorkers[AK_NUM_JOB_TYPES]; ///< The maximum number of concurrent workers that will be requested. Must be >= 1 for each jobType.
200Â AkUInt32 uNumMemorySlabs; ///< Number of memory slabs to pre-allocate for job manager memory. At least one slab per worker thread should be pre-allocated. Default is 1.
201Â AkUInt32 uMemorySlabSize; ///< Size of each memory slab used for job manager memory. Must be a power of two. Default is 8K.
203Â void* pClientData; ///< Arbitrary data that will be passed back to the client when calling FuncRequestJobWorker
206Â /// 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)
207Â /// in_uPluginID may be non-zero when this function is called, to provide extra data about what context this Timer was started in.
208Â /// 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.
214Â /// 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)
217Â ///< External (optional) function for tracking notable events in the sound engine, to act as a marker or bookmark. (only called in Debug and Profile binaries; this is not called in Release)
218Â /// in_uPluginID may be non-zero when this function is called, to provide extra data about what context this Marker was posted in.
219Â /// 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.
236Â bool bEnableGameSyncPreparation; ///< Sets to true to enable AK::SoundEngine::PrepareGameSync usage.
237Â AkUInt32 uContinuousPlaybackLookAhead; ///< Number of quanta ahead when continuous containers should instantiate a new voice before which next sounds should start playing. This look-ahead time allows I/O to occur, and is especially useful to reduce the latency of continuous containers with trigger rate or sample-accurate transitions.
238Â ///< Default is 1 audio quantum, also known as an audio frame. Its size is equal to AkInitSettings::uNumSamplesPerFrame / AkPlatformInitSettings::uSampleRate. For many platforms the default values - which can be overridden - are respectively 1,024 samples and 48 kHz. This gives a default 21.3 ms for an audio quantum, which is adequate if you have a RAM-based streaming device that completes transfers within 20 ms. With 1 look-ahead quantum, voices spawned by continuous containers are more likely to be ready when they are required to play, thereby improving the overall precision of sound scheduling. If your device completes transfers in 30 ms instead, you might consider increasing this value to 2 because it will grant new voices 2 audio quanta (~43 ms) to fetch data.
240Â AkUInt32 uNumSamplesPerFrame; ///< Number of samples per audio frame (256, 512, 1024, or 2048).
242Â AkUInt32 uMonitorQueuePoolSize; ///< Size of the monitoring queue, in bytes. This parameter is not used in Release build.
243Â AkUInt32 uCpuMonitorQueueMaxSize; ///< Maximum size of the CPU monitoring queue, per thread, in bytes. This parameter is not used in Release build.
246Â AkJobMgrSettings settingsJobManager; ///< Settings to configure the behavior of the Sound Engine's internal job manager
248Â AkUInt32 uMaxHardwareTimeoutMs; ///< Amount of time to wait for HW devices to trigger an audio interrupt. If there is no interrupt after that time, the sound engine will revert to silent mode and continue operating until the HW finally comes back. Default value: 2000 (2 seconds)
250Â bool bUseSoundBankMgrThread; ///< Use a separate thread for loading sound banks. Allows asynchronous operations.
251Â bool bUseLEngineThread; ///< Use a separate thread for processing audio. If set to false, audio processing will occur in RenderAudio(). \ref goingfurther_eventmgrthread
253Â AkBackgroundMusicChangeCallbackFunc BGMCallback; ///< Application-defined audio source change event callback function.
254Â void* BGMCallbackCookie; ///< Application-defined user data for the audio source change event callback function.
255Â AkOSChar * szPluginDLLPath; ///< When using DLLs for plugins, specify their path. Leave NULL if DLLs are in the same folder as the game executable.
257Â AkFloorPlane eFloorPlane; ///< 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.
258Â ///< AkFloorPlane is used in to orient the Game Object 3D Viewer in Wwise, and in the transformation of geometry instances in Wwise Spatial Audio.
261Â ///< This setting is used to adapt the size of elements in the Authoring's Game Object 3D Viewer and Audio Object 3D Viewer to meters.
262Â ///< This setting is also used to simulate real-world positioning of System Audio Objects, to improve the HRTF in some cases.
264Â AkUInt32 uBankReadBufferSize; ///< The number of bytes read by the BankReader when new data needs to be loaded from disk during serialization. Increasing this trades memory usage for larger, but fewer, file-read events during bank loading.
266Â AkReal32 fDebugOutOfRangeLimit; ///< Debug setting: Only used when bDebugOutOfRangeCheckEnabled is true. This defines the maximum values samples can have. Normal audio must be contained within +1/-1. This limit should be set higher to allow temporary or short excursions out of range. Default is 16.
268Â bool bDebugOutOfRangeCheckEnabled; ///< Debug setting: Enable checks for out-of-range (and NAN) floats in the processing code. This incurs a small performance hit, but can be enabled in most scenarios. Will print error messages in the log if invalid values are found at various point in the pipeline. Contact AK Support with the new error messages for more information.
270Â AkProfilerPushTimerFunc fnProfilerPushTimer; ///< External (optional) function 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)
271Â AkProfilerPopTimerFunc fnProfilerPopTimer; ///< 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)
272Â AkProfilerPostMarkerFunc fnProfilerPostMarker; ///< External (optional) function for tracking significant events in the sound engine, to act as a marker or bookmark. (only called in Debug and Profile binaries; this is not called in Release)
287Â AkUniqueID mediaID; ///< Media ID of playing item. (corresponds to 'ID' attribute of 'File' element in SoundBank metadata file)
289Â AkUInt32 samplePosition; ///< Position of the source (in samples) associated with that playing item
308Â /// \warning This function is not thread-safe. It should not be called at the same time as \c SoundEngine::Init() or \c SoundEngine::Term().
318Â /// \remark The initial settings should be initialized using <tt>AK::SoundEngine::GetDefaultInitSettings()</tt>
319Â /// and <tt>AK::SoundEngine::GetDefaultPlatformInitSettings()</tt> to fill the structures with their
320Â /// default settings. This is not mandatory, but it helps avoid backward compatibility problems.
324Â /// - \c AK_MemManagerNotInitialized if the memory manager is not available or not properly initialized
325Â /// - \c AK_StreamMgrNotInitialized if the stream manager is not available or not properly initialized
326Â /// - \c AK_SSEInstructionsNotSupported if the machine does not support SSE instruction (only on the PC)
327Â /// - \c AK_InsufficientMemory if there is not enough memory available to initialize the sound engine properly
329Â /// - \c AK_AlreadyInitialized if the sound engine is already initialized, or if the provided settings result in insufficient
339Â AkInitSettings * in_pSettings, ///< Initialization settings (can be NULL, to use the default values)
340Â AkPlatformInitSettings * in_pPlatformSettings ///< Platform-specific settings (can be NULL, to use the default values)
359Â /// the moment of the initialization of the sound engine and might not be the correct one for your game.
368Â AkPlatformInitSettings & out_platformSettings ///< Returned default platform-specific sound engine settings
375Â /// \warning Before calling Term, you must ensure that no other thread is accessing the sound engine.
394Â /// Call this function to get the speaker configuration of the output (which may not correspond
395Â /// to the physical output format of the platform, in the case of downmixing provided by the platform itself).
399Â /// If the speaker configuration of the output is object-based, the speaker configuration of the
400Â /// main mix is returned. To query more information on object-based output devices, see AK::SoundEngine::GetOutputDeviceConfiguration.
402Â /// It is recommended to call GetSpeakerConfiguration anytime after receiving a callback from RegisterAudioDeviceStatusCallback to know if the channel configuration has changed.
405Â /// 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.
407Â /// \return The output configuration. An empty AkChannelConfig not AkChannelConfig::IsValid() if device does not exist or if the Init.bnk was not loaded yet.
413Â AkOutputDeviceID in_idOutput = 0 ///< Output ID to set the bus on. As returned from AddOutput or GetOutputID. You can pass 0 for the main (default) output
417Â /// Call this function to get the channel configuration of the output device as well as its 3D audio capabilities.
418Â /// If the configuration of the output device is object-based (io_channelConfig.eConfigType == AK_ChannelConfigType_Objects),
419Â /// io_capabilities can be inspected to determine the channel configuration of the main mix (Ak3DAudioSinkCapabilities::channelConfig),
420Â /// whether or not the output device uses a passthrough mix (Ak3DAudioSinkCapabilities::bPassthrough) and the maximum number of objects
421Â /// that can play simultaneously on this output device (Ak3DAudioSinkCapabilities::uMax3DAudioObjects). Note that if
422Â /// Ak3DAudioSinkCapabilities::bMultiChannelObjects is false, multi-channel objects will be split into multiple mono objects
425Â /// \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.
452Â AkPanningRule & out_ePanningRule, ///< Returned panning rule (AkPanningRule_Speakers or AkPanningRule_Headphone) for given output.
453Â AkOutputDeviceID in_idOutput = 0 ///< Output ID to set the bus on. As returned from AddOutput or GetOutputID. You can pass 0 for the main (default) output
458Â /// \warning This function posts a message through the sound engine's internal message queue, whereas GetPanningRule() queries the current panning rule directly.
460Â /// The specified panning rule will only impact the sound if the processing format is downmixing to Stereo in the mixing process. It
465Â AkOutputDeviceID in_idOutput = 0 ///< Output ID to set the bus on. As returned from AddOutput or GetOutputID. You can pass 0 for the main (default) output
468Â /// Gets speaker angles of the specified device. Speaker angles are used for 3D positioning of sounds over standard configurations.
470Â /// The speaker angles are expressed as an array of loudspeaker pairs, in degrees, relative to azimuth ]0,180].
471Â /// Supported loudspeaker setups are always symmetric; the center speaker is always in the middle and thus not specified by angles.
473Â /// You may call this function with io_pfSpeakerAngles set to NULL to get the expected number of angle values in io_uNumAngles,
484Â /// - When panning to stereo (speaker mode, see <tt>AK::SoundEngine::SetPanningRule()</tt>), only angle[0] is used, and 3D sounds in the back of the listener are mirrored to the front.
485Â /// - When panning to 5.1, the front speakers use angle[0], and the surround speakers use (angle[2] - angle[1]) / 2.
491Â AkReal32 * io_pfSpeakerAngles, ///< Returned array of loudspeaker pair angles, in degrees relative to azimuth [0,180]. Pass NULL to get the required size of the array.
492Â AkUInt32 & io_uNumAngles, ///< Returned number of angles in io_pfSpeakerAngles, which is the minimum between the value that you pass in, and the number of angles corresponding to AK::GetNumberOfAnglesForConfig( AK_SPEAKER_SETUP_DEFAULT_PLANE ), or just the latter if io_pfSpeakerAngles is NULL.
493Â AkReal32 & out_fHeightAngle, ///< Elevation of the height layer, in degrees relative to the plane [-90,90].
494Â AkOutputDeviceID in_idOutput = 0 ///< Output ID to set the bus on. As returned from AddOutput or GetOutputID. You can pass 0 for the main (default) output
497Â /// Sets speaker angles of the specified device. Speaker angles are used for 3D positioning of sounds over standard configurations.
499Â /// The speaker angles are expressed as an array of loudspeaker pairs, in degrees, relative to azimuth ]0,180].
500Â /// Supported loudspeaker setups are always symmetric; the center speaker is always in the middle and thus not specified by angles.
503Â /// - This function requires that the minimum speaker angle is at least 5 degrees; as well as the subsequent speaker pairs are at least 5 degrees apart.
508Â /// 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().
509Â /// \warning This function only applies to configurations (or subset of these configurations) that are standard and whose speakers are on the plane (2D).
517Â const AkReal32 * in_pfSpeakerAngles, ///< Array of loudspeaker pair angles, in degrees relative to azimuth [0,180].
518Â AkUInt32 in_uNumAngles, ///< Number of elements in in_pfSpeakerAngles. It must correspond to AK::GetNumberOfAnglesForConfig( AK_SPEAKER_SETUP_DEFAULT_PLANE ) (the value returned by GetSpeakerAngles()).
519Â AkReal32 in_fHeightAngle, ///< Elevation of the height layer, in degrees relative to the plane [-90,90].
520Â AkOutputDeviceID in_idOutput = 0 ///< Output ID to set the bus on. As returned from AddOutput or GetOutputID. You can pass 0 for the main (default) output
523Â /// Allows the game to set the volume threshold to be used by the sound engine to determine if a voice must go virtual.
525Â /// If this function is not called, the used value will be the value specified in the platform specific project settings.
534Â /// Allows the game to set the maximum number of non virtual voices to be played simultaneously.
536Â /// If this function is not called, the used value will be the value specified in the platform specific project settings.
546Â /// This function may only be used if a worker function has been set via \ref AkJobMgrSettings.
548Â /// - \c AK_InvalidParameter in_jobType is not a valid jobtype, or in_uNewMaxActiveWorkers is not greater than 0
549Â /// - \c AK_NotInitialized JobMgr system was not already initialized with a function to request for workers
570Â bool in_bAllowSyncRender = true ///< When AkInitSettings::bUseLEngineThread is false, RenderAudio may generate an audio buffer -- unless in_bAllowSyncRender is set to false. Use in_bAllowSyncRender=false when calling RenderAudio from a Sound Engine callback.
586Â /// 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.
597Â /// Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
598Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
599Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
603Â AkUInt32 in_ulCompanyID, ///< Company identifier (as declared in the plug-in description XML file)
604Â AkUInt32 in_ulPluginID, ///< Plug-in identifier (as declared in the plug-in description XML file)
606Â AkCreateParamCallback in_pCreateParamFunc, ///< Pointer to the plug-in's parameter node creation function
607Â AkGetDeviceListCallback in_pGetDeviceList = NULL ///< Optional pointer to the plug-in's device enumeration function. Specify for a sink plug-in to support \ref AK::SoundEngine::GetDeviceList.
612Â /// 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.
615Â /// - \c AK_FileNotFound if the DLL is not found in the OS path or if it has extraneous dependencies not found.
616Â /// - \c AK_InsufficientMemory if the system ran out of resources while loading the dynamic library
617Â /// - \c AK_NotCompatible if the file was found but is not binary-compatible with the system's expected executable format
622Â const AkOSChar* in_DllPath = NULL ///< Optional path to the DLL. Will override szPLuginDLLPath that was set in AkInitSettings.
628Â /// 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.
638Â /// Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
639Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
640Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
643Â AkUInt32 in_ulCompanyID, ///< Company identifier (as declared in the plug-in description XML file)
645Â AkCreateFileSourceCallback in_pFileCreateFunc, ///< Pointer to the codec's file source node creation function
646Â AkCreateBankSourceCallback in_pBankCreateFunc ///< Pointer to the codec's bank source node creation function
649Â /// Registers a global callback function. This function will be called from the audio rendering thread, at the
650Â /// location specified by in_eLocation. This function will also be called from the thread calling
652Â /// For example, in order to be called at every audio rendering pass, and once during teardown for releasing resources, you would call
653Â /// RegisterGlobalCallback(myCallback, AkGlobalCallbackLocation_BeginRender | AkGlobalCallbackLocation_Term, myCookie, AkPluginTypeNone, 0, 0);
655Â /// A Plugin Type, Company ID and Plugin ID can be provided to this function to enable timing in the performance monitor.
656Â /// 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.
661Â /// - \c AK_InvalidParameter if parameters are out of range (check debug console or Wwise Profiler)
668Â AkUInt32 in_eLocation = AkGlobalCallbackLocation_BeginRender, ///< Callback location defined in AkGlobalCallbackLocation. Bitwise OR multiple locations if needed.
670Â AkPluginType in_eType = AkPluginTypeNone, ///< Plug-in type (for example, source or effect). AkPluginTypeNone for no timing.
671Â AkUInt32 in_ulCompanyID = 0, ///< Company identifier (as declared in the plug-in description XML file). 0 for no timing.
672Â AkUInt32 in_ulPluginID = 0 ///< Plug-in identifier (as declared in the plug-in description XML file). 0 for no timing.
675Â /// Unregisters a global callback function, previously registered using RegisterGlobalCallback.
677Â /// It is legal to call this function while already inside of a global callback, If it is unregistering itself and not
682Â /// - \c AK_InvalidParameter if parameters are out of range (check debug console or Wwise Profiler)
689Â AkUInt32 in_eLocation = AkGlobalCallbackLocation_BeginRender ///< Must match in_eLocation as passed to RegisterGlobalCallback for this callback.
692Â /// Registers a resource monitor callback function that gets all of the resource usage data contained in the
693Â /// AkResourceMonitorDataSummary structure. This includes general information about the system, such as CPU usage,
694Â /// active Voices, and Events. This function will be called from the audio rendering thread at the end of each frame.
696Â /// 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.
704Â AkResourceMonitorCallbackFunc in_pCallback ///< Function to register as a resource monitor callback.
707Â /// Unregisters a resource monitor callback function, previously registered using RegisterResourceMonitorCallback.
709Â /// It is legal to call this function while already inside of a resource monitor callback, If it is unregistering itself and not
716Â AkResourceMonitorCallbackFunc in_pCallback ///< Function to unregister as a resource monitor callback.
727Â /// Unregisters the callback for the Audio Device status changes, registered by RegisterAudioDeviceStatusCallback
737Â /// This function will hash the name based on a algorithm ( provided at : /AK/Tools/Common/AkFNVHash.h )
740Â /// AkUniqueID, AkStateGroupID, AkStateID, AkSwitchGroupID, AkSwitchStateID, AkRtpcID, and so on...
756Â /// This function will hash the name based on a algorithm ( provided at : /AK/Tools/Common/AkFNVHash.h )
759Â /// AkUniqueID, AkStateGroupID, AkStateID, AkSwitchGroupID, AkSwitchStateID, AkRtpcID, and so on...
780Â /// The callback function can be used to be noticed when markers are reached or when the event is finished.
781Â /// An array of wave file sources can be provided to resolve External Sources triggered by the event.
782Â /// \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.
784Â /// If used, the array of external sources should contain the information for each external source triggered by the
785Â /// event. When triggering an event with multiple external sources, you need to differentiate each source
786Â /// by using the cookie property in the External Source in the Wwise project and in AkExternalSourceInfo.
787Â /// \aknote If an event triggers the playback of more than one external source, they must be named uniquely in the project
788Â /// (therefore have a unique cookie) in order to tell them apart when filling the AkExternalSourceInfo structures.
801Â void * in_pCookie = NULL, ///< Callback cookie that will be sent to the callback function along with additional information
803Â AkExternalSourceInfo *in_pExternalSources = NULL,///< Optional array of external source resolution information
804Â AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID///< Optional (advanced users only) Specify the playing ID to target with the event. Will Cause active actions in this event to target an existing Playing ID. Let it be AK_INVALID_PLAYING_ID or do not specify any for normal playback.
809Â /// The callback function can be used to be noticed when markers are reached or when the event is finished.
810Â /// An array of wave file sources can be provided to resolve External Sources triggered by the event.
811Â /// \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.
813Â /// If used, the array of external sources should contain the information for each external source triggered by the
814Â /// event. When triggering an event with multiple external sources, you need to differentiate each source
815Â /// by using the cookie property in the External Source in the Wwise project and in AkExternalSourceInfo.
816Â /// \aknote If an event triggers the playback of more than one external source, they must be named uniquely in the project
817Â /// (therefore have a unique cookie) in order to tell them appart when filling the AkExternalSourceInfo structures.
830Â void * in_pCookie = NULL, ///< Callback cookie that will be sent to the callback function along with additional information.
832Â AkExternalSourceInfo *in_pExternalSources = NULL,///< Optional array of external source resolution information
833Â AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID///< Optional (advanced users only) Specify the playing ID to target with the event. Will Cause active actions in this event to target an existing Playing ID. Let it be AK_INVALID_PLAYING_ID or do not specify any for normal playback.
838Â /// The callback function can be used to be noticed when markers are reached or when the event is finished.
839Â /// An array of Wave file sources can be provided to resolve External Sources triggered by the event. P
840Â /// \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.
842Â /// If used, the array of external sources should contain the information for each external source triggered by the
843Â /// event. When triggering an Event with multiple external sources, you need to differentiate each source
844Â /// by using the cookie property in the External Source in the Wwise project and in AkExternalSourceInfo.
845Â /// \aknote If an event triggers the playback of more than one external source, they must be named uniquely in the project
846Â /// (therefore have a unique cookie) in order to tell them apart when filling the AkExternalSourceInfo structures.
859Â void * in_pCookie = NULL, ///< Callback cookie that will be sent to the callback function along with additional information.
861Â AkExternalSourceInfo *in_pExternalSources = NULL,///< Optional array of external source resolution information
862Â AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID///< Optional (advanced users only) Specify the playing ID to target with the event. Will Cause active actions in this event to target an existing Playing ID. Let it be AK_INVALID_PLAYING_ID or do not specify any for normal playback.
865Â // If you modify AkActionOnEventType, don't forget to modify the WAAPI validation schema accordingly.
877Â };
879Â /// Executes an action on all nodes that are referenced in the specified event in an action of type play.
887Â AkActionOnEventType in_ActionType, ///< Action to execute on all the elements that were played using the specified event.
890Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the transition
895Â /// Executes an action on all nodes that are referenced in the specified event in an action of type play.
903Â AkActionOnEventType in_ActionType, ///< Action to execute on all the elements that were played using the specified event.
906Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the transition
911Â /// Executes an Action on all nodes that are referenced in the specified Event in an Action of type Play.
919Â AkActionOnEventType in_ActionType, ///< Action to execute on all the elements that were played using the specified event.
922Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the transition
927Â /// Executes a number of MIDI Events on all nodes that are referenced in the specified Event in an Action of type Play.
928Â /// The time at which a MIDI Event is posted is determined by in_bAbsoluteOffsets. If false, each MIDI event will be
929Â /// posted in AkMIDIPost::uOffset samples from the start of the current frame. If true, each MIDI event will be posted
932Â /// The duration of a sample can be determined from the sound engine's audio settings, via a call to AK::SoundEngine::GetAudioSettings.
933Â /// If a playing ID is specified then that playing ID must be active. Otherwise a new playing ID will be assigned.
934Â /// \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.
945Â bool in_bAbsoluteOffsets = false, ///< Set to true when AkMIDIPost::uOffset are absolute, false when relative to current frame
948Â void * in_pCookie = NULL, ///< Callback cookie that will be sent to the callback function along with additional information
952Â /// Stops MIDI notes on all nodes that are referenced in the specified event in an action of type play,
953Â /// with the specified Game Object. Invalid parameters are interpreted as wildcards. For example, calling
954Â /// this function with in_eventID set to AK_INVALID_UNIQUE_ID will stop all MIDI notes for Game Object
969Â /// 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
970Â /// 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
972Â /// \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.
973Â /// \remarks It is possible to override the prefetch size stored in the sound bank via the low level IO. For more information see <tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt> and AkFileSystemFlags.
974Â /// \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
975Â /// 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.
976Â /// \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
977Â /// will get cached with active priority, while all other files will get cached with inactive priority.
978Â /// \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
979Â /// 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.
995Â /// 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
996Â /// 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
998Â /// \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.
999Â /// \remarks It is possible to override the prefetch size stored in the sound bank via the low level IO. For more information see <tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt> and AkFileSystemFlags.
1000Â /// \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
1001Â /// 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.
1002Â /// \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
1003Â /// will get cached with active priority, while all other files will get cached with inactive priority.
1004Â /// \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
1005Â /// 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.
1021Â /// 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
1022Â /// 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
1024Â /// \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.
1025Â /// \remarks It is possible to override the prefetch size stored in the sound bank via the low level IO. For more information see <tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt> and AkFileSystemFlags.
1026Â /// \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
1027Â /// 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.
1028Â /// \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
1029Â /// will get cached with active priority, while all other files will get cached with inactive priority.
1030Â /// \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
1031Â /// 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.
1046Â /// Releases the set of files that were previously requested to be pinned into cache via <tt>AK::SoundEngine::PinEventInStreamCache()</tt>. The file may still remain in stream cache
1047Â /// after <tt>AK::SoundEngine::UnpinEventInStreamCache()</tt> is called, until the memory is reused by the streaming memory manager in accordance with to its cache management algorithm.
1059Â /// Releases the set of files that were previously requested to be pinned into cache via <tt>AK::SoundEngine::PinEventInStreamCache()</tt>. The file may still remain in stream cache
1060Â /// after <tt>AK::SoundEngine::UnpinEventInStreamCache()</tt> is called, until the memory is reused by the streaming memory manager in accordance with to its cache management algorithm.
1072Â /// Releases the set of files that were previously requested to be pinned into cache via <tt>AK::SoundEngine::PinEventInStreamCache()</tt>. The file may still remain in stream cache
1073Â /// after <tt>AK::SoundEngine::UnpinEventInStreamCache()</tt> is called, until the memory is reused by the streaming memory manager in accordance with to its cache management algorithm.
1084Â /// Returns information about an Event that was requested to be pinned into cache via <tt>AK::SoundEngine::PinEventInStreamCache()</tt>.
1085Â /// Retrieves the smallest buffer fill-percentage for each file referenced by the event, and whether
1086Â /// the cache-pinned memory limit is preventing any of the files from filling up their buffer.
1087Â /// \remarks To set the limit for the maximum number of bytes that can be pinned to cache, see \c AkDeviceSettings
1097Â AkReal32& out_fPercentBuffered, ///< Fill-percentage (out of 100) of requested buffer size for least buffered file in the event.
1098Â bool& out_bCachePinnedMemoryFull ///< True if at least one file can not complete buffering because the cache-pinned memory limit would be exceeded.
1101Â /// Returns information about an Event that was requested to be pinned into cache via \c <tt>AK::SoundEngine::PinEventInStreamCache()</tt>.
1102Â /// Retrieves the smallest buffer fill-percentage for each file referenced by the event, and whether
1103Â /// the cache-pinned memory limit is preventing any of the files from filling up their buffer.
1104Â /// \remarks To set the limit for the maximum number of bytes that can be pinned to cache, see AkDeviceSettings
1114Â AkReal32& out_fPercentBuffered, ///< Fill-percentage (out of 100) of requested buffer size for least buffered file in the event.
1115Â bool& out_bCachePinnedMemoryFull ///< True if at least one file can not complete buffering because the cache-pinned memory limit would be exceeded.
1119Â /// Returns information about an Event that was requested to be pinned into cache via \c <tt>AK::SoundEngine::PinEventInStreamCache()</tt>.
1120Â /// Retrieves the smallest buffer fill-percentage for each file referenced by the event, and whether
1121Â /// the cache-pinned memory limit is preventing any of the files from filling up their buffer.
1122Â /// \remarks To set the limit for the maximum number of bytes that can be pinned to cache, see AkDeviceSettings
1132Â AkReal32& out_fPercentBuffered, ///< Fill-percentage (out of 100) of requested buffer size for least buffered file in the event.
1133Â bool& out_bCachePinnedMemoryFull ///< True if at least one file can not complete buffering because the cache-pinned memory limit would be exceeded.
1137Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1140Â /// - This works with all objects of the actor-mixer hierarchy, and also with Music Segments and Music Switch Containers.
1141Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1142Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1143Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1148Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1149Â /// With objects of the actor-mixer hierarchy, markers are embedded in wave files by an external wave editor.
1150Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1151Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1152Â /// to nearest marker. In the case of objects of the interactive music hierarchy, user (wave) markers are ignored:
1153Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1154Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1158Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1160Â /// - Music segments cannot be looped. You may want to listen to the AK_EndOfEvent notification
1162Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1164Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1165Â /// value that was passed to the method. Use <tt>AK::MusicEngine::GetPlayingSegmentInfo()</tt> to query
1167Â /// (so that it restarts precisely at the position that you specified). <tt>AK::MusicEngine::GetPlayingSegmentInfo()</tt>
1172Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1173Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1174Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1175Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1187Â AkGameObjectID in_gameObjectID, ///< Associated game object ID; use AK_INVALID_GAME_OBJECT to affect all game objects
1189Â bool in_bSeekToNearestMarker = false, ///< If true, the final seeking position will be made equal to the nearest marker (see note above)
1190Â AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID ///< Specify the playing ID for the seek to be applied to. Will result in the seek happening only on active actions of the playing ID. Let it be AK_INVALID_PLAYING_ID or do not specify any, to seek on all active actions of this event ID.
1194Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1197Â /// - This works with all objects of the actor-mixer hierarchy, and also with Music Segments and Music Switch Containers.
1198Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1199Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1200Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1203Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1207Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1208Â /// With objects of the actor-mixer hierarchy, markers are embedded in wave files by an external wave editor.
1209Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1210Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1211Â /// to nearest marker. In the case of objects of the interactive music hierarchy, user (wave) markers are ignored:
1212Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1213Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1217Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1219Â /// - Music segments cannot be looped. You may want to listen to the AK_EndOfEvent notification
1221Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1223Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1224Â /// value that was passed to the method. Use <tt>AK::MusicEngine::GetPlayingSegmentInfo()</tt> to query
1226Â /// (so that it restarts precisely at the position that you specified). <tt>AK::MusicEngine::GetPlayingSegmentInfo()</tt>
1231Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1232Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1233Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1234Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1245Â AkGameObjectID in_gameObjectID, ///< Associated game object ID; use AK_INVALID_GAME_OBJECT to affect all game objects
1247Â bool in_bSeekToNearestMarker = false, ///< If true, the final seeking position will be made equal to the nearest marker (see note above)
1248Â AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID ///< Specify the playing ID for the seek to be applied to. Will result in the seek happening only on active actions of the playing ID. Let it be AK_INVALID_PLAYING_ID or do not specify any, to seek on all active actions of this event ID.
1252Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1255Â /// - This works with all objects of the actor-mixer hierarchy, and also with Music Segments and Music Switch Containers.
1256Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1257Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1258Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1261Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1265Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1266Â /// With objects of the actor-mixer hierarchy, markers are embedded in wave files by an external wave editor.
1267Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1268Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1269Â /// to nearest marker. In the case of objects of the interactive music hierarchy, user (wave) markers are ignored:
1270Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1271Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1275Â /// - With Music Segments, in_iPosition is relative to the Entry Cue, in milliseconds. Use a negative
1277Â /// - Music segments cannot be looped. You may want to listen to the AK_EndOfEvent notification
1279Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1281Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1282Â /// value that was passed to the method. Use <tt>AK::MusicEngine::GetPlayingSegmentInfo()</tt> to query
1284Â /// (so that it restarts precisely at the position that you specified). <tt>AK::MusicEngine::GetPlayingSegmentInfo()</tt>
1289Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1290Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1291Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1292Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1304Â AkGameObjectID in_gameObjectID, ///< Associated game object ID; use AK_INVALID_GAME_OBJECT to affect all game objects
1306Â bool in_bSeekToNearestMarker = false, ///< If true, the final seeking position will be made equal to the nearest marker (see note above)
1307Â AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID ///< Specify the playing ID for the seek to be applied to. Will result in the seek happening only on active actions of the playing ID. Let it be AK_INVALID_PLAYING_ID or do not specify any, to seek on all active actions of this event ID.
1310Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1311Â /// Seek position is specified as a percentage of the sound's total duration, and takes looping into account.
1314Â /// - This works with all objects of the actor-mixer hierarchy, and also with Music Segments and Music Switch Containers.
1315Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1316Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1317Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1321Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1322Â /// With objects of the actor-mixer hierarchy, markers are embedded in wave files by an external wave editor.
1323Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1324Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1325Â /// to nearest marker. In the case of objects of the interactive music hierarchy, user (wave) markers are ignored:
1326Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1327Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1331Â /// - With Music Segments, \c in_fPercent is relative to the Entry Cue, and the segment's duration is the
1332Â /// duration between its entry and exit cues. Consequently, you cannot seek within the pre-entry or
1334Â /// - Music Segments cannot be looped. You may want to listen to the \c AK_EndOfEvent notification
1336Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1338Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1339Â /// value that was passed to the method. Use <tt>AK::MusicEngine::GetPlayingSegmentInfo()</tt> to query
1340Â /// the exact position of a segment. Also, the segment will be silent during the time that period
1341Â /// (so that it restarts precisely at the position that you specified). <tt>AK::MusicEngine::GetPlayingSegmentInfo()</tt>
1346Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1347Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1348Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1349Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1358Â AkGameObjectID in_gameObjectID , ///< Associated game object ID; use AK_INVALID_GAME_OBJECT to affect all game objects
1359Â AkReal32 in_fPercent, ///< Desired position where playback should restart, expressed in a percentage of the file's total duration, between 0 and 1.f (see note above about infinite looping sounds)
1360Â bool in_bSeekToNearestMarker = false, ///< If true, the final seeking position will be made equal to the nearest marker (see note above)
1361Â AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID ///< Specify the playing ID for the seek to be applied to. Will result in the seek happening only on active actions of the playing ID. Let it be AK_INVALID_PLAYING_ID or do not specify any, to seek on all active actions of this event ID.
1365Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1366Â /// Seek position is specified as a percentage of the sound's total duration, and takes looping into account.
1369Â /// - This works with all objects of the actor-mixer hierarchy, and also with Music Segments and Music Switch Containers.
1370Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1371Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1372Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1375Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1376Â /// With objects of the actor-mixer hierarchy, markers are embedded in wave files by an external wave editor.
1377Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1378Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1379Â /// to nearest marker. In the case of objects of the interactive music hierarchy, user (wave) markers are ignored:
1380Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1381Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1385Â /// - With Music Segments, \c in_fPercent is relative to the Entry Cue, and the segment's duration is the
1386Â /// duration between its entry and exit cues. Consequently, you cannot seek within the pre-entry or
1388Â /// - Music Segments cannot be looped. You may want to listen to the \c AK_EndOfEvent notification
1390Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1392Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1393Â /// value that was passed to the method. Use <tt>AK::MusicEngine::GetPlayingSegmentInfo()</tt> to query
1394Â /// the exact position of a segment. Also, the segment will be silent during the time that period
1395Â /// (so that it restarts precisely at the position that you specified). <tt>AK::MusicEngine::GetPlayingSegmentInfo()</tt>
1400Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1401Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1402Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1403Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1412Â AkGameObjectID in_gameObjectID , ///< Associated game object ID; use AK_INVALID_GAME_OBJECT to affect all game objects
1413Â AkReal32 in_fPercent , ///< Desired position where playback should restart, expressed in a percentage of the file's total duration, between 0 and 1.f (see note above about infinite looping sounds)
1414Â bool in_bSeekToNearestMarker = false, ///< If true, the final seeking position will be made equal to the nearest marker (see note above)
1415Â AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID ///< Specify the playing ID for the seek to be applied to. Will result in the seek happening only on active actions of the playing ID. Let it be AK_INVALID_PLAYING_ID or do not specify any, to seek on all active actions of this event ID.
1419Â /// Seeks inside all playing objects that are referenced in Play Actions of the specified Event.
1420Â /// Seek position is specified as a percentage of the sound's total duration, and takes looping into account.
1423Â /// - This works with all objects of the actor-mixer hierarchy, and also with Music Segments and Music Switch Containers.
1424Â /// - There is a restriction with sounds that play within a continuous sequence. Seeking is ignored
1425Â /// if one of their ancestors is a continuous (random or sequence) container with crossfade or
1426Â /// trigger rate transitions. Seeking is also ignored with sample-accurate transitions, unless
1429Â /// - If the option "Seek to nearest marker" is used, the seeking position snaps to the nearest marker.
1430Â /// With objects of the actor-mixer hierarchy, markers are embedded in wave files by an external wave editor.
1431Â /// Note that looping regions ("sampler loop") are not considered as markers. Also, the "add file name marker" of the
1432Â /// conversion settings dialog adds a marker at the beginning of the file, which is considered when seeking
1433Â /// to nearest marker. In the case of objects of the interactive music hierarchy, user (wave) markers are ignored:
1434Â /// seeking occurs to the nearest segment cue (authored in the segment editor), including the Entry Cue, but excluding the Exit Cue.
1435Â /// - This method posts a command in the sound engine queue, thus seeking will not occur before
1439Â /// - With Music Segments, in_fPercent is relative to the Entry Cue, and the segment's duration is the
1440Â /// duration between its entry and exit cues. Consequently, you cannot seek within the pre-entry or
1442Â /// - Music segments cannot be looped. You may want to listen to the AK_EndOfEvent notification
1444Â /// - In order to restart at the correct location, with all their tracks synchronized, Music Segments
1446Â /// Consequently, the resulting position after a call to SeekOnEvent() might be earlier than the
1447Â /// value that was passed to the method. Use <tt>AK::MusicEngine::GetPlayingSegmentInfo()</tt> to query
1448Â /// the exact position of a segment. Also, the segment will be silent during the time that period
1449Â /// (so that it restarts precisely at the position that you specified). <tt>AK::MusicEngine::GetPlayingSegmentInfo()</tt>
1454Â /// This transition is subject to the container's transition rule that matches the current and defined in the container,
1455Â /// so the moment when seeking occurs depends on the rule's "Exit At" property. On the other hand, the starting position
1456Â /// in the target segment depends on both the desired seeking position and the rule's "Sync To" property.
1457Â /// - If the specified time is greater than the destination segment's length, the modulo is taken.
1466Â AkGameObjectID in_gameObjectID, ///< Associated game object ID; use AK_INVALID_GAME_OBJECT to affect all game objects
1467Â AkReal32 in_fPercent, ///< Desired position where playback should restart, expressed in a percentage of the file's total duration, between 0 and 1.f (see note above about infinite looping sounds)
1468Â bool in_bSeekToNearestMarker = false, ///< If true, the final seeking position will be made equal to the nearest marker (see notes above).
1469Â AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID ///< Specify the playing ID for the seek to be applied to. Will result in the seek happening only on active actions of the playing ID. Let it be AK_INVALID_PLAYING_ID or do not specify any, to seek on all active actions of this event ID.
1493Â /// Gets the current position of the source associated with this playing ID, obtained from PostEvent(). If more than one source is playing,
1496Â /// - You need to pass AK_EnableGetSourcePlayPosition to PostEvent() in order to use this function, otherwise
1498Â /// - The source's position is updated at every audio frame, and the time at which this occurs is stored.
1499Â /// When you call this function from your thread, you therefore query the position that was updated in the previous audio frame.
1500Â /// If in_bExtrapolate is true (default), the returned position is extrapolated using the elapsed time since last
1505Â /// - \c AK_PlayingIDNotFound if the playing ID is invalid (not playing yet, or finished playing).
1511Â AkTimeMs* out_puPosition, ///< Position of the source (in ms) associated with the specified playing ID
1512Â bool in_bExtrapolate = true ///< Position is extrapolated based on time elapsed since last sound engine update.
1515Â /// Gets the current position of the sources associated with this playing ID, obtained from PostEvent().
1517Â /// - You need to pass AK_EnableGetSourcePlayPosition to PostEvent() in order to use this function, otherwise
1519Â /// - The source's position is updated at every audio frame, and the time at which this occurs is stored.
1520Â /// When you call this function from your thread, you therefore query the position that was updated in the previous audio frame.
1521Â /// If in_bExtrapolate is true (default), the returned position is extrapolated using the elapsed time since last
1523Â /// - If 0 is passed in for the number of entries (*in_pcPositions == 0) then only the number of positions will be returned and the
1530Â /// - \c AK_PlayingIDNotFound if the playing ID is invalid (not playing yet, or finished playing).
1536Â AkSourcePosition* out_puPositions, ///< Audio Node IDs and positions of sources associated with the specified playing ID
1537Â AkUInt32 * io_pcPositions, ///< Number of entries in out_puPositions. Needs to be set to the size of the array: it is adjusted to the actual number of returned entries
1538Â bool in_bExtrapolate = true ///< Position is extrapolated based on time elapsed since last sound engine update
1541Â /// Gets the stream buffering of the sources associated with this playing ID, obtained from PostEvent().
1543Â /// - You need to pass AK_EnableGetSourceStreamBuffering to PostEvent() in order to use this function, otherwise
1545Â /// - The sources stream buffering is updated at every audio frame. If there are multiple sources associated with this playing ID,
1547Â /// - The returned buffering status out_bIsBuffering will be true If any of the sources associated with the playing ID are actively being buffered.
1548Â /// 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.
1549Â /// - Purely in-memory sources are excluded from this database. If all sources are in-memory, GetSourceStreamBuffering() will return AK_Fail.
1550Â /// - 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.
1551Â /// 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.
1554Â /// - \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.
1559Â AkTimeMs & out_buffering, ///< Returned amount of buffering (in ms) of the source (or one of the sources) associated with that playing ID
1560Â bool & out_bIsBuffering ///< Returned buffering status of the source(s) associated with that playing ID
1566Â AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT ///< (Optional)Specify a game object to stop only playback associated to the provided game object ID.
1578Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear ///< Curve type to be used for the transition
1588Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear ///< Curve type to be used for the transition
1605Â /// This function is provided to give the same behavior on platforms that don't have user-music support.
1618Â /// Sends custom game data to a plug-in that resides on a bus (insert Effect or mixer plug-in).
1622Â /// \aknote The plug-in type and ID is passed and matched with plugins set on the desired bus.
1623Â /// This means that you cannot send different data to various instances of the plug-in on a same bus.\endaknote
1627Â AkGameObjectID in_busObjectID, ///< Bus Object ID. Pass AK_INVALID_GAME_OBJECT to send custom data with global scope. Game object scope supersedes global scope, as with RTPCs.
1629Â AkUInt32 in_uCompanyID, ///< Company identifier (as declared in the plug-in description XML file)
1630Â AkUInt32 in_uPluginID, ///< Plug-in identifier (as declared in the plug-in description XML file)
1643Â /// - \c AK_InvalidParameter if the specified AkGameObjectID is invalid (0 and -1 are invalid)
1644Â /// \remark Registering a game object twice does nothing. Unregistering it once unregisters it no
1657Â /// - \c AK_InvalidParameter if the specified AkGameObjectID is invalid (0 and -1 are invalid)
1658Â /// \remark Registering a game object twice does nothing. Unregistering it once unregisters it no
1673Â /// \remark Registering a game object twice does nothing. Unregistering it once unregisters it no
1676Â /// For example, say a sound associated with this game object is a 3D moving sound. This sound will
1677Â /// stop moving when the game object is unregistered, and there will be no way to regain control over the game object.
1687Â /// Unregister all game objects, or all game objects with a particular matching set of property flags.
1691Â /// \remark Registering a game object twice does nothing. Unregistering it once unregisters it no
1716Â const AkSoundPosition & in_Position,///< Position to set; in_Position.Orientation must be normalized.
1717Â AkSetPositionFlags in_eFlags = AkSetPositionFlags_Default ///< Optional flags to independently set the position of the emitter or listener component.
1721Â /// Setting multiple positions on a single game object is a way to simulate multiple emission sources while using the resources of only one voice.
1722Â /// This can be used to simulate wall openings, area sounds, or multiple objects emitting the same sound in the same area.
1724Â /// - Calling <tt>AK::SoundEngine::SetMultiplePositions()</tt> with only one position is the same as calling <tt>AK::SoundEngine::SetPosition()</tt>
1725Â /// - If a sound has diffraction enabled, it is treated as <tt>MultiPositionType_MultiDirections</tt>. <tt>MultiPositionType_MultiSources</tt> is not supported in this case.
1729Â /// - \c AK_CommandTooLarge if the number of positions is too large for the command queue. Reduce the number of positions.
1742Â MultiPositionType in_eMultiPositionType = MultiPositionType_MultiDirections, ///< \ref AK::SoundEngine::MultiPositionType
1743Â AkSetPositionFlags in_eFlags = AkSetPositionFlags_Default ///< Optional flags to independently set the position of the emitter or listener component.
1746Â /// Sets multiple positions to a single game object, with flexible assignment of input channels.
1747Â /// Setting multiple positions on a single game object is a way to simulate multiple emission sources while using the resources of only one voice.
1748Â /// This can be used to simulate wall openings, area sounds, or multiple objects emitting the same sound in the same area.
1749Â /// \aknote Calling <tt>AK::SoundEngine::SetMultiplePositions()</tt> with only one position is the same as calling <tt>AK::SoundEngine::SetPosition()</tt> \endaknote
1752Â /// - \c AK_CommandTooLarge if the number of positions is too large for the command queue. Reduce the number of positions.
1760Â const AkChannelEmitter * in_pPositions, ///< Array of positions to apply, each using its own channel mask.
1762Â MultiPositionType in_eMultiPositionType = MultiPositionType_MultiDirections, ///< \ref AK::SoundEngine::MultiPositionType
1763Â AkSetPositionFlags in_eFlags = AkSetPositionFlags_Default ///< Optional flags to independently set the position of the emitter or listener component.
1767Â /// Modify the attenuation computations on this Game Object to simulate sounds with a larger or smaller area of effect.
1774Â AkReal32 in_fAttenuationScalingFactor ///< Scaling Factor, 1 means 100%, 0.5 means 50%, 2 means 200%, and so on.
1777Â /// Use the position of a separate game object for distance calculations for a specified listener.
1778Â /// When <tt>AK::SoundEngine::SetDistanceProbe()</tt> is called, Wwise calculates distance attenuation and filtering
1779Â /// based on the distance between the distance probe Game Object (\c in_distanceProbeGameObjectID) and the emitter Game Object's position.
1780Â /// In third-person perspective applications, the distance probe Game Object may be set to the player character's position,
1781Â /// and the listener Game Object's position to that of the camera. In this scenario, attenuation is based on
1782Â /// the distance between the character and the sound, whereas panning, spatialization, and spread and focus calculations are base on the camera.
1783Â /// Both Game Objects, \c in_listenerGameObjectID and \c in_distanceProbeGameObjectID must have been previously registered using <tt>AK::SoundEngine::RegisterGameObj</tt>.
1784Â /// This funciton is optional. if <tt>AK::SoundEngine::SetDistanceProbe()</tt> is never called, distance calculations are based on the listener Game Object position.
1785Â /// 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.
1786Â /// \aknote If the distance probe Game Object is assigned multiple positions, then the first position is used for distance calculations by the listener. \endaknote
1792Â AkGameObjectID in_listenerGameObjectID, ///< Game object identifier for the listener. Must have been previously registered via RegisterGameObj.
1793Â AkGameObjectID in_distanceProbeGameObjectID ///< Game object identifier for the distance probe, or \c AK_INVALID_GAME_OBJECT to reset distance probe. If valid, must have been previously registered via RegisterGameObj.
1803Â /// It also internally calls ClearPreparedEvents() since at least one bank must have been loaded to allow preparing events.
1806Â /// - \c AK_NotInitialized if the sound engine was not correctly initialized or if there is not enough memory to handle the command
1824Â AkReal32 in_fThroughput, ///< Average throughput of bank data streaming (bytes/ms) (the default value is AK_DEFAULT_BANK_THROUGHPUT)
1825Â AkPriority in_priority ///< Priority of bank streaming (the default value is AK_DEFAULT_PRIORITY)
1841Â /// - \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.
1847Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure, check the debug console)
1855Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
1856Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
1857Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
1859Â /// - The sound engine internally calls GetIDFromString(in_pszString) to return the correct bank ID.
1860Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
1861Â /// not the name of the file (if you changed it), nor the full path of the file. The path should be resolved in
1862Â /// your implementation of the Stream Manager, or in the Low-Level I/O module if you use the default Stream Manager's implementation.
1897Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
1905Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
1906Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
1907Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
1909Â /// - The sound engine internally calls GetIDFromString(in_pszString) to return the correct bank ID.
1910Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
1911Â /// not the name of the file (if you changed it), nor the full path of the file. The path should be resolved in
1912Â /// your implementation of the Stream Manager, or in the Low-Level I/O module if you use the default Stream Manager's implementation.
1929Â /// \aknote Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings. \endaknote
1938Â /// - \c AK_BankReadError: I/O error. The bank is either shorter than expected or its data corrupted.
1943Â /// - \c AK_InvalidParameter if some parameters are invalid, check the debug console or Wwise Profiler
1947Â /// - \c AK_Fail: Load or unload failed for any other reason. , check the debug console or Wwise Profiler
1955Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
1956Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
1957Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
1972Â /// IMPORTANT: Banks loaded from memory with in-place data MUST be unloaded using the UnloadBank function
1973Â /// providing the same memory pointer. Make sure you are using the correct UnloadBank(...) overload
1977Â /// In-memory loading is in-place: *** the memory must be valid until the bank is unloaded. ***
1994Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2002Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2003Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2004Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2006Â /// - The memory must be aligned on platform-specific AK_BANK_PLATFORM_DATA_ALIGNMENT bytes (see AkTypes.h).
2007Â /// - (XboxOne only): If the bank may contain XMA in memory data, the memory must be allocated using the Device memory allocator.
2008Â /// - Avoid using this function for banks containing a lot of events or structure data: this data will be unpacked into the sound engine heap,
2009Â /// making the supplied bank memory redundant. For event/structure-only banks, prefer LoadBankMemoryCopy().
2017Â const void * in_pInMemoryBankPtr, ///< Pointer to the in-memory bank to load (pointer is stored in sound engine, memory must remain valid)
2024Â /// IMPORTANT: Banks loaded from memory with in-place data MUST be unloaded using the UnloadBank function
2025Â /// providing the same memory pointer. Make sure you are using the correct UnloadBank(...) overload
2029Â /// In-memory loading is in-place: *** the memory must be valid until the bank is unloaded. ***
2045Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2053Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2054Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2055Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2057Â /// - The memory must be aligned on platform-specific AK_BANK_PLATFORM_DATA_ALIGNMENT bytes (see AkTypes.h).
2058Â /// - (XboxOne only): If the bank may contain XMA in memory data, the memory must be allocated using the Device memory allocator.
2059Â /// - Avoid using this function for banks containing a lot of events or structure data: this data will be unpacked into the sound engine heap,
2060Â /// making the supplied bank memory redundant. For event/structure-only banks, prefer LoadBankMemoryCopy().
2068Â const void * in_pInMemoryBankPtr, ///< Pointer to the in-memory bank to load (pointer is stored in sound engine, memory must remain valid)
2076Â /// NOTE: Banks loaded from in-memory with out-of-place data must be unloaded using the standard UnloadBank function
2080Â /// in a buffer and pass its address to the sound engine, the media section of the bank will be copied into newly
2082Â /// In-memory loading is out-of-place: the buffer can be release as soon as the function returns. The advantage of using this
2100Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2108Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2109Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2110Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2119Â const void * in_pInMemoryBankPtr, ///< Pointer to the in-memory bank to load (pointer is not stored in sound engine, memory can be released after return)
2126Â /// NOTE: Banks loaded from in-memory with out-of-place data must be unloaded using the standard UnloadBank function
2130Â /// in a buffer and pass its address to the sound engine, the media section of the bank will be copied into newly
2132Â /// In-memory loading is out-of-place: the buffer can be release as soon as the function returns. The advantage of using this
2149Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2157Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2158Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2159Â /// 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Â const void * in_pInMemoryBankPtr, ///< Pointer to the in-memory bank to load (pointer is not stored in sound engine, memory can be released after return)
2174Â /// 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.
2176Â /// 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.
2178Â const void * in_pInMemoryBankPtr, ///< Pointer to the in-memory bank to decode (pointer is not stored in sound engine, memory can be released after return)
2180Â AkMemPoolId in_uPoolForDecodedBank, ///< Memory pool to allocate decoded bank into. Specify AK_INVALID_POOL_ID and out_pDecodedBankPtr=NULL to obtain decoded bank size without performing the decode operation. Pass AK_INVALID_POOL_ID and out_pDecodedBankPtr!=NULL to decode bank into specified pointer.
2203Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2204Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2205Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2207Â /// - The sound engine internally calls GetIDFromString(in_pszString) to return the correct bank ID.
2208Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2209Â /// not the name of the file (if you changed it), nor the full path of the file. The path should be resolved in
2210Â /// your implementation of the Stream Manager (<tt>AK::IAkStreamMgr::CreateStd()</tt>), or in the Low-Level I/O module
2211Â /// (<tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt>) if you use the default Stream Manager's implementation.
2212Â /// - The cookie (in_pCookie) is passed to the Low-Level I/O module for your convenience, in <tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt>
2226Â void * in_pCookie, ///< Callback cookie (reserved to user, passed to the callback function, and also to <tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt> as AkFileSystemFlags::pCustomParam)
2250Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2251Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2252Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2254Â /// - The sound engine internally calls GetIDFromString(in_pszString) to return the correct bank ID.
2255Â /// Therefore, \c in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2256Â /// not the name of the file (if you changed it), nor the full path of the file. The path should be resolved in
2257Â /// your implementation of the Stream Manager (<tt>AK::IAkStreamMgr::CreateStd()</tt>), or in the Low-Level I/O module
2258Â /// (<tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt>) if you use the default Stream Manager's implementation.
2259Â /// - The cookie (in_pCookie) is passed to the Low-Level I/O module for your convenience, in <tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt>
2273Â void * in_pCookie, ///< Callback cookie (reserved to user, passed to the callback function, and also to <tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt> as AkFileSystemFlags::pCustomParam)
2279Â /// \aknote Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings. \endaknote
2297Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2298Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2299Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2301Â /// - The file path should be resolved in your implementation of the Stream Manager, or in the Low-Level I/O module if
2302Â /// you use the default Stream Manager's implementation. The ID overload of <tt>AK::IAkStreamMgr::CreateStd()</tt> and <tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt> are called.
2303Â /// - The cookie (in_pCookie) is passed to the Low-Level I/O module for your convenience, in <tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt>
2315Â void * in_pCookie, ///< Callback cookie (reserved to user, passed to the callback function, and also to <tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt> as AkFileSystemFlags::pCustomParam)
2321Â /// IMPORTANT: Banks loaded from memory with in-place data MUST be unloaded using the UnloadBank function
2322Â /// providing the same memory pointer. Make sure you are using the correct UnloadBank(...) overload
2326Â /// In-memory loading is in-place: *** the memory must be valid until the bank is unloaded. ***
2343Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2344Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2345Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2347Â /// - The memory must be aligned on platform-specific AK_BANK_PLATFORM_DATA_ALIGNMENT bytes (see AkTypes.h).
2348Â /// - (XboxOne only): If the bank may contain XMA in memory data, the memory must be allocated using the Device memory allocator.
2349Â /// - Avoid using this function for banks containing a lot of events or structure data: this data will be unpacked into the sound engine heap,
2350Â /// making the supplied bank memory redundant. For event/structure-only banks, prefer LoadBankMemoryCopy().
2359Â const void * in_pInMemoryBankPtr, ///< Pointer to the in-memory bank to load (pointer is stored in sound engine, memory must remain valid)
2368Â /// IMPORTANT: Banks loaded from memory with in-place data MUST be unloaded using the UnloadBank function
2369Â /// providing the same memory pointer. Make sure you are using the correct UnloadBank(...) overload
2373Â /// In-memory loading is in-place: *** the memory must be valid until the bank is unloaded. ***
2389Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2390Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2391Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2393Â /// - The memory must be aligned on platform-specific AK_BANK_PLATFORM_DATA_ALIGNMENT bytes (see AkTypes.h).
2394Â /// - (XboxOne only): If the bank may contain XMA in memory data, the memory must be allocated using the Device memory allocator.
2395Â /// - Avoid using this function for banks containing a lot of events or structure data: this data will be unpacked into the sound engine heap,
2396Â /// making the supplied bank memory redundant. For event/structure-only banks, prefer LoadBankMemoryCopy().
2405Â const void * in_pInMemoryBankPtr, ///< Pointer to the in-memory bank to load (pointer is stored in sound engine, memory must remain valid)
2415Â /// NOTE: Banks loaded from in-memory with out-of-place data must be unloaded using the standard UnloadBank function
2419Â /// in a buffer and pass its address to the sound engine, the media section of the bank will be copied into newly allocated
2421Â /// In-memory loading is out-of-place: the buffer can be released after the callback function is called. The advantage of using this
2439Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2440Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2441Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2451Â const void* in_pInMemoryBankPtr, ///< Pointer to the in-memory bank to load (pointer is not stored in sound engine, memory can be released after callback)
2460Â /// NOTE: Banks loaded from in-memory with out-of-place data must be unloaded using the standard UnloadBank function
2464Â /// in a buffer and pass its address to the sound engine, the media section of the bank will be copied into newly allocated
2466Â /// In-memory loading is out-of-place: the buffer can be released after the callback function is called. The advantage of using this
2484Â /// - Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
2485Â /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
2486Â /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
2496Â const void * in_pInMemoryBankPtr, ///< Pointer to the in-memory bank to load (pointer is not stored in sound engine, memory can be released after callback)
2507Â /// \return AK_Success if successful, AK_Fail otherwise. AK_Success is returned when the bank was not loaded.
2509Â /// - The sound engine internally calls GetIDFromString(in_pszString) to retrieve the bank ID,
2511Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2513Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2521Â const void * in_pInMemoryBankPtr, ///< Memory pointer from where the bank was initially loaded from. (REQUIRED to determine which bank associated to a memory pointer must be unloaded). Pass NULL if NULL was passed when loading the bank or if LoadBankMemoryCopy was used to load the bank.
2528Â /// \return AK_Success if successful, AK_Fail otherwise. AK_Success is returned when the bank was not loaded.
2530Â /// - The sound engine internally calls GetIDFromString(in_pszString) to retrieve the bank ID,
2532Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2534Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2542Â const void * in_pInMemoryBankPtr, ///< Memory pointer from where the bank was initially loaded from. (REQUIRED to determine which bank associated to a memory pointer must be unloaded). Pass NULL if NULL was passed when loading the bank or if LoadBankMemoryCopy was used to load the bank.
2547Â /// \return AK_Success if successful, AK_Fail otherwise. AK_Success is returned when the bank was not loaded.
2549Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2557Â const void * in_pInMemoryBankPtr, ///< Memory pointer from where the bank was initially loaded from. (REQUIRED to determine which bank associated to a memory pointer must be unloaded). Pass NULL if NULL was passed when loading the bank or if LoadBankMemoryCopy was used to load the bank.
2564Â /// \return AK_Success if scheduling successful (use a callback to be notified when completed)
2568Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2570Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2579Â const void * in_pInMemoryBankPtr, ///< Memory pointer from where the bank was initially loaded from. (REQUIRED to determine which bank associated to a memory pointer must be unloaded). Pass NULL if NULL was passed when loading the bank or if LoadBankMemoryCopy was used to load the bank.
2588Â /// \return AK_Success if scheduling successful (use a callback to be notified when completed)
2592Â /// Therefore, in_pszString should be the real name of the SoundBank (with or without the BNK extension - it is trimmed internally),
2594Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2603Â const void * in_pInMemoryBankPtr, ///< Memory pointer from where the bank was initially loaded from. (REQUIRED to determine which bank associated to a memory pointer must be unloaded). Pass NULL if NULL was passed when loading the bank or if LoadBankMemoryCopy was used to load the bank.
2611Â /// \return AK_Success if scheduling successful (use a callback to be notified when completed)
2613Â /// - In order to force the memory deallocation of the bank, sounds that use media from this bank will be stopped.
2622Â const void * in_pInMemoryBankPtr, ///< Memory pointer from where the bank was initially loaded from. (REQUIRED to determine which bank associated to a memory pointer must be unloaded). Pass NULL if NULL was passed when loading the bank or if LoadBankMemoryCopy was used to load the bank.
2628Â /// Cancels all Event callbacks associated with a specific callback cookie specified while loading Banks of preparing Events.\n
2646Â Preparation_Load, ///< \c PrepareEvent() will load required information to play the specified event.
2647Â Preparation_Unload, ///< \c PrepareEvent() will unload required information to play the specified event.
2648Â Preparation_LoadAndDecode ///< Vorbis media is decoded when loading, and an uncompressed PCM version is used for playback.
2649Â };
2653Â /// 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.
2659Â AkBankContent_StructureOnly, ///< Use AkBankContent_StructureOnly to load only the structural content, including Events, and then later use the PrepareEvent() functions to load media on demand from loose files on the disk.
2661Â };
2664Â /// 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
2665Â /// 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(),
2667Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2674Â /// 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
2675Â /// 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;
2676Â /// 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.
2678Â AK::SoundEngine::PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
2680Â AK::SoundEngine::AkBankContent in_uFlags = AkBankContent_All, ///< Structures only (including events) or all content.
2685Â /// 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
2686Â /// 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(),
2688Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2695Â /// \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
2696Â /// 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;
2697Â /// for example, a game may have a tool mode that uses PrepareEvent() to load loose files on-demand and, also, a game mode that uses \c LoadBank() to load the bank in entirety.
2699Â AK::SoundEngine::PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
2701Â AK::SoundEngine::AkBankContent in_uFlags = AkBankContent_All, ///< Structures only (including events) or all content.
2705Â /// \n\aknote Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings. \endaknote
2706Â /// 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
2707Â /// 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(),
2709Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2716Â /// \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
2717Â /// 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;
2718Â /// 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.
2720Â AK::SoundEngine::PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
2722Â AK::SoundEngine::AkBankContent in_uFlags = AkBankContent_All, ///< Structures only (including events) or all content.
2727Â /// 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
2728Â /// 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(),
2730Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2737Â /// 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
2738Â /// 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;
2739Â /// 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.
2741Â AK::SoundEngine::PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
2745Â AK::SoundEngine::AkBankContent in_uFlags = AkBankContent_All, ///< Structures only (including events) or all content.
2750Â /// 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
2751Â /// 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(),
2753Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2760Â /// 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
2761Â /// 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;
2762Â /// 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.
2764Â AK::SoundEngine::PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
2768Â AK::SoundEngine::AkBankContent in_uFlags = AkBankContent_All, ///< Structures only (including events) or all content.
2772Â /// \n\aknote Requires that the "Use SoundBank names" option be unchecked in the Wwise Project Settings. \endaknote
2773Â /// 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
2774Â /// 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(),
2776Â /// Calling this function specifying the flag AkBankContent_StructureOnly will load only the structural part (including events) of this bank,
2783Â /// \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
2784Â /// 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;
2785Â /// 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.
2787Â AK::SoundEngine::PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
2791Â AK::SoundEngine::AkBankContent in_uFlags = AkBankContent_All, ///< Structures only (including events) or all content.
2798Â /// - \c AK_Fail if the sound engine was not correctly initialized or if there is not enough memory to handle the command.
2821Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareEvent() does not exist.
2828Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2840Â PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
2860Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareEvent() does not exist.
2867Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2881Â PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
2887Â /// The Events are identified by their ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
2899Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareEvent() does not exist.
2906Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
2918Â PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
2925Â /// The Events are identified by string (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
2934Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
2948Â PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
2957Â /// The Events are identified by string (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
2966Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
2980Â PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
2988Â /// The Events are identified by their ID (refer to \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.
3011Â PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
3019Â /// The sources are identified by their ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3020Â /// \return AK_Success if operation was successful, AK_InvalidParameter if in_pSourceSettings is invalid or media sizes are 0.
3026Â /// Removes the specified source from the list of loaded media, even if this media is already in use.
3027Â /// The sources are identified by their ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3030Â /// If the media is still in use, this function will attempt to forcibly kill all sounds and effects referencing this media,
3031Â /// and then return AK_ResourceInUse. The client should NOT presume that the memory can be safely released at this point.
3032Â /// The moment at which the memory can be safely released is unknown, and the only safe course of action is to keep the memory
3036Â /// - \c AK_Success: Operation was successful, and the memory can be released on the client side.
3037Â /// - \c AK_ResourceInUse: Specified media is still in use by the sound engine, the client should not release the memory.
3044Â /// Removes the specified source from the list of loaded media, only if this media is not already in use.
3045Â /// The sources are identified by their ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3046Â /// \aknote Media that is still in use by the sound engine should not be unset. It is marked for removal to prevent additional use.
3047Â /// If this function returns AK_ResourceInUse, then the client must not release memory for this media.
3048Â /// Instead, the client should retry the TryUnsetMedia operation later with the same parameters and check for AK_Success.
3050Â /// 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.
3051Â /// out_pUnsetResults will be filled with either AK_Success or AK_ResourceInUse, indicating which media was still in use and not unset.
3053Â /// - \c AK_Success: Operation was successful, and the memory can be released on the client side.
3054Â /// - \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.
3064Â /// The group and game syncs are specified by string (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3073Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareGameSyncs() does not exist.
3080Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
3082Â /// You need to call PrepareGameSyncs() if the sound engine was initialized with AkInitSettings::bEnableGameSyncPreparation
3083Â /// set to true. When set to false, the sound engine automatically prepares all game syncs when preparing events,
3093Â PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
3096Â const wchar_t** in_ppszGameSyncName, ///< The specific ID of the state to either support or not support.
3102Â /// The group and game syncs are specified by string (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3111Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareGameSyncs() does not exist.
3118Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
3120Â /// You need to call PrepareGameSyncs() if the sound engine was initialized with AkInitSettings::bEnableGameSyncPreparation
3121Â /// set to true. When set to false, the sound engine automatically prepares all game syncs when preparing events,
3131Â PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
3134Â const char** in_ppszGameSyncName, ///< The specific ID of the state to either support or not support.
3139Â /// The group and game syncs are specified by ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3148Â /// - \c AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareGameSyncs() does not exist.
3155Â /// - \c AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
3157Â /// You need to call \c PrepareGameSyncs() if the sound engine was initialized with \c AkInitSettings::bEnableGameSyncPreparation
3158Â /// set to \c true. When set to \c false, the sound engine automatically prepares all game syncs when preparing Events,
3168Â PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
3171Â AkUInt32* in_paGameSyncID, ///< Array of ID of the game syncs to either support or not support.
3177Â /// The group and game syncs are specified by string (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3183Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3186Â /// You need to call \c PrepareGameSyncs() if the sound engine was initialized with \c AkInitSettings::bEnableGameSyncPreparation
3187Â /// set to \c true. When set to \c false, the sound engine automatically prepares all game syncs when preparing Events,
3198Â PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
3201Â const wchar_t** in_ppszGameSyncName, ///< The specific ID of the state to either support or not support.
3209Â /// The group and game syncs are specified by string (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3215Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3218Â /// You need to call PrepareGameSyncs() if the sound engine was initialized with AkInitSettings::bEnableGameSyncPreparation
3219Â /// set to true. When set to false, the sound engine automatically prepares all game syncs when preparing events,
3230Â PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
3233Â const char** in_ppszGameSyncName, ///< The specific ID of the state to either support or not support.
3240Â /// The group and game syncs are specified by ID (refer to \ref soundengine_banks_general for a discussion on using strings and IDs).
3246Â /// The function returns immediately. Use a callback to be notified when the request has finished being processed.
3249Â /// You need to call PrepareGameSyncs() if the sound engine was initialized with AkInitSettings::bEnableGameSyncPreparation
3250Â /// set to true. When set to false, the sound engine automatically prepares all Game Syncs when preparing Events,
3261Â PreparationType in_PreparationType, ///< Preparation type ( Preparation_Load or Preparation_Unload )
3264Â AkUInt32* in_paGameSyncID, ///< Array of ID of the Game Syncs to either support or not support.
3278Â /// 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.
3279Â /// Calling this function will override the default set of listeners and in_emitterGameObj will now reference its own, unique set of listeners.
3282Â /// - \c AK_CommandTooLarge if the number of positions is too large for the command queue. Reduce the number of positions.
3289Â AkGameObjectID in_emitterGameObj, ///< Emitter game object. Must have been previously registered via RegisterGameObj.
3290Â const AkGameObjectID* in_pListenerGameObjs, ///< Array of listener game object IDs that will be activated for in_emitterGameObj.
3295Â /// 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.
3296Â /// Calling this function will override the default set of listeners and in_emitterGameObj will now reference its own, unique set of listeners.
3303Â AkGameObjectID in_emitterGameObj, ///< Emitter game object. Must have been previously registered via RegisterGameObj.
3304Â AkGameObjectID in_listenerGameObj ///< Listener game object IDs that will be activated for in_emitterGameObj.
3308Â /// Calling this function will override the default set of listeners and in_emitterGameObj will now reference its own, unique set of listeners.
3316Â AkGameObjectID in_listenerGameObj ///< Listener game object IDs that will be deactivated for in_emitterGameObj. Game objects must have been previously registered.
3319Â /// 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
3320Â /// a call to AddListener, RemoveListener, SetListeners or SetGameObjectOutputBusVolume is made on that game object.
3321Â /// 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.
3326Â const AkGameObjectID* in_pListenerObjs, ///< Array of listener game object IDs that will be activated for subsequent registrations. Game objects must have been previously registered.
3330Â /// Add a single listener to the default set of listeners. Upon registration, all game objects reference the default listener set, until
3331Â /// a call to AddListener, RemoveListener, SetListeners or SetGameObjectOutputBusVolume is made on that game object.
3337Â AkGameObjectID in_listenerGameObj ///< Listener game object IDs that will be added to the default set of listeners.
3340Â /// Remove a single listener from the default set of listeners. Upon registration, all game objects reference the default listener set, until
3341Â /// a call to AddListener, RemoveListener, SetListeners or SetGameObjectOutputBusVolume is made on that game object.
3347Â AkGameObjectID in_listenerGameObj ///< Listener game object IDs that will be removed from the default set of listeners.
3350Â /// Resets the listener associations to the default listener(s), as set by <tt>SetDefaultListeners</tt>. This will also reset per-listener gains that have been set using <tt>SetGameObjectOutputBusVolume</tt>.
3363Â /// If \c in_bSpatialized is false, only \c in_pVolumeOffsets is used for this listener (3D positions
3364Â /// have no effect on the speaker distribution). Otherwise, \c in_pVolumeOffsets is added to the speaker
3366Â /// Use helper functions of \c AK::SpeakerVolumes to manipulate the vector of volume offsets in_pVolumeOffsets.
3369Â /// - If a sound is mixed into a bus that has a different speaker configuration than in_channelConfig,
3380Â bool in_bSpatialized, ///< Spatialization toggle (True : enable spatialization, False : disable spatialization)
3381Â AkChannelConfig in_channelConfig, ///< Channel configuration associated with volumes in_pVolumeOffsets. Ignored if in_pVolumeOffsets is NULL.
3382Â AK::SpeakerVolumes::VectorPtr in_pVolumeOffsets = NULL ///< Per-speaker volume offset, in dB. See AkSpeakerVolumes.h for how to manipulate this vector.
3393Â /// With this function, you may set a game parameter value with global scope or with game object scope.
3394Â /// 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
3395Â /// game objects that not yet registered, or already registered but not overridden with a value with game object scope.
3396Â /// To set a game parameter value with global scope, pass \c AK_INVALID_GAME_OBJECT as the game object.
3397Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3398Â /// value for \c in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3399Â /// according to the interpolation curve. If you call \c <tt><tt>SetRTPCValue()</tt></tt> with <tt>in_uValueChangeDuration = 0</tt> in the
3400Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3401Â /// function at every game frame, you should not use \c in_uValueChangeDuration, as it would have no effect and it is less efficient.
3415Â AkTimeMs in_uValueChangeDuration = 0, ///< Duration during which the game parameter is interpolated towards in_value
3416Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the game parameter interpolation
3417Â bool in_bBypassInternalValueInterpolation = false ///< True if you want to bypass the internal "slew rate" or "over time filtering" specified by the sound designer. This is meant to be used when for example loading a level and you dont want the values to interpolate.
3422Â /// With this function, you may set a game parameter value to global scope or to game object scope.
3423Â /// 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
3424Â /// game objects that not yet registered, or already registered but not overridden with a value with game object scope.
3425Â /// To set a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3426Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3427Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3428Â /// according to the interpolation curve. If you call SetRTPCValue() with in_uValueChangeDuration = 0 in the
3429Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3430Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3444Â AkTimeMs in_uValueChangeDuration = 0, ///< Duration during which the game parameter is interpolated towards in_value
3445Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the game parameter interpolation
3446Â bool in_bBypassInternalValueInterpolation = false ///< True if you want to bypass the internal "slew rate" or "over time filtering" specified by the sound designer. This is meant to be used when for example loading a level and you dont want the values to interpolate.
3451Â /// With this function, you may set a game parameter value with global scope or with game object scope.
3452Â /// 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
3453Â /// game objects that not yet registered, or already registered but not overridden with a value with game object scope.
3454Â /// To set a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3455Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3456Â /// value for \c in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3457Â /// according to the interpolation curve. If you call SetRTPCValue() with in_uValueChangeDuration = 0 in the
3458Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3459Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3473Â AkTimeMs in_uValueChangeDuration = 0, ///< Duration during which the game parameter is interpolated towards in_value
3474Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the game parameter interpolation
3475Â bool in_bBypassInternalValueInterpolation = false ///< True if you want to bypass the internal "slew rate" or "over time filtering" specified by the sound designer. This is meant to be used when for example loading a level and you dont want the values to interpolate.
3481Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3482Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3483Â /// according to the interpolation curve. If you call SetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3484Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3485Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3499Â AkTimeMs in_uValueChangeDuration = 0, ///< Duration during which the game parameter is interpolated towards in_value
3500Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the game parameter interpolation
3501Â bool in_bBypassInternalValueInterpolation = false ///< True if you want to bypass the internal "slew rate" or "over time filtering" specified by the sound designer. This is meant to be used when, for example, loading a level and you don't want the values to interpolate.
3508Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3509Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3510Â /// according to the interpolation curve. If you call SetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3511Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3512Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3526Â AkTimeMs in_uValueChangeDuration = 0, ///< Duration during which the game parameter is interpolated towards in_value
3527Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the game parameter interpolation
3528Â bool in_bBypassInternalValueInterpolation = false ///< True if you want to bypass the internal "slew rate" or "over time filtering" specified by the sound designer. This is meant to be used when, for example, loading a level and you don't want the values to interpolate.
3535Â /// With this function, you may also change the value of a game parameter over time. To do so, specify a non-zero
3536Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3537Â /// according to the interpolation curve. If you call SetRTPCValueByPlayingID() with in_uValueChangeDuration = 0 in the
3538Â /// middle of an interpolation, the interpolation stops and the new value is set directly. Thus, if you call this
3539Â /// function at every game frame, you should not use in_uValueChangeDuration, as it would have no effect and it is less efficient.
3553Â AkTimeMs in_uValueChangeDuration = 0, ///< Duration during which the game parameter is interpolated towards in_value
3554Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the game parameter interpolation
3555Â bool in_bBypassInternalValueInterpolation = false ///< True if you want to bypass the internal "slew rate" or "over time filtering" specified by the sound designer. This is meant to be used when for example loading a level and you dont want the values to interpolate.
3558Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3559Â /// With this function, you may reset a game parameter to its default value with global scope or with game object scope.
3560Â /// Game object scope supersedes global scope. Game parameter values reset with global scope are applied to all
3562Â /// To reset a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3563Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3564Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3565Â /// according to the interpolation curve. If you call SetRTPCValue() or ResetRTPCValue() with in_uValueChangeDuration = 0 in the
3579Â AkTimeMs in_uValueChangeDuration = 0, ///< Duration during which the game parameter is interpolated towards its default value
3580Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the game parameter interpolation
3581Â bool in_bBypassInternalValueInterpolation = false ///< True if you want to bypass the internal "slew rate" or "over time filtering" specified by the sound designer. This is meant to be used when for example loading a level and you dont want the values to interpolate.
3585Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3586Â /// With this function, you may reset a game parameter to its default value with global scope or with game object scope.
3587Â /// Game object scope supersedes global scope. Game parameter values reset with global scope are applied to all
3589Â /// To reset a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3590Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3591Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3592Â /// according to the interpolation curve. If you call SetRTPCValue() or ResetRTPCValue() with in_uValueChangeDuration = 0 in the
3606Â AkTimeMs in_uValueChangeDuration = 0, ///< Duration during which the game parameter is interpolated towards its default value
3607Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the game parameter interpolation
3608Â bool in_bBypassInternalValueInterpolation = false ///< True if you want to bypass the internal "slew rate" or "over time filtering" specified by the sound designer. This is meant to be used when for example loading a level and you dont want the values to interpolate.
3612Â /// Resets the value of the game parameter to its default value, as specified in the Wwise project.
3613Â /// With this function, you may reset a game parameter to its default value with global scope or with game object scope.
3614Â /// Game object scope supersedes global scope. Game parameter values reset with global scope are applied to all
3616Â /// To reset a game parameter value with global scope, pass AK_INVALID_GAME_OBJECT as the game object.
3617Â /// With this function, you may also reset the value of a game parameter over time. To do so, specify a non-zero
3618Â /// value for in_uValueChangeDuration. At each audio frame, the game parameter value will be updated internally
3619Â /// according to the interpolation curve. If you call SetRTPCValue() or ResetRTPCValue() with in_uValueChangeDuration = 0 in the
3633Â AkTimeMs in_uValueChangeDuration = 0, ///< Duration during which the game parameter is interpolated towards its default value
3634Â AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the game parameter interpolation
3635Â bool in_bBypassInternalValueInterpolation = false ///< True if you want to bypass the internal "slew rate" or "over time filtering" specified by the sound designer. This is meant to be used when for example loading a level and you dont want the values to interpolate.
3782Â /// Registers a callback to allow the game to modify or override the volume to be applied at the output of an audio bus.
3786Â /// \aknote The callback function will not be called for the Master Audio Bus, since the output of this bus is not a bus, but is instead an Audio Device.\endaknote
3804Â /// 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
3805Â /// 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.
3825Â /// 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
3826Â /// 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.
3839Â AkOutputDeviceID in_idOutput, ///< Output ID, as returned from AddOutput or GetOutputID. You can pass 0 for the main (default) output
3847Â /// 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
3848Â /// 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.
3859Â AkGameObjectID in_listenerObjID, ///< Associated listener game object ID. Pass AK_INVALID_GAME_OBJECT to set the Output Bus Volume for all connected listeners.
3870Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's effect will
3875Â AkUniqueID in_audioNodeID, ///< Can be a member of the Actor-Mixer or Interactive Music Hierarchy (not a bus).
3877Â AkUniqueID in_shareSetID ///< ShareSets ID; pass AK_INVALID_UNIQUE_ID to clear the effect slot
3886Â /// \aknote This function has unspecified behavior when adding an Effect to a currently playing
3887Â /// Bus which does not have any Effects, or removing the last Effect on a currently playing bus.
3889Â /// \aknote This function will replace existing Effects on the node. If the target node is not at
3890Â /// the top of the hierarchy and is in the actor-mixer hierarchy, the option "Override Parent" in
3891Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's Effect will
3901Â AkUniqueID in_shareSetID ///< ShareSets ID; pass AK_INVALID_UNIQUE_ID to clear the Effect slot
3911Â /// \aknote This function has unspecified behavior when adding an Effect to a currently playing
3912Â /// bus which does not have any Effects, or removing the last Effect on a currently playing Bus.
3914Â /// \aknote This function will replace existing Effects on the node. If the target node is not at
3915Â /// the top of the hierarchy and is in the Actor-Mixer Hierarchy, the option "Override Parent" in
3916Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's Effect will
3927Â AkUniqueID in_shareSetID ///< ShareSets ID; pass AK_INVALID_UNIQUE_ID to clear the effect slot
3937Â /// \aknote This function has unspecified behavior when adding an Effect to a currently playing
3938Â /// Bus which does not have any effects, or removing the last Effect on a currently playing bus.
3940Â /// \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
3941Â /// \aknote This function will replace existing Effects on the node. If the target node is not at
3942Â /// the top of the hierarchy and is in the Actor-Mixer Hierarchy, the option "Override Parent" in
3943Â /// the Effect section in Wwise must be enabled for this node, otherwise the parent's Effect will
3954Â AkUniqueID in_shareSetID ///< ShareSets ID; pass AK_INVALID_UNIQUE_ID to clear the effect slot
3957Â /// Sets an audio device effect shareset on the specified output device and effect slot index.
3961Â /// \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
3962Â /// \aknote This function will replace existing effects of the audio device shareset. \endaknote
3963Â /// \aknote Audio device effects support is limited to one shareset per plug-in type at any time. \endaknote
3964Â /// \aknote Errors are reported in the Wwise Capture Log if the effect cannot be set on the output device. \endaknote
3968Â AkOutputDeviceID in_outputDeviceID, ///< Output ID, as returned from AddOutput or GetOutputID. Most of the time this should be 0 to designate the main (default) output
3975Â /// Bus which does not have any Effects or mixer, or removing the last mixer on a currently playing Bus.
3977Â /// \aknote Make sure the new mixer shareset is included in a soundbank, and that sound bank is loaded. Otherwise you will see errors in the Capture Log.\endaknote
3989Â /// bus which does not have any effects nor mixer, or removing the last mixer on a currently playing bus.
3991Â /// \aknote Make sure the new mixer shareset is included in a soundbank, and that sound bank is loaded. Otherwise you will see errors in the Capture Log.\endaknote
4005Â /// bus which does not have any effects nor mixer, or removing the last mixer on a currently playing bus.
4007Â /// \aknote Make sure the new mixer shareset is included in a soundbank, and that sound bank is loaded. Otherwise you will see errors in the Capture Log.\endaknote
4024Â AkChannelConfig in_channelConfig ///< Desired channel configuration. An invalid configuration (from default constructor) means "as parent".
4036Â AkChannelConfig in_channelConfig ///< Desired channel configuration. An invalid configuration (from default constructor) means "as parent".
4048Â AkChannelConfig in_channelConfig ///< Desired channel configuration. An invalid configuration (from default constructor) means "as parent".
4051Â /// Sets a game object's obstruction and occlusion levels. If SetMultiplePositions were used, values are set for all positions.
4052Â /// To assign a unique obstruction and occlusion value to each sound position, instead use AK::SoundEngine::SetMultipleObstructionAndOcclusion.
4065Â /// Sets a game object's obstruction and occlusion value for each position defined by AK::SoundEngine::SetMultiplePositions.
4066Â /// This function differs from AK::SoundEngine::SetObjectObstructionAndOcclusion as a list of obstruction/occlusion pair is provided
4067Â /// and each obstruction/occlusion pair will affect the corresponding position defined at the same index.
4068Â /// \aknote In the case the number of obstruction/occlusion pairs is smaller than the number of positions, remaining positions'
4072Â /// - \c AK_CommandTooLarge if the number of obstruction values is too large for the command queue.
4073Â /// - \c AK_InvalidParameter if one of the parameter is out of range (check the debug console)
4078Â /// \return AK_Success if occlusion/obstruction values are successfully stored for this emitter
4082Â AkObstructionOcclusionValues* in_fObstructionOcclusionValues, ///< Array of obstruction/occlusion pairs to apply
4085Â AkUInt32 in_uNumOcclusionObstruction ///< Number of obstruction/occlusion pairs specified in the provided array
4089Â /// This function will write history data for all currently loaded containers and instantiated game
4090Â /// objects (for example, current position in Sequence Containers and previously played elements in
4093Â /// This function acquires the main audio lock, and may block the caller for several milliseconds.
4104Â /// This function will read history data from the passed-in stream reader interface, and apply it to all
4108Â /// This function acquires the main audio lock, and may block the caller for several milliseconds.
4126Â /// If more than one device is active, the system will create multiple files in the same output
4129Â /// If no device is running yet, the system will return success AK_Success despite doing nothing.
4130Â /// Use RegisterAudioDeviceStatusCallback to get notified when devices are created/destructed.
4132Â /// \return AK_Success if successful, AK_Fail if there was a problem starting the output capture.
4134Â /// - The sound engine opens a stream for writing using <tt>AK::IAkStreamMgr::CreateStd()</tt>. If you are using the
4135Â /// default implementation of the Stream Manager, file opening is executed in your implementation of
4136Â /// the Low-Level IO interface <tt>AK::StreamMgr::IAkFileLocationResolver::Open()</tt>. The following
4137Â /// AkFileSystemFlags are passed: uCompanyID = AKCOMPANYID_AUDIOKINETIC and uCodecID = AKCODECID_PCM,
4138Â /// and the AkOpenMode is AK_OpenModeWriteOvrwr. Refer to \ref streamingmanager_lowlevel_location for
4155Â /// \return AK_Success if successful, AK_Fail if there was a problem stopping the output capture.
4176Â /// The callback will be called from the audio thread during real-time rendering and from the main thread during offline rendering.
4188Â AkOutputDeviceID in_idOutput = AK_INVALID_OUTPUT_DEVICE_ID, ///< The audio device specific id, return by AK::SoundEngine::AddOutput or AK::SoundEngine::GetOutputID
4189Â void* in_pCookie = NULL ///< Callback cookie that will be sent to the callback function along with additional information
4204Â AkOutputDeviceID in_idOutput = AK_INVALID_OUTPUT_DEVICE_ID, ///< The audio device specific id, return by AK::SoundEngine::AddOutput or AK::SoundEngine::GetOutputID
4205Â void* in_pCookie = NULL ///< Callback cookie that will be sent to the callback function along with additional information
4208Â /// Starts recording the sound engine profiling information into a file. This file can be read
4209Â /// by Wwise Authoring. The file is created at the base path. If you have integrated Wwise I/O,
4210Â /// you can use <tt>CAkDefaultIOHookBlocking::SetBasePath()</tt> (or <tt>CAkDefaultIOHookBlocking::AddBasePath()</tt>)
4211Â /// to change the location where the file is saved. The profiling session records all data types possible.
4217Â const AkOSChar* in_CaptureFileName ///< Name of the output profiler file (.prof extension recommended)
4232Â /// 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.
4250Â /// Adds an output to the sound engine. Use this to add controller-attached headphones, controller speakers, DVR output, etc.
4251Â /// 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).
4253Â /// Like most functions of AK::SoundEngine, AddOutput is asynchronous. A successful return code merely indicates that the request is properly queued.
4254Â /// Error codes returned by this function indicate various invalid parameters. To know if this function succeeds or not, and the failure code,
4263Â /// The following codes are returned directly from the function, as opposed to the AkDeviceStatusCallback
4265Â /// - \c AK_InvalidParameter: Out of range parameters or unsupported parameter combinations (see parameter list below).
4266Â /// - \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.
4267Â /// - \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.
4268Â /// - \c AK_NotInitialized: If AK::SoundEngine::Init was not called or if the Init.bnk was not loaded before the call.
4273Â /// - \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.
4274Â /// - \c AK_PluginNotRegistered: The audioDeviceShareset exists but the plug-in it refers to is not installed or statically linked with the game.
4275Â /// - \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.
4276Â /// - \c AK_DeviceNotCompatible: The hardware does not support this type of output. Wwise will NOT fallback to any other type of output.
4277Â /// - \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.
4278Â /// - \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.
4280Â const AkOutputSettings & in_Settings, ///< Creation parameters for this output. \ref AkOutputSettings
4281Â AkOutputDeviceID *out_pDeviceID = NULL, ///< (Optional) Output ID to use with all other Output management functions. Leave to NULL if not required. \ref AK::SoundEngine::GetOutputID
4282Â const AkGameObjectID* in_pListenerIDs = NULL, ///< Specific listener(s) to attach to this device.
4283Â ///< If specified, only the sounds routed to game objects linked to those listeners will play in this device.
4284Â ///< It is necessary to have separate listeners if multiple devices of the same type can coexist (e.g. controller speakers)
4285Â ///< If not specified, sound routing simply obey the associations between Master Busses and Audio Devices setup in the Wwise Project.
4290Â /// If a listener was associated with the device, you should consider unregistering the listener prior to call RemoveOutput
4296Â AkOutputDeviceID in_idOutput ///< ID of the output to remove. Use the returned ID from AddOutput, GetOutputID, or ReplaceOutput
4299Â /// Replaces an output device previously created during engine initialization or from AddOutput, with a new output device.
4300Â /// 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
4301Â /// that the old output device was associated with, and preserve all listeners that were attached to the old output device.
4303Â /// Like most functions of AK::SoundEngine, AddOutput is asynchronous. A successful return code merely indicates that the request is properly queued.
4304Â /// Error codes returned by this function indicate various invalid parameters. To know if this function succeeds or not, and the failure code,
4312Â /// - \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.
4313Â /// - \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.
4314Â /// - \c AK_DeviceNotFound: The in_outputDeviceId provided does not match with any of the output devices that the sound engine is currently using.
4315Â /// - \c AK_InvalidParameter: Out of range parameters or unsupported parameter combinations on in_settings
4318Â const AkOutputSettings & in_Settings, ///< Creation parameters for this output. \ref AkOutputSettings
4319Â AkOutputDeviceID in_outputDeviceId, ///< AkOutputDeviceID of the output to replace. Use 0 to target the current main output, regardless of its id. Otherwise, use the AkOuptutDeviceID returned from AddOutput() or ReplaceOutput(), or generated by GetOutputID()
4320Â AkOutputDeviceID *out_pOutputDeviceId = NULL ///< (Optional) Pointer into which the method writes the AkOutputDeviceID of the new output device. If the call fails, the value pointed to will not be modified.
4324Â /// 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.
4325Â /// Use 0 for in_idShareset & in_idDevice to get the Main Output ID (the one usually initialized during AK::SoundEngine::Init)
4328Â AkUniqueID in_idShareset, ///< Audio Device ShareSet ID, as defined in the Wwise Project. If needed, use AK::SoundEngine::GetIDFromString() to convert from a string. Set to AK_INVALID_UNIQUE_ID to use the default.
4329Â AkUInt32 in_idDevice ///< Device specific identifier, when multiple devices of the same type are possible. If only one device is possible, leave to 0.
4334Â const char* in_szShareSet, ///< Audio Device ShareSet Name, as defined in the Wwise Project. If Null, will select the Default Output shareset (always available)
4335Â AkUInt32 in_idDevice ///< Device specific identifier, when multiple devices of the same type are possible. If only one device is possible, leave to 0.
4341Â const wchar_t* in_szShareSet, ///< Audio Device ShareSet Name, as defined in the Wwise Project. If Null, will select the Default Output shareset (always available)
4342Â AkUInt32 in_idDevice ///< Device specific identifier, when multiple devices of the same type are possible. If only one device is possible, leave to 0.
4347Â /// Sets the Audio Device to which a master bus outputs. This overrides the setting in the Wwise project.
4348Â /// Can only be set on top-level busses. The Init bank should be successfully loaded prior to this call.
4349Â /// \aknote This function is useful only if used before the creation of an output, at the beginning of the sound engine setup.
4350Â /// Once active outputs using this Bus have been created, it is imperative to use AK::SoundEngine:ReplaceOutput instead to change the type of output.
4352Â /// AK_IDNotFound when either the Bus ID or the Device ID are not present in the Init bank or the bank was not loaded
4353Â /// AK_InvalidParameter when the specified bus is not a Master Bus. This function can be called only on busses that have no parent bus.
4359Â /// Sets the Audio Device to which a master bus outputs. This overrides the setting in the Wwise project.
4360Â /// Can only be set on top-level busses. The Init bank should be successfully loaded prior to this call.
4361Â /// \aknote This function is useful only if used before the creation of an output, at the beginning of the sound engine setup.
4362Â /// Once active outputs using this Bus have been created, it is imperative to use AK::SoundEngine:ReplaceOutput instead to change the type of output.
4364Â /// AK_IDNotFound when either the Bus ID or the Device ID are not present in the Init bank or the bank was not loaded
4365Â /// AK_InvalidParameter when the specified bus is not a Master Bus. This function can be called only on busses that have no parent bus.
4372Â /// Sets the Audio Device to which a master bus outputs. This overrides the setting in the Wwise project.
4373Â /// Can only be set on top-level busses. The Init bank should be successfully loaded prior to this call.
4374Â /// SetBusDevice must be preceded by a call to AddOutput for the new device shareset to be registered as an output.
4376Â /// AK_IDNotFound when either the Bus ID or the Device ID are not present in the Init bank or the bank was not loaded
4377Â /// AK_InvalidParameter when the specified bus is not a Master Bus. This function can be called only on busses that have no parent bus.
4384Â /// Returns a listing of the current devices for a given sink plug-in, including Device ID, friendly name, and state.
4386Â /// Prerequisites: the plug-in must have been initialized by loading the init bank or by calling \ref AK::SoundEngine::RegisterPlugin.
4389Â /// - \c AK_PluginNotRegistered if the plug-in has not been registered yet either by loading the init bank or by calling RegisterPluginDLL.
4394Â AkUInt32 in_ulCompanyID, ///< Company identifier (as declared in the plug-in description XML file)
4395Â AkUInt32 in_ulPluginID, ///< Plug-in identifier (as declared in the plug-in description XML file)
4396Â AkUInt32& io_maxNumDevices, ///< In: The length of the out_deviceDescriptions array. Out: If out_deviceDescriptions is not-null, this will be set to the number of entries in out_deviceDescriptions that was populated. If out_deviceDescriptions is null, this will be set to the number of devices that may be available.
4400Â /// Returns a listing of the current devices for a given sink plug-in, including Device ID, friendly name, and state.
4403Â /// * The plug-in must have been initialized by loading the init bank or by calling \ref AK::SoundEngine::RegisterPlugin.
4404Â /// * The audio device shareset must have been loaded from a soundbank and a device with this shareset must exist in the pipeline.
4407Â /// AK_PluginNotRegistered if the plug-in has not been registered yet either by loading the init bank or by calling RegisterPluginDLL.
4409Â AkUniqueID in_audioDeviceShareSetID, ///< In: The audio device shareset ID for which to list the sink plug-in devices.
4410Â AkUInt32& io_maxNumDevices, ///< In: The length of the out_deviceDescriptions array. Out: If out_deviceDescriptions is not-null, this will be set to the number of entries in out_deviceDescriptions that was populated. If out_deviceDescriptions is null, this will be set to the number of devices that may be available.
4419Â AkOutputDeviceID in_idOutput, ///< Output ID to set the volume on. As returned from AddOutput or GetOutputID
4423Â /// 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).
4424Â /// 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
4425Â /// 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
4426Â /// 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.
4428Â /// AK_NotCompatible when the device ID provided does not support spatial audio, or the platform does not support spatial audio
4429Â /// AK_Fail when there is some other miscellaneous failure, or the device ID provided does not match a device that the system knows about
4432Â AkUInt32 in_idDevice ///< Device specific identifier, when multiple devices of the same type are possible. If only one device is possible, leave to 0.
4439Â /// 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.
4440Â /// Call \c WakeupFromSuspend when your application receives the message from the OS that the process is back in foreground.
4441Â /// When suspended, the sound engine will process API messages (like PostEvent and SetSwitch) only when \ref RenderAudio() is called.
4442Â /// It is recommended to match the <b>in_bRenderAnyway</b> parameter with the behavior of the rest of your game:
4443Â /// 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.
4444Â /// If you want to minimize CPU when in background, then don't allow rendering and never call RenderAudio from the game.
4446Â /// Consult \ref workingwithsdks_system_calls to learn when it is appropriate to call this function for each platform.
4450Â bool in_bRenderAnyway = false, ///< If set to true, audio processing will still occur, but not outputted. When set to false, no audio will be processed at all, even upon reception of RenderAudio().
4451Â bool in_bFadeOut = true ///< Delay the suspend by one audio frame in order to fade-out. When false, the suspend takes effect immediately but audio may glitch.
4454Â /// 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.
4456Â /// Consult \ref workingwithsdks_system_calls to learn when it is appropriate to call this function for each platform.
4460Â 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.
4463Â /// Obtains the current audio output buffer tick. This corresponds to the number of buffers produced by
AKSOUNDENGINE_API AKRESULT RegisterPluginDLL(const AkOSChar *in_DllName, const AkOSChar *in_DllPath=NULL)
AkUInt32 uMonitorQueuePoolSize
Size of the monitoring queue, in bytes. This parameter is not used in Release build.
Definition: AkSoundEngine.h:242
AKSOUNDENGINE_API AKRESULT RemoveDefaultListener(AkGameObjectID in_listenerGameObj)
AKSOUNDENGINE_API AKRESULT PrepareEvent(PreparationType in_PreparationType, const char **in_ppszString, AkUInt32 in_uNumEvent)
AKSOUNDENGINE_API AkUInt32 GetSampleRate()
void(* AkProfilerPostMarkerFunc)(AkPluginID in_uPluginID, const char *in_pszMarkerName)
Definition: AkSoundEngine.h:220
AKSOUNDENGINE_API AKRESULT SetRTPCValue(AkRtpcID in_rtpcID, AkRtpcValue in_value, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)
AKSOUNDENGINE_API AKRESULT SetOutputDeviceEffect(AkOutputDeviceID in_outputDeviceID, AkUInt32 in_uFXIndex, AkUniqueID in_FXShareSetID)
AKSOUNDENGINE_API AKRESULT SetSpeakerAngles(const AkReal32 *in_pfSpeakerAngles, AkUInt32 in_uNumAngles, AkReal32 in_fHeightAngle, AkOutputDeviceID in_idOutput=0)
AkBackgroundMusicChangeCallbackFunc BGMCallback
Application-defined audio source change event callback function.
Definition: AkSoundEngine.h:253
Auxiliary bus sends information per game object per given auxiliary bus.
Definition: AkTypes.h:923
Definition: AkCommonDefs.h:419
AKSOUNDENGINE_API void ExecuteActionOnPlayingID(AkActionOnEventType in_ActionType, AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
AKSOUNDENGINE_API AKRESULT LoadBankMemoryView(const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankID &out_bankID)
AKSOUNDENGINE_API AKRESULT PrepareGameSyncs(PreparationType in_PreparationType, AkGroupType in_eGameSyncType, const char *in_pszGroupName, const char **in_ppszGameSyncName, AkUInt32 in_uNumGameSyncs)
AKSOUNDENGINE_API AKRESULT GetSourcePlayPositions(AkPlayingID in_PlayingID, AkSourcePosition *out_puPositions, AkUInt32 *io_pcPositions, bool in_bExtrapolate=true)
AKSOUNDENGINE_API AKRESULT Init(AkInitSettings *in_pSettings, AkPlatformInitSettings *in_pPlatformSettings)
AKSOUNDENGINE_API AKRESULT SetSwitch(AkSwitchGroupID in_switchGroup, AkSwitchStateID in_switchState, AkGameObjectID in_gameObjectID)
void(* AkResourceMonitorCallbackFunc)(const AkResourceMonitorDataSummary *in_pdataSummary)
Definition: AkCallback.h:375
void(* AkJobWorkerFunc)(AkJobType in_jobType, AkUInt32 in_uExecutionTimeUsec)
Definition: AkSoundEngine.h:180
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:2659
IAkSoftwareCodec *(* AkCreateFileSourceCallback)(void *in_pCtx)
Registered file source creation function prototype.
Definition: AkTypes.h:1098
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:271
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:240
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:169
AkReal32 fDebugOutOfRangeLimit
Debug setting: Only used when bDebugOutOfRangeCheckEnabled is true. This defines the maximum values s...
Definition: AkSoundEngine.h:266
Definition: AkSpeakerConfig.h:497
AKSOUNDENGINE_API AKRESULT RegisterGlobalCallback(AkGlobalCallbackFunc in_pCallback, AkUInt32 in_eLocation=AkGlobalCallbackLocation_BeginRender, void *in_pCookie=NULL, AkPluginType in_eType=AkPluginTypeNone, AkUInt32 in_ulCompanyID=0, AkUInt32 in_ulPluginID=0)
AKSOUNDENGINE_API void CancelEventCallbackCookie(void *in_pCookie)
AkUInt32 updateBufferTick
Value of GetBufferTick() at the time the position was updated.
Definition: AkSoundEngine.h:290
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:1335
AKSOUNDENGINE_API AKRESULT RegisterGameObj(AkGameObjectID in_gameObjectID)
void(* AkGlobalCallbackFunc)(AK::IAkGlobalPluginContext *in_pContext, AkGlobalCallbackLocation in_eLocation, void *in_pCookie)
Definition: AkCallback.h:368
@ Preparation_LoadAndDecode
Vorbis media is decoded when loading, and an uncompressed PCM version is used for playback.
Definition: AkSoundEngine.h:2648
AkMeteringFlags
Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback(...
Definition: AkTypes.h:1207
AKSOUNDENGINE_API AKRESULT GetContainerHistory(AK::IWriteBytes *in_pBytes)
AKSOUNDENGINE_API AKRESULT LoadBank(const char *in_pszString, AkBankID &out_bankID, AkBankType in_bankType=AkBankType_User)
AKSOUNDENGINE_API AKRESULT SetState(AkStateGroupID in_stateGroup, AkStateID in_state)
Platform-independent initialization settings of output devices.
Definition: AkSoundEngine.h:132
AKSOUNDENGINE_API bool IsInitialized()
@ Preparation_Unload
PrepareEvent() will unload required information to play the specified event.
Definition: AkSoundEngine.h:2647
@ AkBankContent_All
Use AkBankContent_All to load both the media and structural content.
Definition: AkSoundEngine.h:2660
void(* AkBusMeteringCallbackFunc)(AkBusMeteringCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:286
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:289
AKSOUNDENGINE_API AKRESULT SetOutputVolume(AkOutputDeviceID in_idOutput, AkReal32 in_fVolume)
AKSOUNDENGINE_API AKRESULT GetPanningRule(AkPanningRule &out_ePanningRule, AkOutputDeviceID in_idOutput=0)
void(* AkOutputDeviceMeteringCallbackFunc)(AkOutputDeviceMeteringCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:296
AKSOUNDENGINE_API AKRESULT SetBankLoadIOSettings(AkReal32 in_fThroughput, AkPriority in_priority)
AKSOUNDENGINE_API AKRESULT AddOutputCaptureMarker(const char *in_MarkerText)
AKSOUNDENGINE_API AKRESULT RegisterAudioDeviceStatusCallback(AK::AkDeviceStatusCallbackFunc in_pCallback)
AKSOUNDENGINE_API AKRESULT PostTrigger(AkTriggerID in_triggerID, AkGameObjectID in_gameObjectID)
AKSOUNDENGINE_API AKRESULT PinEventInStreamCache(AkUniqueID in_eventID, AkPriority in_uActivePriority, AkPriority in_uInactivePriority)
AKSOUNDENGINE_API void CancelEventCallbackGameObject(AkGameObjectID in_gameObjectID)
Position and orientation of game objects in the world (i.e. supports 64-bit-precision position)
Definition: AkTypes.h:474
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:196
AKSOUNDENGINE_API AKRESULT SetActorMixerEffect(AkUniqueID in_audioNodeID, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
AkSetPositionFlags
Flags to independently set the position of the emitter or listener component on a game object.
Definition: AkTypes.h:1172
AKSOUNDENGINE_API AKRESULT RegisterCodec(AkUInt32 in_ulCompanyID, AkUInt32 in_ulCodecID, AkCreateFileSourceCallback in_pFileCreateFunc, AkCreateBankSourceCallback in_pBankCreateFunc)
@ MultiPositionType_MultiDirections
Simulate one sound coming from multiple directions. Useful for repositionning sounds based on wall op...
Definition: AkTypes.h:1147
bool bUseLEngineThread
Use a separate thread for processing audio. If set to false, audio processing will occur in RenderAud...
Definition: AkSoundEngine.h:251
AKSOUNDENGINE_API AKRESULT StopProfilerCapture()
AKSOUNDENGINE_API AKRESULT SetObjectObstructionAndOcclusion(AkGameObjectID in_EmitterID, AkGameObjectID in_ListenerID, AkReal32 in_fObstructionLevel, AkReal32 in_fOcclusionLevel)
AKSOUNDENGINE_API AkOutputDeviceID GetOutputID(AkUniqueID in_idShareset, AkUInt32 in_idDevice)
AkOutputSettings(const char *in_szDeviceShareSet, AkUniqueID in_idDevice=AK_INVALID_UNIQUE_ID, AkChannelConfig in_channelConfig=AkChannelConfig(), AkPanningRule in_ePanning=AkPanningRule_Speakers)
AkUInt32 uMaxActiveWorkers[AK_NUM_JOB_TYPES]
The maximum number of concurrent workers that will be requested. Must be >= 1 for each jobType.
Definition: AkSoundEngine.h:198
AkReal32 * VectorPtr
Volume vector. Access each element with the standard bracket [] operator.
Definition: AkSpeakerVolumes.h:48
AKSOUNDENGINE_API AKRESULT DecodeBank(const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkMemPoolId in_uPoolForDecodedBank, void *&out_pDecodedBankPtr, AkUInt32 &out_uDecodedBankSize)
Definition: AkTypes.h:321
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:215
@ AkFloorPlane_XZ
The floor is oriented along the ZX-plane. The front vector points towards +Z, the up vector towards +...
Definition: AkSoundEngine.h:168
AkUInt32 uContinuousPlaybackLookAhead
Default is 1 audio quantum, also known as an audio frame. Its size is equal to AkInitSettings::uNumSa...
Definition: AkSoundEngine.h:237
AKSOUNDENGINE_API AKRESULT RemoveOutput(AkOutputDeviceID in_idOutput)
bool bEnableGameSyncPreparation
Sets to true to enable AK::SoundEngine::PrepareGameSync usage.
Definition: AkSoundEngine.h:236
AKSOUNDENGINE_API AkUInt32 GetBufferTick()
AKSOUNDENGINE_API AKRESULT RegisterResourceMonitorCallback(AkResourceMonitorCallbackFunc in_pCallback)
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:255
void * pClientData
Arbitrary data that will be passed back to the client when calling FuncRequestJobWorker.
Definition: AkSoundEngine.h:203
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:232
Necessary settings for setting externally-loaded sources.
Definition: AkSoundEngine.h:277
AkUInt32 uMemorySlabSize
Size of each memory slab used for job manager memory. Must be a power of two. Default is 8K.
Definition: AkSoundEngine.h:201
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:248
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:2646
AKSOUNDENGINE_API AKRESULT UnregisterGameObj(AkGameObjectID in_gameObjectID)
AKSOUNDENGINE_API AKRESULT SetJobMgrMaxActiveWorkers(AkJobType in_jobType, AkUInt32 in_uNewMaxActiveWorkers)
AKSOUNDENGINE_API AKRESULT RenderAudio(bool in_bAllowSyncRender=true)
AkJobMgrSettings settingsJobManager
Settings to configure the behavior of the Sound Engine's internal job manager.
Definition: AkSoundEngine.h:246
void(* AkCaptureCallbackFunc)(AkAudioBuffer &in_CaptureBuffer, AkOutputDeviceID in_idOutput, void *in_pCookie)
Definition: AkCallback.h:408
Positioning information for a sound, with specified subset of its channels.
Definition: AkTypes.h:776
AKSOUNDENGINE_API AKRESULT SetListenerSpatialization(AkGameObjectID in_uListenerID, bool in_bSpatialized, AkChannelConfig in_channelConfig, AK::SpeakerVolumes::VectorPtr in_pVolumeOffsets=NULL)
AKSOUNDENGINE_API AKRESULT SetGameObjectAuxSendValues(AkGameObjectID in_gameObjectID, AkAuxSendValue *in_aAuxSendValues, AkUInt32 in_uNumSendValues)
Settings for the Sound Engine's internal job manager.
Definition: AkSoundEngine.h:187
AKSOUNDENGINE_API AkPlayingID PostMIDIOnEvent(AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkMIDIPost *in_pPosts, AkUInt16 in_uNumPosts, bool in_bAbsoluteOffsets=false, AkUInt32 in_uFlags=0, AkCallbackFunc in_pfnCallback=NULL, void *in_pCookie=NULL, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID)
static const AkUInt32 AK_NUM_JOB_TYPES
Number of possible job types recognized by the Sound Engine.
Definition: AkTypes.h:195
void(* AkCallbackFunc)(AkCallbackType in_eType, AkCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:266
AKRESULT(* AkBackgroundMusicChangeCallbackFunc)(bool in_bBackgroundMusicMuted, void *in_pCookie)
Definition: AkSoundEngine.h:125
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:280
AKSOUNDENGINE_API AKRESULT UnloadBank(const char *in_pszString, const void *in_pInMemoryBankPtr, AkBankType in_bankType=AkBankType_User)
AKSOUNDENGINE_API AKRESULT RegisterBusMeteringCallback(AkUniqueID in_busID, AkBusMeteringCallbackFunc in_pfnCallback, AkMeteringFlags in_eMeteringFlags, void *in_pCookie=NULL)
AKSOUNDENGINE_API void SetRandomSeed(AkUInt32 in_uSeed)
Definition: IAkPlugin.h:1364
void(* AkBusCallbackFunc)(AkSpeakerVolumeMatrixCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:276
AkUInt32 uNumMemorySlabs
Number of memory slabs to pre-allocate for job manager memory. At least one slab per worker thread sh...
Definition: AkSoundEngine.h:200
AKSOUNDENGINE_API void GetDefaultPlatformInitSettings(AkPlatformInitSettings &out_platformSettings)
AKSOUNDENGINE_API AKRESULT TryUnsetMedia(AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings, AKRESULT *out_pUnsetResults)
AKSOUNDENGINE_API AKRESULT SetMultiplePositions(AkGameObjectID in_GameObjectID, const AkSoundPosition *in_pPositions, AkUInt16 in_NumPositions, MultiPositionType in_eMultiPositionType=MultiPositionType_MultiDirections, AkSetPositionFlags in_eFlags=AkSetPositionFlags_Default)
AKSOUNDENGINE_API AKRESULT GetSourcePlayPosition(AkPlayingID in_PlayingID, AkTimeMs *out_puPosition, bool in_bExtrapolate=true)
Definition: IBytes.h:152
AKSOUNDENGINE_API AKRESULT SetDistanceProbe(AkGameObjectID in_listenerGameObjectID, AkGameObjectID in_distanceProbeGameObjectID)
AKSOUNDENGINE_API AKRESULT SetListeners(AkGameObjectID in_emitterGameObj, const AkGameObjectID *in_pListenerGameObjs, AkUInt32 in_uNumListeners)
AKSOUNDENGINE_API AKRESULT SetPosition(AkGameObjectID in_GameObjectID, const AkSoundPosition &in_Position, AkSetPositionFlags in_eFlags=AkSetPositionFlags_Default)
AKSOUNDENGINE_API AKRESULT SendPluginCustomGameData(AkUniqueID in_busID, AkGameObjectID in_busObjectID, AkPluginType in_eType, AkUInt32 in_uCompanyID, AkUInt32 in_uPluginID, const void *in_pData, AkUInt32 in_uSizeInBytes)
@ AkPanningRule_Speakers
Left and right positioned 60 degrees apart (by default - see AK::SoundEngine::GetSpeakerAngles()).
Definition: AkTypes.h:1182
AKSOUNDENGINE_API AKRESULT SetBusEffect(AkUniqueID in_audioNodeID, AkUInt32 in_uFXIndex, AkUniqueID in_shareSetID)
void(* AkBankCallbackFunc)(AkUInt32 in_bankID, const void *in_pInMemoryBankPtr, AKRESULT in_eLoadResult, void *in_pCookie)
Definition: AkCallback.h:326
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:109
AKSOUNDENGINE_API AKRESULT SetMixer(AkUniqueID in_audioNodeID, AkUniqueID in_shareSetID)
AKSOUNDENGINE_API AkUInt32 GetIDFromString(const char *in_pszString)
AKSOUNDENGINE_API AKRESULT PrepareBank(AK::SoundEngine::PreparationType in_PreparationType, const char *in_pszString, AK::SoundEngine::AkBankContent in_uFlags=AkBankContent_All, AkBankType in_bankType=AkBankType_User)
AKSOUNDENGINE_API AKRESULT SetOfflineRendering(bool in_bEnableOfflineRendering)
AKSOUNDENGINE_API AKRESULT LoadBankMemoryCopy(const void *in_pInMemoryBankPtr, AkUInt32 in_uInMemoryBankSize, AkBankID &out_bankID)
AKSOUNDENGINE_API AKRESULT SetPanningRule(AkPanningRule in_ePanningRule, AkOutputDeviceID in_idOutput=0)
AKSOUNDENGINE_API AKRESULT AddDefaultListener(AkGameObjectID in_listenerGameObj)
AKSOUNDENGINE_API AKRESULT SetGameObjectOutputBusVolume(AkGameObjectID in_emitterObjID, AkGameObjectID in_listenerObjID, AkReal32 in_fControlValue)
AKSOUNDENGINE_API AKRESULT AddOutput(const AkOutputSettings &in_Settings, AkOutputDeviceID *out_pDeviceID=NULL, const AkGameObjectID *in_pListenerIDs=NULL, AkUInt32 in_uNumListeners=0)
AKSOUNDENGINE_API AKRESULT Suspend(bool in_bRenderAnyway=false, bool in_bFadeOut=true)
Definition: AkTypes.h:301
AKSOUNDENGINE_API AKRESULT StopOutputCapture()
AkUInt32 uCpuMonitorQueueMaxSize
Maximum size of the CPU monitoring queue, per thread, in bytes. This parameter is not used in Release...
Definition: AkSoundEngine.h:243
AK::IAkPluginParam *(* AkCreateParamCallback)(AK::IAkPluginMemAlloc *in_pAllocator)
Registered plugin parameter node creation function prototype.
Definition: IAkPlugin.h:1333
AKSOUNDENGINE_API AKRESULT ResetListenersToDefault(AkGameObjectID in_emitterGameObj)
AKSOUNDENGINE_API AKRESULT SetBusDevice(AkUniqueID in_idBus, AkUniqueID in_idNewDevice)
AKSOUNDENGINE_API AKRESULT ExecuteActionOnEvent(AkUniqueID in_eventID, AkActionOnEventType in_ActionType, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)
AKSOUNDENGINE_API AKRESULT SetMedia(AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings)
AKSOUNDENGINE_API void CancelBankCallbackCookie(void *in_pCookie)
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:162
@ AkFloorPlane_YZ
The floor is oriented along the YZ-plane. The front vector points towards +Y, the up vector towards +...
Definition: AkSoundEngine.h:170
AkTimeMs msTime
Position of the source (in ms) associated with that playing item.
Definition: AkSoundEngine.h:288
void * BGMCallbackCookie
Application-defined user data for the audio source change event callback function.
Definition: AkSoundEngine.h:254
AkUniqueID sourceID
Source ID (available in the SoundBank content files)
Definition: AkSoundEngine.h:278
bool bUseSoundBankMgrThread
Use a separate thread for loading sound banks. Allows asynchronous operations.
Definition: AkSoundEngine.h:250
void(* AkDeviceStatusCallbackFunc)(AK::IAkGlobalPluginContext *in_pContext, AkUniqueID in_idAudioDeviceShareset, AkUInt32 in_idDeviceID, AkAudioDeviceEvent in_idEvent, AKRESULT in_AkResult)
Definition: AkCallback.h:390
AkUniqueID mediaID
Media ID of playing item. (corresponds to 'ID' attribute of 'File' element in SoundBank metadata file...
Definition: AkSoundEngine.h:287
Definition: AkMidiTypes.h:237
bool bDebugOutOfRangeCheckEnabled
Debug setting: Enable checks for out-of-range (and NAN) floats in the processing code....
Definition: AkSoundEngine.h:268
Definition: AkSoundEngine.h:231
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:272
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:1331
IAkSoftwareCodec *(* AkCreateBankSourceCallback)(void *in_pCtx)
Registered bank source node creation function prototype.
Definition: AkTypes.h:1100
AKSOUNDENGINE_API AkUInt64 GetSampleTick()
AKSOUNDENGINE_API AK::IAkGlobalPluginContext * GetGlobalPluginContext()
AKSOUNDENGINE_API AKRESULT UnsetMedia(AkSourceSettings *in_pSourceSettings, AkUInt32 in_uNumSourceSettings)
AKSOUNDENGINE_API AKRESULT SetBusConfig(AkUniqueID in_audioNodeID, AkChannelConfig in_channelConfig)
AKSOUNDENGINE_API bool GetBackgroundMusicMute()
void(* AkProfilerPushTimerFunc)(AkPluginID in_uPluginID, const char *in_pszZoneName)
Definition: AkSoundEngine.h:209
AkProfilerPushTimerFunc fnProfilerPushTimer
External (optional) function for tracking performance of the sound engine that is called when a timer...
Definition: AkSoundEngine.h:270
AKSOUNDENGINE_API void StopPlayingID(AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
@ AkGlobalCallbackLocation_BeginRender
Start of frame rendering, after having processed game messages.
Definition: AkCallback.h:342
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:189
AkUInt32 uBankReadBufferSize
The number of bytes read by the BankReader when new data needs to be loaded from disk during serializ...
Definition: AkSoundEngine.h:264
AKSOUNDENGINE_API AKRESULT RemoveListener(AkGameObjectID in_emitterGameObj, AkGameObjectID in_listenerGameObj)
AKSOUNDENGINE_API AKRESULT GetBufferStatusForPinnedEvent(AkUniqueID in_eventID, AkReal32 &out_fPercentBuffered, bool &out_bCachePinnedMemoryFull)
AKSOUNDENGINE_API AKRESULT GetSpeakerAngles(AkReal32 *io_pfSpeakerAngles, AkUInt32 &io_uNumAngles, AkReal32 &out_fHeightAngle, AkOutputDeviceID in_idOutput=0)
AKSOUNDENGINE_API void CancelEventCallback(AkPlayingID in_playingID)
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell us about your project. We're here to help.
Register your project and we'll help you get started with no strings attached!
Get started with Wwise