• 实时音视频
    • 实时音视频>客户端 API>iOS

    iOS

    编辑文档 更新于
    概况BRTCBRTCDelegateBRTCDeviceManagerBRTCBeautyManagerBRTCMediaPlayerManager对象和枚举错误码

    BRTC 是 BRTC SDK 的入口类，它为 App 提供了快速搭建音视频通信的 API。
    BRTCDelegate 来自 SDK 的各类事件通知，调用 BRTC 的接口最好在同一个线程进行，不建议在不同的线程同时调用。

    函数列表 描述
    callExperimentalAPI 调用实验性接口
    enableAudioVolumeEvaluation 启用音量大小提示
    enableEncSmallVideoStream 开启大小画面双路编码模式
    enterRoom 进入房间
    exitRoom 离开房间
    getAudioCaptureVolume 获取本地音频的采集音量
    getAudioEffecter 获取音效管理类
    getAudioPlayoutVolume 获取远端音频的播放音量
    getBeautyManager 获取美颜管理类
    getDeviceManager 获取设备管理类
    getSDKVersion 获取 SDK 版本信息
    delegate 设置 BRTC 事件回调
    muteAllRemoteAudio 暂停/恢复播放所有远端用户的音频流
    muteAllRemoteVideoStreams 暂停/恢复订阅所有远端用户的视频流
    muteLocalAudio 暂停/恢复发布本地的音频流
    muteLocalVideo 暂停/恢复发布本地的视频流
    muteRemoteAudio 暂停/恢复播放远端的音频流
    muteRemoteVideoStream 暂停/恢复订阅远端用户的视频流
    pauseScreenCapture 暂停屏幕分享
    resumeScreenCapture 恢复屏幕分享
    sendCustomCmdMsg 使用 UDP 通道发送自定义消息给房间内所有用户
    sendSEIMsg 使用 SEI 通道发送自定义消息给房间内所有用户
    setAudioCaptureVolume 设定本地音频的采集音量
    setAudioFrameCallbackDelegate 设置音频数据自定义回调
    setAudioPlayoutVolume 设定远端音频的播放音量
    setAudioRoute 设置音频路由
    setConsoleEnabled 启用/禁用控制台日志打印
    setCustomAudioRenderingFrameCallbackFormat 设置回调音频的格式
    setDefaultStreamRecvMode 设置订阅模式（需要在进入房前设置才能生效）
    setGSensorMode 设置重力感应的适配模式
    setLocalRenderParams 设置本地画面的渲染参数
    setLogDelegate 设置日志回调
    setLogDirPath 设置本地日志的保存路径
    setLogLevel 设置 Log 输出级别
    setNetworkQosParam 设置网络质量控制的相关参数
    setRemoteRenderParams 设置远端画面的渲染模式
    setRemoteVideoStreamType 切换指定远端用户的大小画面
    setVideoEncoderMirror 设置编码器输出的画面镜像模式
    setVideoEncoderParam 设置视频编码器的编码参数
    setWatermark 添加水印
    sharedInstance 创建 BRTC 实例(单例模式)
    snapshotVideo 视频画面截图
    startLocalAudio 开启本地音频的采集和发布
    startLocalPreview 开启本地摄像头的预览画面
    startRemoteView 订阅远端用户的视频流，并绑定视频渲染控件
    startScreenCaptureByReplaykit 开始全系统的屏幕分享（仅支持 iOS 11.0 及以上系统）
    startScreenCaptureInApp 开始应用内的屏幕分享（仅支持 iOS 13.0 及以上系统）
    stopAllRemoteView 停止订阅所有远端用户的视频流，并释放全部渲染资源
    stopLocalAudio 停止本地音频的采集和发布
    stopLocalPreview 停止摄像头预览
    stopRemoteView 停止订阅远端用户的视频流，并释放渲染控件
    stopScreenCapture 停止屏幕分享
    switchRole 切换角色
    updateRemoteView 更新远端用户的视频渲染控件
    startMixTranscode 开始混流
    stopMixTranscode 停止混流
    playMixStream 播放混流
    stopMixStream 停止播放混流
    sendAIInterrupt 手动打断智能体
    sendAIQuestion 向智能体发送文字进行提问
    requestAIGreetingMessage 请求智能体播报欢迎语
    setAudioEQEnable 设置是否开启人声音质增强

    详细信息

    sharedInstance
    创建 BRTC 单例

    + (instancetype)sharedInstance;

    返回

    • BRTC 单例

    详情

    • BRTC 类的所有接口函数，如无特殊说明，都是异步调用，对接口的调用建议在同一个线程进行。
    • 请确保在调用其他 API 前先调用该方法创建并初始化。
    • BRTC Native SDK 只支持每个App中创建一个 BRTC 单例。

    destroySharedIntance
    销毁 BRTC 单例

    + (void)destroySharedIntance;

    详情

    • 该方法释放 BRTC SDK 使用的所有资源。
    • 调用 destroySharedIntance 方法后，你将无法再使用 SDK 的其它方法和回调。
    • 如需再次使用实时音视频通信功能，你必须重新调用 sharedInstance 方法创建一个新的 BRTC 实例。
    • 如需在销毁后再次创建 BRTC 单例，需要等待 destroySharedIntance 方法执行结束后再创建实例。

    delegate
    设置回调接口

    - (id<BRTCDelegate>)delegate;

    详情

    • 您可以通过 BRTCDelegate 获得来自 SDK 的各种状态通知，详见 BRTCDelegate。

    enterRoom
    加入房间

    - (void)enterRoom:(BRTCParams *_Nonnull)param;

    参数

    名称 描述
    param 进房参数，详见 BRTCParams

    详情

    • 调用接口后，您会收到来自 BRTCDelegate 中的 onEnterRoom(result) 回调。
    • 如果加入成功，result 会是一个正数（result > 0），表示加入房间的时间消耗，单位是毫秒（ms）。
    • 如果加入失败，result 会是一个负数（result < 0），表示进房失败的错误码。
    • 不管进房是否成功，enterRoom() 都必须与 exitRoom() 配对使用，在调用 exitRoom() 前再次调用 enterRoom() 函数会导致不可预期的错误问题。

    exitRoom
    离开房间

    - (void)exitRoom;

    详情

    • 调用 exitRoom() 接口会执行退出房间的相关逻辑，例如释放音视频设备资源和编解码器资源等。
    • 待资源释放完毕，SDK 会通过 BRTCDelegate 中的 onExitRoom() 回调通知到您。
    • 如果您要再次调用 enterRoom() 或者切换到其他的音视频 SDK，请等待 onExitRoom() 回调到来之后再执行相关操作，否则可能会遇到摄像头或麦克风（例如 iOS 里的 AudioSession）被占用等各种异常问题。

    switchRole
    切换角色

    - (void)switchRole:(BRTCRoleType)role;

    参数

    名称 描述
    role BRTCRoleAnchor 主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。

    BRTCRoleAudience 观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 switchRole 切换成“主播”，同一个房间内同时最多可以容纳 10 万名观众。

    setDefaultStreamRecvMode
    设置订阅模式（需要在进入房前设置才能生效）

    - (void)setDefaultStreamRecvMode:(BOOL)autoRecvAudio video:(BOOL)autoRecvVideo;

    参数

    名称 描述
    autoRecvAudio YES:自动订阅音频；NO:需手动调用 muteRemoteAudio(NO) 订阅音频。默认值:YES。
    autoRecvVideo YES:自动订阅视频；NO:需手动调用 startRemoteView 订阅视频。默认值:YES。

    startLocalPreview
    开启本地视频的预览画面

    - (void)startLocalPreview:(BOOL)frontCamera view:(BRTCView *)view;

    参数

    名称 描述
    frontCamera YES:前置摄像头；NO:后置摄像头
    view 承载视频画面的控件

    详情

    • 请在 enterRoom 之后调用此函数。
    • 当开始渲染首帧摄像头画面时，您会收到 BRTCDelegate 中的 onFirstVideoFrame(nil) 回调。

    stopLocalPreview
    停止本地视频采集及预览

    - (void)stopLocalPreview;

    muteLocalVideo
    暂停/恢复推送本地的视频数据

    - (void)muteLocalVideo:(BOOL)mute;

    参数

    名称 描述
    mute YES:暂停；NO:恢复

    详情

    • 当暂停推送本地视频后，房间里的其它成员将会收到 onUserVideoAvailable(userid， NO)回调通知。
    • 当恢复推送本地视频后，房间里的其它成员将会收到 onUserVideoAvailable(userid， YES)回调通知。

    setVideoMuteImage
    设置本地画面被暂停期间的替代图片

    - (void) setVideoMuteImage:(Image *) image fps:(NSInteger) fps

    参数

    名称 描述
    image 设置替代图片，空值代表在 muteLocalVideo 之后不再发送视频流数据，默认值为空
    fps 设置替代图片帧率，最小值为5，最大值为10，默认5

    详情

    • 当您调用 muteLocalVideo(true) 暂停本地画面时，您可以通过调用本接口设置一张替代图片，设置后，房间中的其他用户会看到这张替代图片，而不是黑屏画面。

    startRemoteView
    开始拉取并显示指定用户的远端画面

    - (void)startRemoteView:(NSString *)userId streamType:(BRTCVideoStreamType)streamType view:(BRTCView *)view;

    参数

    名称 描述
    userId 指定远端用户的 userId
    streamType 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig
    低清小画面:BRTCVideoStreamTypeSmall
    辅流（屏幕分享）:BRTCVideoStreamTypeSub
    view 承载视频画面的控件

    详情

    • 该函数会拉取指定 userid 的视频流显示在您指定的 view 控件上，您可以通过 setRemoteRenderParams 设置显示模式。
    • 如果您提前知道房间中某个 userid 正在推流，可以直接调用 startRemoteView 显示该用户的远端画面。
    • 如果您不知道房间中有哪些用户开启了视频，可以在 enterRoom 后等待来自 SDK 的 onUserVideoAvailable(userId， true) 回调通知。
    • 调用 startRemoteView 只是启动拉取，此时画面还需要加载，当加载完毕后会通过 onFirstVideoFrame(userId) 通知您。
    • SDK 支持同时观看某 userid 的大画面和辅路，或者小画面和辅路，但不支持同时观看大画面和小画面。
    • 只有当指定的 userid 通过 enableEncSmallVideoStream 开启双路编码后，才能观看该用户的小画面。
    • 如果该用户的小画面不存在，则默认切换到大画面。

    updateRemoteView
    更新远端视频画面的窗口 ( 大小流 )

    - (void)updateRemoteView:(BRTCView *)view streamType:(BRTCVideoStreamType)type forUser:(NSString *)userId;

    参数

    名称 描述
    view 承载视频画面的控件
    type 设置预览窗口的流类型，详见 BRTCVideoStreamType
    userId 对方的用户标识

    stopRemoteView
    停止显示远端视频画面，同时不再拉取该远端用户的视频数据流

    - (void)stopRemoteView:(NSString *)userId streamType:(BRTCVideoStreamType)streamType;

    参数

    名称 描述
    userId 指定远端用户的 userId
    streamType 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig
    低清小画面:BRTCVideoStreamTypeSmall
    辅流（屏幕分享）:BRTCVideoStreamTypeSub

    详情

    • 调用此接口后，SDK 会停止接收该用户的远程视频流，同时会清理相关的视频显示资源。

    stopAllRemoteView
    停止订阅所有远端用户的视频流，并释放全部渲染资源

    - (void)stopAllRemoteView;

    muteRemoteVideoStream
    暂停/恢复接收指定的远端视频流

    - (void)muteRemoteVideoStream:(NSString *)userId streamType:(BRTCVideoStreamType)streamType mute:(BOOL)mute;

    参数

    名称 描述
    userId 对方的用户标识
    streamType 视频流类型
    mute YES:暂停；NO:恢复

    详情

    • 该接口仅暂停/恢复接收指定类型的远端用户的视频流，但并不释放显示资源。
    • 在 enterRoom 之前或之后调用此 API 均会进入屏蔽状态，屏蔽状态在您调用 exitRoom 之后会被重置为 false。

    muteAllRemoteVideoStreams
    暂停/恢复接收所有远端视频流

    - (void)muteAllRemoteVideoStreams:(BOOL)mute;

    参数

    名称 描述
    mute YES:暂停；NO:恢复

    详情

    • 该接口仅暂停/恢复接收所有远端用户的视频流，但并不释放显示资源。
    • 在 enterRoom 之前或之后调用此 API 均会进入屏蔽状态，屏蔽状态在您调用 exitRoom 之后会被重置为 false。

    setVideoEncoderParam
    设置视频编码器相关参数

    - (void)setVideoEncoderParam:(BRTCVideoEncParam *_Nonnull)param;

    参数

    名称 描述
    param 视频编码参数，详情 BRTCVideoEncParam

    详情

    • 该设置决定了远端用户看到的画面质量（同时也是云端录制出的视频文件的画面质量）。

    setNetworkQosParam
    设置网络流控相关参数

    - (void)setNetworkQosParam:(BRTCNetworkQosParam *)param;

    参数

    名称 描述
    param 网络流控参数，详见 BRTCNetworkQosParam

    详情

    • 该设置决定 SDK 在各种网络环境下的调控策略（例如弱网下选择“保清晰”或“保流畅”）。

    setLocalRenderParams
    本地图像的渲染设置

    - (void)setLocalRenderParams:(BRTCRenderParams *)params;

    参数

    名称 描述
    params 详见 BRTCRenderParams

    setRemoteRenderParams
    远端图像的渲染设置

    - (void)setRemoteRenderParams:(NSString *)userId streamType:(BRTCVideoStreamType)type params:(BRTCRenderParams *)params;

    参数

    名称 描述
    userId 用户 ID
    type 指定要观看 userId 的视频流类型:
    高清大画面:BRTCVideoStreamTypeBig
    低清小画面:BRTCVideoStreamTypeSmall
    辅流（屏幕分享）:BRTCVideoStreamTypeSub
    params 详见 BRTCRenderParams

    详情

    • 开启后会在 onUserVoiceVolume 中获取到 SDK 对音量大小值的评估。如需打开此功能，请在 startLocalAudio() 之前调用。
    • intervalMs 决定了 onUserVoiceVolume 回调的触发间隔，单位为ms，最小间隔为100ms，如果小于等于0则会关闭回调，建议设置为300ms。

    setVideoEncoderMirror
    设置编码器输出的画面镜像模式

    - (void)setVideoEncoderMirror:(BOOL)mirror;

    参数

    名称 描述
    mirror YES:开启远端画面镜像；NO:关闭远端画面镜像，默认值:NO

    详情

    • 该接口不改变本地摄像头的预览画面，但会改变另一端用户看到的（以及服务器录制的）画面效果。

    setGSensorMode
    设置重力感应的适配模式

    - (void)setGSensorMode:(BRTCGSensorMode)mode;

    参数

    名称 描述
    mode 重力感应模式，详情请参见 BRTCGSensorMode，默认值:BRTCGSensorMode_UIAutoLayout

    enableEncSmallVideoStream
    开启大小画面双路编码模式

    - (int)enableEncSmallVideoStream:(BOOL)enable withQuality:(BRTCVideoEncParam *_Nonnull)smallVideoEncParam;

    参数

    名称 描述
    enable YES:开启；NO:不开启，默认值:NO
    smallVideoEncParam 详见 BRTCVideoEncParam

    返回

    • 0:成功；-1:大画面已经是最低画质

    详情

    • 如果当前用户是房间中的主要角色（例如主播、老师、主持人等），并且使用 PC 或者 Mac 环境，可以开启该模式。
    • 开启该模式后，当前用户会同时输出【高清大画面】和【低清小画面】两路视频流（但只有一路音频流）。
    • 对于开启该模式的当前用户，会占用更多的网络带宽，并且会更加消耗 CPU 计算资源。
    • 对于同一房间的远程观众而言:
      • 如果下行网络很好，可以选择观看【高清大画面】
      • 如果下行网络较差，可以选择观看【低清小画面】
    • 双路编码开启后，会消耗更多的 CPU 和 网络带宽，所以对于 iMac、Windows 或者高性能 Pad 可以考虑开启，但请不要在手机端开启。

    setRemoteVideoStreamType
    切换指定远端用户的大小画面

    - (void)setRemoteVideoStreamType:(NSString *)userId type:(BRTCVideoStreamType)type;

    参数

    名称 描述
    userId 用于指定要观看的 userId
    type 视频流类型，即选择看大画面或小画面，默认为大画面

    详情

    • 此功能需要该 userId 通过 enableEncSmallVideoStream 提前开启双路编码模式。
    • 如果该 userId 没有开启双路编码模式，则此操作将无任何反应。
    • 在不通过此接口进行设置的情况下，startRemoteView 默认观看的画面为大画面。

    snapshotVideo
    视频画面截图

    - (void)snapshotVideo:(NSString *)userId type:(BRTCVideoStreamType)type sourceType:(BRTCSnapshotSourceType)sourceType
 completionBlock:(void (^)(UIImage *image))completionBlock;

    参数

    名称 描述
    userId 用户 ID，nil 表示截取本地视频画面
    type 视频流类型，支持主路画面（BRTCVideoStreamTypeBig，一般用于摄像头）和 辅路画面（BRTCVideoStreamTypeSub，一般用于屏幕分享）
    sourceType 截图画面来源，支持视频流（BRTCSnapshotSourceTypeStream）和视频渲染画面（BRTCSnapshotSourceTypeView）
    completionBlock 画面截取后的回调

    详情

    • 截取本地、远程主路和远端辅流的视频画面，并通过 UIImage(iOS)。

    startLocalAudio
    开启本地音频的采集和上行

    - (void)startLocalAudio:(BRTCAudioQuality)quality;

    参数

    名称 描述
    quality 声音音质，详见 BRTCAudioQuality

    详情

    • SDK 默认不采集声音，您需要调用该函数启动麦克风采集。
    • 该函数会检查麦克风的使用权限，如果当前 App 没有麦克风权限，SDK 会向用户申请开启。

    stopLocalAudio
    关闭本地音频的采集和上行

    - (void)stopLocalAudio;

    详情

    • 当关闭本地音频的采集

    muteLocalAudio
    静音/取消静音本地的音频

    - (void)muteLocalAudio:(BOOL)mute;

    参数

    名称 描述
    mute YES:静音；NO:取消静音

    详情

    • 当静音本地音频后，房间里的其它成员会收到 onUserAudioAvailable(userId， NO) 回调通知。
    • 当取消静音本地音频后，房间里的其它成员会收到 onUserAudioAvailable(userId， YES) 回调通知。

    muteRemoteAudio
    静音/取消静音指定的远端用户的声音

    - (void)muteRemoteAudio:(NSString *)userId mute:(BOOL)mute;

    参数

    名称 描述
    userId 对方的用户 ID
    mute YES:静音；NO:取消静音

    详情

    • 静音时会停止接收该用户的远端音频流并停止播放，取消静音时会自动拉取该用户的远端音频流并进行播放。
    • 在 enterRoom 之前或之后调用此 API 均会进入屏蔽状态，屏蔽状态在您调用 exitRoom 之后会被重置为 false。

    muteAllRemoteAudio
    静音/取消静音所有用户的声音

    - (void)muteAllRemoteAudio:(BOOL)mute;

    参数

    名称 描述
    mute YES:静音；NO:取消静音

    详情

    • 静音时会停止接收所有用户的远端音频流并停止播放，取消静音时会自动拉取所有用户的远端音频流并进行播放。
    • 在 enterRoom 之前或之后调用此 API 均会进入屏蔽状态，屏蔽状态在您调用 exitRoom 之后会被重置为 false。

    setAudioCaptureVolume
    设置 SDK 采集音量

    - (void)setAudioCaptureVolume:(NSInteger)volume;

    参数

    名称 描述
    volume 音量大小，100为原始音量，范围是:[0 ~ 150]，默认值为100

    getAudioCaptureVolume
    获取 SDK 采集音量

    - (NSInteger)getAudioCaptureVolume;

    setAudioPlayoutVolume
    设置 SDK 播放音量

    - (void)setAudioPlayoutVolume:(NSInteger)volume;

    参数

    名称 描述
    volume 音量大小，100为原始音量，范围是:[0 ~ 150]，默认值为100

    详情

    • 该函数会控制最终交给系统播放的声音音量，会影响录制本地音频文件的音量大小，但不会影响耳返的音量。

    getAudioPlayoutVolume
    获取 SDK 播放音量

    - (NSInteger)getAudioPlayoutVolume;

    enableAudioVolumeEvaluation
    启用音量大小提示

    - (void)enableAudioVolumeEvaluation:(NSUInteger)interval;

    参数

    名称 描述
    interval 设置 onUserVoiceVolume 回调的触发间隔，单位为ms，最小间隔为100ms，如果小于等于0则会关闭回调，建议设置为300ms

    详情

    • 开启此功能后，SDK 会在 onUserVoiceVolume() 中反馈对每一路声音音量大小值的评估。

    getDeviceManager
    获取设备管理类 BRTCDeviceManager

    - (BRTCDeviceManager *)getDeviceManager;

    getBeautyManager
    获取美颜特效类 BRTCBeautyManager

    - (BRTCBeautyManager *)getBeautyManager;

    setWatermark
    添加水印 setWatermark

    - (void)setWatermark:(BRTCImage *)image streamType:(BRTCVideoStreamType)streamType rect:(CGRect)rect;

    参数

    名称 描述
    image image 水印图片，必须使用透明底色的 png 格式
    streamType 指定给哪一路画面设置水印，详情请参考{@link BRTCVideoStreamType}
    rect 水印相对于编码分辨率的归一化坐标，x，y，width，height 取值范围0 - 1

    getAudioEffecter
    获取音效管理类 getAudioEffecter

    - (nullable BRTCAudioEffecter *)getAudioEffecter;

    startScreenCaptureInApp
    开始应用内的屏幕分享（该接口仅支持 iOS 13.0 及以上的 iPhone 和 iPad）

    - (void)startScreenCaptureInApp:(BRTCVideoEncParam *)encParams streamType:(BRTCVideoStreamType)streamType view:(nullable BRTCView *)view API_AVAILABLE(ios(13.0));

    参数

    名称 描述
    encParams 设置屏幕分享时的编码参数，推荐采用上述推荐配置，如果您指定 config 为 nil，则使用您调用 startScreenCapture之前的编码参数设置
    streamType 共享流类型，设置 BRTCVideoStreamTypeBig 时屏幕共享会替换主摄像头流, 设置 BRTCVideoStreamTypeSub 则不会
    view 承载屏幕共享画面，可以传空。如果 view 参数为空且 streamType 为 BRTCVideoStreamTypeBig 时，屏幕共享的回显会显示在 startLocalPreview 传进来的 view 上

    详情

    • iPhone 屏幕分享的推荐配置参数:
      • 分辨率(videoResolution): 1280 x 720
      • 帧率(videoFps): 10 FPS
      • 码率(videoBitrate): 1600 kbps
      • 分辨率自适应(enableAdjustRes): NO

    startScreenCaptureByReplaykit
    开始全系统的屏幕分享（该接口支持 iOS 11.0 及以上的 iPhone 和 iPad）

    - (void)startScreenCaptureByReplaykit:(BRTCVideoEncParam *)encParams streamType:(BRTCVideoStreamType)streamType view:(nullable BRTCView *)view appGroup:(NSString *)appGroup API_AVAILABLE(ios(11.0));

    参数

    名称 描述
    encParams 设置屏幕分享时的编码参数，推荐采用上述推荐配置，如果您指定 config 为 nil，则使用您调用 startScreenCapture之前的编码参数设置
    streamType 共享流类型，设置 BRTCVideoStreamTypeBig 时屏幕共享会替换主摄像头流, 设置 BRTCVideoStreamTypeSub 则不会
    view 承载屏幕共享画面，可以传空。如果 view 参数为空且 streamType 为 BRTCVideoStreamTypeBig 时，屏幕共享的回显会显示在 startLocalPreview 传进来的 view 上
    appGroup 主 App 与 Broadcast 共享的 Application Group Identifier，可以指定为 nil，但按照文档设置会使功能更加可靠

    详情

    • iPhone 屏幕分享的推荐配置参数:
      • 分辨率(width x height): 1280 x 720
      • 帧率(fps): 10 FPS
      • 码率(bandWidth): 1600 kbps

    stopScreenCapture
    停止屏幕采集

    - (int)stopScreenCapture API_AVAILABLE(ios(11.0));

    返回

    • 0:成功；<0:失败

    pauseScreenCapture
    暂停屏幕分享

    - (int)pauseScreenCapture API_AVAILABLE(ios(11.0));

    返回

    • 0:成功；<0:失败

    resumeScreenCapture
    恢复屏幕分享

    - (int)resumeScreenCapture API_AVAILABLE(ios(11.0));

    返回

    • 0:成功；<0:失败

    setAudioFrameCallbackDelegate
    设置音频帧数据的回调

    - (void)setAudioFrameCallbackDelegate:(id<BRTCAudioCallbackDelegate>)delegate;

    setCustomAudioRenderingFrameCallbackFormat
    设置回调音频的格式

    - (void)setCustomAudioRenderingFrameCallbackFormat:(BRTCCustomAudioDelegateFormat *)format;

    参数

    名称 描述
    format 音频数据回调格式

    详情

    • 本接口用于设置 onAudioCapturedRawAudioFrame 回调出来的 AudioFrame 的格式。

    sendCustomCmdMsg
    自定义消息发送

    - (BOOL)sendCustomCmdMsg:(NSInteger)cmdID data:(NSData *)data reliable:(BOOL)reliable ordered:(BOOL)ordered;

    参数

    名称 描述
    cmdID 消息 ID，取值范围为1 - 10
    data 待发送的消息，最大支持 1KB 的数据大小
    reliable 是否可靠发送，可靠发送的代价是会引入一定的延时，因为接收端要暂存一段时间的数据来等待重传
    ordered 是否要求有序，即是否要求接收端接收的数据顺序和发送端发送的顺序一致，这会带来一定的接收延时，因为在接收端需要暂存并排序这些消息

    返回

    • YES:消息已经发出；NO:消息发送失败。0则会关闭回调，建议设置为300ms

    详情

    • 该接口可以借助音视频数据通道向当前房间里的其他用户广播您自定义的数据，但因为复用了音视频数据通道，请务必严格控制自定义消息的发送频率和消息体的大小，否则会影响音视频数据的质量控制逻辑，造成不确定性的问题。

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

    - (BOOL)sendSEIMsg:(NSData *)data repeatCount:(int)repeatCount;

    参数

    名称 描述
    data 待发送的消息，最大支持 1KB（1000 字节）的数据大小
    repeatCount 发送数据次数

    返回

    • YES:消息已通过限制，等待后续视频帧发送；NO:消息被限制发送

    详情

    • sendSEIMsg 是将数据直接塞入视频数据头中。因此，即使视频帧被旁路到了直播 CDN 上，这些数据也会一直存在。由于需要把数据嵌入视频帧中，建议尽量控制数据大小，推荐使用几个字节大小的数据。
    • 最常见的用法是把自定义的时间戳（timstamp）用 sendSEIMsg 嵌入视频帧中，实现消息和画面的完美对齐，数据在接口调用完后不会被即时发送出去，而是从下一帧视频帧开始带在视频帧中发送，发送消息到房间内所有用户，每秒最多能发送 30 条消息（与 sendCustomCmdMsg 共享限制），每个包最大为 1KB，若发送大量数据，会导致视频码率增大，可能导致视频画质下降甚至卡顿（与 sendCustomCmdMsg 共享限制）。
    • 每个客户端每秒最多能发送总计8KB数据（与 sendCustomCmdMsg 共享限制）。
    • 若指定多次发送（repeatCount > 1），则数据会被带在后续的连续 repeatCount 个视频帧中发送出去，同样会导致视频码率增大。
    • 如果 repeatCount > 1，多次发送，接收消息 onRecvSEIMsg 回调也可能会收到多次相同的消息，需要去重。

    getSDKVersion
    获取 SDK 版本信息

    + (NSString *)getSDKVersion;

    setLogLevel
    设置log输出级别

    + (void)setLogLevel:(BRTCLogLevel)level;

    参数

    名称 描述
    level log级别，详见 BRTCLogLevel，默认值:BRTCLogLevelInfo

    setConsoleEnabled
    启用或禁用控制台日志打印

    + (void)setConsoleEnabled:(BOOL)enabled;

    参数

    名称 描述
    enabled 指定是否启用，默认为禁止状态

    setLogDirPath
    修改日志保存路径

    + (void)setLogDirPath:(NSString *__nullable)path;

    参数

    名称 描述
    path 存储日志路径

    详情

    • 日志文件默认保存在 sandbox Library/Caches 下，如需修改，请务必在所有其他接口之前调用，并且保证您指定的目录是存在的，并且您的应用程序拥有对该目录的读写权限。

    setLogDelegate
    设置日志回调

    + (void)setLogDelegate:(id<BRTCLogDelegate> __nullable)logDelegate;

    callExperimentalAPI
    调用实验性 API 接口

    - (void)callExperimentalAPI:(NSString *)jsonStr;

    参数

    名称 描述
    jsonStr 接口及参数描述的 JSON 字符串

    详情

    • 该接口用于调用一些实验性功能。

    startMixTranscode
    开始混流

    - (void)startMixTranscode:(BRTCMixStreamParams *)params;

    参数

    名称 描述
    params 主播发起混流的参数，详见 BRTCMixStreamParams

    详情

    • 主播才可以开始混流

    stopMixTranscode
    停止混流

    - (void)stopMixTranscode:(NSString *)mixStreamId;

    参数

    名称 描述
    mixStreamId 流 ID

    详情

    • 主播才可以停止混流

    playMixStream
    播放 Blive 混流

    - (void)playMixStream:(BRTCPlayMixStreamInfo *)playInfo;

    参数

    名称 描述
    playInfo 混流播放信息，详见 BRTCPlayMixStreamInfo

    stopMixStream
    停止播放 Blive 混流

    - (void)stopMixStream:(nullable NSString *)mixStreamID urlString:(nullable NSString *)urlString;

    参数

    名称 描述
    mixStreamID 流 ID
    urlString 播放地址

    详情

    • 指定了 mixStreamID，将会停止正在播放的该 mixStreamID 的所有流
    • 指定了 urlString，将会停止指定播放的 urlString 的流
    • 如果是合流，建议调用当前接口，不直接调用 BliveView 的 clear 方法

    sendAIInterrupt
    手动打断智能体

    - (void)sendAIInterrupt;

    sendAIQuestion
    向智能体发送文字进行提问

    - (void)sendAIQuestion:(NSString *)question;

    参数

    名称 描述
    question 问题内容

    requestAIGreetingMessage
    请求智能体播报欢迎语

    - (void)requestAIGreetingMessage;

    setAudioEQEnable
    设置是否开启人声音质增强

    注意：此方法从 3.12.0 开始提供 

    - (void)setAudioEQEnable:(BOOL)enable;

    参数

    名称 描述
    enable 是否开启人声音质增强。YES 表示开启，NO 表示关闭

    详情

    • 开启后，SDK 会对麦克风采集到的音频数据进行处理，增强其中人声部分的音质。
    • 设置此接口是开启人生音质增强的必要条件，此外您还必需要联系我们帮助您开通后台的配置选项来获取完整能力。
    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论