_ak_platform_init_settings_8h

Wwise SDK 2021.1.14

 /*******************************************************************************

 The content of this file includes portions of the AUDIOKINETIC Wwise Technology

 released in source code form as part of the SDK installer package.

 Commercial License Usage

 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology

 may use this file in accordance with the end user license agreement provided 

 with the software or, alternatively, in accordance with the terms contained in a

 written agreement between you and Audiokinetic Inc.

 Apache License Usage

 Alternatively, this file may be used under the Apache License, Version 2.0 (the 

 "Apache License"); you may not use this file except in compliance with the 

 Apache License. You may obtain a copy of the Apache License at 

 http://www.apache.org/licenses/LICENSE-2.0.

 Unless required by applicable law or agreed to in writing, software distributed

 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES

 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for

 the specific language governing permissions and limitations under the License.

   Version: v2021.1.14  Build: 6590

   Copyright (c) 2006-2023 Audiokinetic Inc.

 *******************************************************************************/

 // AkPlatformInitSettings.h

 /// \file 

 /// Platform-specific initialization settings.

 /// \cond Web

 /// Browse to \ref root_AkPlatformInitSettings for each platform-specific initialization settings.

 struct AkPlatformInitSettings

 {

 };

 /// Browse to \ref root_AkAudioAPI for each platform-specific audio output API.

 enum AkAudioAPI

 {

 };

 /// \endcond

AK::SoundEngine::GetSampleRate

AKSOUNDENGINE_API AkUInt32 GetSampleRate()

AkMarkerCallbackInfo::strLabel

const char * strLabel

Label of the marker, read from the file

Definition: AkCallback.h:120

Audiokinetic namespace

Definition: AkWwiseSDKVersion.cs:32

AK_Fail

@ AK_Fail

The operation failed.

Definition: AkTypes.h:135

Ak3DAudioSinkCapabilities

Definition: AkCommonDefs.h:403

AK_EndOfEvent

@ AK_EndOfEvent

Callback triggered when reaching the end of an event. AkCallbackInfo can be cast to AkEventCallbackIn...

Definition: AkCallback.h:50

AK::IAkEffectPlugin

Software effect plug-in interface (see Creating Sound Engine Effect Plug-ins).

Definition: IAkPlugin.h:741

AkEventCallbackInfo

Definition: AkCallback.h:96

AK::IAkSourcePlugin

Wwise sound engine source plug-in interface (see Creating Sound Engine Source Plug-ins).

Definition: IAkPlugin.h:1218

AkMarkerCallbackInfo

Definition: AkCallback.h:117

AkPlatformInitSettings

Definition: AkPlatformInitSettings.h:36

AkCallbackInfo

Definition: AkCallback.h:86

AkGameObjectID

AkUInt64 AkGameObjectID

Game object ID

Definition: AkTypes.h:70

AkChannelConfig

Definition: AkSpeakerConfig.h:498

AKRESULT

Standard function call result.

Definition: AkTypes.h:132

AK::SoundEngine::RegisterGameObj

AKSOUNDENGINE_API AKRESULT RegisterGameObj(AkGameObjectID in_gameObjectID)

AkUInt8

uint8_t AkUInt8

Unsigned 8-bit integer

Definition: AkTypes.h:57

AK::GetDeviceID

AKSOUNDENGINE_API AkUInt32 GetDeviceID(IMMDevice *in_pDevice)

AkOutputSettings

Platform-independent initialization settings of output devices.

Definition: AkSoundEngine.h:129

AK::FNVHash

Definition: AkFNVHash.h:75

AkAudioAPI

Browse to Platform-Specific Audio Output API (enum AkAudioAPI) for each platform-specific audio outpu...

Definition: AkPlatformInitSettings.h:42

AK::SoundEngine::SetOfflineRenderingFrameTime

AKSOUNDENGINE_API AKRESULT SetOfflineRenderingFrameTime(AkReal32 in_fFrameTimeInSeconds)

AkCallbackType

Type of callback. Used as a bitfield in methods AK::SoundEngine::PostEvent() and AK::SoundEngine::Dyn...

Definition: AkCallback.h:49

AK::Comm::Init

AKSOUNDENGINE_API AKRESULT Init(const AkCommSettings &in_settings)

AK.Wwise::ConversionResult

ConversionResult

Conversion error code.

Definition: Utilities.h:190

NULL

#define NULL

Definition: AkTypes.h:47

AK::SoundEngine::StopProfilerCapture

AKSOUNDENGINE_API AKRESULT StopProfilerCapture()

AK::SoundEngine::GetOutputID

AKSOUNDENGINE_API AkOutputDeviceID GetOutputID(AkUniqueID in_idShareset, AkUInt32 in_idDevice)

AkMarkerCallbackInfo::uIdentifier

AkUInt32 uIdentifier

Cue point identifier

Definition: AkCallback.h:118

AkUniqueID

AkUInt32 AkUniqueID

Unique 32-bit ID

Definition: AkTypes.h:62

AK::SoundEngine::StartProfilerCapture

AKSOUNDENGINE_API AKRESULT StartProfilerCapture(const AkOSChar *in_CaptureFileName)

PlatformID::PS5

AK_ID_DECLARE BasePlatformID PS5

Definition: PlatformID.h:99

AkMarkerCallbackInfo::uPosition

AkUInt32 uPosition

Position in the cue point (unit: sample frames)

Definition: AkCallback.h:119

PlatformID::Windows

AK_ID_DECLARE BasePlatformID Windows

Definition: PlatformID.h:87

AK::SoundEngine::GetOutputDeviceConfiguration

AKSOUNDENGINE_API AKRESULT GetOutputDeviceConfiguration(AkOutputDeviceID in_idOutput, AkChannelConfig &io_channelConfig, Ak3DAudioSinkCapabilities &io_capabilities)

AK::SoundEngine::RegisterCaptureCallback

AKSOUNDENGINE_API AKRESULT RegisterCaptureCallback(AkCaptureCallbackFunc in_pfnCallback, AkOutputDeviceID in_idOutput=AK_INVALID_OUTPUT_DEVICE_ID, void *in_pCookie=NULL)

AK::SoundEngine::RenderAudio

AKSOUNDENGINE_API AKRESULT RenderAudio(bool in_bAllowSyncRender=true)

AK.Wwise::ConversionSuccess

@ ConversionSuccess

Definition: Utilities.h:191

AkCallbackFunc

void(* AkCallbackFunc)(AkCallbackType in_eType, AkCallbackInfo *in_pCallbackInfo)

Definition: AkCallback.h:267

AK::SoundEngine::UnregisterCaptureCallback

AKSOUNDENGINE_API AKRESULT UnregisterCaptureCallback(AkCaptureCallbackFunc in_pfnCallback, AkOutputDeviceID in_idOutput=AK_INVALID_OUTPUT_DEVICE_ID, void *in_pCookie=NULL)

AK_INVALID_UNIQUE_ID

static const AkUniqueID AK_INVALID_UNIQUE_ID

Invalid unique 32-bit ID

Definition: AkTypes.h:102

AK::SoundEngine::SetOfflineRendering

AKSOUNDENGINE_API AKRESULT SetOfflineRendering(bool in_bEnableOfflineRendering)

AK::SoundEngine::AddOutput

AKSOUNDENGINE_API AKRESULT AddOutput(const AkOutputSettings &in_Settings, AkOutputDeviceID *out_pDeviceID=NULL, const AkGameObjectID *in_pListenerIDs=NULL, AkUInt32 in_uNumListeners=0)

AK::GetDeviceIDFromName

AKSOUNDENGINE_API AkUInt32 GetDeviceIDFromName(wchar_t *in_szToken)

AkOutputSettings::idDevice

AkUInt32 idDevice

Definition: AkSoundEngine.h:150

AkChannelConfig::SetStandard

AkForceInline void SetStandard(AkUInt32 in_uChannelMask)

Set channel config as a standard configuration specified with given channel mask.

Definition: AkSpeakerConfig.h:565

AkOutputSettings::audioDeviceShareset

AkUniqueID audioDeviceShareset

Definition: AkSoundEngine.h:142

AkUInt32

uint32_t AkUInt32

Unsigned 32-bit integer

Definition: AkTypes.h:59

AkOutputSettings::channelConfig

AkChannelConfig channelConfig

Definition: AkSoundEngine.h:157

AkOutputDeviceID

AkUInt64 AkOutputDeviceID

Audio Output device ID

Definition: AkTypes.h:94

AK::SoundEngine::DynamicSequence::Open

AKSOUNDENGINE_API AkPlayingID Open(AkGameObjectID in_gameObjectID, AkUInt32 in_uFlags=0, AkCallbackFunc in_pfnCallback=NULL, void *in_pCookie=NULL, DynamicSequenceType in_eDynamicSequenceType=DynamicSequenceType_SampleAccurate)

AK::FNVHash::Compute

HashParams::HashType Compute(const void *in_pData, typename HashParams::SizeType in_dataSize)

Definition: AkFNVHash.h:106

AK_SPEAKER_SETUP_STEREO

#define AK_SPEAKER_SETUP_STEREO

2.0 setup channel mask

Definition: AkSpeakerConfig.h:60

AK::IAkPluginParam::ALL_PLUGIN_DATA_ID

static const AkPluginParamID ALL_PLUGIN_DATA_ID

Definition: IAkPlugin.h:666

AK::SoundEngine::PostEvent

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)

AkAudioFormat

Defines the parameters of an audio buffer format.

Definition: AkCommonDefs.h:63

AkPlayingID

AkUInt32 AkPlayingID

Playing ID

Definition: AkTypes.h:65

AK_Marker

@ AK_Marker

Callback triggered when encountering a marker during playback. AkCallbackInfo can be cast to AkMarker...

Definition: AkCallback.h:52