nertc::wwiseplugin 命名空间参考

类
class	IAudioDeviceManager
class	IDeviceCollection
class	IRtcCallback
class	IRtcEngine
class	IVoiceEngine
class	IVoiceEngineCallback
class	NertcAudioManagerImpl
class	NertcDeviceCollection
class	NertcEngine
class	NertcEngineImpl
class	NertcVoiceEngineImpl
struct	RtcAudioVolumeInfo
class	RtcConstants
struct	RtcDeviceInfo
struct	RtcEngineContext

枚举
enum	RtcLogLevel {   kWWISEPLUGINLevelFatal = 0 , kWWISEPLUGINLevelError = 1 , kWWISEPLUGINLevelWarning = 2 , kWWISEPLUGINLevelInfo = 3 ,   kWWISEPLUGINLevelDetailInfo = 4 , kWWISEPLUGINLevelVerbos = 5 , kWWISEPLUGINLevelDebug = 6 , kWWISEPLUGINLevelOff = 7 }
enum	RtcConnectionStateType {   kWWISEPLUGINConnectionStateDisconnected = 1 , kWWISEPLUGINConnectionStateConnecting = 2 , kWWISEPLUGINConnectionStateConnected = 3 , kWWISEPLUGINConnectionStateReconnecting = 4 ,   kWWISEPLUGINConnectionStateFailed = 5 }
enum	RtcReasonConnectionChangedType {   kWWISEPLUGINReasonConnectionChangedLeaveChannel = 1 , kWWISEPLUGINReasonConnectionChangedChannelClosed = 2 , kWWISEPLUGINReasonConnectionChangedBeKicked = 3 , kWWISEPLUGINReasonConnectionChangedTimeOut = 4 ,   kWWISEPLUGINReasonConnectionChangedJoinChannel = 5 , kWWISEPLUGINReasonConnectionChangedJoinSucceed = 6 , kWWISEPLUGINReasonConnectionChangedReJoinSucceed = 7 , kWWISEPLUGINReasonConnectionChangedMediaConnectionDisconnected = 8 ,   kWWISEPLUGINReasonConnectionChangedSignalDisconnected = 9 , kWWISEPLUGINReasonConnectionChangedRequestChannelFailed = 10 , kWWISEPLUGINReasonConnectionChangedJoinChannelFailed = 11 , kWWISEPLUGINReasonConnectionChangedReDispatch = 12 ,   kWWISEPLUGINReasonConnectionChangedSettingProxyServer = 13 }
enum	RtcNetworkType {   kWWISEPLUGINNetworkTypeUnknown = 0 , kWWISEPLUGINNetworkTypeEthernet , kWWISEPLUGINNetworkTypeWifi , kWWISEPLUGINNetworkType2G ,   kWWISEPLUGINNetworkType3G , kWWISEPLUGINNetworkType4G , kWWISEPLUGINNetworkType5G , kWWISEPLUGINNetworkTypeWWAN ,   kWWISEPLUGINNetworkTypeBluetooth , kWWISEPLUGINNetworkTypeNone }
enum	RtcClientRole { kWWISEPLUGINClientRoleBroadcaster = 0 , kWWISEPLUGINClientRoleAudience = 1 }
enum	RtcRangeAudioMode { kWWISEPLUGINRangeAudioModeNone = -1 , kWWISEPLUGINRangeAudioModeDefault = 0 , kWWISEPLUGINRangeAudioModeTeam = 1 }
enum	RtcAudioProfileType {   kWWISEPLUGINAudioProfileDefault = 0 , kWWISEPLUGINAudioProfileStandard = 1 , kWWISEPLUGINAudioProfileStandardExtend = 2 , kWWISEPLUGINAudioProfileMiddleQuality = 3 ,   kWWISEPLUGINAudioProfileMiddleQualityStereo = 4 , kWWISEPLUGINAudioProfileHighQuality = 5 , kWWISEPLUGINAudioProfileHighQualityStereo = 6 }
enum	RtcAudioScenarioType { kWWISEPLUGINAudioScenarioDefault = 0 , kWWISEPLUGINAudioScenarioSpeech = 1 , kWWISEPLUGINAudioScenarioMusic = 2 , kWWISEPLUGINAudioScenarioChatroom = 3 }
enum	RtcAudioDumpType { kWWISEPLUGINAudioDumpTypePCM = 0 , kWWISEPLUGINAudioDumpTypeAll = 1 , kWWISEPLUGINAudioDumpTypeWAV = 2 }
enum	RtcErrorCode {   kWWISEPLUGINNoError = 0 , kWWISEPLUGINErrChannelReservePermissionDenied = 403 , kWWISEPLUGINErrChannelReserveTimeOut = 408 , kWWISEPLUGINErrChannelReserveErrorParam = 414 ,   kWWISEPLUGINErrChannelReserveErrorAppKey = 417 , kWWISEPLUGINErrChannelReserveServerFail = 500 , kWWISEPLUGINErrChannelReserveMoreThanTwoUser = 600 , kWWISEPLUGINErrChannelNoPublishPermission = 1620 ,   kWWISEPLUGINErrChannelNoSubscribePermission = 2803 , kWWISEPLUGINErrServerPersonsInRoomReachedTheLimit = 4003 , kWWISEPLUGINErrFatal = 30001 , kWWISEPLUGINErrOutOfMemory = 30002 ,   kWWISEPLUGINErrInvalidParam = 30003 , kWWISEPLUGINErrNotSupported = 30004 , kWWISEPLUGINErrInvalidState = 30005 , kWWISEPLUGINErrLackOfResource = 30006 ,   kWWISEPLUGINErrInvalidIndex = 30007 , kWWISEPLUGINErrDeviceNotFound = 30008 , kWWISEPLUGINErrInvalidDeviceSourceID = 30009 , kWWISEPLUGINErrInvalidVideoProfile = 30010 ,   kWWISEPLUGINErrCreateDeviceSourceFail = 30011 , kWWISEPLUGINErrInvalidRender = 30012 , kWWISEPLUGINErrDevicePreviewAlreadyStarted = 30013 , kWWISEPLUGINErrTransmitPendding = 30014 ,   kWWISEPLUGINErrConnectFail = 30015 , kWWISEPLUGINErrDeviceOccupied = 30027 , kWWISEPLUGINErrChannelAlreadyJoined = 30100 , kWWISEPLUGINErrChannelNotJoined = 30101 ,   kWWISEPLUGINErrChannelRepleatedlyLeave = 30102 , kWWISEPLUGINErrRequestJoinChannelFail = 30103 , kWWISEPLUGINErrSessionNotFound = 30104 , kWWISEPLUGINErrUserNotFound = 30105 ,   kWWISEPLUGINErrInvalidUserID = 30106 , kWWISEPLUGINErrMediaNotStarted = 30107 , kWWISEPLUGINErrSourceNotFound = 30108 , kWWISEPLUGINErrConnectionNotFound = 30200 ,   kWWISEPLUGINErrStreamNotFound = 30201 , kWWISEPLUGINErrAddTrackFail = 30202 , kWWISEPLUGINErrTrackNotFound = 30203 , kWWISEPLUGINErrMediaConnectionDisconnected = 30204 ,   kWWISEPLUGINErrSignalDisconnected = 30205 , kWWISEPLUGINErrServerKicked = 30206 , kWWISEPLUGINErrKickedForRoomClosed = 30207 , kWWISEPLUGINErrChannelLeaveBySwitchAction = 30208 ,   kWWISEPLUGINErrChannelLeaveByDuplicateUidLogin = 30209 , kWWISEPLUGINErrPTTAuthorizeFailed = 31001 , kWWISEPLUGINErrPTTAuthNetError = 31002 , kWWISEPLUGINErrPTTAuthTimeOut = 31003 ,   kWWISEPLUGINErrPTTRecordingAreadyStarted = 31011 , kWWISEPLUGINErrPTTRecordingOpenFileFailed = 31012 , kWWISEPLUGINErrPTTRecordingDurationTooShort = 31013 , kWWISEPLUGINErrPTTRecordingNotStarted = 31014 ,   kWWISEPLUGINErrPTTPlayOpenFileFailed = 31021 , kWWISEPLUGINErrPTTPlayReadFileFailed = 31022 , kWWISEPLUGINErrPTTPlayNotStarted = 31023 , kWWISEPLUGINErrPTTUploadOpenFileFailed = 31031 ,   kWWISEPLUGINErrPTTUploadFileTooLarge = 31032 , kWWISEPLUGINErrPTTUploadAuthFailed = 31033 , kWWISEPLUGINErrPTTUploadNetError = 31034 , kWWISEPLUGINErrPTTUploadDataError = 31035 ,   kWWISEPLUGINErrPTTDownloadOpenFileFailed = 31041 , kWWISEPLUGINErrPTTDownloadAuthFailed = 31042 , kWWISEPLUGINErrPTTDownloadNetError = 31043 , kWWISEPLUGINErrPTTDownloadNotFound = 31044 ,   kWWISEPLUGINErrPTTDownloadDataError = 31045 , kWWISEPLUGINErrPTTSTTAuthFailed = 31051 , kWWISEPLUGINErrPTTSTTNetError = 31052 , kWWISEPLUGINErrPTTSTTTranslateFaild = 31053 ,   kWWISEPLUGINErrPTTSTTNotFound = 31054 , kWWISEPLUGINErrPTTSTTDataError = 31055 , kWWISEPLUGINRuntimeErrADMNoAuthorize = 40000 , kWWISEPLUGINRuntimeErrADMInitRecording = 40001 ,   kWWISEPLUGINRuntimeErrADMStartRecording = 40002 , kWWISEPLUGINRuntimeErrADMStopRecording = 40003 , kWWISEPLUGINRuntimeErrADMInitPlayout = 40004 , kWWISEPLUGINRuntimeErrADMStartPlayout = 40005 ,   kWWISEPLUGINRuntimeErrADMStopPlayout = 40006 , kWWISEPLUGINRuntimeErrADMRecordingFailed = 40007 , kWWISEPLUGINRuntimeErrADMPlayoutFailed = 40008 }
enum	RtcAudioStreamType { kWWISEPLUGINAudioStreamTypeMain = 0 , kWWISEPLUGINAudioStreamTypeSub = 1 }
enum	RtcAudioOutputRouting {   kWWISEPLUGINAudioOutputRoutingDefault = 0 , kWWISEPLUGINAudioOutputRoutingHeadset , kWWISEPLUGINAudioOutputRoutingEarpiece , kWWISEPLUGINAudioOutputRoutingLoudspeaker ,   kWWISEPLUGINAudioOutputRoutingBluetooth }
enum	RtcAudioDeviceTransportType {   kWWISEPLUGINAudioDeviceTransportTypeUnknown = 0 , kWWISEPLUGINAudioDeviceTransportTypeBluetooth = 1 , kWWISEPLUGINAudioDeviceTransportTypeBluetoothA2DP = 2 , kWWISEPLUGINAudioDeviceTransportTypeBluetoothLE = 3 ,   kWWISEPLUGINAudioDeviceTransportTypeUSB = 4 , kWWISEPLUGINAudioDeviceTransportTypeHDMI = 5 , kWWISEPLUGINAudioDeviceTransportTypeBuiltIn = 6 , kWWISEPLUGINAudioDeviceTransportTypeThunderbolt = 7 ,   kWWISEPLUGINAudioDeviceTransportTypeAirPlay = 8 , kWWISEPLUGINAudioDeviceTransportTypeVirtual = 9 , kWWISEPLUGINAudioDeviceTransportTypeOther = 10 }
enum	RtcAudioDeviceType { kWWISEPLUGINAudioDeviceUnknown = 0 , kWWISEPLUGINAudioDeviceRecord , kWWISEPLUGINAudioDevicePlayout }
enum	RtcAudioDeviceState { kWWISEPLUGINAudioDeviceActive = 0 , kWWISEPLUGINAudioDeviceUnactive }

函数
void	HandleOnError (const char *channelName, int error_code, const char *msg)
void	HandleOnWarning (const char *channelName, int warn_code, const char *msg)
void	HandleOnJoinChannel (const char *channelName, uint64_t cid, uint64_t uid, int result, uint64_t elapsed)
void	HandleOnReconnectingStart (const char *channelName, uint64_t cid, uint64_t uid)
void	HandleOnConnectionStateChange (const char *channelName, WWISEPLUGIN_ConnectionStateType state, WWISEPLUGIN_ReasonConnectionChangedType reason)
void	HandleOnNetworkTypeChanged (WWISEPLUGIN_NetworkType new_type)
void	HandleOnRejoinChannel (const char *channelName, uint64_t cid, uint64_t uid, int result, uint64_t elapsed)
void	HandleOnLeaveChannel (const char *channelName, int result, uint64_t channel_id)
void	HandleOnDisconnect (const char *channelName, int reason)
void	HandleOnClientRoleChanged (const char *channelName, WWISEPLUGIN_ClientRole old_role, WWISEPLUGIN_ClientRole new_role)
void	HandleOnUserJoined (const char *channelName, uint64_t uid, const char *user_name)
void	HandleOnUserLeft (const char *channelName, uint64_t uid, int reason)
void	HandleOnUserAudioStart (const char *channelName, WWISEPLUGIN_AudioStreamType type, uint64_t uid)
void	HandleOnUserAudioStop (const char *channelName, WWISEPLUGIN_AudioStreamType type, uint64_t uid)
void	HandleOnUserAudioMute (const char *channelName, WWISEPLUGIN_AudioStreamType type, uint64_t uid, bool mute)
void	HandleOnAudioDeviceRoutingDidChange (WWISEPLUGIN_AudioOutputRouting routing)
void	HandleOnAudioDeviceStateChanged (const char *deviceId, WWISEPLUGIN_AudioDeviceType deviceType, WWISEPLUGIN_AudioDeviceState deviceState)
void	HandleOnAudioDefaultDeviceChanged (const char *deviceId, WWISEPLUGIN_AudioDeviceType deviceType)
void	HandleOnFirstAudioDataReceived (const char *channelName, WWISEPLUGIN_AudioStreamType type, uint64_t uid)
void	HandleOnFirstAudioFrameDecoded (const char *channelName, WWISEPLUGIN_AudioStreamType type, uint64_t uid)
void	HandleOnLocalAudioVolumeIndication (const char *channelName, int volume, bool enable_vad)
void	HandleOnRemoteAudioVolumeIndication (const char *channelName, const struct WWISEPLUGIN_AudioVolumeInfo *speakers, uint32_t speaker_number, int total_volume)
void	BindEngineEvents (struct WWISEPLUGIN_Events &events)
void	HandleOnAuth (int errorCode)
void	HandleOnRecordCompleted (int errorCode, const char *filePath)
void	HandleOnPlayCompleted (int errorCode, const char *filePath)
void	HandleOnUploadCompleted (int errorCode, const char *filePath, const char *fileID)
void	HandleOnDownloadCompleted (int errorCode, const char *filePath, const char *fileID)
void	HandleOnSpeechToTextCompleted (int errorCode, const char *fileID, const char *text)
void	HandleOnRecordingVolume (int volume)
void	HandleOnPlayingVolume (int volume)
void	BindVoiceEngineEvents (struct WWISEPLUGIN_VoiceEngineEvents &events)

枚举类型说明

RtcLogLevel

enum nertc::wwiseplugin::RtcLogLevel

日志级别。

枚举值
kWWISEPLUGINLevelFatal	Fatal 级别日志信息。
kWWISEPLUGINLevelError	Error 级别日志信息。
kWWISEPLUGINLevelWarning	Warning 级别日志信息。默认级别
kWWISEPLUGINLevelInfo	Info 级别日志信息。
kWWISEPLUGINLevelDetailInfo	Detail Info 级别日志信息。
kWWISEPLUGINLevelVerbos	Verbos 级别日志信息。
kWWISEPLUGINLevelDebug	Debug 级别日志信息。如果你想获取最完整的日志，可以将日志级别设为该等级。
kWWISEPLUGINLevelOff	不输出日志信息。

RtcConnectionStateType

enum nertc::wwiseplugin::RtcConnectionStateType

连接状态

枚举值
kWWISEPLUGINConnectionStateDisconnected	未加入房间。
kWWISEPLUGINConnectionStateConnecting	正在加入房间。
kWWISEPLUGINConnectionStateConnected	加入房间成功。
kWWISEPLUGINConnectionStateReconnecting	正在尝试重新加入房间。
kWWISEPLUGINConnectionStateFailed	加入房间失败。

RtcReasonConnectionChangedType

enum nertc::wwiseplugin::RtcReasonConnectionChangedType

连接状态变更原因

枚举值
kWWISEPLUGINReasonConnectionChangedLeaveChannel	kWWISEPLUGINConnectionStateDisconnected 离开房间
kWWISEPLUGINReasonConnectionChangedChannelClosed	kWWISEPLUGINConnectionStateDisconnected 房间被关闭
kWWISEPLUGINReasonConnectionChangedBeKicked	kWWISEPLUGINConnectionStateDisconnected 用户被踢
kWWISEPLUGINReasonConnectionChangedTimeOut	kWWISEPLUGINConnectionStateDisconnected 服务超时
kWWISEPLUGINReasonConnectionChangedJoinChannel	kWWISEPLUGINConnectionStateConnected 加入房间
kWWISEPLUGINReasonConnectionChangedJoinSucceed	kWWISEPLUGINConnectionStateConnected 加入房间成功
kWWISEPLUGINReasonConnectionChangedReJoinSucceed	kWWISEPLUGINConnectionStateConnected 重新加入房间成功（重连）
kWWISEPLUGINReasonConnectionChangedMediaConnectionDisconnected	kWWISEPLUGINConnectionStateReconnecting 媒体连接断开
kWWISEPLUGINReasonConnectionChangedSignalDisconnected	kWWISEPLUGINConnectionStateReconnecting 信令连接断开
kWWISEPLUGINReasonConnectionChangedRequestChannelFailed	kWWISEPLUGINConnectionStateFailed 请求房间失败
kWWISEPLUGINReasonConnectionChangedJoinChannelFailed	kWWISEPLUGINConnectionStateFailed 加入房间失败
kWWISEPLUGINReasonConnectionChangedReDispatch	kWWISEPLUGINConnectionStateReconnecting 重新分配了服务端IP
kWWISEPLUGINReasonConnectionChangedSettingProxyServer	开始使用云代理进行连接。

RtcNetworkType

enum nertc::wwiseplugin::RtcNetworkType

网络类型

枚举值
kWWISEPLUGINNetworkTypeUnknown
kWWISEPLUGINNetworkTypeEthernet
kWWISEPLUGINNetworkTypeWifi
kWWISEPLUGINNetworkType2G
kWWISEPLUGINNetworkType3G
kWWISEPLUGINNetworkType4G
kWWISEPLUGINNetworkType5G
kWWISEPLUGINNetworkTypeWWAN
kWWISEPLUGINNetworkTypeBluetooth
kWWISEPLUGINNetworkTypeNone

RtcClientRole

enum nertc::wwiseplugin::RtcClientRole

参会者角色类型

枚举值
kWWISEPLUGINClientRoleBroadcaster	（默认）直播模式中的主播，可以操作摄像头等音视频设备、发布流、配置互动直播推流任务、上下线对房间内其他用户可见。
kWWISEPLUGINClientRoleAudience	直播模式中的观众，观众只能接收音视频流，不支持操作音视频设备、配置互动直播推流任务、上下线不通知其他用户。

RtcRangeAudioMode

enum nertc::wwiseplugin::RtcRangeAudioMode

范围语音模式

枚举值
kWWISEPLUGINRangeAudioModeNone	无范围语音
kWWISEPLUGINRangeAudioModeDefault	世界模式
kWWISEPLUGINRangeAudioModeTeam	小组模式

RtcAudioProfileType

enum nertc::wwiseplugin::RtcAudioProfileType

音频属性。设置采样率，码率，编码模式和声道数。

枚举值
kWWISEPLUGINAudioProfileDefault	0: 默认设置。Speech 场景下为 kWWISEPLUGINAudioProfileStandardExtend，Music 场景下为 kWWISEPLUGINAudioProfileHighQuality。
kWWISEPLUGINAudioProfileStandard	1: 普通质量的音频编码，16000Hz，20Kbps
kWWISEPLUGINAudioProfileStandardExtend	2: 普通质量的音频编码，16000Hz，32Kbps
kWWISEPLUGINAudioProfileMiddleQuality	3: 中等质量的音频编码，48000Hz，32Kbps
kWWISEPLUGINAudioProfileMiddleQualityStereo	4: 中等质量的立体声编码，48000Hz * 2，64Kbps
kWWISEPLUGINAudioProfileHighQuality	5: 高质量的音频编码，48000Hz，64Kbps
kWWISEPLUGINAudioProfileHighQualityStereo	6: 高质量的立体声编码，48000Hz * 2，128Kbps

RtcAudioScenarioType

enum nertc::wwiseplugin::RtcAudioScenarioType

音频应用场景。不同的场景设置对应不同的音频采集模式、播放模式。

枚举值
kWWISEPLUGINAudioScenarioDefault	0: 默认设置 kWWISEPLUGINChannelProfileCommunication下为kWWISEPLUGINAudioScenarioSpeech， kWWISEPLUGINChannelProfileLiveBroadcasting下为kWWISEPLUGINAudioScenarioMusic。
kWWISEPLUGINAudioScenarioSpeech	1: 语音场景. WWISEPLUGINAudioProfileType 推荐使用 kWWISEPLUGINAudioProfileMiddleQuality 及以下
kWWISEPLUGINAudioScenarioMusic	2: 音乐场景。WWISEPLUGINAudioProfileType 推荐使用 kWWISEPLUGINAudioProfileMiddleQualityStereo 及以上
kWWISEPLUGINAudioScenarioChatroom	3: 语聊房场景 (只适用于移动端）。WWISEPLUGINAudioProfileType 推荐使用 kWWISEPLUGINAudioProfileHighQuality 及以上

RtcAudioDumpType

enum nertc::wwiseplugin::RtcAudioDumpType

音频dump类型

枚举值
kWWISEPLUGINAudioDumpTypePCM	仅输出.dump文件 自从 v4.6.0
kWWISEPLUGINAudioDumpTypeAll	输出.dump和.wav文件 自从 v4.6.0
kWWISEPLUGINAudioDumpTypeWAV	仅输出.wav文件（默认） 自从 v4.6.0

RtcErrorCode

enum nertc::wwiseplugin::RtcErrorCode

错误代码。
错误代码意味着 SDK 遇到不可恢复的错误，需要应用程序干预。

枚举值
kWWISEPLUGINNoError	没有错误
kWWISEPLUGINErrChannelReservePermissionDenied	权限不足。原因包括： 未开通音视频通话 2.0 服务，或试用期已过、未及时续费等。 安全模式下加入房间时未设置 Token。 其他权限问题。
kWWISEPLUGINErrChannelReserveTimeOut	请求超时
kWWISEPLUGINErrChannelReserveErrorParam	服务器请求参数错误
kWWISEPLUGINErrChannelReserveErrorAppKey	非法的APP KEY
kWWISEPLUGINErrChannelReserveServerFail	分配房间服务器未知错误
kWWISEPLUGINErrChannelReserveMoreThanTwoUser	只支持两个用户, 有第三个人试图使用相同的房间名分配房间
kWWISEPLUGINErrChannelNoPublishPermission	没有发布权限
kWWISEPLUGINErrChannelNoSubscribePermission	没有订阅权限
kWWISEPLUGINErrServerPersonsInRoomReachedTheLimit	加入房间的人数达到限制
kWWISEPLUGINErrFatal	通用错误
kWWISEPLUGINErrOutOfMemory	内存耗尽
kWWISEPLUGINErrInvalidParam	错误的参数
kWWISEPLUGINErrNotSupported	不支持的操作
kWWISEPLUGINErrInvalidState	当前状态不支持的操作
kWWISEPLUGINErrLackOfResource	资源耗尽
kWWISEPLUGINErrInvalidIndex	非法 index
kWWISEPLUGINErrDeviceNotFound	设备未找到
kWWISEPLUGINErrInvalidDeviceSourceID	非法设备 ID
kWWISEPLUGINErrInvalidVideoProfile	非法的视频 profile type
kWWISEPLUGINErrCreateDeviceSourceFail	设备创建错误
kWWISEPLUGINErrInvalidRender	非法的渲染容器
kWWISEPLUGINErrDevicePreviewAlreadyStarted	设备已经打开
kWWISEPLUGINErrTransmitPendding	传输错误
kWWISEPLUGINErrConnectFail	连接服务器错误
kWWISEPLUGINErrDeviceOccupied	所选设备已被占用
kWWISEPLUGINErrChannelAlreadyJoined	重复加入房间
kWWISEPLUGINErrChannelNotJoined	尚未加入房间
kWWISEPLUGINErrChannelRepleatedlyLeave	重复离开房间
kWWISEPLUGINErrRequestJoinChannelFail	加入房间操作失败
kWWISEPLUGINErrSessionNotFound	会话未找到
kWWISEPLUGINErrUserNotFound	用户未找到
kWWISEPLUGINErrInvalidUserID	非法的用户 ID
kWWISEPLUGINErrMediaNotStarted	用户多媒体数据未连接
kWWISEPLUGINErrSourceNotFound	source 未找到
kWWISEPLUGINErrConnectionNotFound	连接未找到
kWWISEPLUGINErrStreamNotFound	媒体流未找到
kWWISEPLUGINErrAddTrackFail	加入 track 失败
kWWISEPLUGINErrTrackNotFound	track 未找到
kWWISEPLUGINErrMediaConnectionDisconnected	媒体连接断开
kWWISEPLUGINErrSignalDisconnected	信令连接断开
kWWISEPLUGINErrServerKicked	被踢出房间
kWWISEPLUGINErrKickedForRoomClosed	因房间已关闭而被踢出
kWWISEPLUGINErrChannelLeaveBySwitchAction	因为切换房间的操作房间被关闭
kWWISEPLUGINErrChannelLeaveByDuplicateUidLogin	因为有重复 uid 登录导致房间被关闭
kWWISEPLUGINErrPTTAuthorizeFailed	PTT 权限验证失败。
kWWISEPLUGINErrPTTAuthNetError	PTT 权限验证网络错误。
kWWISEPLUGINErrPTTAuthTimeOut	PTT 权限超时。
kWWISEPLUGINErrPTTRecordingAreadyStarted	PTT 录音已经开始 。
kWWISEPLUGINErrPTTRecordingOpenFileFailed	PTT 录音打开文件失败。
kWWISEPLUGINErrPTTRecordingDurationTooShort	PTT 录音时长太短。
kWWISEPLUGINErrPTTRecordingNotStarted	PTT 录音未开始。
kWWISEPLUGINErrPTTPlayOpenFileFailed	PTT 播放打开文件失败。
kWWISEPLUGINErrPTTPlayReadFileFailed	PTT 播放读取文件失败，可能是播放器错误或解码失败。
kWWISEPLUGINErrPTTPlayNotStarted	PTT 播放未开始。
kWWISEPLUGINErrPTTUploadOpenFileFailed	PTT 上传打开文件失败。
kWWISEPLUGINErrPTTUploadFileTooLarge	PTT 上传文件大小超过限制。
kWWISEPLUGINErrPTTUploadAuthFailed	PTT 上传权限验证失败
kWWISEPLUGINErrPTTUploadNetError	PTT 上传网络错误 。
kWWISEPLUGINErrPTTUploadDataError	PTT 上传服务数据错误，可能是参数异常或者服务异常。
kWWISEPLUGINErrPTTDownloadOpenFileFailed	PTT 下载打开文件失败。
kWWISEPLUGINErrPTTDownloadAuthFailed	PTT 下载权限验证失败。
kWWISEPLUGINErrPTTDownloadNetError	PTT 下载网络错误。
kWWISEPLUGINErrPTTDownloadNotFound	PTT 下载文件不存在。
kWWISEPLUGINErrPTTDownloadDataError	PTT 下载服务数据错误，可能是参数异常或者服务异常。
kWWISEPLUGINErrPTTSTTAuthFailed	PTT 语音转文字权限验证失败。
kWWISEPLUGINErrPTTSTTNetError	PTT 语音转文字网络错误 。
kWWISEPLUGINErrPTTSTTTranslateFaild	PTT 语音转文字转换服务失败。
kWWISEPLUGINErrPTTSTTNotFound	语音转文字文件不存在。
kWWISEPLUGINErrPTTSTTDataError	PTT 语音转文字服务数据错误，可能是参数异常或者服务异常。
kWWISEPLUGINRuntimeErrADMNoAuthorize	没有音频设备权限
kWWISEPLUGINRuntimeErrADMInitRecording	音频设备模块：初始化录音设备时出现错误。请检查录音设备是否正常或者权限限制，或者尝试重新进入房间。
kWWISEPLUGINRuntimeErrADMStartRecording	音频设备模块：启动录音设备出现错误。请检查录音设备是否正常，或者尝试重新进入房间。
kWWISEPLUGINRuntimeErrADMStopRecording	音频设备模块：运行时录音错误。请检查录音设备是否正常，或者尝试重新进入房间。
kWWISEPLUGINRuntimeErrADMInitPlayout	音频设备模块：初始化播放设备出现错误。请检查播放设备是否异常或者权限限制，或者尝试重新进入房间。
kWWISEPLUGINRuntimeErrADMStartPlayout	音频设备模块：启动播放设备出现错误。请检查播放设备是否正常，或者尝试重新进入房间。
kWWISEPLUGINRuntimeErrADMStopPlayout	音频设备模块：运行时播放出现错误。请检查播放设备是否正常，或者尝试重新进入房间。
kWWISEPLUGINRuntimeErrADMRecordingFailed	音频采集设备运行异常
kWWISEPLUGINRuntimeErrADMPlayoutFailed	音频播放设备运行异常

RtcAudioStreamType

enum nertc::wwiseplugin::RtcAudioStreamType

音频流类型。

枚举值
kWWISEPLUGINAudioStreamTypeMain	主流。
kWWISEPLUGINAudioStreamTypeSub	辅流。

RtcAudioOutputRouting

enum nertc::wwiseplugin::RtcAudioOutputRouting

音频路由 仅iOS和Android有效

枚举值
kWWISEPLUGINAudioOutputRoutingDefault	系统默认
kWWISEPLUGINAudioOutputRoutingHeadset	耳机
kWWISEPLUGINAudioOutputRoutingEarpiece	听筒
kWWISEPLUGINAudioOutputRoutingLoudspeaker	扬声器
kWWISEPLUGINAudioOutputRoutingBluetooth	蓝牙外设

RtcAudioDeviceTransportType

enum nertc::wwiseplugin::RtcAudioDeviceTransportType

音频设备连接类型。

枚举值
kWWISEPLUGINAudioDeviceTransportTypeUnknown	未知设备
kWWISEPLUGINAudioDeviceTransportTypeBluetooth	蓝牙设备
kWWISEPLUGINAudioDeviceTransportTypeBluetoothA2DP	蓝牙立体声设备
kWWISEPLUGINAudioDeviceTransportTypeBluetoothLE	蓝牙低功耗设备
kWWISEPLUGINAudioDeviceTransportTypeUSB	USB设备
kWWISEPLUGINAudioDeviceTransportTypeHDMI	HDMI设备
kWWISEPLUGINAudioDeviceTransportTypeBuiltIn	内置设备
kWWISEPLUGINAudioDeviceTransportTypeThunderbolt	雷电接口设备
kWWISEPLUGINAudioDeviceTransportTypeAirPlay	AirPlay设备
kWWISEPLUGINAudioDeviceTransportTypeVirtual	虚拟设备
kWWISEPLUGINAudioDeviceTransportTypeOther	其他设备

RtcAudioDeviceType

enum nertc::wwiseplugin::RtcAudioDeviceType

音频设备类型。

枚举值
kWWISEPLUGINAudioDeviceUnknown	未知音频设备
kWWISEPLUGINAudioDeviceRecord	音频采集设备
kWWISEPLUGINAudioDevicePlayout	音频播放设备

RtcAudioDeviceState

enum nertc::wwiseplugin::RtcAudioDeviceState

音频设备类型状态。

枚举值
kWWISEPLUGINAudioDeviceActive	音频设备已激活
kWWISEPLUGINAudioDeviceUnactive	音频设备未激活

函数说明

HandleOnError()

void nertc::wwiseplugin::HandleOnError	(	const char *	channelName,
		int	error_code,
		const char *	msg )

HandleOnWarning()

void nertc::wwiseplugin::HandleOnWarning	(	const char *	channelName,
		int	warn_code,
		const char *	msg )

HandleOnJoinChannel()

void nertc::wwiseplugin::HandleOnJoinChannel	(	const char *	channelName,
		uint64_t	cid,
		uint64_t	uid,
		int	result,
		uint64_t	elapsed )

HandleOnReconnectingStart()

void nertc::wwiseplugin::HandleOnReconnectingStart	(	const char *	channelName,
		uint64_t	cid,
		uint64_t	uid )

HandleOnConnectionStateChange()

void nertc::wwiseplugin::HandleOnConnectionStateChange	(	const char *	channelName,
		WWISEPLUGIN_ConnectionStateType	state,
		WWISEPLUGIN_ReasonConnectionChangedType	reason )

HandleOnNetworkTypeChanged()

void nertc::wwiseplugin::HandleOnNetworkTypeChanged

(

WWISEPLUGIN_NetworkType

new_type

)

HandleOnRejoinChannel()

void nertc::wwiseplugin::HandleOnRejoinChannel	(	const char *	channelName,
		uint64_t	cid,
		uint64_t	uid,
		int	result,
		uint64_t	elapsed )

HandleOnLeaveChannel()

void nertc::wwiseplugin::HandleOnLeaveChannel	(	const char *	channelName,
		int	result,
		uint64_t	channel_id )

HandleOnDisconnect()

void nertc::wwiseplugin::HandleOnDisconnect	(	const char *	channelName,
		int	reason )

HandleOnClientRoleChanged()

void nertc::wwiseplugin::HandleOnClientRoleChanged	(	const char *	channelName,
		WWISEPLUGIN_ClientRole	old_role,
		WWISEPLUGIN_ClientRole	new_role )

HandleOnUserJoined()

void nertc::wwiseplugin::HandleOnUserJoined	(	const char *	channelName,
		uint64_t	uid,
		const char *	user_name )

HandleOnUserLeft()

void nertc::wwiseplugin::HandleOnUserLeft	(	const char *	channelName,
		uint64_t	uid,
		int	reason )

HandleOnUserAudioStart()

void nertc::wwiseplugin::HandleOnUserAudioStart	(	const char *	channelName,
		WWISEPLUGIN_AudioStreamType	type,
		uint64_t	uid )

HandleOnUserAudioStop()

void nertc::wwiseplugin::HandleOnUserAudioStop	(	const char *	channelName,
		WWISEPLUGIN_AudioStreamType	type,
		uint64_t	uid )

HandleOnUserAudioMute()

void nertc::wwiseplugin::HandleOnUserAudioMute	(	const char *	channelName,
		WWISEPLUGIN_AudioStreamType	type,
		uint64_t	uid,
		bool	mute )

HandleOnAudioDeviceRoutingDidChange()

void nertc::wwiseplugin::HandleOnAudioDeviceRoutingDidChange

(

WWISEPLUGIN_AudioOutputRouting

routing

)

HandleOnAudioDeviceStateChanged()

void nertc::wwiseplugin::HandleOnAudioDeviceStateChanged	(	const char *	deviceId,
		WWISEPLUGIN_AudioDeviceType	deviceType,
		WWISEPLUGIN_AudioDeviceState	deviceState )

HandleOnAudioDefaultDeviceChanged()

void nertc::wwiseplugin::HandleOnAudioDefaultDeviceChanged	(	const char *	deviceId,
		WWISEPLUGIN_AudioDeviceType	deviceType )

HandleOnFirstAudioDataReceived()

void nertc::wwiseplugin::HandleOnFirstAudioDataReceived	(	const char *	channelName,
		WWISEPLUGIN_AudioStreamType	type,
		uint64_t	uid )

HandleOnFirstAudioFrameDecoded()

void nertc::wwiseplugin::HandleOnFirstAudioFrameDecoded	(	const char *	channelName,
		WWISEPLUGIN_AudioStreamType	type,
		uint64_t	uid )

HandleOnLocalAudioVolumeIndication()

void nertc::wwiseplugin::HandleOnLocalAudioVolumeIndication	(	const char *	channelName,
		int	volume,
		bool	enable_vad )

HandleOnRemoteAudioVolumeIndication()

void nertc::wwiseplugin::HandleOnRemoteAudioVolumeIndication	(	const char *	channelName,
		const struct WWISEPLUGIN_AudioVolumeInfo *	speakers,
		uint32_t	speaker_number,
		int	total_volume )

BindEngineEvents()

void nertc::wwiseplugin::BindEngineEvents

(

struct WWISEPLUGIN_Events &

events

)

HandleOnAuth()

void nertc::wwiseplugin::HandleOnAuth

(

int

errorCode

)

HandleOnRecordCompleted()

void nertc::wwiseplugin::HandleOnRecordCompleted	(	int	errorCode,
		const char *	filePath )

HandleOnPlayCompleted()

void nertc::wwiseplugin::HandleOnPlayCompleted	(	int	errorCode,
		const char *	filePath )

HandleOnUploadCompleted()

void nertc::wwiseplugin::HandleOnUploadCompleted	(	int	errorCode,
		const char *	filePath,
		const char *	fileID )

HandleOnDownloadCompleted()

void nertc::wwiseplugin::HandleOnDownloadCompleted	(	int	errorCode,
		const char *	filePath,
		const char *	fileID )

HandleOnSpeechToTextCompleted()

void nertc::wwiseplugin::HandleOnSpeechToTextCompleted	(	int	errorCode,
		const char *	fileID,
		const char *	text )

HandleOnRecordingVolume()

void nertc::wwiseplugin::HandleOnRecordingVolume

(

int

volume

)

HandleOnPlayingVolume()

void nertc::wwiseplugin::HandleOnPlayingVolume

(

int

volume

)

BindVoiceEngineEvents()

void nertc::wwiseplugin::BindVoiceEngineEvents

(

struct WWISEPLUGIN_VoiceEngineEvents &

events

)