• 文档中心 /
• RTC 实时音视频 /
• 音视频SDK /
• iOS /
• iOS /

CloudHubSDK iOS

• 概览
• CloudHubRtcEngineKit
• CloudHubRtcEngineDelegate
• CloudHubRtcChannelKit
• CloudHubRtcChannelDelegate
• CloudHubEnumerates
• CloudHubObjects

CloudHubRtcEngineKit

代理设置

delegate:

设置 CloudHubRtcEngineKit 的回调代理

@property (nonatomic, weak) id<CloudHubRtcEngineDelegate> _Nullable delegate;

详情

详见 CloudHubRtcEngineDelegate

频道管理

sharedEngineWithAppId:config:

获得 RTC 引擎单例对象指针

+ (instancetype _Nonnull)sharedEngineWithAppId:(NSString * _Nonnull)appId
                                        config:(NSString * _Nullable)config;

参数

返回

• 非空: 方法调用成功
• nil： 方法调用失败

详情

请在主线程调用 CloudHubRtcEngineKit 类的接口函数

Note

• 可以多次重复调用，在第一次调用时，会有一个单例被初始化

sharedEngineWithAppId:config:externalDevices:

获得 RTC 引擎单例对象指针

- (instancetype _Nonnull)sharedEngineWithAppId:(NSString * _Nonnull)appId
                                        config:(NSString * _Nullable)config
                                        externalDevices:(int)extDevices;

参数

返回

• 非空: 方法调用成功
• nil： 方法调用失败

详情

请在主线程调用 CloudHubRtcEngineKit 类的接口函数

Note

• 可以多次重复调用，在第一次调用时，会有一个单例被初始化

setChannelProfile

设置频道场景

- (int)setChannelProfile:(CloudHubChannelProfile)profile;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

CloudHubRtcEngineKit 会针对不同的使用场景采用不同的优化策略，如通信场景偏好流畅，直播场景偏好画质

Note

• 同频道内的用户必须使用同一种频道场景
• 该方法必须在加入频道前调用，进入频道后无法再设置频道场景

setClientRole

设置用户角色

- (int)setClientRole:(CloudHubClientRole)role;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

在加入频道前，用户需要通过本方法设置观众(默认)或主播角色，在加入频道后，用户可以通过本方法切换用户角色 如果你在加入频道后调用该方法切换用户角色，调用成功后，本地会触发 rtcEngine:onClientRoleChangedFrom:to: 回调； 远端会触发 rtcEngine:didJoinedOfUid:properties:isHistory:fromChannel: 或 rtcEngine:didOfflineOfUid:reason: 回调

Note

• 该方法仅适用于直播场景
• 当调用 publishStream 方法时，用户角色会被自动切换成主播角色

joinChannelByToken:channelId:properties:uid:autosubscribeAudio:autoSubscribeVideo:joinSuccess:

加入频道

- (int)joinChannelByToken:(NSString * _Nullable)token
                channelId:(NSString * _Nonnull)channelId
               properties:(NSString * _Nullable)properties
                      uid:(NSString * _Nullable)uid
       autoSubscribeAudio:(BOOL)autoSubscribeAudio
       autoSubscribeVideo:(BOOL)autoSubscribeVideo
              joinSuccess:(void(^ _Nullable)(NSString * _Nonnull uid, NSInteger elapsed))joinSuccessBlock;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

该方法让用户加入通话频道，在同一个频道内的用户可以互相通话，多个用户加入同一个频道，可以群聊，使用不同 App ID 的 App 是不能互通的，如果已在通话中，用户必须调用 leaveChannel 退出当前通话，才能进入下一个频道

• 加入频道后，本地会触发 rtcEngine:didJoinChannelwithUid:elapsed: 回调
• 通信场景下的用户和直播场景下的主播加入频道后，远端会触发 rtcEngine:didJoinedOfUid:properties:isHistory:fromChannel: 回调
• 在网络状况不理想的情况下，客户端可能会与服务器失去连接；SDK 会自动尝试重连并发送 rtcEngine:connectionChangedToState: 回调，重连成功后，本地会触发 rtcEngine:didReJoinChannelwithUid:elapsed: 回调

Note

• 频道内的各用户之间uid不能重复，如果重复，后面相同 uid 的用户进入时，会触发前面的用户自动离开频道，此时前面的用户会收到 rtcEngine:onLocalUserEvicted: 回调

leaveChannel

离开频道

- (int)leaveChannel:(void(^ _Nullable)(void))leaveChannelBlock;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

离开频道，即挂断或退出通话，当调用 joinChannelByToken:channelId:properties:uid:autosubscribeAudio:autoSubscribeVideo:joinSuccess: 方法后，必须调用 leaveChannel: 结束通话，否则无法开始下一次通话， 不管当前是否在通话中，都可以调用本方法，没有副作用，该方法会把会话相关的所有资源释放掉，该方法是异步操作，调用返回时并没有真正退出频道

• 成功调用该方法离开频道后，本地会触发 rtcEngine:didLeaveChannel: 回调
• 通信场景下的用户和直播场景下的主播离开频道后，远端会触发 rtcEngine:didOfflineOfUid:reason: 回调

renewToken

更新token

- (int)renewToken:(NSString * _Nonnull)token;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

该方法用于更新 Token，如果启用了 Token 机制，过一段时间后使用的 Token 会失效当以下任意一种情况发生时：

• rtcEngine:tokenPrivilegeWillExpire: 回调
• rtcEngineRequestToken: 回调

App 应重新获取 Token，然后调用该 API 更新 Token，否则 SDK 无法和服务器建立连接

getConnectionState

获取当前网络连接状态

- (CloudHubConnectionStateType)getConnectionState;

返回

• 详见 CloudHubConnectionStateType

音频管理

enableAudio

启⽤⾳频模块

- (int)enableAudio;

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

本⽅法可以启⽤⾳频模块，（⾳频模块默认为开启状态）

disableAudio

关闭⾳频模块

- (int)disableAudio;

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

本⽅法可以关闭⾳频模块，（⾳频模块默认为开启状态）

adjustRecordingSignalVolume:

调节麦克风采集信号音量

- (int)adjustRecordingSignalVolume:(int)volume;

参数

返回

• 0: 成功
• 非0: 失败

adjustUserPlaybackSignalVolume:volume:

调节本地播放的所有远端用户的信号音量

- (int)adjustUserPlaybackSignalVolume:(NSString* _Nonnull)uid
                               volume:(int)volume;

参数

返回

• 0: 成功
• 非0: 失败

adjustPlaybackSignalVolume:

调节本地播放的所有远端用户的信号音量

- (int)adjustPlaybackSignalVolume:(int)volume;

参数

返回

• 0: 成功
• 非0: 失败

enableLocalAudio

开关本地音频采集

- (int)enableLocalAudio:(BOOL)enabled;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

当调用 publishStream 方法发布本地音视频流后，语音默认是开启的，该方法可以关闭或重新开启本地语音功能，即停止或重新开始本地音频采集 该方法不影响接收或播放远端音频流，enableLocalAudio: NO 适用于只听不发的用户场景

Note

• 该方法需要在启⽤⾳频模块enableAudio之后生效
• 该方法与 muteLocalAudioStream 的区别在于：
  • enableLocalAudio 开启或关闭本地语音采集及处理，使用该方法关闭或开启本地采集后，本地听远端播放会有短暂中断
  • muteLocalAudioStream 停止或继续发送本地音频流
• 共同点在于，它们都只影响 publishStream 之后发布的音频流

muteLocalAudioStream

开关本地音频发送

- (int)muteLocalAudioStream:(BOOL)mute;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

该方法用于允许/禁止往网络发送本地音频流，成功调用该方法后，远端会触发 rtcEngine:remoteAudioStateChangedOfUid:state:reason: 回调（reason 为 CloudHubAudioRemoteReasonLocalMuted）

Note

• 该方法不影响录音状态，并没有禁用麦克风

muteRemoteAudioStream:mute:

接收／停止接收指定音频流

- (int)muteRemoteAudioStream:(NSString* _Nonnull)uid 
                        mute:(BOOL)mute;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

Note

• 如果之前有调用过 muteAllRemoteAudioStreams:YES) 对所有远端音频进行静音，在调用本 API 之前请确保你已调用 muteAllRemoteAudioStreams:NO
• muteAllRemoteAudioStreams 是全局控制，muteRemoteAudioStream:mute: 是精细控制

muteAllRemoteAudioStreams

接收／停止接收指定音频流

- (int)muteAllRemoteAudioStreams:(BOOL)mute;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

视频管理

enableVideo

启用视频模块

- (int)enableVideo;

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

该方法用于打开视频模式，可以在加入频道前或者通话中调用，在加入频道前调用，则自动开启视频模式，在通话中调用则由音频模式切换为视频模式，调用 disableVideo 方法可关闭视频模式

Note

• 该方法设置的是内部引擎为启用状态，在 leaveChannel: 后仍然有效
• 该方法重置整个引擎，响应速度较慢，因此我们建议使用如下方法来控制视频模块：
  • enableLocalVideo：是否启动摄像头采集并创建本地视频流
  • muteLocalVideoStream：是否发布本地视频流
  • muteRemoteVideoStreamWithUid:mute:：是否接收并播放远端视频流
  • muteAllRemoteVideoStreams：是否接收并播放所有远端视频流

disableVideo

关闭视频模块

- (int)disableVideo;

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

该方法用于关闭视频模式，详情请见 enableVideo

setVideoEncoderConfiguration

设置视频编码属性

- (int)setVideoEncoderConfiguration:(CloudHubVideoEncoderConfiguration * _Nonnull)config;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

该方法设置视频编码配置，每个配置对应一套视频参数，如分辨率、帧率、码率、视频方向等，所有设置的参数均为理想情况下的最大值，当视频引擎因设备、网络环境等原因无法达到设置的分辨率、帧率或码率的最大值时，会取最接近最大值的那个值

startPlayingLocalVideo:renderMode:mirrorMode:

为本地视频设置视图并开始播放

- (int)startPlayingLocalVideo:(VIEW_CLASS * _Nonnull)view  
                   renderMode:(CloudHubVideoRenderMode) renderMode  
                   mirrorMode:(CloudHubVideoMirrorMode) mirrorMode;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

调用该方法开始预览本地视频，需要预先调用 enableVideo 和 enableLocalVideo 启动本地摄像头，离开频道再次进入时，需要重新调用该方法才能再次开始预览本地视频

Note

• 如果你希望在通话中更新本地用户视图的渲染或镜像模式，请使用 setLocalRenderMode:mirrorMode: 方法

startPlayingRemoteVideo:streamId:renderMode:mirrorMode:

为远端视频设置视图并开始播放

- (int)startPlayingRemoteVideo:(VIEW_CLASS * _Nonnull)view 
                      streamId:(NSString * _Nonnull)streamId 
                    renderMode:(CloudHubVideoRenderMode) renderMode
                    mirrorMode:(CloudHubVideoMirrorMode) mirrorMode;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

调⽤该⽅法开始播放远端视频，需要预先调⽤ enableVideo 启动视频引擎

Note

• 如果你希望在通话中更新远端⽤户视图的渲染或镜像模式，请使⽤ setRemoteRenderMode:renderMode:mirrorMode: ⽅法

setLocalRenderMode:mirrorMode:

更新本地视图显示模式

- (int)setLocalRenderMode:(CloudHubVideoRenderMode) renderMode
               mirrorMode:(CloudHubVideoMirrorMode) mirrorMode;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

初始化本地用户视图后，你可以调用该方法更新本地用户视图的渲染和镜像模式，该方法只影响本地用户看到的视频画面，不影响本地发布视频

Note

• 请在调用 startPlayingLocalVideo:renderMode:mirrorMode: 方法初始化本地视图后，调用该方法
• 你可以在通话中多次调用该方法，多次更新本地用户视图的显示模式

setRemoteRenderMode:renderMode:mirrorMode:

更新远端视图显示模式

- (int)setRemoteRenderMode:(NSString * _Nonnull)streamId
                renderMode:(CloudHubVideoRenderMode) renderMode
                mirrorMode:(CloudHubVideoMirrorMode) mirrorMode;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

初始化远端⽤户视图后，你可以调⽤该⽅法更新远端⽤户视图在本地显示时的渲染和镜像模式，该⽅法只影响本地⽤户看到的视频画⾯

Note

• 请在调⽤ startPlayingRemoteVideo:streamId:renderMode:mirrorMode: ⽅法初始化远端视图后，调⽤该⽅法
• 你可以在通话中多次调⽤该⽅法，多次更新远端⽤户视图的显示模式

enableLocalVideo

开关本地视频采集

- (int)enableLocalVideo:(BOOL)enabled;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

该方法禁用或重新启用本地视频采集，不影响接收远端视频

Note

• 该方法需要在启⽤视频模块enableVideo之后生效

muteLocalVideoStream

开关本地视频发送

- (int)muteLocalVideoStream:(BOOL)mute;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

成功调用该方法后，远端会触发 rtcEngine:remoteVideoStateChangedOfUid:streamId:type:state:reason:streamInfo: 回调，reason 为CloudHubVideoRemoteStateReasonRemoteMuted

Note

• 调用该方法时，SDK 不再发送本地视频流，但摄像头仍然处于工作状态，相比于 enableLocalVideo 用于控制本地视频流发送的方法，该方法响应速度更快，该方法不影响本地视频流获取，没有禁用摄像头

muteRemoteVideoStreamWithUid:mute:

是否停⽌接收指定远端⽤户的视频流

- (int)muteRemoteVideoStreamWithUid:(NSString * _Nonnull)uid
                               mute:(BOOL)mute;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

在加入频道后

Note

• 成功调⽤该⽅法后，本地会触发 rtcEngine:remoteVideoStateChangedOfUid:streamId:type:state:reason:streamInfo: 回调，reason 为CloudHubVideoRemoteStateReasonLocalMuted

muteRemoteVideoByStreamId:mute:

取消或恢复订阅指定远端视频流

- (int)muteRemoteVideoByStreamId:(NSString * _Nonnull)streamId
                            mute:(BOOL)mute;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

在加入频道后

muteAllRemoteVideoStreams

是否停⽌接收指定远端⽤户的视频流

- (int)muteAllRemoteVideoStreams:(BOOL)mute;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

stopPlayingLocalVideo

停止播放本地视频并释放本地视频视图

- (int)stopPlayingLocalVideo;

返回

• 0: 方法调用成功
• 非0：方法调用失败

stopPlayingRemoteVideo

停止播放远端视频并释放视图

- (int)stopPlayingRemoteVideo:(NSString * _Nonnull)streamId;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

setLocalVideoHD

设置本地视频高清采集。

- (int)setLocalVideoHD;

返回

• 0：方法调用成功
• 非 0：方法调用失败

详情

该方法启用本地视频高清采集，但不影响发送到远端的视频尺寸。发出的视频会做裁剪、拉伸等处理，受 setVideoEncoderConfiguration 控制。

setVideoRotation

设置本地视频旋转方式

- (int)setVideoRotation:(CloudHubVideoRotation)rotation;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

该方法设置本地视频旋转方式，默认情况下（也即选中 CloudHubVideoRotationAuto 时），无论设备处于任何角度，远端看到你的视频总会是头朝上的： 当手机被竖向手持时，发出的视频也是竖向的； 当手机被横置时，发出的视频也是横向的，但你可以通过设置此值，固定视频旋转角度为某个方向，以与你的界面保持一致，此时只有手机方向与你设置的方向一致时，你的视频在远端看起来才是正向

视频前处理及后处理

setBeautyEffectOptions:options:

- (int)setBeautyEffectOptions:(BOOL)enabled options:(CloudHubBeautyOptions *_Nullable)options;

设置美颜参数

参数

返回

• 0：方法调用成功
• 非 0：方法调用失败

setVideoEffectEnable:options:device:

- (int)setVideoEffectEnable:(BOOL)enabled
                    options:(CloudHubVideoEffectOptions *_Nullable)options
                     device:(NSString *_Nullable)deviceID;

设置美颜参数

参数

返回

• 0：方法调用成功
• 非 0：方法调用失败

子频道方法

createChannel:

创建子频道

- (CloudHubRtcChannelKit * _Nullable) createChannel:(NSString * _Nonnull)channelId;

参数

返回

• 子频道

destroyChannel:

销毁子频道

(int) destroyChannel:(CloudHubRtcChannelKit * _Nonnull)channel;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

音乐文件播放

startPlayingMovie:cycle:

开始播放一个音乐文件

- (int) startPlayingMovie:(NSString * _Nonnull)filepath
                    cycle:(BOOL)cycle;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

startPlayingMovie:cycle:view:paused:

开始播放一个音乐文件

- (int) startPlayingMovie:(NSString * _Nonnull)filepath
                    cycle:(BOOL)cycle
                     view:(VIEW_CLASS * _Nullable)view
                   paused:(BOOL)paused;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

stopPlayingMovie:

停止播放一个音乐文件

- (int) stopPlayingMovie:(NSString * _Nonnull)filepath;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

pausePlayingMovie:

暂停播放一个音乐文件

- (int) pausePlayingMovie:(NSString * _Nonnull)filepath;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

resumePlayingMovie:

继续播放一个音乐文件

- (int) resumePlayingMovie:(NSString * _Nonnull)filepath;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

getMovieInfo:

获取音乐文件播放数据

- (CloudHubLocalMovieInfo * _Nullable) getMovieInfo:(NSString * _Nonnull)filepath;

参数

返回

• 详见 CloudHubLocalMovieInfo

getMovieCurrentPosition:

获取音乐文件的播放进度

- (NSUInteger) getMovieCurrentPosition:(NSString * _Nonnull)filepath;

参数

返回

• 播放进度（以毫秒为单位）

setMoviePosition:withFile:

为播放中的音乐文件设置进度

- (int) setMoviePosition:(NSUInteger)pos 
                withFile:(NSString * _Nonnull)filepath;

参数

返回

• 0: 方法调用成功
• 非 0: 方法调用失败

⾳效文件播放

getEffectsVolume

获取⾳效⽂件播放⾳量

- (int) getEffectsVolume;

返回

• ⽅法调⽤成功返回⾳效到⾳量值，范围为[0, 100]
• <0：⽅法调⽤失败

setEffectsVolume:

设置⾳效⽂件播放⾳量

- (int) setEffectsVolume:(int)volume;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

setVolumeOfEffect:volume:

实时调整⾳效⽂件播放饮料，范围为[0，100]

- (int) setVolumeOfEffect:(int)soundId 
                   volume:(int)volume;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

playEffect:filePath:loopCount:pitch:gain:publish:startTimeMS:endTimeMS:

开始播放⼀个⾳效⽂件

- (int) playEffect:(int)soundId  
          filePath:(NSString * _Nonnull)filepath  
         loopCount:(int)loopCount  
             pitch:(double)pitch
               pan:(double)pan
              gain:(int)gain  
           publish:(BOOL)publish  
       startTimeMS:(NSUInteger)starttime  
         endTimeMS:(NSUInteger)endtime;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

该⽅法可以播放指定的本地或在线⾳效⽂件来给应⽤增加⾳效，⽐如游戏中特 定操作的⾳效

你可以在该⽅法中设置⾳效⽂件的播放次数和增益，以及远端⽤户是否能听到该⾳效， 你可以多次调⽤该⽅法，通过传⼊不同的⾳效⽂件的 soundID 和 filePath，同时播放多个⾳效⽂件，实现⾳效叠加， 为获得最佳⽤户体验，我们建议同时播放的⾳效⽂件不要超过 3 个

调⽤该⽅法播放⾳效结束后，会触发 rtcEngine:onAudioEffectFinish: 回调

stopEffect:

停⽌播放⼀个⾳效⽂件

- (int) stopEffect:(int)soundId;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

stopAllEffects

停⽌播放⼀个⾳效⽂件

- (int) stopAllEffects;

返回

• 0: 方法调用成功
• 非0：方法调用失败

preloadEffect:filePath:

将指定音效文件预加载至内存

- (int) preloadEffect:(int)soundId 
             filePath:(NSString * _Nonnull)filepath;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

unloadEffect:

从内存释放某个预加载的音效文件

- (int) unloadEffect:(int)soundId;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

pauseEffect:

暂停播放⼀个⾳效⽂件

- (int) pauseEffect:(int)soundId;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

pauseAllEffects

暂停播放⼀个⾳效⽂件

- (int) pauseAllEffects;

返回

• 0: 方法调用成功
• 非0：方法调用失败

resumeEffect:

继续播放⼀个⾳效⽂件

- (int) resumeEffect:(int)soundId;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

resumeAllEffects

暂停播放⼀个⾳效⽂件

- (int) resumeAllEffects;

返回

• 0: 方法调用成功
• 非0：方法调用失败

translateWavFileToText:

从声音文件识别文本

- (int)translateWavFileToText:(NSString* _Nonnull)wavFile;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

人声效果

要使用人声效果相关功能，请先联系我们帮您开通

setAudioQuality

设置本地发送音频质量

- (int)setAudioQuality:(CloudHubAudioQuality)quality;

参数

返回

• 0: 成功
• 非0: 失败

setLocalVoicePitch:

设置本地语音音调

- (int)setLocalVoicePitch:(double)pitch

参数

返回

• 0: 成功
• 非0: 失败

详情

该方法改变本地说话人声音的音调。该方法需要在 enableLocalAudio 后调用。 注意，调用 enableLocalAudio 接口并传入 NO 会重设 pitch 为默认状态（即不需要修改音调）

setLocalVoiceEqualizationOfBandFrequency:withGain:

设置本地语音音效均衡

- (int)setLocalVoiceEqualizationOfBandFrequency:(CloudHubAudioEqualizationBandFrequency)bandFrequency 
                                       withGain:(NSInteger)gain

参数

返回

• 0: 成功
• 非0: 失败

详情

该方法改变本地说话人声音的音调。该方法需要在 enableLocalAudio 后调用。注意，调用 enableLocalAudio接口并传入 false 会重设音效均衡为初始状态

setLocalVoiceReverbOfType:withValue:

设置本地音效混响

- (int)setLocalVoiceReverbOfType:(CloudHubAudioReverbType)reverbType
                       withValue:(double)value

参数

返回

• 0: 成功
• 非0: 失败

详情

该方法设置本地音效混响。该方法需要在 enableLocalAudio后调用。注意，调用 enableLocalAudio接口并传入 false 会取消混响效果

setAudioEffectPreset:

设置 SDK 预设的人声音效

- (int)setAudioEffectPreset:(CloudHubAudioEffectPreset)preset

参数

返回

• 0: 成功
• 非0: 失败

详情

该方法设置 SDK 预设的人声音效。该方法需要在 enableLocalAudio 后调用。注意，调用 enableLocalAudio 接口并传入 false 会取消预设音效。此方法不能和 setLocalVoicePitch: 、 setLocalVoiceEqualizationOfBandFrequency:withGain: 、 setLocalVoiceReverbOfType:withValue: 混用

enableDeepLearningDenoise:

开启或关闭 AI 降噪模式

- (int)enableDeepLearningDenoise:(BOOL)enabled

参数

返回

• 0: 成功
• 非0: 失败

听声辨位

enableSoundPositionIndication:

开启/关闭远端用户的语音立体声

- (int)enableSoundPositionIndication:(BOOL)enabled

参数

返回

• 0: 成功
• 非0: 失败

详情

如果想调用 setRemoteVoicePosition:pan:gain: 实现听声辨位的功能，请确保在enableAudio前调用本方法开启远端用户的语音立体声

setRemoteVoicePosition:pan:gain:

设置远端用户的语音位置

- (int)setRemoteVoicePosition:(NSString * _Nonnull)uid
                          pan:(double)pan
                         gain:(double)gain

参数

返回

• 0: 成功
• 非0: 失败

详情

设置远端用户声音的空间位置和音量，方便本地用户听声辨位

通过调用该接口设置远端用户声音出现的位置，左右声道的声音差异会产生声音的方位感，从而判断出远端用户的实时位置

Note

• 该方法需要在加入频道后调用。使用该方法需要在enableAudio前调用 enableSoundPositionIndication: 开启远端用户的语音立体声
• 为获得最佳听觉体验，我们建议：
  • 在 iOS 使用该方法时佩戴耳机
  • 在 macOS 使用该方法时使用立体声外放

跨频道媒体流转发

startChannelMediaRelay:

开始跨频道媒体流转发

- (int) startChannelMediaRelay: (CloudHubChannelMediaRelayConfig* _Nonnull) config;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

成功调⽤该⽅法后，SDK 会触发 rtcEngine:onChannel:MediaRelayStateChanged:error: 回调，并在回调中报告当前的跨频道媒体流转发状态和事件

• 如果 rtcEngine:onChannel:MediaRelayStateChanged:error: 回调报告 CloudHub_RELAY_STATE_RUNNING 和 CloudHub_RELAY_OK， 则表示 SDK 开始在源频道和⽬标频道之间转发媒体流
• 如果 rtcEngine:onChannel:MediaRelayStateChanged:error: 回调报告 CloudHub_RELAY_STATE_FAILURE，则表示跨频道媒体流转发出现异常

Note

• 该方法仅适用于直播场景
• 跨频道媒体流转发功能需要联系技术⽀持开通
• 请在成功加⼊频道后调⽤该⽅法
• 该⽅法仅适⽤于直播场景下的主播
• 成功调⽤该⽅法后，若你想再次调⽤该⽅法，必须先调⽤ stopChannelMediaRelay ⽅法退出当前的转发状态

updateChannelMediaRelay:

更新媒体流转发的频道

- (int) updateChannelMediaRelay: (CloudHubChannelMediaRelayConfig* _Nonnull) config;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

成功开始跨频道转发媒体流后，如果你希望将流转发到多个⽬标频道，或退出当前的转发频道，可以调⽤该⽅法

Note

• 请在 startChannelMediaRelay: ⽅法后调⽤该⽅法， 更新媒体流转发的频道
• 跨频道媒体流转发最多⽀持 4 个⽬标频道

stopChannelMediaRelay

停⽌跨频道媒体流转发

- (int) stopChannelMediaRelay;

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

⼀旦停⽌，主播会退出所有⽬标频道 成功调⽤该⽅法后，SDK 会触发 rtcEngine:onChannel:MediaRelayStateChanged:error: 回调，如果报告 CloudHub_RELAY_STATE_IDLE 和 CloudHub_RELAY_OK，则表示已停⽌转发媒体流

Note

• 如果该⽅法调⽤不成功，SDK 会触发 rtcEngine:onChannel:MediaRelayStateChanged:error: 回调，并报告状态码 CloudHub_RELAY_ERROR_SERVER_NO_RESPONSE 或 CloudHub_RELAY_ERROR_SERVER_CONNECTION_LOST

• 你可以调⽤ leaveChannel: ⽅法离开频道，跨频道媒体流 转发会⾃动停⽌

音量提示

enableAudioVolumeIndication:smooth:reportVAD:

启用说话者音量提示

- (int)enableAudioVolumeIndication:(NSInteger)interval 
                            smooth:(NSInteger)smooth 
                         reportVAD:(BOOL)reportVad;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

切换播放声音使用扬声器或听筒

setEnableSpeakerphone:

设置当前是否使用扬声器

- (int)setEnableSpeakerphone:(BOOL)enableSpeaker;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

该方法设置是否将语音路由到扬声器（外放），该方法可以在 joinChannelByToken:channelId:properties:uid:autosubscribeAudio:autoSubscribeVideo:joinSuccess: 之前调用

isSpeakerphoneEnabled

获得当前是否使用扬声器

- (BOOL)isSpeakerphoneEnabled;

返回

• YES: 使用扬声器播放声音
• NO：使用听筒播放声音

详情

在接入有线或蓝牙耳机时，声音会被自动切换至耳机，此时 isSpeakerphoneEnabled 的返回值仍然是接入耳机之前的设置，当断开耳机后，声音也将回到接入耳机之前设置的播放路径

耳返控制

enableInEarMonitoring:

开启耳返功能

- (int)enableInEarMonitoring:(BOOL)enabled

参数

返回

• 0: 成功
• 非0: 失败

详情

该方法在加入频道前后都能调用

Note

• 该方法仅适用于 iOS 平台
• 用户必须使用有线耳机才能听到耳返效果

setInEarMonitoringVolume:

设置耳返音量

- (int)setInEarMonitoringVolume:(NSInteger)volume

参数

返回

• 0: 成功
• 非0: 失败 详情

该方法在加入频道前后都能调用

Note

• 该方法仅适用于 iOS 平台
• 用户必须使用有线耳机才能听到耳返效果

通话前⽹络测试

startEchoTest:

开始语⾳通话回路测试

- (int)startEchoTest: (int)intervalInSeconds;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

Note

• 需要预先调用 enableVideo 和 enableAudio

stopEchoTest

停止语⾳通话回路测试

- (int)stopEchoTest;

返回

• 0: 方法调用成功
• 非0：方法调用失败

startLastmileProbeTest:

开始通话前⽹络质量探测

- (int)startLastmileProbeTest:(CloudHubLastmileProbeConfig* _Nonnull)config;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

开始通话前⽹络质量探测，向⽤户反馈上下⾏⽹络的带宽、丢包、⽹络抖动和 往返时延数据

启⽤该⽅法后，SDK 会依次返回如下 2 个回调：

• lastmileQuality，视⽹络情况约每 2 秒返回1次，该回调通过打分反 馈上下⾏⽹络质量，更贴近⽤户的主观感受
• lastmile，视⽹络情况约 30 秒内返回，该回调通过具体数据反馈上 下⾏⽹络质量，更加客观

Note

• 请在加⼊频道之前进⾏该测试，需要预先调用 enableVideo 和 enableAudio

stopLastmileProbeTest

停止通话前⽹络质量探测

- (int)stopLastmileProbeTest;

返回

• 0: 方法调用成功
• 非0：方法调用失败

音频自采集（仅 Push 模式）

setExternalAudioSourceSampleRate:channels:

- (int) setExternalAudioSourceSampleRate:(int)sampleRate
                                channels:(int)channels;

设置采集数据的格式。

详情 该方法需要在加入频道前调用。

参数

返回

• 0：方法调用成功
• 非0: 失败

pushAudioFrame:

- (int) pushAudioFrame:(NSData * _Nonnull)buffer;

推送外部音频帧

参数

返回

• 0：方法调用成功
• 非0: 失败

音频自渲染（仅 Pull 模式）

setExternalAudioSinkSampleRate:channels:

- (int) setExternalAudioSinkSampleRate:(int)sampleRate
                              channels:(int)channels;

设置渲染数据的格式。

详情 该方法需要在加入频道前调用。

参数

返回

• 0：方法调用成功
• 非0: 失败

pullAudioFrame:

- (int) pullAudioFrame:(NSData * _Nonnull)buffer;

拉取播放(混音后）数据（一次拉取10ms数据）（用户需要持续以10ms间隔调用）。

调用该方法后，App 会采取主动拉取的方式获取远端已解码和混音后的音频数据，用于音频播放。

参数

返回

• 0：方法调用成功
• 非0: 失败

原始音频数据

setRecordingAudioFrameSampleRate:channels:samples:

- (int) setRecordingAudioFrameSampleRate:(int)sampleRate
                                channels:(int)channel
                                 samples:(int)samplesPerCall;

设置IAudioFrameObaser::onRecordAudioFrame回调数据格式。 该方法设置 rtcEngine:onRecordAudioFrame:sampleRate:channels: 回调的采集音频格式。

详情 该方法需要在加入频道前调用。

参数

返回

• 0：方法调用成功
• 非0: 失败

setPlaybackAudioFrameSampleRate:channels:samples:

- (int) setPlaybackAudioFrameSampleRate:(int)sampleRate
                               channels:(int)channel
                                samples:(int)samplesPerCall;

设置IAudioFrameObaser::OnPlaybackAudioFrame回调数据格式。 该方法设置 rtcEngine:onPlaybackAudioFrame:sampleRate:channels: 回调的采集音频格式。

详情 该方法需要在加入频道前调用。

参数

返回

• 0：方法调用成功
• 非0: 失败

音频录制

startRecordingVoiceClip:duration:fileType:

开始录制声音片段

- (int)startRecordingVoiceClip:(NSString* _Nonnull) clipBaseName
                      duration:(NSInteger)clipDurationSeconds
                      fileType:(CloudHubMediaFileType) type;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

调用成功后，用户会收到 rtcEngine:voiceClipFileReady:clip:ts: 回调。

stopRecordingVoiceClip:

停止录制声音片段

- (int)stopRecordingVoiceClip:(NSString* _Nonnull) clipBaseName;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

摄像头控制

switchCamera:

切换前置/后置摄像头

- (int)switchCamera:(BOOL)front;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

在调用 joinChannelByToken:channelId:properties:uid:autosubscribeAudio:autoSubscribeVideo:joinSuccess: 之前也可以调用该方法

setCameraFlipMode

设置摄像头的翻转模式

- (int)setCameraFlipMode:(BOOL)horizontalFlip  Vertivcal:(BOOL)verticalFlip

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

该方法对摄像头采集的数据进行水平翻转(和/或)垂直翻转。对于同一个摄像头，关闭该摄像头后，引擎仍然会记住该摄像头的翻转设置，下次打开该摄像头后会自动加载之前的设置，除非用户通过 enableVideo: NO关闭过视频引擎。

correctCameraKeystoning

校正摄像头的梯形畸变

- (int)correctCameraKeystoning:(float)fromX FromY:(float)fromY ToX:(float)toX ToY:(float)toY

参数

返回

• 0：方法调用成功
• 非 0：方法调用失败

详情

该方法通过增量交互的模式校正摄像头的梯形畸变。起点A(fromX,fromY)和终点B(toX,toY)构成的向量AB代表了本次校正的位移，相当于用户拖动鼠标从A移动到B，引擎会根据起点A的位置自动判断本次校正的角点是图片的哪个角点。

视图左上角和右下角的坐标为(0.0，0.0)和(1.0，1.0)，视图划分为四个等分的1/4区域，分别为左上区、右上区、右下区、左下区。A点和B点必须位于视图的某个等分区域内，跨区域校正是无效的。

resetCameraKeystoning

取消校正摄像头的梯形畸变

- (int)resetCameraKeystoning

返回

• 0：方法调用成功
• 非 0：方法调用失败

详情

该方法禁用摄像头的梯形校正功能，恢复默认行为

流消息

sendStreamMessage:

- (int) sendStreamMessage:(NSData * _Nonnull)message;

发送数据流。

该方法发送数据流消息到频道内所有用户。SDK 对该方法的实现进行了如下限制：频道内每秒最多能发送 30 个包，且每个包最大为 1 KB。 每个客户端每秒最多能发送 6 KB 数据。频道内每人最多能同时有 5 个数据通道。

成功调用该方法后，远端会触发 rtcEngine:onStreamMessagWithUid:data: 回调，远端用户可以在该回调中获取接收到的流消息。

参数

返回

• 0：方法调用成功
• < 0：方法调用失败

发布管理

setPublishStreamInfo:

设置发布本地音视频时用户自定义数据(Json字符串格式)

- (int)setPublishStreamInfo:(NSString * _Nonnull)info;

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

此方法必须在 rtcEngine:didJoinChannelwithUid:elapsed: 回调成功后，publishStream 之前调用。 如果远端成功订阅此视频流, 将会在收到 rtcEngine:remoteVideoStateChangedOfUid:streamId:type:state:reason:streamInfo: 回调时，通过 streamInfo 参数通知远端。

publishStream

开始发布本地音视频

- (int)publishStream;

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

将自己的音视频发布到频道中，让其他人观看和收听，当发布成功后，本地会收到 rtcEngine:localVideoStateChangeWithState:error: 回调

• 远端如果关闭了自动订阅，会收到 rtcEngine:onUserPublished:type:stream: 回调，此时对方如果决定收看此人，则需要调用 subscribe， 成功后收到 rtcEngine:remoteVideoStateChangedOfUid:streamId:type:state:reason:streamInfo: 回调
• 远端如果未关闭自动订阅，会直接收到 rtcEngine:remoteVideoStateChangedOfUid:streamId:type:state:reason:streamInfo: 回调

Note

• 只有在加入频道成功后，才能调用此方法

unPublishStream

停止发布本地音视频

- (int)unPublishStream;

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

停止发布自己的音视频，当停止发布后，本地会收到 rtcEngine:localVideoStateChangeWithState:error: 回调， 远端如果关闭了自动订阅，会收到 rtcEngine:onUserUnPublished:type:stream: 回调，另外不论远端是否关闭自动订阅，都会收到 rtcEngine:remoteVideoStateChangedOfUid:streamId:type:state:reason:streamInfo: 回调

Note

• 只有在加入频道成功后，才能调用此方法

手动订阅管理

subscribe

开始订阅一路音视频

- (int)subscribe:(NSString * _Nonnull)streamId;

参数

• 0: 方法调用成功
• 非0：方法调用失败

详情

请在收到 rtcEngine:onUserPublished:type:stream: 回调后调⽤

unSubscribe

取消订阅一路音视频

- (int)unSubscribe:(NSString * _Nonnull)streamId;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

• 在收到 rtcEngine:onUserPublished:type:stream: 回调后，可以反复调⽤ subscribe / unSubscribe ⽅法来建⽴/移除对这路⾳视频流的订阅
• 在收到 rtcEngine:onUserUnPublished:type:stream: 回调后，⽆需⼿⼯调⽤unSubscribe⽅法

服务器录制

• 当频道内有⼈调⽤开始/停⽌/暂停/恢复服务器录制接⼝，使得服务器录制 状态发⽣改变时，频道内的所有⼈都会收到 rtcEngine:onServerRecordStateChange:startTS:currTS:pauseDuration:recordDuration: 回调通知
• 当频道当前处于录制中/录制暂停中这两种状态下时，新进⼊频道的⼈也会收到 rtcEngine:onServerRecordStateChange:startTS:currTS:pauseDuration:recordDuration: 回调通知

startServerRecord

开始服务器录制

- (int) startServerRecord;

返回

• 0: 方法调用成功
• 非0：方法调用失败

stopServerRecord

停⽌服务器录制

- (int) stopServerRecord;

返回

• 0: 方法调用成功
• 非0：方法调用失败

pauseServerRecord

暂停服务器录制

- (int) pauseServerRecord;

返回

• 0: 方法调用成功
• 非0：方法调用失败

resumeServerRecord

恢复服务器录制

- (int) resumeServerRecord;

返回

• 0: 方法调用成功
• 非0：方法调用失败

⾼级信令⽅法

setPropertyOfUid:tell:properties:

为频道内某个用户设置自定义属性

- (int)setPropertyOfUid:(NSString * _Nonnull)uid 
                   tell:(NSString * _Nullable)whom 
             properties:(NSString * _Nonnull)prop;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

自定义属性有两种设置方法：

• 用户加入频道时，在 joinChannelByToken:channelId:properties:uid:autosubscribeAudio:autoSubscribeVideo:joinSuccess: 中指定 properties
• 用户加入频道后，调用 setPropertyOfUid:tell:properties:，则用户会收到 rtcEngine:onSetPropertyOfUid:from:properties: 回调
• 设置成功后，被通知的用户和被设置的用户都会收到通知，除此以外，新进入频道的用户也会在 rtcEngine:didJoinedOfUid:properties:isHistory:fromChannel: 回调中获得该用户的这些属性

Note

• 如果多次指定相同用户的不同属性，则这些属性都会被记录，并通过 rtcEngine:didJoinedOfUid:properties:isHistory:fromChannel: 回调发送给之后新进入频道的用户
• 如果多次指定相同用户的相同属性，则后设置的属性会覆盖之前设置的属性，比如为用户 A 重复设置两次，分别传入{"test": true"} 和 {"test": false}，则新进入频道的用户 B，在收到关于用户 A 的 rtcEngine:didJoinedOfUid:properties:isHistory:fromChannel: 回调中，会得到用户 A 的属性 {"test": false}

sendChatMsg:to:withExtraData:

发送聊天消息

- (int)sendChatMsg:(NSString * _Nonnull)message 
                to:(NSString * _Nullable)whom 
     withExtraData:(NSString * _Nullable)extraData;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

通常可以使用 extraData 来传递一些字体、头像等信息
频道内的用户会收到 rtcEngine:onChatMessageArrival:from:withExtraData: 回调

pubMsg:msgId:to:withData:associatedWithUser:associatedWithMsg:save:extraData:

发布一条自定义消息

- (int)     pubMsg:(NSString * _Nonnull)msgName
             msgId:(NSString * _Nonnull)msgId
                to:(NSString * _Nullable)whom
          withData:(NSString * _Nullable)data
associatedWithUser:(NSString * _Nullable)uid
 associatedWithMsg:(NSString * _Nullable)assMsgID
              save:(BOOL)save
         extraData:(NSString * _Nullable)extra;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

pubMsg 机制类似于一个留言板，用于保存和同步频道内的业务状态，无论是已经在频道内的用户，还是之后新加入的用户，都可以通过 rtcEngine:onPubMsg:msgId:from:withData:associatedWithUser:associatedWithMsg:ts:withExtraData:isHistory: 回调收到当前频道内已经发布的自定义消息

delMsg:msgId:to:

删除一条自定义消息

- (int)delMsg:(NSString * _Nonnull)msgName
        msgId:(NSString * _Nonnull)msgId
           to:(NSString * _Nullable)whom;  

和

- (int)delMsg:(NSString * _Nonnull)msgName
        msgId:(NSString * _Nonnull)msgId
           to:(NSString * _Nullable)whom
     withData:(NSString * _Nullable)data;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

调用成功后，已经在频道内的用户，会收到 rtcEngine:onDelMsg:msgId:from:withData: 消息

Note

• 删除一条不存在的消息会失败

evictUser:reason:

将一个用户踢出频道

- (int)evictUser:(NSString * _Nonnull)uid 
          reason:(NSInteger)reason;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

详情

调用成功后，被踢用户会收到 rtcEngine:onLocalUserEvicted: 回调，其他用户会收到 rtcEngine:didOfflineOfUid:reason: 回调

CDN推流

addPublishStreamUrl:

增加推流地址

- (int) addPublishStreamUrl:(NSString* _Nonnull)url;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

removePublishStreamUrl:

删除推流地址

- (int) removePublishStreamUrl:(NSString* _Nonnull)url;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

setLiveTranscoding:

设置转码参数

- (int) setLiveTranscoding:(CloudHubLiveTranscoding* _Nonnull)transcoding;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

其他方法

getCallId

获取频道号

- (NSString * _Nullable)getCallId;

返回

• 当前频道号

getSdkVersion

获取sdk版本号

+ (NSString * _Nonnull)getSdkVersion;

返回

• 当前版本号

setLogFilter:

设置日志输出等级

- (int)setLogFilter:(NSUInteger)filter;

参数

返回

• 0: 方法调用成功
• 非0：方法调用失败

getNativeHandle

获取 Native SDK Engine Handle

- (void *_Nullable)getNativeHandle;

详情

该方法获取 native SDK engine 的 C++ handle，用于包括注册音视频帧观测器在内的特殊场景