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

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

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

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– startPreview required method

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

- (int)startPreview

Return Value

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

Discussion

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– stopPreview required method

关闭自己的本地视频预览

- (int)stopPreview

Return Value

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

Discussion

关闭自己的本地视频预览

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– setLocalRenderScaleMode: required method

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

- (int)setLocalRenderScaleMode:(NERtcVideoRenderScaleMode)mode

Parameters

mode

缩放模式

Return Value

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

Discussion

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– setRemoteRenderScaleMode:forUserID: required method

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

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

Parameters

mode

缩放模式

userID

userID

Return Value

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

Discussion

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– muteLocalVideo: required method

静音自己的视频发送

- (int)muteLocalVideo:(BOOL)muted

Parameters

muted

是否静音

Return Value

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

Discussion

静音自己的视频发送

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

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

– setExternalVideoSource:isScreen: required method

配置外部视频源 如果使用了外部视频源,请在调用 startScreenCapture、enableLocalVideo 或 startPreview 之前调用此 API 外部输入是屏幕共享时使用辅流的通道,非屏幕共享时使用主流的通道,此时与Camera互斥

- (int)setExternalVideoSource:(BOOL)enable isScreen:(BOOL)isScreen

Parameters

enable

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

isScreen

使用外部视频源是否是屏幕共享数据

Return Value

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

Discussion

配置外部视频源 如果使用了外部视频源,请在调用 startScreenCapture、enableLocalVideo 或 startPreview 之前调用此 API 外部输入是屏幕共享时使用辅流的通道,非屏幕共享时使用主流的通道,此时与Camera互斥

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– pushExternalVideoFrame: required method

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

- (int)pushExternalVideoFrame:(NERtcVideoFrame *)frame

Parameters

frame

是否使用外部视频源

Return Value

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

Discussion

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– setupLocalSubStreamVideoCanvas: required method

设置自己的辅流视频回放画布 若使用外部渲染,建议在加入频道之前设置。

- (int)setupLocalSubStreamVideoCanvas:(NERtcVideoCanvas *)canvas

Parameters

canvas

视频窗口,如果需要删除则传 nil

Return Value

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

Discussion

设置自己的辅流视频回放画布 若使用外部渲染,建议在加入频道之前设置。

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– startScreenCapture: required method

开启辅流,需要借助自定义视频输入接口 只能在加入频道后调用 若使用外部渲染,建议在收到对方加入回调中设置。

- (int)startScreenCapture:(NERtcVideoSubStreamEncodeConfiguration *)config

Parameters

config

辅流编码参数

Return Value

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

Discussion

开启辅流,需要借助自定义视频输入接口 只能在加入频道后调用 若使用外部渲染,建议在收到对方加入回调中设置。

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– stopScreenCapture required method

关闭辅流

- (int)stopScreenCapture

Return Value

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

Discussion

关闭辅流

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– setLocalRenderSubStreamScaleMode: required method

设置自己的辅流渲染缩放模式

- (int)setLocalRenderSubStreamScaleMode:(NERtcVideoRenderScaleMode)mode

Parameters

mode

缩放模式

Return Value

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

Discussion

设置自己的辅流渲染缩放模式

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– setupRemoteSubStreamVideoCanvas:forUserID: required method

设置远端的辅流视频回放画布 只能在加入频道后调用 若使用外部渲染,建议在收到对方加入回调中设置。

- (int)setupRemoteSubStreamVideoCanvas:(NERtcVideoCanvas *)canvas forUserID:(uint64_t)userID

Parameters

canvas

视频窗口,如果需要删除则传 nil

userID

userID

Return Value

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

Discussion

设置远端的辅流视频回放画布 只能在加入频道后调用 若使用外部渲染,建议在收到对方加入回调中设置。

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– subscribeRemoteSubStreamVideo:forUserID: required method

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

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

Parameters

subscribe

是否订阅

userID

userID

Return Value

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

Discussion

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– setRemoteRenderSubStreamVideoScaleMode:forUserID: required method

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

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

Parameters

mode

缩放模式

userID

userID

Return Value

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

Discussion

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

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

– isCameraZoomSupported required method

当前开启的摄像头是否支持缩放

- (BOOL)isCameraZoomSupported

Return Value

YES/NO,支持/不支持

Discussion

当前开启的摄像头是否支持缩放

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– isCameraTorchSupported required method

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

- (BOOL)isCameraTorchSupported

Return Value

YES/NO,支持/不支持

Discussion

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– isCameraFocusSupported required method

当前开启的摄像头是否支持手动对焦

- (BOOL)isCameraFocusSupported

Return Value

YES/NO,支持/不支持

Discussion

当前开启的摄像头是否支持手动对焦

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– isCameraExposurePositionSupported required method

当前开启的摄像头是否支持手动曝光

- (BOOL)isCameraExposurePositionSupported

Return Value

YES/NO,支持/不支持

Discussion

当前开启的摄像头是否支持手动曝光

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– setCameraExposurePosition: required method

设置当前摄像头手动曝光位置

- (int)setCameraExposurePosition:(CGPoint)positionInView

Parameters

positionInView

曝光位置点

Return Value

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

Discussion

设置当前摄像头手动曝光位置

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– setCameraTorchOn: required method

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

- (int)setCameraTorchOn:(BOOL)on

Parameters

on

开启/关闭

Return Value

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

Discussion

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– isCameraTorchOn required method

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

- (BOOL)isCameraTorchOn

Return Value

YES/NO,打开/关闭

Discussion

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– setCameraZoomFactor: required method

设置当前摄像头缩放比例

- (int)setCameraZoomFactor:(float)factor

Parameters

factor

比例

Return Value

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

Discussion

设置当前摄像头缩放比例

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– maxCameraZoomScale required method

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

- (float)maxCameraZoomScale

Return Value

最大缩放比例

Discussion

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

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

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

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

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

– setExternalAudioSource:sampleRate:channels: required method

开启或关闭外部音频源数据输入 该方法启用外部音频数据输入功能,只允许通话前调用。当该方法调用成功后,音频输入设备选择和异常重启失效。 该方法设置内部引擎为启用状态,启动时将用虚拟设备代替麦克风工作。

- (int)setExternalAudioSource:(BOOL)enabled sampleRate:(int32_t)sampleRate channels:(int32_t)channels

Parameters

enabled

是否外部数据输入:

sampleRate

数据采样率,后续数据传入需要按该格式传入。

channels

数据声道数,后续数据传入需要按该格式传入。

Return Value

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

Discussion

开启或关闭外部音频源数据输入 该方法启用外部音频数据输入功能,只允许通话前调用。当该方法调用成功后,音频输入设备选择和异常重启失效。 该方法设置内部引擎为启用状态,启动时将用虚拟设备代替麦克风工作。

Declared In

INERtcEngineEx.h

– pushExternalAudioFrame: required method

推送外部音频数据输入 该方法将数据帧设置给内部引擎。

- (int)pushExternalAudioFrame:(NERtcAudioFrame *)frame

Parameters

frame

桢数据:数据长度不超过7kByte

Return Value

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

Discussion

推送外部音频数据输入 该方法将数据帧设置给内部引擎。

Note: 该方法在外部音频输入工作,。

Declared In

INERtcEngineEx.h

– setExternalAudioRender:sampleRate:channels: required method

开启或关闭外部音频渲染 该方法启用外部音频数据渲染功能,只允许通话前调用。当该方法调用成功后,音频输入设备选择和异常重启失效。

- (int)setExternalAudioRender:(BOOL)enabled sampleRate:(int32_t)sampleRate channels:(int32_t)channels

Parameters

enabled

是否外部数据输入

sampleRate

数据采样率

channels

数据声道数

Return Value

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

Discussion

开启或关闭外部音频渲染 该方法启用外部音频数据渲染功能,只允许通话前调用。当该方法调用成功后,音频输入设备选择和异常重启失效。

Declared In

INERtcEngineEx.h

– pullExternalAudioFrame:length: required method

拉取内部音频数据 该方法将从内部引擎拉取音频数据。

- (int)pullExternalAudioFrame:(void *_Nonnull)data length:(int)len

Parameters

data

数据指针

len

数据长度, 单位字节

Return Value

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

Discussion

拉取内部音频数据 该方法将从内部引擎拉取音频数据。

Note: 该方法在外部音频渲染工作,。

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

– setMixedAudioFrameParameters: required method

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

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

Parameters

format

指定 onNERtcEngineMixedAudioFrame 返回数据的采样率,目前只支持设置采样率,其他设置无效。允许传入 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

– setLocalVoiceEqualizationPreset: required method

设置预设的EQ模式

- (int)setLocalVoiceEqualizationPreset:(NERtcVoiceEqualizationType)type

Parameters

type

预设置的EQ模式值

Return Value

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

Discussion

设置预设的EQ模式

Declared In

INERtcEngineEx.h

– setLocalVoiceEqualizations: required method

设置自定义的EQ

- (int)setLocalVoiceEqualizations:(NSArray<NSNumber*> *)bandGain

Parameters

bandGain

每个 band 的增益,数组大小为10,[0-9]分别代表 10 个频带,对应的中心频率是 [31,63,125,250,500,1k,2k,4k,8k,16k] Hz 单位是 dB,每一个值的范围是 [-15,15],默认值为 0

Return Value

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

Discussion

设置自定义的EQ

Declared In

INERtcEngineEx.h

– setLocalVoiceReverbPreset: required method

设置预设的混响模式

- (int)setLocalVoiceReverbPreset:(NERtcVoiceReverbType)type

Parameters

type

预设置的混响模式值

Return Value

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

Discussion

设置预设的混响模式

Declared In

INERtcEngineEx.h

– setLocalVoiceChangerPreset: required method

设置预设的变声模式

- (int)setLocalVoiceChangerPreset:(NERtcVoiceChangerType)type

Parameters

type

预设置的变声模式值

Return Value

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

Discussion

设置预设的变声模式

Declared In

INERtcEngineEx.h

– uploadSdkInfo required method

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

- (int)uploadSdkInfo

Return Value

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

Discussion

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

Declared In

INERtcEngineEx.h

– sendSEIMsg:streamChannelType: required method

将小数据量的自定义数据嵌入视频帧中

- (int)sendSEIMsg:(NSData *)data streamChannelType:(NERtcStreamChannelType)type

Parameters

data

自定义数据

type

sei使用的流通道类型

Return Value

操作返回值,成功则返回 0 成功: 成功进入待发送队列,会在最近的视频帧之后发送该数据 失败: 数据被限制发送,可能发送的频率太高,队列已经满了,或者数据大小超过最大值 4k

Discussion

将小数据量的自定义数据嵌入视频帧中

注意点: 本接口有以下限制: 1.sei 的发送的最大数据长度为 4k,若发送大量数据,会导致视频码率增大,可能导致视频画质下降甚至卡顿 2.sei 发送的频率,最高为视频发送的帧率,建议不超过 10 次/秒 3.sei 数据不一定立刻发出去,最快在下一帧视频数帧之后发送,最慢在接下来的 5 帧视频帧之后发送 4.sei 数据有可能由于弱网信息而丢失,所以建议多次发送来保证接收端收到的概率 5.需要使用哪个通道发送sei时,需要提前把对应的数据流通道开启

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h

– sendSEIMsg: required method

将小数据量的自定义数据嵌入视频帧中

- (int)sendSEIMsg:(NSData *)data

Parameters

data

自定义数据

Return Value

操作返回值,成功则返回 0 成功: 成功进入待发送队列,会在最近的视频帧之后发送该数据 失败: 数据被限制发送,可能发送的频率太高,队列已经满了,或者数据大小超过最大值 4k

Discussion

将小数据量的自定义数据嵌入视频帧中

注意点: 本接口有以下限制: 1.sei 的发送的最大数据长度为 4k,若发送大量数据,会导致视频码率增大,可能导致视频画质下降甚至卡顿 2.sei 发送的频率,最高为视频发送的帧率,建议不超过 10 次/秒 3.sei 数据不一定立刻发出去,最快在下一帧视频数帧之后发送,最慢在接下来的 5 帧视频帧之后发送 4.sei 数据有可能由于弱网信息而丢失,所以建议多次发送来保证接收端收到的概率 5.默认使用通道发送sei

Note: 纯音频SDK禁用该接口,如需使用请前往云信官网下载并替换成视频SDK

Declared In

INERtcEngineEx.h