_ak_dynamic_dialogue_8h

Wwise SDK 2024.1.10

 /*******************************************************************************
 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.
  
   Copyright (c) 2025 Audiokinetic Inc.
 *******************************************************************************/
  
 #ifndef _AK_SOUNDENGINE_AKDYNAMICDIALOGUE_H
 #define _AK_SOUNDENGINE_AKDYNAMICDIALOGUE_H
  
 #include AK/SoundEngine/Common/AkSoundEngine.h>
  
 /// Callback prototype used with dialogue event resolution. This function is called
 /// for every candidate in a ResolveDialogueEvent execution.
 /// \return true to accept candidate, false to reject.
 /// \sa 
 /// - AK::SoundEngine::DynamicDialogue::ResolveDialogueEvent()
 AK_CALLBACK( bool, AkCandidateCallbackFunc )(
     AkUniqueID in_idEvent,
     AkUniqueID in_idCandidate,
     void* in_cookie
     );
  
 namespace AK
 {
     namespace SoundEngine
     {
         /// Dynamic Dialogue namespace
         /// \remarks The functions in this namespace are thread-safe, unless stated otherwise.
         namespace DynamicDialogue
         {
             /// Resolve a dialogue event into an audio node ID based on the specified argument path.
             /// \return Unique ID of audio node, or AK_INVALID_UNIQUE_ID if no audio node is defined for specified argument path
             AK_EXTERNAPIFUNC( AkUniqueID, 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                         ///
                 );
  
 #ifdef AK_SUPPORT_WCHAR
             /// Resolve a dialogue event into an audio node ID based on the specified argument path.
             /// \return Unique ID of audio node, or AK_INVALID_UNIQUE_ID if no audio node is defined for specified argument path
             AK_EXTERNAPIFUNC( AkUniqueID, ResolveDialogueEvent )(
                     const wchar_t*      in_pszEventName,            ///
                     const wchar_t**     in_aArgumentValueNames,     ///
                     AkUInt32            in_uNumArguments,           ///
                     AkPlayingID         in_idSequence = AK_INVALID_PLAYING_ID,  ///
                     AkCandidateCallbackFunc in_candidateCallbackFunc = NULL, ///
                     void* in_pCookie = NULL                         ///
                 );
 #endif //AK_SUPPORT_WCHAR
  
             /// Resolve a dialogue event into an audio node ID based on the specified argument path.
             /// \return Unique ID of audio node, or AK_INVALID_UNIQUE_ID if no audio node is defined for specified argument path
             AK_EXTERNAPIFUNC( AkUniqueID, ResolveDialogueEvent )(
                     const char*         in_pszEventName,            ///
                     const char**        in_aArgumentValueNames,     ///
                     AkUInt32            in_uNumArguments,           ///
                     AkPlayingID         in_idSequence = AK_INVALID_PLAYING_ID,  ///
                     AkCandidateCallbackFunc in_candidateCallbackFunc = NULL, ///
                     void* in_pCookie = NULL                         ///
                 );
  
             /// Get the value of a custom property of integer or boolean type.
             /// \return 
             /// - AK_Success if the value is found          
             /// - 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.
             /// - AK_IDNotFound if the EventID is unknown (not loaded or typo in the id)
             AK_EXTERNAPIFUNC(AKRESULT, GetDialogueEventCustomPropertyValue)(
                 AkUniqueID in_eventID,          ///
                 AkUInt32 in_uPropID,            ///
                 AkInt32& out_iValue             ///
                 );
  
             /// Get the value of a custom property of real type.
             /// \return 
             /// - AK_Success if the value is found          
             /// - 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.
             /// - AK_IDNotFound if the EventID is unknown (not loaded or typo in the id)
             AK_EXTERNAPIFUNC(AKRESULT, GetDialogueEventCustomPropertyValue)(
                 AkUniqueID in_eventID,          ///
                 AkUInt32 in_uPropID,            ///
                 AkReal32& out_fValue            ///
                 );
         }
     }
 }
  
 #endif // _AK_SOUNDENGINE_AKDYNAMICDIALOGUE_H

AK::SoundEngine::DynamicDialogue::ResolveDialogueEvent

AKSOUNDENGINE_API AkUniqueID 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)

AkSoundEngine.h

Definition of data structures for AkAudioObject

Definition: AkWwiseSDKVersion.cs:31

AK_EXTERNAPIFUNC

#define AK_EXTERNAPIFUNC(_type, _name)

Definition: AkSoundEngineExport.h:81

AKRESULT

Standard function call result.

Definition: AkTypes.h:134

AkArgumentValueID

AkUInt32 AkArgumentValueID

Argument value ID