#include <INertcEngineEx.h>

类 nertc::IRtcEngineEx 继承关系图:

Public 成员函数
virtual	~IRtcEngineEx ()

virtual IRtcChannel *	createChannel (const char *channel_name)=0

virtual IRtcVoiceEngine *	getVoiceEngine ()=0

virtual NERtcConnectionStateType	getConnectionState ()=0

virtual int	muteLocalAudioStream (NERtcAudioStreamType type, bool mute)=0

virtual int	setAudioProfile (NERtcAudioProfileType profile, NERtcAudioScenarioType scenario)=0

virtual int	setAudioEffectPreset (NERtcVoiceChangerType type)=0

virtual int	setVoiceBeautifierPreset (NERtcVoiceBeautifierType type)=0

virtual int	setLocalVoicePitch (double pitch)=0

virtual int	setLocalVoiceEqualization (NERtcVoiceEqualizationBand band_frequency, int band_gain)=0

virtual int	subscribeRemoteAudioStream (NERtcAudioStreamType stream_type, uid_t uid, bool subscribe)=0

virtual int	subscribeAllRemoteAudioStream (bool subscribe)=0

virtual int	setPublishAudioAllowList (uid_t *uid_array, uint32_t size)=0

virtual int	setSubscribeAudioAllowList (uid_t *uid_array, uint32_t size)=0

virtual int	setSubscribeAudioBlockList (uid_t *uid_array, uint32_t size)=0

virtual int	setAudioSessionOperationRestriction (NERtcAudioSessionOperationRestriction restriction)=0

virtual int	setAudioFocusMode (NERtcAudioFocusMode focus_mode)=0

virtual int	setPlayoutDeviceMute (bool muted)=0

virtual int	getPlayoutDeviceMute (bool *muted)=0

virtual int	setParameters (const char *parameters)=0

virtual int	setAudioFrameObserver (INERtcAudioFrameObserver *observer)=0

virtual int	startAudioDump (NERtcAudioDumpType type)=0

virtual int	stopAudioDump ()=0

virtual int	setLoudspeakerMode (bool enable)=0

virtual int	getLoudspeakerMode (bool *enabled)=0

virtual int	setStatsObserver (IRtcMediaStatsObserver *observer)=0

virtual int	enableAudioVolumeIndication (bool enable, uint64_t interval, bool enable_vad)=0

virtual const char *	getVersion (int *build)=0

virtual const char *	getErrorDescription (int error_code)=0

virtual void	uploadSdkInfo ()=0

virtual int	adjustRecordingSignalVolume (int volume)=0

virtual int	adjustPlaybackSignalVolume (int volume)=0

virtual int	enableMediaPublish (bool enabled, NERtcMediaPubType media_type)=0

virtual int	setRangeAudioMode (NERtcRangeAudioMode mode)=0

virtual int	setRangeAudioTeamID (int32_t team_id)=0

virtual int	setAudioRecvRange (int audible_distance, int conversational_distance, NERtcDistanceRolloffModel roll_off)=0

virtual int	updateSelfPosition (const NERtcPositionInfo &info)=0

virtual int	initSpatializer ()=0

virtual int	enableSpatializer (bool enable)=0

virtual int	getMicrophoneMode (bool *enabled)=0

virtual int	getRecordingSignalVolume ()=0

virtual int	getPlaybackSignalVolume ()=0

virtual bool	checkMicPermision ()=0

virtual int	pauseAudio ()=0

virtual int	resumeAudio ()=0

virtual bool	isInChannel ()=0

virtual bool	acquireAndroidRecordingPermissions ()=0

Public 成员函数继承自 nertc::IRtcEngine
virtual	~IRtcEngine ()

virtual int	initialize (const NERtcEngineContext &context)=0

virtual void	release (bool sync=false)=0

virtual int	setClientRole (NERtcClientRole role)=0

virtual int	setChannelProfile (NERtcChannelProfileType profile)=0

virtual int	joinChannel (const char token, const char channel_name, uid_t uid, const NERtcJoinChannelOptions &channel_options)=0

virtual int	switchChannel (const char token, const char channel_name, const NERtcJoinChannelOptions &channel_options)=0

virtual int	switchChannelEx (const char token, const char channel_name, uid_t uid, const NERtcJoinChannelOptionsEx &channel_options)=0

virtual int	leaveChannel ()=0

virtual int	queryInterface (NERtcInterfaceIdType iid, void **inter)=0

virtual int	enableLocalAudio (NERtcAudioStreamType type, bool enabled)=0

构造及析构函数说明

◆ ~IRtcEngineEx()

virtual nertc::IRtcEngineEx::~IRtcEngineEx ( )

inlinevirtual

成员函数说明

◆ acquireAndroidRecordingPermissions()

virtual bool nertc::IRtcEngineEx::acquireAndroidRecordingPermissions ( )

pure virtual

安卓平台下请求录音权限、蓝牙权限

◆ adjustPlaybackSignalVolume()

virtual int nertc::IRtcEngineEx::adjustPlaybackSignalVolume ( int volume )

pure virtual

调节本地播放音量。

注解: 该方法仅调节应用程序中音量，不修改设备音量。如果需要修改设备音量，请查看设备管理相关接口。

参数

[in]

volume

播放音量。取值范围为 [0, 400]。其中：

0: 静音；
100: 原始音量；
400: 最大可为原始音量的 4 倍（自带溢出保护）。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ adjustRecordingSignalVolume()

virtual int nertc::IRtcEngineEx::adjustRecordingSignalVolume ( int volume )

pure virtual

调节采集信号音量。

注解: 该方法仅调节应用程序中的采集信号音量，不修改设备音量。如果需要修改设备音量，请查看设备管理相关接口。

参数

[in]

volume

采集录音音量，取值范围为 [0, 400]。其中：

0: 静音；
100: 原始音量；
400: 最大可为原始音量的 4 倍（自带溢出保护）。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ checkMicPermision()

virtual bool nertc::IRtcEngineEx::checkMicPermision ( )

pure virtual

检查平台麦克风权限（移动端）

返回: 麦克风权限

◆ createChannel()

virtual IRtcChannel * nertc::IRtcEngineEx::createChannel ( const char * channel_name )

pure virtual

创建一个 IRtcChannel 对象

参数

[in] channel_name 房间名。设置相同房间名称的用户会进入同一个通话房间。字符串格式，长度为1~ 64 字节。支持以下89个字符：a-z, A-Z, 0-9, space, !#$%&()+-:;≤.,>? @[]^_{|}~”

返回

返回 IRtcChannel 对象指针

0: 方法调用失败。

◆ enableAudioVolumeIndication()

virtual int nertc::IRtcEngineEx::enableAudioVolumeIndication	(	bool	enable,
		uint64_t	interval,
		bool	enable_vad )

pure virtual

启用说话者音量提示。
该方法允许 SDK 定期向 App 反馈本地发流用户和瞬时音量最高的远端用户（最多 3 位）的音量相关信息，即当前谁在说话以及说话者的音量。
启用该方法后，只要房间内有发流用户，无论是否有人说话，SDK 都会在加入房间后根据预设的时间间隔触发onRemoteAudioVolumeIndication回调。

参数

enable	是否启用说话者音量提示。
interval	指定音量提示的时间间隔，单位为毫秒。必须设置为 100 毫秒的整数倍值。
enable_vad	是否启用本地采集人声监测。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ enableMediaPublish()

virtual int nertc::IRtcEngineEx::enableMediaPublish	(	bool	enabled,
		NERtcMediaPubType	media_type )

pure virtual

开启或关闭本地媒体流（主流）的发送。
该方法用于开始或停止向网络发送本地音频或视频数据。
该方法不影响接收或播放远端媒体流，也不会影响本地音频或视频的采集状态。

注解

该方法暂时仅支持控制音频流的发送。
该方法在加入房间前后均可调用。
停止发送媒体流的状态会在通话结束后被重置为允许发送。
成功调用该方法切换本地用户的发流状态后，房间内其他用户会收到 onUserAudioStart（开启发送音频）或 onUserAudioStop（停止发送音频）的回调。

相关接口

muteLocalAudioStream：
- 在需要开启本地音频采集（监测本地用户音量）但不发送音频流的情况下，您也可以调用 muteLocalAudioStream(true) 方法。
- 两者的差异在于，muteLocalAudioStream(true) 仍然保持与服务器的音频通道连接，而 enableMediaPub(false) 表示断开此通道，因此若您的实际业务场景为多人并发的大房间，建议您调用 enableMediaPub 方法。

参数

enabled	是否发布本地媒体流。 true（默认）：发布本地媒体流。 false：不发布本地媒体流。
media_type	媒体发布类型，暂时仅支持音频。

返回

0：方法调用成功。
其他：方法调用失败。

◆ enableSpatializer()

virtual int nertc::IRtcEngineEx::enableSpatializer ( bool enable )

pure virtual

引擎3D音效算法开关

注解: 通话前调用，通话结束后不重置

参数

enable 是否打开3D音效算法功能

返回

0: 方法调用成功
其他: 调用失败

◆ getConnectionState()

virtual NERtcConnectionStateType nertc::IRtcEngineEx::getConnectionState ( )

pure virtual

获取当前网络状态。

返回: 当前网络状态。#NERtcConnectionStateType.

◆ getErrorDescription()

virtual const char * nertc::IRtcEngineEx::getErrorDescription ( int error_code )

pure virtual

查看指定错误码的错误描述。

注解: 目前该方法无效，只返回空值。请在 onError 中查看返回的错误码及具体的错误描述。

参数

[in] error_code NERtcErrorCode 。

返回: 详细错误码描述

◆ getLoudspeakerMode()

virtual int nertc::IRtcEngineEx::getLoudspeakerMode ( bool * enabled )

pure virtual

获取目前是否使用扬声器模式（仅iOS/Android有效）

参数

enabled 是否正在使用扬声器模式

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ getMicrophoneMode()

virtual int nertc::IRtcEngineEx::getMicrophoneMode ( bool * enabled )

pure virtual

获取麦克风开关状态

返回: 麦克风打开状态

◆ getPlaybackSignalVolume()

virtual int nertc::IRtcEngineEx::getPlaybackSignalVolume ( )

pure virtual

获取扬声器音量

返回: 扬声器音量

◆ getPlayoutDeviceMute()

virtual int nertc::IRtcEngineEx::getPlayoutDeviceMute ( bool * muted )

pure virtual

获取音频播放设备的静音状态。

参数

muted 是否静音。

返回: 操作返回值，成功则返回 0

◆ getRecordingSignalVolume()

virtual int nertc::IRtcEngineEx::getRecordingSignalVolume ( )

pure virtual

获取麦克风音量

返回: 麦克风音量

◆ getVersion()

virtual const char * nertc::IRtcEngineEx::getVersion ( int * build )

pure virtual

查询 SDK 版本号。该方法在加入房间前后都能调用。

返回: 当前的 SDK 版本号，格式为字符串，如1.0.0.

◆ getVoiceEngine()

virtual IRtcVoiceEngine * nertc::IRtcEngineEx::getVoiceEngine ( )

pure virtual

获取 IRtcVoiceEngine 对象

注解

返回IRtcEngineEx引擎中的语音模块对象。

该对象用于实现语音消息的录制、播放、上传、下载。
当IRtcEngineEx释放后该模块失效。

返回

返回 IRtcVoiceEngine 对象指针

0: 方法调用失败。

◆ initSpatializer()

virtual int nertc::IRtcEngineEx::initSpatializer ( )

pure virtual

初始化引擎3D音效算法

注解: 此接口在加入房间前调用，退出房间后不重置

返回

0: 方法调用成功
其他: 调用失败

◆ isInChannel()

virtual bool nertc::IRtcEngineEx::isInChannel ( )

pure virtual

检查是否已经在房间内

参数

enabled 输出结果，true:在房间内 false:不在房间内

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ muteLocalAudioStream()

virtual int nertc::IRtcEngineEx::muteLocalAudioStream	(	NERtcAudioStreamType	type,
		bool	mute )

pure virtual

开关本地音频发送。该方法用于允许或禁止向网络发送本地音频流。

注解

该方法不影响录音状态，因为并没有禁用录音设备。
静音状态会在通话结束后被重置为非静音

参数

[in]	type	音频流类型:
[in]	mute	静音/取消静音: true: 静音本地音频 false: 取消静音本地音频（默认）

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ pauseAudio()

virtual int nertc::IRtcEngineEx::pauseAudio ( )

pure virtual

暂停音频输入与输出

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ resumeAudio()

virtual int nertc::IRtcEngineEx::resumeAudio ( )

pure virtual

暂停音频输入与输出

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setAudioEffectPreset()

virtual int nertc::IRtcEngineEx::setAudioEffectPreset ( NERtcVoiceChangerType type )

pure virtual

设置 SDK 预设的人声的变声音效。设置变声音效可以将人声原因调整为多种特殊效果，改变声音特性。

注解

此方法在加入房间前后都能调用，通话结束后重置为默认关闭状态。
此方法和 setLocalVoicePitch 互斥，调用此方法后，本地语音语调会恢复为默认值 1.0。

参数

[in] type 预设的变声音效。默认关闭变声音效。详细信息请参考 nertc::NERtcVoiceChangerType 。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setAudioFocusMode()

virtual int nertc::IRtcEngineEx::setAudioFocusMode ( NERtcAudioFocusMode focus_mode )

pure virtual

设置音频焦点模式。
该方法仅适用于 Android 平台。

返回: 0 方法调用成功，其他失败。

◆ setAudioFrameObserver()

virtual int nertc::IRtcEngineEx::setAudioFrameObserver ( INERtcAudioFrameObserver * observer )

pure virtual

注册语音观测器对象。
该方法用于设置音频采集和播放PCM回调，可用于声音处理等操作。当需要引擎给出 onAudioFrameDidRecord 或 onAudioFrameWillPlayback 回调时，需要使用该方法注册回调。

参数

observer 接口对象实例。如果传入 NULL，则取消注册，同时会清理NERtcAudioFrameRequestFormat相关设置。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setAudioProfile()

virtual int nertc::IRtcEngineEx::setAudioProfile	(	NERtcAudioProfileType	profile,
		NERtcAudioScenarioType	scenario )

pure virtual

设置音频编码属性。

注解

该方法需要在 joinChannel 之前设置好， joinChannel 之后设置不生效。
音乐场景下，建议将 profile 设置为 kNERtcAudioProfileHighQuality。

参数

[in]	profile	设置采样率，码率，编码模式和声道数: NERtcAudioProfileType 。
[in]	scenario	设置音频应用场景: NERtcAudioScenarioType 。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setAudioRecvRange()

virtual int nertc::IRtcEngineEx::setAudioRecvRange	(	int	audible_distance,
		int	conversational_distance,
		NERtcDistanceRolloffModel	roll_off )

pure virtual

引擎3D音效算法距离范围设置

注解: 依赖enableSpatializer接口开启，通话前调用

参数

audible_distance	监听器能够听到扬声器并接收其文本消息的距离扬声器的最大距离。[0,1000] 默认值为 32。
conversational_distance	控制扬声器音频保持其原始音量的范围，超出该范围时，语音聊天的响度在被听到时开始淡出。默认值为 1。
roll_off:距离衰减模式	NERtcDistanceRolloffModel ，默认值 kNERtcDistanceRolloffNone

返回

0: 方法调用成功
其他: 调用失败

◆ setAudioSessionOperationRestriction()

virtual int nertc::IRtcEngineEx::setAudioSessionOperationRestriction ( NERtcAudioSessionOperationRestriction restriction )

pure virtual

设置 SDK 对 Audio Session 的控制权限。
该方法仅适用于 iOS 平台。
该方法限制 SDK 对 Audio Session 的操作权限。在默认情况下，SDK 和 App 对 Audio Session 都有控制权，但某些场景下，App 会希望限制 SDK 对 Audio Session 的控制权限，而使用其他应用或第三方组件对 Audio Session 进行操控。调用该方法可以实现该功能。
该接口只能在入会之前调用。

注解: 一旦调用该方法限制了 SDK 对 Audio Session 的控制权限， SDK 将无法对 Audio Session 进行相关设置，而需要用户自己或第三方组件进行维护。

参数

restriction SDK 对 Audio Session 的控制权限。详细信息请参考 NERtcAudioSessionOperationRestriction。

返回: 操作返回值，成功则返回 0

◆ setLocalVoiceEqualization()

virtual int nertc::IRtcEngineEx::setLocalVoiceEqualization	(	NERtcVoiceEqualizationBand	band_frequency,
		int	band_gain )

pure virtual

设置本地语音音效均衡，即自定义设置本地人声均衡波段的中心频率。

注解: 该方法在加入房间前后都能调用，通话结束后重置为默认关闭状态。

参数

[in]	band_frequency	频谱子带索引，取值范围是 [0-9]，分别代表 10 个频带，对应的中心频率是 [31，62，125，250，500，1k，2k，4k，8k，16k] Hz。
[in]	band_gain	每个 band 的增益，单位是 dB，每一个值的范围是 [-15，15]，默认值为 0。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setLocalVoicePitch()

virtual int nertc::IRtcEngineEx::setLocalVoicePitch ( double pitch )

pure virtual

设置本地语音音调。该方法改变本地说话人声音的音调。

注解

通话结束后该设置会重置，默认为 1.0。
此方法与 setAudioEffectPreset 互斥，调用此方法后，已设置的变声效果会被取消。

参数

[in] pitch 语音频率。可以在 [0.5, 2.0] 范围内设置。取值越小，则音调越低。默认值为 1.0，表示不需要修改音调。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setLoudspeakerMode()

virtual int nertc::IRtcEngineEx::setLoudspeakerMode ( bool enable )

pure virtual

设置音频播放扬声器模式（仅iOS/Android有效）

参数

enable 是否使用扬声器模式

返回: 操作返回值，成功则返回 0

◆ setParameters()

virtual int nertc::IRtcEngineEx::setParameters ( const char * parameters )

pure virtual

设置音视频通话的相关参数。通过 JSON 配置 SDK 提供技术预览或特别定制功能。以标准化方式公开 JSON 选项。

参数

[in] parameters 音视频通话的相关参数。 JSON 字符串形式。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setPlayoutDeviceMute()

virtual int nertc::IRtcEngineEx::setPlayoutDeviceMute ( bool muted )

pure virtual

设置是否静音音频播放设备。

参数

muted 是否静音播放设备。默认为不静音状态。

返回: 操作返回值，成功则返回 0

◆ setPublishAudioAllowList()

virtual int nertc::IRtcEngineEx::setPublishAudioAllowList	(	uid_t *	uid_array,
		uint32_t	size )

pure virtual

你可以调用该方法指定音频流被谁订阅。

注解

此接口需要在加入房间成功后调用。
对于调用接口时不在房间的 uid 不生效。

参数

[in] uid_array 可订阅自己音频的用户uid 列表

注解: 此列表为全量列表。如果列表为空或 null，取消订阅白名单。

参数

[in] size uid_array 的数组长度。

返回

0：方法调用成功。
其他：方法调用失败。

◆ setRangeAudioMode()

virtual int nertc::IRtcEngineEx::setRangeAudioMode ( NERtcRangeAudioMode mode )

pure virtual

设置范围语音模式

注解: 此接口在加入房间前后均可调用。

参数

mode 范围语音模式

返回: 操作返回值，成功则返回 0

◆ setRangeAudioTeamID()

virtual int nertc::IRtcEngineEx::setRangeAudioTeamID ( int32_t team_id )

pure virtual

设置范围语音小队

注解: 此接口在加入房间前后均可调用。

参数

team_id 小队ID

返回: 操作返回值，成功则返回 0

◆ setStatsObserver()

virtual int nertc::IRtcEngineEx::setStatsObserver ( IRtcMediaStatsObserver * observer )

pure virtual

注册统计信息观测器。

参数

[in] observer 统计信息观测器

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setSubscribeAudioAllowList()

virtual int nertc::IRtcEngineEx::setSubscribeAudioAllowList	(	uid_t *	uid_array,
		uint32_t	size )

pure virtual

你可以调用该方法指定只订阅的音频流。

注解

此接口需要在加入房间成功后调用。
对于调用接口时不在房间的 uid 不生效。

参数

[in] uid_array 只订阅此用户uid列表的音频。

注解: 此列表为全量列表。如果列表为空或 null，取消订阅白名单。

参数

[in] size uid_array 的数组长度。

返回

0：方法调用成功。
其他：方法调用失败。

◆ setSubscribeAudioBlockList()

virtual int nertc::IRtcEngineEx::setSubscribeAudioBlockList	(	uid_t *	uid_array,
		uint32_t	size )

pure virtual

你可以调用该方法指定不订阅的音频流。

注解

此接口需要在加入房间成功后调用。
对于调用接口时不在房间的 uid 不生效。

参数

[in] uid_array 不订阅此用户uid列表的音频。

注解: 此列表为全量列表。如果列表为空或 null，取消订阅黑名单。

参数

[in] size uid_array 的数组长度。

返回

0：方法调用成功。
其他：方法调用失败。

◆ setVoiceBeautifierPreset()

virtual int nertc::IRtcEngineEx::setVoiceBeautifierPreset ( NERtcVoiceBeautifierType type )

pure virtual

设置 SDK 预设的美声效果。调用该方法可以为本地发流用户设置 SDK 预设的人声美声效果。

注解: 通话结束后重置为默认关闭

参数

[in] type 预设的美声效果模式。默认关闭美声效果。详细信息请参考 nertc::NERtcVoiceBeautifierType 。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ startAudioDump()

virtual int nertc::IRtcEngineEx::startAudioDump ( NERtcAudioDumpType type )

pure virtual

开始记录音频 dump。音频 dump 可用于分析音频问题。

参数

type 音频dump类型

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ stopAudioDump()

virtual int nertc::IRtcEngineEx::stopAudioDump ( )

pure virtual

结束音频dump。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ subscribeAllRemoteAudioStream()

virtual int nertc::IRtcEngineEx::subscribeAllRemoteAudioStream ( bool subscribe )

pure virtual

取消或恢复订阅所有远端用户的音频主流。
加入房间时，默认订阅所有远端用户的音频主流，即 setParameters 方法的 KEY_AUTO_SUBSCRIBE_AUDIO 参数默认设置为 true；只有当该参数的设置为 false 时，此接口的调用才会生效。

调用时机: 请在引擎初始化之后调用此接口，且该方法在加入房间前后均可调用。

业务场景: 适用于重要会议需要一键全体静音的场景。

注解

设置该方法的 subscribe 参数为 true 后，对后续加入房间的用户同样生效。
在开启自动订阅（默认）时，设置该方法的 subscribe 参数为 false 可以实现取消订阅所有远端用户的音频流，但此时无法再调用 subscribeRemoteAudioStream 方法单独订阅指定远端用户的音频流。

参数说明

参数名称	类型	描述
subscribe	bool	是否订阅所有用户的音频主流： true：订阅音频主流。 false：取消订阅音频主流。

示例代码: //订阅所有远端用户的音频主流

rtc_engine_->subscribeAllRemoteAudioStream(true);

//取消订阅所有远端用户的音频主流

rtc_engine_->subscribeAllRemoteAudioStream(false);

返回

0（kNERtcNoError）：方法调用成功。
其他：方法调用失败。
- 30005（kNERtcErrInvalidState)：引擎未初始化。
- 30026：ASL 选路功能启用失败。
- 30400：Transceiver 未找到。

◆ subscribeRemoteAudioStream()

virtual int nertc::IRtcEngineEx::subscribeRemoteAudioStream	(	NERtcAudioStreamType	stream_type,
		uid_t	uid,
		bool	subscribe )

pure virtual

取消或恢复订阅指定远端用户音频流。
加入房间时，默认订阅所有远端用户的音频流，您可以通过此方法取消或恢复订阅指定远端用户的音频流。

注解: 当kNERtcKeyAutoSubscribeAudio默认打开时，用户不能手动修改音频订阅状态

参数

[in]	stream_type	音频流类型: kNERtcAudioStreamTypeMain主流音频，kNERtcAudioStreamTypeSub辅流音频。
[in]	uid	指定用户的 ID。
[in]	subscribe	是否订阅远端用户音频流。 true: 订阅指定音频流（默认）。 false: 取消订阅指定音频流。

返回

0: 方法调用成功。
30005: 状态异常，可能是自动订阅打开，导致该接口无效。
其他: 方法调用失败。

◆ updateSelfPosition()

virtual int nertc::IRtcEngineEx::updateSelfPosition ( const NERtcPositionInfo & info )

pure virtual

引擎3D音效算法中本人坐标方位更新接口

注解: 依赖enableSpatializer接口开启，enableSpatializer接口关闭后重置设置

参数

speaker_position	嘴巴位置信息，默认值{0,0,0}
speaker_quaternion	嘴巴方向信息，四元组格式，默认值{0,0,0,0}
head_position	耳朵位置信息，默认值{0,0,0}
head_quaternion	耳朵方向信息，四元组格式，默认值{0,0,0,0}

返回

0: 方法调用成功
其他: 调用失败

◆ uploadSdkInfo()

virtual void nertc::IRtcEngineEx::uploadSdkInfo ( )

pure virtual

上传 SDK 信息。
只能在加入房间后调用。
上传的信息包括 log 和 Audio dump 等文件。

返回: void

该类的文档由以下文件生成:

D:/Formatter/api-for-code/1-ToWarehouse/unreal-sdk/Plugins/NertcPlugin/Source/NertcPlugin/Public/INertcEngineEx.h

Public 成员函数

构造及析构函数说明

◆ ~IRtcEngineEx()

成员函数说明

◆ acquireAndroidRecordingPermissions()

◆ adjustPlaybackSignalVolume()

◆ adjustRecordingSignalVolume()

◆ checkMicPermision()

◆ createChannel()

◆ enableAudioVolumeIndication()

◆ enableMediaPublish()

◆ enableSpatializer()

◆ getConnectionState()

◆ getErrorDescription()

◆ getLoudspeakerMode()

◆ getMicrophoneMode()

◆ getPlaybackSignalVolume()

◆ getPlayoutDeviceMute()

◆ getRecordingSignalVolume()

◆ getVersion()

◆ getVoiceEngine()

◆ initSpatializer()

◆ isInChannel()

◆ muteLocalAudioStream()

◆ pauseAudio()

◆ resumeAudio()

◆ setAudioEffectPreset()

◆ setAudioFocusMode()

◆ setAudioFrameObserver()

◆ setAudioProfile()

◆ setAudioRecvRange()

◆ setAudioSessionOperationRestriction()

◆ setLocalVoiceEqualization()

◆ setLocalVoicePitch()

◆ setLoudspeakerMode()

◆ setParameters()

◆ setPlayoutDeviceMute()

◆ setPublishAudioAllowList()

◆ setRangeAudioMode()

◆ setRangeAudioTeamID()

◆ setStatsObserver()

◆ setSubscribeAudioAllowList()

◆ setSubscribeAudioBlockList()

◆ setVoiceBeautifierPreset()

◆ startAudioDump()

◆ stopAudioDump()

◆ subscribeAllRemoteAudioStream()

◆ subscribeRemoteAudioStream()

◆ updateSelfPosition()

◆ uploadSdkInfo()