Wwise SDK
_ak_win_sound_engine_8h_source
版本
menu_open
link
目标平台:
Wwise SDK 2023.1.2
|
AkWinSoundEngine.h
浏览该文件的文档.
50 ///< the moment of the initialization of the sound engine and might not be the correct one for your game.
57 AkThreadProperties threadBankManager; ///< Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
58 AkThreadProperties threadMonitor; ///< Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL). This parameter is not used in Release build.
61 AkUInt16 uNumRefillsInVoice; ///< Number of refill buffers in voice buffer. 2 == double-buffered, defaults to 4.
63 AkUInt32 uSampleRate; ///< Sampling Rate. Default is 48000 Hz. Use 24000hz for low quality. Any positive reasonable sample rate is supported. However be careful setting a custom value. Using an odd or really low sample rate may result in malfunctionning sound engine.
65 bool bEnableAvxSupport; ///< Enables run-time detection of AVX and AVX2 SIMD support in the engine and plug-ins. Disabling this may improve CPU performance by allowing for higher CPU clockspeeds.
67 AkUInt32 uMaxSystemAudioObjects; ///< Dictates how many Microsoft Spatial Sound dynamic objects will be reserved by the System sink. On Windows, other running processes will be prevented from reserving these objects. Set to 0 to disable the use of System Audio Objects. Default is 128.
70 bool bEnableDirectInputSupport; ///< Enables run-time enumeration and support of DirectInput devices for AK Motion plug-in. Disabling this can alleviate potential issues with stability around device management, and improve overall responsiveness of device enumeration. Default is false.
81 /// \note CoInitialize must have been called for the calling thread. See Microsoft's documentation about CoInitialize for more details.
85 /// Finds an audio endpoint that matches the token in the device name or device ID and returns an ID.
86 /// This is a helper function that searches in the device ID (as returned by IMMDevice->GetId) and
87 /// in the property PKEY_Device_FriendlyName. The token parameter is case-sensitive. If you need to do matching on different conditions, use IMMDeviceEnumerator directly and AK::GetDeviceID.
88 /// \note CoInitialize must have been called for the calling thread. See Microsoft's documentation about CoInitialize for more details.
89 /// \return The device ID as returned by IMMDevice->GetId, hashed by AK::SoundEngine::GetIDFromName()
92 /// Get the user-friendly name for the specified device. Call repeatedly with index starting at 0 and increasing to get all available devices, including disabled and unplugged devices, until the returned string is null and out_uDeviceID is AK_INVALID_DEVICE_ID.
93 /// The number of indexable devices for the given uDeviceStateMask can be fetched by calling AK::SoundEngine::GetWindowsDeviceCount().
94 /// You can also get the default device information by specifying index=-1. The default device is the one with a green checkmark in the Audio Playback Device panel in Windows.
95 /// The returned out_uDeviceID parameter is the Device ID to use with Wwise. Use it to specify the main device in AkPlatformInitSettings.idAudioDevice.
96 /// \note CoInitialize must have been called for the calling thread. See Microsoft's documentation about CoInitialize for more details.
97 /// \return The name of the device at the "index" specified. The pointer is valid until the next call to GetWindowsDeviceName.
99 AkInt32 index, ///< Index of the device in the array. -1 to get information on the default device.
100 AkUInt32 &out_uDeviceID, ///< Device ID for Wwise. This is the same as what is returned from AK::GetDeviceID and AK::GetDeviceIDFromName. Use it to specify the main device in AkPlatformInitSettings.idAudioDevice.
101 AkAudioDeviceState uDeviceStateMask = AkDeviceState_All ///< Optional bitmask used to filter the device based on their state.
105 /// \note CoInitialize must have been called for the calling thread. See Microsoft's documentation about CoInitialize for more details.
108 AkAudioDeviceState uDeviceStateMask = AkDeviceState_All ///< Optional bitmask used to filter the device based on their state.
111 /// Get the Audio Endpoint for the specified device index. Call repeatedly with index starting at 0 and increasing to get all available devices, including disabled and unplugged devices, until the false is returned.
112 /// You can also get the default device information by specifying index=-1. The default device is the one with a green checkmark in the Audio Playback Device panel in Windows.
113 /// The returned out_uDeviceID parameter is the Device ID to use with Wwise. Use it to specify the main device in AkPlatformInitSettings.idAudioDevice.
114 /// The returned out_ppDevice is a pointer to a pointer variable to which the method writes the address of the IMMDevice. out_ppDevice is optional; if it is null, then no action is taken.
115 /// If the method returns false, *out_ppDevice is null and out_uDeviceID is AK_INVALID_DEVICE_ID. If the method successed, *out_ppDevice will be a counted reference to the interface, and the caller is responsible for releasing the interface when it is no longer needed, by calling Release(), or encapsulating the device in a COM Smart Pointer.
116 /// \note CoInitialize must have been called for the calling thread. See Microsoft's documentation about CoInitialize for more details.
119 AkInt32 in_index, ///< Index of the device in the array. -1 to get information on the default device.
120 AkUInt32& out_uDeviceID, ///< Device ID for Wwise. This is the same as what is returned from AK::GetDeviceID and AK::GetDeviceIDFromName. Use it to specify the main device in AkPlatformInitSettings.idAudioDevice.
121 IMMDevice** out_ppDevice, ///< pointer to a pointer variable to which the method writes the address of the IMMDevice in question.
122 AkAudioDeviceState uDeviceStateMask = AkDeviceState_All ///< Optional bitmask used to filter the device based on their state.
Definition: AkPlatformFuncs.h:47
AkUInt32 uMaxSystemAudioObjects
Dictates how many Microsoft Spatial Sound dynamic objects will be reserved by the System sink....
Definition: AkWinSoundEngine.h:67
Definition: AkAndroidSoundEngine.h:55
bool bEnableDirectInputSupport
Enables run-time enumeration and support of DirectInput devices for AK Motion plug-in....
Definition: AkWinSoundEngine.h:70
AKSOUNDENGINE_API AkUInt32 GetDeviceID(IMMDevice *in_pDevice)
AKSOUNDENGINE_API bool GetWindowsDevice(AkInt32 in_index, AkUInt32 &out_uDeviceID, IMMDevice **out_ppDevice, AkAudioDeviceState uDeviceStateMask=AkDeviceState_All)
AkThreadProperties threadMonitor
Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL)....
Definition: AkAndroidSoundEngine.h:60
AkThreadProperties threadLEngine
Lower engine threading properties
Definition: AkAndroidSoundEngine.h:57
AkUInt16 uNumRefillsInVoice
Number of refill buffers in voice buffer. Defaults to 4.
Definition: AkAndroidSoundEngine.h:66
AkThreadProperties threadOutputMgr
Ouput thread threading properties
Definition: AkAndroidSoundEngine.h:58
AKSOUNDENGINE_API const wchar_t * GetWindowsDeviceName(AkInt32 index, AkUInt32 &out_uDeviceID, AkAudioDeviceState uDeviceStateMask=AkDeviceState_All)
AKSOUNDENGINE_API AkUInt32 GetDeviceIDFromName(wchar_t *in_szToken)
bool bEnableAvxSupport
Enables run-time detection of AVX and AVX2 SIMD support in the engine and plug-ins....
Definition: AkWinSoundEngine.h:65
AkUInt32 uSampleRate
Sampling Rate. Set to 0 to get the native sample rate. Default value is 0.
Definition: AkAndroidSoundEngine.h:65
AkThreadProperties threadBankManager
Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
Definition: AkAndroidSoundEngine.h:59
AKSOUNDENGINE_API AkUInt32 GetWindowsDeviceCount(AkAudioDeviceState uDeviceStateMask=AkDeviceState_All)