Wwise SDK 2021.1.14
_ak_audio_input_plugin_8h_source
搜索
版本
2023.1.4.8496
2022.1.13.8454
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
Wwise SDK 2021.1.14
Wwise 帮助文档
Wwise 基础知识
Cube Integration
Sample Project
Wwise Unity 集成
Wwise Unreal Integration
Strata
ReaWwise
Audiokinetic Launcher
Wwise Audio Lab
Wwise Adventure Game
GME In-Game Voice Chat
menu_open
link
Wwise SDK 2021.1.14
AK
Plugin
AkAudioInputPlugin.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: v2021.1.14 Build: 6590
25
Copyright (c) 2006-2023 Audiokinetic Inc.
26
*******************************************************************************/
27
28
/// \file
29
///! Definition of callbacks used for the Audio Input Plugin
30
/// <br><b>Wwise source name:</b> AudioInput
31
/// <br><b>Library file:</b> AkAudioInputSource.lib
32
33
#pragma once
34
#define AKSOURCEID_AUDIOINPUT 200
35
////////////////////////////////////////////////////////////////////////////////////////////
36
// API external to the plug-in, to be used by the game.
37
38
/// Callback requesting for the AkAudioFormat to use for the plug-in instance.
39
/// Refer to the Source Input plugin documentation to learn more about the valid formats.
40
/// \sa \ref soundengine_plugins_source
41
AK_CALLBACK
(
void
,
AkAudioInputPluginGetFormatCallbackFunc
)(
42
AkPlayingID
in_playingID,
///< Playing ID (same that was returned from the PostEvent call).
43
AkAudioFormat
& io_AudioFormat
///< Already filled format, modify it if required.
44
);
45
46
/// Function that returns the Gain to be applied to the Input Plugin.
47
/// [0..1] range where 1 is maximum volume.
48
AK_CALLBACK
(
AkReal32
,
AkAudioInputPluginGetGainCallbackFunc
)(
49
AkPlayingID
in_playingID
///< Playing ID (same that was returned from the PostEvent call).
50
);
51
52
/// Callback requesting for new data for playback.
53
/// \param in_playingID Playing ID (same that was returned from the PostEvent call)
54
/// \param io_pBufferOut Buffer to fill
55
/// \remarks See IntegrationDemo sample for a sample on how to implement it.
56
AK_CALLBACK
(
void
,
AkAudioInputPluginExecuteCallbackFunc
)(
57
AkPlayingID
in_playingID,
58
AkAudioBuffer
* io_pBufferOut
59
);
60
61
/// This function should be called at the same place the AudioInput plug-in is being registered.
62
AK_EXTERNAPIFUNC
(
void
,
SetAudioInputCallbacks
)(
63
AkAudioInputPluginExecuteCallbackFunc
in_pfnExecCallback,
64
AkAudioInputPluginGetFormatCallbackFunc
in_pfnGetFormatCallback =
NULL
,
// Optional
65
AkAudioInputPluginGetGainCallbackFunc
in_pfnGetGainCallback =
NULL
// Optional
66
);
67
////////////////////////////////////////////////////////////////////////////////////////////
AkReal32
float AkReal32
32-bit floating point
Definition:
AkTypes.h:70
AK_EXTERNAPIFUNC
#define AK_EXTERNAPIFUNC(_type, _name)
Definition:
AkSoundEngineExport.h:78
AkAudioInputPluginGetFormatCallbackFunc
void(* AkAudioInputPluginGetFormatCallbackFunc)(AkPlayingID in_playingID, AkAudioFormat &io_AudioFormat)
Definition:
AkAudioInputPlugin.h:41
NULL
#define NULL
Definition:
AkTypes.h:47
SetAudioInputCallbacks
AKSOUNDENGINE_API void SetAudioInputCallbacks(AkAudioInputPluginExecuteCallbackFunc in_pfnExecCallback, AkAudioInputPluginGetFormatCallbackFunc in_pfnGetFormatCallback=NULL, AkAudioInputPluginGetGainCallbackFunc in_pfnGetGainCallback=NULL)
This function should be called at the same place the AudioInput plug-in is being registered.
AK_CALLBACK
#define AK_CALLBACK(_type, _name)
Definition:
AkSoundEngineExport.h:84
AkAudioInputPluginGetGainCallbackFunc
AkReal32(* AkAudioInputPluginGetGainCallbackFunc)(AkPlayingID in_playingID)
Definition:
AkAudioInputPlugin.h:48
AkAudioBuffer
Definition:
AkCommonDefs.h:438
AkAudioFormat
Defines the parameters of an audio buffer format.
Definition:
AkCommonDefs.h:63
AkAudioInputPluginExecuteCallbackFunc
void(* AkAudioInputPluginExecuteCallbackFunc)(AkPlayingID in_playingID, AkAudioBuffer *io_pBufferOut)
Definition:
AkAudioInputPlugin.h:56
AkPlayingID
AkUInt32 AkPlayingID
Playing ID
Definition:
AkTypes.h:65
此页面对您是否有帮助?
thumb_up
是
thumb_down
否
提交
需要技术支持?
仍有疑问?或者问题?需要更多信息?欢迎联系我们,我们可以提供帮助!
查看我们的“技术支持”页面
介绍一下自己的项目。我们会竭力为您提供帮助。
来注册自己的项目,我们帮您快速入门,不带任何附加条件!
开始 Wwise 之旅
You need to enable JavaScript to run this app.