INERtcEngineEx Protocol Reference

Conforms to INERtcEngine
Declared in INERtcEngineEx.h

Overview

NERtcEngine 扩展接口

– enableDualStreamMode: required method

开启视频双流模式 可以在加入频道前和频道后调用

- (int)enableDualStreamMode:(BOOL)enable

Parameters

enable

YES 发送双流, NO 发送单流

Return Value

操作返回值,成功则返回 0

Discussion

开启视频双流模式 可以在加入频道前和频道后调用

Declared In

INERtcEngineEx.h

– muteLocalAudio: required method

静音自己的音频 mute 了发送静音包,不重启音频硬件

- (int)muteLocalAudio:(BOOL)muted

Parameters

muted

是否静音

Return Value

操作返回值,成功则返回 0

Discussion

静音自己的音频 mute 了发送静音包,不重启音频硬件

Declared In

INERtcEngineEx.h

– subscribeRemoteAudio:forUserID: required method

订阅或取消订阅别人的音频 订阅了才会接收别人的音频数据

- (int)subscribeRemoteAudio:(BOOL)subscribe forUserID:(uint64_t)userID

Parameters

subscribe

是否订阅

userID

userID

Return Value

操作返回值,成功则返回 0

Discussion

订阅或取消订阅别人的音频 订阅了才会接收别人的音频数据

Declared In

INERtcEngineEx.h

– subscribeAllRemoteAudio: required method

订阅或取消订阅所有的远端音频 该操作属于全局操作

- (int)subscribeAllRemoteAudio:(BOOL)subscribe

Parameters

subscribe

是否订阅

Return Value

操作返回值,成功则返回 0

Discussion

订阅或取消订阅所有的远端音频 该操作属于全局操作

Declared In

INERtcEngineEx.h

– subscribeRemoteVideo:forUserID:streamType: required method

订阅或取消订阅别人的视频 订阅了才会接收别人的视频数据

- (int)subscribeRemoteVideo:(BOOL)subscribe forUserID:(uint64_t)userID streamType:(NERtcRemoteVideoStreamType)streamType

Parameters

subscribe

是否订阅

userID

userID

streamType

订阅的远端视频流类型

Return Value

操作返回值,成功则返回 0

Discussion

订阅或取消订阅别人的视频 订阅了才会接收别人的视频数据

Declared In

INERtcEngineEx.h

– startPreview required method

打开自己的本地视频预览 不能跟 startLocalVideo 同时使用

- (int)startPreview

Return Value

操作返回值,成功则返回 0

Discussion

打开自己的本地视频预览 不能跟 startLocalVideo 同时使用

Declared In

INERtcEngineEx.h

– stopPreview required method

关闭自己的本地视频预览

- (int)stopPreview

Return Value

操作返回值,成功则返回 0

Discussion

关闭自己的本地视频预览

Declared In

INERtcEngineEx.h

– setLocalRenderScaleMode: required method

设置自己的视频渲染缩放模式

- (int)setLocalRenderScaleMode:(NERtcVideoRenderScaleMode)mode

Parameters

mode

缩放模式

Return Value

操作返回值,成功则返回 0

Discussion

设置自己的视频渲染缩放模式

Declared In

INERtcEngineEx.h

– setRemoteRenderScaleMode:forUserID: required method

设置别人的视频渲染缩放模式

- (int)setRemoteRenderScaleMode:(NERtcVideoRenderScaleMode)mode forUserID:(uint64_t)userID

Parameters

mode

缩放模式

userID

userID

Return Value

操作返回值,成功则返回 0

Discussion

设置别人的视频渲染缩放模式

Declared In

INERtcEngineEx.h

– muteLocalVideo: required method

静音自己的视频发送

- (int)muteLocalVideo:(BOOL)muted

Parameters

muted

是否静音

Return Value

操作返回值,成功则返回 0

Discussion

静音自己的视频发送

Declared In

INERtcEngineEx.h

– setLoudspeakerMode: required method

设置音频播放扬声器模式

- (int)setLoudspeakerMode:(bool)enable

Parameters

enable

是否使用扬声器模式

Return Value

操作返回值,成功则返回 0

Discussion

设置音频播放扬声器模式

Declared In

INERtcEngineEx.h

– getLoudspeakerMode: required method

获取目前是否使用扬声器模式

- (int)getLoudspeakerMode:(bool *)enabled

Parameters

enabled

是否正在使用扬声器模式

Return Value

操作返回值,成功则返回 0

Discussion

获取目前是否使用扬声器模式

Declared In

INERtcEngineEx.h

– startAudioDump required method

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

- (int)startAudioDump

Return Value

操作返回值,成功则返回 0

Discussion

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

Declared In

INERtcEngineEx.h

– stopAudioDump required method

结束记录音频 dump

- (int)stopAudioDump

Return Value

操作返回值,成功则返回 0

Discussion

结束记录音频 dump

Declared In

INERtcEngineEx.h

– setAudioSessionOperationRestriction: required method

设置 SDK 对 Audio Session 的控制权限

- (int)setAudioSessionOperationRestriction:(NERtcAudioSessionOperationRestriction)restriction

Return Value

操作返回值,成功则返回 0

Discussion

设置 SDK 对 Audio Session 的控制权限

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

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

Declared In

INERtcEngineEx.h

– setPlayoutDeviceMute: required method

设置音频播放设备的状态 默认状态为unmute

- (int)setPlayoutDeviceMute:(bool)muted

Parameters

muted

是否静音

Return Value

操作返回值,成功则返回 0

Discussion

设置音频播放设备的状态 默认状态为unmute

Declared In

INERtcEngineEx.h

– getPlayoutDeviceMute: required method

获取音频播放设备的状态

- (int)getPlayoutDeviceMute:(bool *)muted

Parameters

muted

是否静音

Return Value

操作返回值,成功则返回 0

Discussion

获取音频播放设备的状态

Declared In

INERtcEngineEx.h

– setRecordDeviceMute: required method

设置录音设备的状态 默认状态为unmute

- (int)setRecordDeviceMute:(bool)muted

Parameters

muted

是否静音

Return Value

操作返回值,成功则返回 0

Discussion

设置录音设备的状态 默认状态为unmute

Declared In

INERtcEngineEx.h

– getRecordDeviceMute: required method

获取录音设备的状态

- (int)getRecordDeviceMute:(bool *)muted

Parameters

muted

是否静音

Return Value

操作返回值,成功则返回 0

Discussion

获取录音设备的状态

Declared In

INERtcEngineEx.h

– isCameraTorchSupported required method

当前开启的摄像头是否支持打开手电筒

- (BOOL)isCameraTorchSupported

Return Value

YES/NO,支持/不支持

Discussion

当前开启的摄像头是否支持打开手电筒

Declared In

INERtcEngineEx.h

– setCameraTorchOn: required method

设置当前摄像头打开/关闭手电筒

- (int)setCameraTorchOn:(BOOL)on

Parameters

on

开启/关闭

Return Value

操作返回值,成功则返回 0

Discussion

设置当前摄像头打开/关闭手电筒

Declared In

INERtcEngineEx.h

– isCameraTorchOn required method

查询当前摄像头是否打开手电筒

- (BOOL)isCameraTorchOn

Return Value

YES/NO,打开/关闭

Discussion

查询当前摄像头是否打开手电筒

Declared In

INERtcEngineEx.h

– setCameraZoomFactor: required method

设置当前摄像头缩放比例

- (int)setCameraZoomFactor:(float)factor

Parameters

factor

比例

Return Value

操作返回值,成功则返回 0

Discussion

设置当前摄像头缩放比例

Declared In

INERtcEngineEx.h

– maxCameraZoomScale required method

当前摄像头支持的最大缩放比例

- (float)maxCameraZoomScale

Return Value

最大缩放比例

Discussion

当前摄像头支持的最大缩放比例

Declared In

INERtcEngineEx.h

– setCameraFocusPositionX:Y: required method

设置当前摄像头聚焦点位置

- (int)setCameraFocusPositionX:(float)focusX Y:(float)focusY

Parameters

focusX

(0-1) 之间

focusY

(0-1) 之间

Return Value

操作返回值,成功则返回 0

Discussion

设置当前摄像头聚焦点位置

Declared In

INERtcEngineEx.h

– startAudioMixingWithOption: required method

开始伴音

- (int)startAudioMixingWithOption:(NERtcCreateAudioMixingOption *)option

Parameters

option

伴音的选项

Return Value

操作返回值,成功则返回 0

Discussion

开始伴音

Declared In

INERtcEngineEx.h

– stopAudioMixing required method

结束伴音

- (int)stopAudioMixing

Return Value

操作返回值,成功则返回 0

Discussion

结束伴音

Declared In

INERtcEngineEx.h

– pauseAudioMixing required method

暂停伴音

- (int)pauseAudioMixing

Return Value

操作返回值,成功则返回 0

Discussion

暂停伴音

Declared In

INERtcEngineEx.h

– resumeAudioMixing required method

恢复伴音

- (int)resumeAudioMixing

Return Value

操作返回值,成功则返回 0

Discussion

恢复伴音

Declared In

INERtcEngineEx.h

– setAudioMixingSendVolume: required method

设置伴音的发送音量

- (int)setAudioMixingSendVolume:(uint32_t)volume

Parameters

volume

音量值,0-100

Return Value

操作返回值,成功则返回 0

Discussion

设置伴音的发送音量

Declared In

INERtcEngineEx.h

– getAudioMixingSendVolume: required method

获取伴音的发送音量

- (int)getAudioMixingSendVolume:(uint32_t *)volume

Parameters

volume

返回的发送音量

Return Value

操作返回值,成功则返回 0

Discussion

获取伴音的发送音量

Declared In

INERtcEngineEx.h

– setAudioMixingPlaybackVolume: required method

设置伴音的回放音量

- (int)setAudioMixingPlaybackVolume:(uint32_t)volume

Parameters

volume

音量值,0-100

Return Value

操作返回值,成功则返回 0

Discussion

设置伴音的回放音量

Declared In

INERtcEngineEx.h

– getAudioMixingPlaybackVolume: required method

获取伴音的回放音量

- (int)getAudioMixingPlaybackVolume:(uint32_t *)volume

Parameters

volume

返回的音量值

Return Value

操作返回值,成功则返回 0

Discussion

获取伴音的回放音量

Declared In

INERtcEngineEx.h

– getAudioMixingDuration: required method

获取伴音的总长度

- (int)getAudioMixingDuration:(uint64_t *)duration

Parameters

duration

返回的长度

Return Value

操作返回值,成功则返回 0

Discussion

获取伴音的总长度

Declared In

INERtcEngineEx.h

– getAudioMixingCurrentPosition: required method

获取伴音当前播放位置

- (int)getAudioMixingCurrentPosition:(uint64_t *)position

Parameters

position

返回的当前播放位置

Return Value

操作返回值,成功则返回 0

Discussion

获取伴音当前播放位置

Declared In

INERtcEngineEx.h

– setAudioMixingPosition: required method

设置伴音的播放位置

- (int)setAudioMixingPosition:(uint64_t)position

Parameters

position

想要设置的位置

Return Value

操作返回值,成功则返回 0

Discussion

设置伴音的播放位置

Declared In

INERtcEngineEx.h

– playEffectWitdId:effectOption: required method

播放音效

- (int)playEffectWitdId:(uint32_t)effectId effectOption:(NERtcCreateAudioEffectOption *)option

Parameters

effectId

音效ID

option

播放音效选项

Return Value

操作返回值,成功则返回 0

Discussion

播放音效

Declared In

INERtcEngineEx.h

– stopEffectWitdId: required method

结束音效

- (int)stopEffectWitdId:(uint32_t)effectId

Parameters

effectId

音效ID

Return Value

操作返回值,成功则返回 0

Discussion

结束音效

Declared In

INERtcEngineEx.h

– stopAllEffects required method

结束所有音效

- (int)stopAllEffects

Return Value

操作返回值,成功则返回 0

Discussion

结束所有音效

Declared In

INERtcEngineEx.h

– pauseEffectWitdId: required method

暂停音效

- (int)pauseEffectWitdId:(uint32_t)effectId

Parameters

effectId

音效ID

Return Value

操作返回值,成功则返回 0

Discussion

暂停音效

Declared In

INERtcEngineEx.h

– resumeEffectWitdId: required method

恢复音效

- (int)resumeEffectWitdId:(uint32_t)effectId

Parameters

effectId

音效ID

Return Value

操作返回值,成功则返回 0

Discussion

恢复音效

Declared In

INERtcEngineEx.h

– pauseAllEffects required method

暂停所有音效

- (int)pauseAllEffects

Return Value

操作返回值,成功则返回 0

Discussion

暂停所有音效

Declared In

INERtcEngineEx.h

– resumeAllEffects required method

恢复所有音效

- (int)resumeAllEffects

Return Value

操作返回值,成功则返回 0

Discussion

恢复所有音效

Declared In

INERtcEngineEx.h

– setEffectSendVolumeWithId:volume: required method

设置音效的发送音量

- (int)setEffectSendVolumeWithId:(uint32_t)effectId volume:(uint32_t)volume

Parameters

effectId

音效ID

volume

音量值,0-100

Return Value

操作返回值,成功则返回 0

Discussion

设置音效的发送音量

Declared In

INERtcEngineEx.h

– getEffectSendVolumeWithId:volume: required method

获取音效的发送音量

- (int)getEffectSendVolumeWithId:(uint32_t)effectId volume:(uint32_t *)volume

Parameters

effectId

音效ID

volume

返回的发送音量

Return Value

操作返回值,成功则返回 0

Discussion

获取音效的发送音量

Declared In

INERtcEngineEx.h

– setEffectPlaybackVolumeWithId:volume: required method

设置音效的回放音量

- (int)setEffectPlaybackVolumeWithId:(uint32_t)effectId volume:(uint32_t)volume

Parameters

effectId

音效ID

volume

音量值,0-100

Return Value

操作返回值,成功则返回 0

Discussion

设置音效的回放音量

Declared In

INERtcEngineEx.h

– getEffectPlaybackVolumeWithId:volume: required method

获取音效的回放音量

- (int)getEffectPlaybackVolumeWithId:(uint32_t)effectId volume:(uint32_t *)volume

Parameters

effectId

音效ID

volume

返回的音量值

Return Value

操作返回值,成功则返回 0

Discussion

获取音效的回放音量

Declared In

INERtcEngineEx.h

– enableEarback:volume: required method

使能耳返

- (int)enableEarback:(BOOL)enabled volume:(uint32_t)volume

Parameters

enabled

是否使能耳返

volume

耳返的音量值

Return Value

操作返回值,成功则返回 0

Discussion

使能耳返

Declared In

INERtcEngineEx.h

– setEarbackVolume: required method

设置耳返的音量

- (int)setEarbackVolume:(uint32_t)volume

Parameters

volume

耳返的音量值

Return Value

操作返回值,成功则返回 0

Discussion

设置耳返的音量

Declared In

INERtcEngineEx.h

– addEngineMediaStatsObserver: required method

添加 media 统计信息观测器

- (int)addEngineMediaStatsObserver:(id<NERtcEngineMediaStatsObserver>)observer

Parameters

observer

统计信息观测器

Return Value

操作返回值,成功则返回 0

Discussion

添加 media 统计信息观测器

Declared In

INERtcEngineEx.h

– removeEngineMediaStatsObserver: required method

删除 media 统计信息观测器

- (int)removeEngineMediaStatsObserver:(id<NERtcEngineMediaStatsObserver>)observer

Parameters

observer

统计信息观测器

Return Value

操作返回值,成功则返回 0

Discussion

删除 media 统计信息观测器

Declared In

INERtcEngineEx.h

– cleanupEngineMediaStatsObserver required method

清空 media 统计信息观测器

- (int)cleanupEngineMediaStatsObserver

Return Value

操作返回值,成功则返回 0

Discussion

清空 media 统计信息观测器

Declared In

INERtcEngineEx.h

– addLiveStreamTask:compeltion: required method

添加房间推流任务,成功添加后当前用户可以收到该直播流的状态通知。通话中有效。

- (int)addLiveStreamTask:(NERtcLiveStreamTaskInfo *)taskInfo compeltion:(NERtcLiveStreamCompletion)completion

Parameters

taskInfo

直播任务信息

completion

任务结果回调

Return Value

操作返回值,成功则返回 0

Discussion

添加房间推流任务,成功添加后当前用户可以收到该直播流的状态通知。通话中有效。

Declared In

INERtcEngineEx.h

– updateLiveStreamTask:compeltion: required method

更新修改房间推流任务。通话中有效。

- (int)updateLiveStreamTask:(NERtcLiveStreamTaskInfo *)taskInfo compeltion:(NERtcLiveStreamCompletion)completion

Parameters

taskInfo

直播任务信息

completion

任务结果回调

Return Value

操作返回值,成功则返回 0

Discussion

更新修改房间推流任务。通话中有效。

Declared In

INERtcEngineEx.h

– removeLiveStreamTask:compeltion: required method

删除房间推流任务。通话中有效。

- (int)removeLiveStreamTask:(NSString *)taskId compeltion:(NERtcLiveStreamCompletion)completion

Parameters

taskId

直播任务Id

completion

任务结果回调

Return Value

操作返回值,成功则返回 0

Discussion

删除房间推流任务。通话中有效。

Declared In

INERtcEngineEx.h

– setRecordingAudioFrameParameters: required method

设置回调的录制声音格式 设置是异步生效的 join channel 前/后都允许更改设置,leave channel 后重置为空

- (int)setRecordingAudioFrameParameters:(nullable NERtcAudioFrameRequestFormat *)format

Parameters

format

指定 onNERtcEngineAudioFrameDidRecord 返回数据的采样率和数据的通道数。允许传入 nil,默认为 nil(代表使用音频的原始格式)

Return Value

操作返回值,成功则返回 0

Discussion

设置回调的录制声音格式 设置是异步生效的 join channel 前/后都允许更改设置,leave channel 后重置为空

Declared In

INERtcEngineEx.h

– setPlaybackAudioFrameParameters: required method

设置回调的播放声音格式 设置是异步生效的 join channel 前/后都允许更改设置,leave channel 后重置为空

- (int)setPlaybackAudioFrameParameters:(nullable NERtcAudioFrameRequestFormat *)format

Parameters

format

指定 onNERtcEngineAudioFrameWillPlayback 返回数据的采样率和数据的通道数。允许传入 nil,默认为 nil(代表使用音频的原始格式)

Return Value

操作返回值,成功则返回 0

Discussion

设置回调的播放声音格式 设置是异步生效的 join channel 前/后都允许更改设置,leave channel 后重置为空

Declared In

INERtcEngineEx.h

– setAudioFrameObserver: required method

设置 Audio Frame Observer 在 join 之前设置 允许设空,设空表示不再回调 leave channel 后不清掉

- (int)setAudioFrameObserver:(nullable id<NERtcEngineAudioFrameObserver>)observer

Parameters

observer

音频数据帧观测器

Return Value

操作返回值,成功则返回 0

Discussion

设置 Audio Frame Observer 在 join 之前设置 允许设空,设空表示不再回调 leave channel 后不清掉

Declared In

INERtcEngineEx.h

– enableAudioVolumeIndication:interval: required method

启用说话者音量提示。该方法允许 SDK 定期向 App 反馈当前谁在说话以及说话者的音量。

启用该方法后,无论频道内是否有人说话,都会在 onRemoteAudioVolumeIndication 和 onRemoteAudioVolumeIndication 回调中按设置的间隔时间返回音量提示。 如果要停止接收说话者的音量,请设置 enable 为 false。

- (int)enableAudioVolumeIndication:(BOOL)enable interval:(uint64_t)interval

Parameters

enable

是否启用说话者音量提示。

interval

指定音量提示的时间间隔,单位为毫秒。必须设置为 100 毫秒的整数倍值。

Return Value

操作返回值,成功则返回 0

Discussion

启用说话者音量提示。该方法允许 SDK 定期向 App 反馈当前谁在说话以及说话者的音量。

启用该方法后,无论频道内是否有人说话,都会在 onRemoteAudioVolumeIndication 和 onRemoteAudioVolumeIndication 回调中按设置的间隔时间返回音量提示。 如果要停止接收说话者的音量,请设置 enable 为 false。

Declared In

INERtcEngineEx.h

– adjustRecordingSignalVolume: required method

调节录音音量 加入频道前后都可以调用 调节范围为:[0~400] 0: 静音 100: 原始音量 (默认) 400: 最大可为原始音量的 4 倍(自带溢出保护)

- (int)adjustRecordingSignalVolume:(uint32_t)volume

Parameters

volume

调节的音量值。

Return Value

操作返回值,成功则返回 0

Discussion

调节录音音量 加入频道前后都可以调用 调节范围为:[0~400] 0: 静音 100: 原始音量 (默认) 400: 最大可为原始音量的 4 倍(自带溢出保护)

Declared In

INERtcEngineEx.h

– adjustPlaybackSignalVolume: required method

调节播放音量 加入频道前后都可以调用 调节范围为:[0~400] 0: 静音 100: 原始音量 (默认) 400: 最大可为原始音量的 4 倍(自带溢出保护)

- (int)adjustPlaybackSignalVolume:(uint32_t)volume

Parameters

volume

调节的音量值。

Return Value

操作返回值,成功则返回 0

Discussion

调节播放音量 加入频道前后都可以调用 调节范围为:[0~400] 0: 静音 100: 原始音量 (默认) 400: 最大可为原始音量的 4 倍(自带溢出保护)

Declared In

INERtcEngineEx.h

– setExternalVideoSource: required method

配置外部视频源 如果使用了外部视频源,请在调用 enableLocalVideo 或 startPreview 之前调用此 API

- (int)setExternalVideoSource:(BOOL)enable

Parameters

enable

是否使用外部视频源 true:使用外部视频源 false:不使用外部视频源(默认)

Return Value

操作返回值,成功则返回 0

Discussion

配置外部视频源 如果使用了外部视频源,请在调用 enableLocalVideo 或 startPreview 之前调用此 API

Declared In

INERtcEngineEx.h

– pushExternalVideoFrame: required method

推送外部视频帧 只能在设置setExternalVideoSource之后才能调用,否则会一直报错

- (int)pushExternalVideoFrame:(NERtcVideoFrame *)frame

Parameters

frame

是否使用外部视频源

Return Value

操作返回值,成功则返回 0

Discussion

推送外部视频帧 只能在设置setExternalVideoSource之后才能调用,否则会一直报错

Declared In

INERtcEngineEx.h

– uploadSdkInfo required method

上传SDK日志信息 只能在加入频道后调用

- (int)uploadSdkInfo

Return Value

操作返回值,成功则返回 0

Discussion

上传SDK日志信息 只能在加入频道后调用

Declared In

INERtcEngineEx.h