menu
 
Version
2024.1.2.8726

2024.1.2.8726

2023.1.10.8659

2022.1.18.8567

2021.1.14.8108

2019.2.15.7667

2019.1.11.7296

2018.1.11.6987

2017.2.10.6745

2017.1.9.6501

2016.2.6.6153

2015.1.9.5624


menu_open
Wwise SDK 2024.1.2
AkPlatforms.h File Reference

Go to the source code of this file.

Macros

#define AK_ALIGN(_declaration_, _alignment_)   _declaration_ __attribute__( ( aligned( _alignment_ ) ) )
 
#define AK_ALIGN_TO_NEXT_BOUNDARY(__num__, __boundary__)   (((__num__) + ((__boundary__)-1)) & ~((__boundary__)-1))
 
#define AK_IS_POWER_OF_TWO(__num__)   (((__num__) & ((__num__) - 1)) == 0)
 
#define AK_ENDIANNESS_LITTLE
 
#define AK_UNALIGNED
 AK_UNALIGNED refers to the __unaligned compilation flag available on some platforms. Note that so far, on the tested platform this should always be placed before the pointer symbol *. More...
 
#define AK_SELECTANY
 
#define AK_NODISCARD   [[nodiscard]]
 
#define AK_POINTER_64
 
#define AK_UNUSEDVAR(x)   ((void)(x))
 
#define AK_THREAD_LOCAL
 

Detailed Description

Audiokinetic platform checks. This is where we detect which platform is being compiled, and where we define the corresponding AK-specific symbols.

Definition in file AkPlatforms.h.

Defines the parameters of a marker.
Definition: AkAudioMarker.h:16
AKSOUNDENGINE_API AkUInt32 GetSampleRate()
AkInt32 AkTimeMs
Time in ms.
Definition: AkTypes.h:56
Definition of data structures for AkAudioObject.
@ AK_EndOfEvent
Callback triggered when reaching the end of an event. AkCallbackInfo can be cast to AkEventCallbackIn...
Definition: AkCallback.h:49
AkPanningRule ePanningRule
AkUInt32 dwIdentifier
Identifier.
Definition: AkAudioMarker.h:17
AkUInt32 uNumChannels
Number of channels.
AkUInt64 AkGameObjectID
Game object ID.
Definition: AkTypes.h:60
AKRESULT
Standard function call result.
Definition: AkTypes.h:134
AKSOUNDENGINE_API AKRESULT RegisterGameObj(AkGameObjectID in_gameObjectID)
AkUInt32 dwLabelSize
Length of label read the from the file + terminating null character.
Definition: AkAudioMarker.h:20
Platform-independent initialization settings of output devices.
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:48
AKSOUNDENGINE_API AKRESULT Init(const AkCommSettings &in_settings)
#define NULL
Definition: AkTypes.h:46
float AkReal32
32-bit floating point
@ AK_Success
The operation was successful.
Definition: AkTypes.h:136
AKSOUNDENGINE_API AKRESULT ReplaceOutput(const AkOutputSettings &in_Settings, AkOutputDeviceID in_outputDeviceId, AkOutputDeviceID *out_pOutputDeviceId=NULL)
AKSOUNDENGINE_API void Term()
#define AK_SPEAKER_SETUP_DOLBY_7_1_4
Dolby 7.1.4 setup channel mask.
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:52
AK_ID_DECLARE BasePlatformID PS5
Definition: PlatformID.h:106
Type
IDs of temporary memory pools used by the sound engine.
AKSOUNDENGINE_API AKRESULT RegisterCaptureCallback(AkCaptureCallbackFunc in_pfnCallback, AkOutputDeviceID in_idOutput=AK_INVALID_OUTPUT_DEVICE_ID, void *in_pCookie=NULL)
AKSOUNDENGINE_API AKRESULT RenderAudio(bool in_bAllowSyncRender=true)
bool SetMediaSource(const AkOSChar *in_pszFilePathToImport, unsigned int in_Index, bool in_bReplace)
Requests to set the specified file as a data input file.
void(* AkCallbackFunc)(AkCallbackType in_eType, AkCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:272
AKSOUNDENGINE_API AKRESULT UnregisterCaptureCallback(AkCaptureCallbackFunc in_pfnCallback, AkOutputDeviceID in_idOutput=AK_INVALID_OUTPUT_DEVICE_ID, void *in_pCookie=NULL)
virtual IAkMarkerNotificationService * CreateMarkerNotificationService(IAkSourcePluginContext *in_pSourcePluginContext)=0
V1::Source Source
Latest version of the C++ Source interface.
Definition: Source.h:173
@ AkPanningRule_Speakers
Left and right positioned 60 degrees apart (by default - see AK::SoundEngine::GetSpeakerAngles()).
Definition: AkTypes.h:1152
AKSOUNDENGINE_API AKRESULT SetOfflineRendering(bool in_bEnableOfflineRendering)
AKSOUNDENGINE_API AKRESULT AddOutput(const AkOutputSettings &in_Settings, AkOutputDeviceID *out_pDeviceID=NULL, const AkGameObjectID *in_pListenerIDs=NULL, AkUInt32 in_uNumListeners=0)
AkForceInline void SetStandard(AkUInt32 in_uChannelMask)
Set channel config as a standard configuration specified with given channel mask.
const char * strLabel
Label of the marker taken from the file.
Definition: AkAudioMarker.h:19
AkUniqueID audioDeviceShareset
#define AK_GET_PLUGIN_SERVICE_MARKERS(plugin_ctx)
Definition: IAkPlugin.h:1911
uint32_t AkUInt32
Unsigned 32-bit integer.
AkChannelConfig channelConfig
AkUInt32 dwPosition
Position in the audio data in sample frames.
Definition: AkAudioMarker.h:18
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)
Defines the parameters of an audio buffer format.
Definition: AkCommonDefs.h:60
AkUInt32 AkPlayingID
Playing ID.
Definition: AkTypes.h:55
@ AK_Marker
Callback triggered when encountering a marker during playback. AkCallbackInfo can be cast to AkMarker...
Definition: AkCallback.h:51
AkForceInline AkUInt16 MaxFrames() const
Definition: AkCommonDefs.h:500

Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise