Table of Contents

Wwise SDK 2019.1.9
AkDynamicDialogue.h
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Version: <VERSION> Build: <BUILDNUMBER>
25  Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
26 *******************************************************************************/
27 
28 #ifndef _AK_SOUNDENGINE_AKDYNAMICDIALOGUE_H
29 #define _AK_SOUNDENGINE_AKDYNAMICDIALOGUE_H
30 
31 #include <AK/SoundEngine/Common/AkSoundEngine.h>
32 
33 /// Callback prototype used with dialogue event resolution. This function is called
34 /// for every candidate in a ResolveDialogueEvent execution.
35 /// \return true to accept candidate, false to reject.
36 /// \sa
37 /// - AK::SoundEngine::DynamicDialogue::ResolveDialogueEvent()
38 AK_CALLBACK( bool, AkCandidateCallbackFunc )(
39  AkUniqueID in_idEvent,
40  AkUniqueID in_idCandidate,
41  void* in_cookie
42  );
43 
44 namespace AK
45 {
46  namespace SoundEngine
47  {
48  /// Dynamic Dialogue namespace
49  /// \remarks The functions in this namespace are thread-safe, unless stated otherwise.
50  namespace DynamicDialogue
51  {
52  /// Resolve a dialogue event into an audio node ID based on the specified argument path.
53  /// \return Unique ID of audio node, or AK_INVALID_UNIQUE_ID if no audio node is defined for specified argument path
54  AK_EXTERNAPIFUNC( AkUniqueID, ResolveDialogueEvent )(
55  AkUniqueID in_eventID, ///< Unique ID of dialogue event
56  AkArgumentValueID* in_aArgumentValues, ///< Argument path, as array of argument value IDs. AK_FALLBACK_ARGUMENTVALUE_ID indicates a fallback argument value
57  AkUInt32 in_uNumArguments, ///< Number of argument value IDs in in_aArgumentValues
58  AkPlayingID in_idSequence = AK_INVALID_PLAYING_ID, ///< Optional sequence ID in which the token will be inserted (for profiling purposes)
59  AkCandidateCallbackFunc in_candidateCallbackFunc = NULL, ///< Optional callback for candidate validation based on custom criteria
60  void* in_pCookie = NULL ///< Callback cookie (reserved to user, passed to the callback function)
61  );
62 
63 #ifdef AK_SUPPORT_WCHAR
64  /// Resolve a dialogue event into an audio node ID based on the specified argument path.
65  /// \return Unique ID of audio node, or AK_INVALID_UNIQUE_ID if no audio node is defined for specified argument path
66  AK_EXTERNAPIFUNC( AkUniqueID, ResolveDialogueEvent )(
67  const wchar_t* in_pszEventName, ///< Name of dialogue event
68  const wchar_t** in_aArgumentValueNames, ///< Argument path, as array of argument value names. L"" indicates a fallback argument value
69  AkUInt32 in_uNumArguments, ///< Number of argument value names in in_aArgumentValueNames
70  AkPlayingID in_idSequence = AK_INVALID_PLAYING_ID, ///< Optional sequence ID in which the token will be inserted (for profiling purposes)
71  AkCandidateCallbackFunc in_candidateCallbackFunc = NULL, ///< Optional callback for candidate validation based on custom criteria
72  void* in_pCookie = NULL ///< Callback cookie (reserved to user, passed to the callback function)
73  );
74 #endif //AK_SUPPORT_WCHAR
75 
76  /// Resolve a dialogue event into an audio node ID based on the specified argument path.
77  /// \return Unique ID of audio node, or AK_INVALID_UNIQUE_ID if no audio node is defined for specified argument path
78  AK_EXTERNAPIFUNC( AkUniqueID, ResolveDialogueEvent )(
79  const char* in_pszEventName, ///< Name of dialogue event
80  const char** in_aArgumentValueNames, ///< Argument path, as array of argument value names. "" indicates a fallback argument value
81  AkUInt32 in_uNumArguments, ///< Number of argument value names in in_aArgumentValueNames
82  AkPlayingID in_idSequence = AK_INVALID_PLAYING_ID, ///< Optional sequence ID in which the token will be inserted (for profiling purposes)
83  AkCandidateCallbackFunc in_candidateCallbackFunc = NULL, ///< Optional callback for candidate validation based on custom criteria
84  void* in_pCookie = NULL ///< Callback cookie (reserved to user, passed to the callback function)
85  );
86 
87  /// Get the value of a custom property of integer or boolean type.
88  /// \return AK_PartialSuccess if the event was found but no matching custom property was found on this object. Note that it could mean this value is the default value.
89  AK_EXTERNAPIFUNC(AKRESULT, GetDialogueEventCustomPropertyValue)(
90  AkUniqueID in_eventID, ///< Unique ID of dialogue event
91  AkUInt32 in_uPropID, ///< Property ID of your custom property found under the Custom Properties tab of the Wwise project settings.
92  AkInt32& out_iValue ///< Property Value
93  );
94 
95  /// Get the value of a custom property of real type.
96  /// \return AK_PartialSuccess if the event was found but no matching custom property was found on this object. Note that it could mean this value is the default value.
97  AK_EXTERNAPIFUNC(AKRESULT, GetDialogueEventCustomPropertyValue)(
98  AkUniqueID in_eventID, ///< Unique ID of dialogue event
99  AkUInt32 in_uPropID, ///< Property ID of your custom property found under the Custom Properties tab of the Wwise project settings.
100  AkReal32& out_fValue ///< Property Value
101  );
102  }
103  }
104 }
105 
106 #endif // _AK_SOUNDENGINE_AKDYNAMICDIALOGUE_H
AKSOUNDENGINE_API AKRESULT __cdecl GetDialogueEventCustomPropertyValue(AkUniqueID in_eventID, AkUInt32 in_uPropID, AkInt32 &out_iValue)
Audiokinetic namespace.
AKSOUNDENGINE_API AkUniqueID __cdecl ResolveDialogueEvent(AkUniqueID in_eventID, AkArgumentValueID *in_aArgumentValues, AkUInt32 in_uNumArguments, AkPlayingID in_idSequence=AK_INVALID_PLAYING_ID, AkCandidateCallbackFunc in_candidateCallbackFunc=NULL, void *in_pCookie=NULL)