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

    Electron

    编辑文档 更新于
    BRTCBRTCCallBack对象和枚举BRTCError

    BRTCCloud 是 BRTC SDK 的入口类,它为 App 提供了快速搭建音视频通信的 API。
    BRTCCallback 包含了 BRTC SDK 主要的回调通知和监听事件。

    基础函数  
    static BRTC_API BRTCCloud createBRTCloud()
    static BRTC_API void destroyBRTCCloud()
    房间相关接口函数  
    void enterRoom(roomId: string, uid: UserId, sig: string)
    void exitRoom()
    视频相关接口函数  
    void startLocalPreview(view?: HTMLElement)
    void stopLocalPreview()
    void muteLocalVideo(enable: boolean)
    void startRemoteView(userId: UserId, view: HTMLElement, streamType: BRTCVideoStreamType)
    void updateRemoteView(userId: UserId, view: HTMLElement, streamType: BRTCVideoStreamType)
    void stopRemoteView(userId: UserId, streamType: BRTCVideoStreamType)
    void muteRemoteVideoStream(userId: UserId, mute: boolean)
    void muteAllRemoteVideoStreams(mute: boolean)
    void setVideoEncoderParam(params: VideoCodecParams)
    void setNetworkQosParam(params: object)
    void setLocalRenderParams(params: BRTCRenderParams)
    void setRemoteRenderParams(userId: UserId, streamType: BRTCVideoStreamType, params: BRTCRenderParams)
    void setVideoEncoderMirror(mirror: boolean)
    void enableEncSmallVideoStream(enable: boolean, params: VideoCodecParams)
    void setRemoteVideoStreamType(userId: UserId, streamType: BRTCVideoStreamType)
    void snapshotVideo(userId: UserId, streamType: BRTCVideoStreamType, sourceType: BRTCSnapshotSourceType)
    void resizeLocalVideo(type: BRTCVideoStreamType, width?: number, height?: number)
    void resizeRemoteVideo(userId: UserId, type: BRTCVideoStreamType, width?: number, height?: number)
    音频相关接口  
    void startLocalAudio(quality: BRTCAudioQuality)
    void stopLocalAudio()
    void muteLocalAudio(mute: boolean)
    void muteRemoteAudio(userId: UserId, mute: boolean)
    void setAudioCaptureVolume(volume: number)
    number getAudioCaptureVolume()
    void setAudioPlayoutVolume(volume: number)
    number getAudioPlayoutVolume()
    void enableAudioVolumeEvaluation(interval: number)
    背景音乐相关接口  
    void startPlayMusicAudio(musicParam: AudioMusicParam)
    void stopPlayMusicAudio(id: number)
    void pausePlayMusicAudio(id: number)
    void resumePlayMusicAudio(id: number)
    number getMusicCurrentPosInMS(id: number)
    number getMusicDurationInMS(id: number)
    void seekMusicToPosInTime(id: number, pts: number)
    void setAllMusicVolume(volume: number)
    void setMusicPitch(id: number, pitch: number)
    void setMusicPlayoutVolume(id: number, volume: number)
    void setMusicPublishVolume(id: number, volume: number)
    void setMusicSpeedRate(id: number, speedRate: number)
    屏幕共享相关接口  
    void startScreenCapture(type: BRTCVideoStreamType, params: VideoCodecParams)
    void stopScreenCapture()
    void pauseScreenCapture()
    void resumeScreenCapture()
    void startSystemAudioLoopback()
    void stopSystemAudioLoopback()
    void setSystemAudioLoopbackVolume(volume: number)
    设备管理相关接口  
    Device getCameraDevicesList()
    Device getMicDevicesList()
    Device getSpeakerDevicesList()
    Device getCurrentCameraDevice()
    Device getCurrentMicDevice()
    Device getCurrentSpeakerDevice()
    boolean getCurrentMicDeviceMute()
    boolean getCurrentSpeakerDeviceMute()
    number getCurrentMicDeviceVolume()
    number getCurrentSpeakerVolume()
    void setCurrentMicVolume(volume: number)
    void setCurrentSpeakerVolume(volume: number)
    void checkDevicePermission()
    本地录制  
    void startRecord(filename: string, audio: boolean)
    void stopRecord()
    void transcode(input: string, output: string, ffmpeg: string)
    自定义消息发送  
    void sendCustomCmdMsg(params: object)
    void sendSEIMsg(params: object)
    Log 相关接口函数  
    string getSDKVersion()
    void setLogLevel(level: BRTCLogLevel)
    void callExperimentalAPI(json: Data)

    详细信息

    创建 BRTC 单例 

    createBRTCloud(): *BRTCCloud*

    返回

    • 返回 BRTC 单例对象的指针

    详情

    • 用于动态加载 dll 时，获取 BRTC 对象指针

    销毁 BRTC 单例 

    destroyBRTCCloud() : void

    详情

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

    加入房间 

    enterRoom(roomId: string, uid: UserId, sig: string): *Promise‹void›*

    参数

    Name Type Description
    roomId string 房间号
    uid UserId UserId实例，其实也是string类型，用户ID
    sig string 签名 参考SDK 动态授权

    详情

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

    离开房间 

    exitRoom(): *Promise‹void›*

    详情

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

    开启本地视频的预览画面 

    startLocalPreview(`view?`: HTMLElement) : void

    参数

    Name Type Description
    view? HTMLElement 视图对象

    详情

    • 这个接口会启动默认的摄像头，可以通过 BRTCDeviceManager::setCurrentDevice 接口选用其他摄像头
    • 当开始渲染首帧摄像头画面时，你会收到 BRTCCallback 中的 onFirstVideoFrame(nullptr) 回调

    停止本地视频采集及预览 

    stopLocalPreview() : void

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

    muteLocalVideo(`enable`: boolean) : void

    参数

    Name Type Description
    enable boolean 控制推视频流行为，true:表示暂停，false:表示恢复

    Returns: void

    详情

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

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

    startRemoteView(`userId`: UserId, `view`: HTMLElement, `streamType`: BRTCVideoStreamType) : void

    参数

    Name Type Default Description
    userId UserId - 远端用户的ID
    view HTMLElement - 视频视图对象，用来承载视频画面
    streamType BRTCVideoStreamType BRTCVideoStreamType.BRTC_VIDEO_STREAM_TYPE_BIG 视频流类型，分为大流、小流、辅流三种，详见 BRTCVideoStreamType

    Returns: void

    详情

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

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

    stopRemoteView(`userId`: UserId, `streamType`: BRTCVideoStreamType) : void

    参数

    Name Type Default Description
    userId UserId - 用户ID
    streamType BRTCVideoStreamType BRTCVideoStreamType.BRTC_VIDEO_STREAM_TYPE_BIG 视频流类型

    Returns: void

    详情

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

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

    muteRemoteVideoStream(`userId`: UserId, `mute`: boolean) : void

    参数

    Name Type Description
    userId UserId 用户ID
    mute boolean true:暂停；false:恢复

    Returns: void

    详情

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

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

    muteAllRemoteVideoStreams(`mute`: boolean): void

    参数

    Name Type Description
    mute boolean true:暂停；false:恢复

    Returns: void

    详情

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

    设置视频编码器相关参数 

    setVideoEncoderParam(`params`: VideoCodecParams): void

    参数

    Name Type Description
    params VideoCodecParams 视频编码参数，详见 VideoCodecParams

    Returns: void

    详情

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

    本地图像的渲染设置 

    setLocalRenderParams(`params`: BRTCRenderParams) : void

    参数

    名称 描述
    params 详见 BRTCRenderParams

    详情

    • 暂不对外开放

    远端图像的渲染设置 

    setRemoteRenderParams(`userId`: UserId, `streamType`: BRTCVideoStreamType, `params`: BRTCRenderParams) : void

    参数

    Name Type Description
    userId UserId 用户ID
    streamType BRTCVideoStreamType 视频流类型
    params BRTCRenderParams 视频渲染参数

    详情

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

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

    setVideoEncoderMirror(`mirror`: boolean) : void

    参数

    Name Type Description
    mirror boolean 是否启用镜像功能，true：表示开启远端画面镜像；false：关闭远端画面镜像，默认是false

    Returns: void

    详情

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

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

    enableEncSmallVideoStream(`enable`: boolean, `params`: VideoCodecParams) : void

    参数

    Name Type Description
    enable boolean true：开启；false：不开启，默认值是 false
    params VideoCodecParams 视频编码参数，详见VideoCodecParams

    返回

    • void

    详情

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

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

    setRemoteVideoStreamType(`userId`: UserId, `streamType`: BRTCVideoStreamType)

    参数

    Name Type Description
    userId UserId 远端用户ID
    streamType BRTCVideoStreamType 视频流类型

    详情

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

    设置网络流控相关参数 

    setNetworkQosParam(`params`: object) : void

    参数

    网络流控参数，详见 BRTCNetworkQosParam

    Name Type
    controlMode BRTCQosControlMode
    preference BRTCVideoQosPreference

    Returns: void

    详情

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

    视频画面截图 

    snapshotVideo(`userId`: UserId, `streamType`: BRTCVideoStreamType, `sourceType`: BRTCSnapshotSourceType) : void

    参数

    Name Type Description
    userId UserId 用户ID
    streamType BRTCVideoStreamType 视频流类型
    sourceType BRTCSnapshotSourceType 截图画面来源类型，视频流或者 View

    详情

    • 截取本地、远程主路和远端辅流的视频画面，并通过 UIImage(c++) 或 NSImage(macOS) 对象返回

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

    startLocalAudio(`quality`: BRTCAudioQuality) : void

    参数

    Name Type Default Description
    quality BRTCAudioQuality BRTCAudioQuality.BRTC_AUDIO_QUALITY_DEFAULT 声音音质，详见BRTCAudioQuality

    详情

    • SDK 默认不采集声音，您需要调用该函数启动麦克风采集，并将音频数据传输给房间里的其他用户
    • 该函数会检查麦克风的使用权限，如果当前 App 没有麦克风权限，SDK 会向用户申请开启

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

    stopLocalAudio() : void

    详情

    • 当关闭本地音频的采集和上行，房间里的其它成员会收到 onUserAudioAvailable(false) 回调通知

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

    muteLocalAudio(`mute`: boolean) : void

    参数

    Name Type Description
    mute boolean true：静音；false：取消静音

    详情

    • 当静音本地音频后，房间里的其它成员会收到 onUserAudioAvailable(userId, false) 回调通知
    • 当取消静音本地音频后，房间里的其它成员会收到 onUserAudioAvailable(userId, true) 回调通知
    • 与 stopLocalAudio 不同之处在于，muteLocalAudio:true 并不会停止发送音视频数据，而是继续发送码率极低的静音包

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

    muteRemoteAudio(`userId`: UserId, `mute`: boolean) : void

    参数

    Name Type Description
    userId UserId 远端用户ID
    mute boolean true：静音；false：取消静音

    详情

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

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

    muteAllRemoteAudio(bool mute) : void

    参数

    Name Type Description
    mute boolean true：静音；false：取消静音

    详情

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

    设置 SDK 采集音量 

    setAudioCaptureVolume(`volume`: number) : void

    参数

    Name Type Description
    volume number 音量大小，100为原始音量，范围是：[0 ~ 150]，默认值为100

    获取 SDK 采集音量 

    getAudioCaptureVolume() : *number*

    设置 SDK 播放音量 

    setAudioPlayoutVolume(`volume`: number) : void

    参数

    Name Type Description
    volume number 设置 SDK 播放音量，音量大小，100为原始音量，范围是：[0 ~ 150]，默认值为100

    详情

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

    获取 SDK 播放音量 

    getAudioPlayoutVolume(): *number*

    详情

    • 获取 SDK 播放音量

    启用音量大小提示 

    enableAudioVolumeEvaluation(`interval`: number) : void

    参数

    Name Type Description
    interval number 设置 onUserVoiceVolume 回调的触发间隔，单位为 ms，最小间隔为 100ms，如果小于等于 0 则会关闭回调，建议设置为 300ms

    详情

    • 开启此功能后，SDK 会在 onUserVoiceVolume() 中反馈对每一路声音音量大小值的评估
    • 如需打开此功能，请在 startLocalAudio 之前调用

    自定义消息发送 

    sendCustomCmdMsg(`params`: object) : void

    参数

    Name Type Description
    cmdId? number 消息 ID，取值范围为1 - 10
    data ArrayBuffer 待发送的消息，最大支持 1KB（1000 字节）的数据大小
    ordered? boolean 是否可靠发送，可靠发送的代价是会引入一定的延时，因为接收端要暂存一段时间的数据来等待重传
    reliable? boolean 是否要求有序，即是否要求接收端接收的数据顺序和发送端发送的顺序一致，这会带来一定的接收延时，因为在接收端需要暂存并排序这些消息

    返回

    • void

    详情

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

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

    sendSEIMsg(`params`: object) : void

    参数

    Name Type Description
    data ArrayBuffer 待发送的消息，最大支持 1KB（1000 字节）的数据大小
    repeatCount? number 发送数据次数

    返回

    • true：消息已通过限制，等待后续视频帧发送；false：消息被限制发送

    详情

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

    获取 SDK 版本信息 

    getSDKVersion() : *string*

    设置log输出级别 

    setLogLevel(`level`: BRTCLogLevel) : void

    参数

    Name Type Description
    level BRTCLogLevel 日志等级，详见 BRTCLogLevel

    详情

    • 日志文件默认保存在 C:/Users/[系统用户名]/AppData/Roaming/BRTC/log，即 %appdata%/BRTC/log 下，如需修改，必须在所有方法前调用

    调用实验性 API 接口 

    callExperimentalAPI(`json`: Data) : void

    参数

    Name Type Description
    json Data json 字符串参数

    详情

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

    设备权限检测接口 

    checkDevicePermission():*Promise‹void›*

    Returns: Promise‹void›

    详情

    • 该接口用于设备权限检测，如果没有会自动申请

    获取摄像头设备列表 

    getCameraDevicesList():*Device[]*

    Returns: Device[]

    详情

    • 摄像头设备，以数组形式返回

    获取麦克风设备列表 

    getMicDevicesList():*Device[]*

    Returns: Device[]

    详情

    • 麦克风设备，以数组形式返回

    获取扬声器设备列表 

    getSpeakerDevicesList():*Device[]*

    Returns: Device[]

    详情

    • 扬声器设备，以数组形式返回

    获取当前摄像头设备 

    getCurrentCameraDevice():*Device*

    Returns: Device

    详情

    • 摄像头设备对象实例

    获取当前麦克风设备 

    getCurrentMicDevice():*Device*

    Returns: Device

    详情

    • 麦克风设备对象实例

    获取当前扬声器设备 

    getCurrentSpeakerDevice():*Device*

    Returns: Device

    详情

    • 扬声器设备对象实例

    获取当前麦克风设备的音量大小 

    getCurrentMicDeviceVolume():*number*

    详情

    • 获取当前麦克风设备的音量大小

    获取当前扬声器设备的音量大小 

    getCurrentSpeakerVolume():*number*

    详情

    • 获取当前扬声器设备的音量大小

    获取当前麦克风设备的静音状态 

    getCurrentMicDeviceMute():*boolean*

    详情

    • 获取当前麦克风设备的静音状态，true 表示静音，false 表示取消静音。

    获取当前扬声器设备的静音状态 

    getCurrentSpeakerDeviceMute():*boolean*

    详情

    • 获取当前扬声器设备的静音状态，true 表示静音，false 表示取消静音。

    设置当前麦克风音量的接口 

    setCurrentMicVolume(`volume`: number) : void

    参数

    Name Type Description
    volume number 音量大小

    详情

    • 设置当前麦克风设备音量大小

    设置当前扬声器音量的接口 

    setCurrentSpeakerVolume(`volume`: number) : void

    参数

    Name Type Description
    volume number 音量大小

    详情

    • 设置当前扬声器设备音量大小

    开始屏幕分享 

    startScreenCapture(`type`: BRTCVideoStreamType, `params`: VideoCodecParams) : void

    参数

    Name Type Description
    type BRTCVideoStreamType 视频流类型
    params VideoCodecParams 视频编码参数

    停止屏幕分享 

    stopScreenCapture() : void

    Returns: void

    暂停屏幕分享 

    pauseScreenCapture() : void

    Returns: void

    详情

    • 调用该接口后，可以调用 resumeScreenCapture 接口恢复屏幕分享。

    恢复屏幕分享 

    resumeScreenCapture() : void

    Returns: void

    详情

    • 调用该接口前，需要确保已经调用了 pauseScreenCapture 接口。

    重置本地视图大小 

    resizeLocalVideo(`type`: BRTCVideoStreamType, `width?`: number, `height?`: number) : void

    参数

    Name Type Default Description
    type BRTCVideoStreamType BRTCVideoStreamType.BRTC_VIDEO_STREAM_TYPE_BIG 视频流类型，分为主流、小流、辅流三种，和创建视图的类型相对应
    width? number - 视图宽度
    height? number - 视图长度

    Returns: void

    重置远端视图大小 

    resizeRemoteVideo(`userId`: UserId, `type`: BRTCVideoStreamType, `width?`: number, `height?`: number) : void

    参数

    Name Type Default Description
    userId UserId - 用户 ID
    type BRTCVideoStreamType BRTCVideoStreamType.BRTC_VIDEO_STREAM_TYPE_BIG 视频流类型
    width? number - 视图宽度
    height? number - 视图宽度

    Returns: void

    开始录制 

    startRecord(`filename`: string, `audio`: boolean) : void

    参数

    Name Type Description
    filename string 录制文件名称
    audio boolean 是否录制音频

    Returns: void

    停止录制 

    stopRecord() : void

    Returns: void

    开始录制 

    transcode(`input`: string, `output`: string, `ffmpeg`: string) : void

    参数

    Name Type Description
    input string 源文件（绝对路径）
    output string 目标文件（绝对路径）
    ffmpeg string ffmpeg 引用地址（绝对路径）

    Returns: void

    设置采集系统声音音量大小 

    setSystemAudioLoopbackVolume(`volume`: number) : void

    参数

    Name Type Description
    volume number 音量大小

    Returns: void

    开始采集系统声音 

    startSystemAudioLoopback() : void

    Returns: void

    停止采集系统声音 

    stopSystemAudioLoopback() : void

    Returns: void

    开始播放背景音乐文件 

    startPlayMusicAudio(`musicParam`: AudioMusicParam) : void

    参数

    Name Type Description
    musicParam AudioMusicParam 背景音乐播放参数，详见 AudioMusicParam

    Returns: void

    停止播放背景音乐文件 

    stopPlayMusicAudio(`id`: number) : void

    参数

    Name Type Description
    id number 背景音乐文件的 ID，和开始播放时设置的文件 ID 对应

    Returns: void

    暂停播放背景音乐文件 

    pausePlayMusicAudio(`id`: number) : void

    参数

    Name Type Description
    id number 背景音乐文件的 ID，和开始播放时设置的文件 ID 对应

    Returns: void

    恢复播放背景音乐文件 

    resumePlayMusicAudio(`id`: number) : void

    参数

    Name Type Description
    id number 背景音乐文件的 ID，和开始播放时设置的文件 ID 对应

    Returns: void

    获取背景音乐当前的播放进度（单位：毫秒） 

    getMusicCurrentPosInMS(`id`: number) : number

    参数

    Name Type Description
    id number 背景音乐文件的 ID，和开始播放时设置的文件 ID 对应

    Returns: number

    • 成功返回当前播放时间，单位：毫秒，失败返回 -1

    获取背景音乐文件的总时长（单位：毫秒） 

    getMusicDurationInMS(`id`: number) : number

    参数

    Name Type Description
    id number 背景音乐文件的 ID，和开始播放时设置的文件 ID 对应

    Returns: number

    成功返回时长，失败返回 -1

    设置背景音乐的播放进度（单位：毫秒） 

    seekMusicToPosInTime(`id`: number, `pts`: number) : void

    参数

    Name Type Description
    id number 背景音乐文件的 ID，和开始播放时设置的文件 ID 对应
    pts number 时间戳，单位: 毫秒

    Returns: void

    设置所有背景音乐的本地音量和远端音量的大小 

    setAllMusicVolume(`volume`: number) : void

    参数

    Name Type Description
    volume number 音量大小，取值范围为 0 - 100，默认值：100。

    Returns: void

    调整背景音乐的音调高低 

    setMusicPitch(`id`: number, `pitch`: number) : void

    参数

    Name Type Description
    id number 音乐 ID
    pitch number 音调，默认值是 0.0f，范围是：[-1 ~ 1] 之间的浮点数

    Returns: void

    设置某一首背景音乐的本地音量的大小 

    setMusicPlayoutVolume(`id`: number, `volume`: number) : void

    参数

    Name Type Description
    id number 音乐 ID
    volume number 音量大小，取值范围为 0 - 100，默认值：100。

    Returns: void

    详情

    • 该接口可以细粒度地控制每一首背景音乐的本地音量，也就是主播本地可以听到的背景音乐的音量大小。

    设置某一首背景音乐的远端音量的大小 

    setMusicPublishVolume(`id`: number, `volume`: number) : void

    参数

    Name Type Description
    id number 音乐 ID
    volume number 音量大小，取值范围为 0 - 100，默认值：100。

    Returns: void

    调整背景音乐的变速效果 

    setMusicSpeedRate(`id`: number, `volume`: number) : void

    参数

    Name Type Description
    id number 音乐 ID
    speedRate number 速度，默认值是 1.0f，范围是：[0.5 ~ 2] 之间的浮点数

    Returns: void

    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论