API

更新时间：2025-05-07

启动BRTC SDK

Plain Text

1BRTC_Start()

介绍

启动SDK时使用。

参数

参数	类型	描述
server	string	百度的RTC 服务器，使用默认值即可。
appid	string	百度派发的AppID, 开发者的唯一标识
token	string	app server 派发的token字符串, 用来校验通信的合法性

该接口参数数量较多，请参考下面的参数详解进行了解。

无

参数详解

参数	类型	描述	默认值
server	string	百度的RTC 服务器，使用默认值即可。	"wss://rtc.exp.bcelive.com/janus"
appid	string	百度派发的AppID, 开发者的唯一标识
token	string	app server 派发的token字符串, 用来校验对应通信的合法性
roomname	string	房间名称
userid	string	用户ID, 小于2^53整数的字符串
displayname	string	显示的用户名
remotevideoviewid	string	显示远端视频，来自html的DOM对象的ID名称
localvideoviewid	string	显示本地摄像头视频，来自html的DOM对象的ID名称
showvideobps	bool	是否显示视频的带宽值	默认true，显示。
shownovideo	bool	不存在视频时的显示提示	默认true，显示。
showspinner	bool	是否显示加载过程	默认true
aspublisher	bool	是否是发布者	默认true，是发布者
usingdatachannel	bool	是否使用数据通道	默认true，开启数据通道
usingvideo	bool	是否使用本地视频设备	默认true
usingaudio	bool	是否使用本地音频设备	默认true
sharescreen	bool	是否是屏幕共享	默认false
videodeviceid	string	视频设备ID	默认使用摄像头，设备的值可以通过函数BRTC_GetVideoDevices获得
rtmpserver	string	直播转推流的地址	格式是："rtmp://server/stream"
rtmpmixtemplate	string	直播转推模版	模板名称，默认值为默认大小窗口模版
rtmpmix	bool	直播转推是否混流	默认false
rtmpmixlayoutindex	string	转推混流ID标识	配合RTMP转推混流函数BRTC_StartLiveServerStreamingEx使用
autosubscribe	bool	是否自动订阅流	默认true
autopublish	bool	是否自动发布流	默认true
waitpermissiontimeoutms	int	等待权限超时大小，单位是毫秒	默认值是180000毫秒
candidateip	string	代理服务器的IP	默认值null
mediaserverip	string	代理指向的媒体服务器IP	默认值null
videocodec	string	视频编码类型配置	可选参数, 默认值是'h264'; 支持'h264','vp8','h263','vp9'视频编码格式, 需要房间中的每个用户配置一致.
videoprofile	string 或Object	本地摄像头视频配置参数	'lowres','stdres','hires','fhdres','4kres'或者配置视频的宽高值 { 'height': {'ideal': 240}, 'width': {'ideal': 240}},
bitrate	int	设置摄像头编码的码率	默认值浏览器根据带宽决定，单位kbps，对于720p视频建议设置为1500
screenbitrate	int	设置屏幕共享的码率	默认值1500，单位kbps
remotevideoon	function(idx)	远端视频流到达的回调
remotevideooff	function(idx)	远端视频流离开的回调
remotevideocoming	function(id,display,attribute)	远端用户流上线的回调
remotevideoleaving	function(id)	远端用户流离开的回调
onlocalstream	function(stream,name)	本地视频流自动， name是流名称，相机是'camera'或屏幕共享'screen'
onlocalstream_end	function(name)	本地视频流关闭， name是流名称，相机是'camera'或屏幕共享'screen'
localvideopublishing	function	本地视频开始发布的回调
localvideopublished_ok	function	本地视频成功发布到回调
onmessage	function(msg)	消息事件回调{msg.id,msg.data}
onattribute	function(a)	属性事件回调{a.id,a.attribute}
userevent	bool	是否启用用户级事件	true表示启用用户级事件，当用户一旦加入房间就会发出事件，无需用户推流。 false 表示不启用
userevent_joinedroom	function(id,display,attribute)	用户加入房间的事件，此时用户还没有发布流
userevent_leavingroom	function(id,display)	用户离开房间，用户已经关闭了流或者没有发布过流
success	function()	BRTC_Start()成功
error	function(error)	BRTC_Start()失败，或运行过程中出现了错误
destroyed	function(error)	运行过程中出现错误被销毁的回调
debuglevel	bool/array	是否打印调试信息	默认值为true，可取值为: true, false, 'all', ['debug','log','error']

停止BRTC

Plain Text

1BRTC_Stop()

介绍

停止BRTC

参数

无

获得SDK的版本号

Plain Text

1 BRTC_Version();

介绍

获得SDK的版本号信息。

参数

无

返回BRTC SDK的版本号

获得视频设备列表

Plain Text

1 BRTC_GetVideoDevices()

介绍

获得视频设备列表

通过回调返回视频设备列表。

参数详解

Plain Text

1var callback = {
2success: function (devices) { 
3    const str = JSON.stringify(devices);
4    }
5}
6BRTC_GetVideoDevices(callback);

切换视频设备

Plain Text

1BRTC_ReplaceVideo(DeviceID)

介绍

用于多个摄像头设备上进行摄像头切换。

参数

参数	类型	描述
DeviceID	string	视频设备的ID号，可以通过BRTC_GetVideoDevices获得视频设备列表

无

替换视频源

Plain Text

1 BRTC_ReplaceStream(stream);

介绍

在已经推流的实例上使用，用于把video或canvas标签抓取的内容作为源发送出去。

参数

参数	类型	描述
stream	MediaStream	抓取canvas的视频流: var stream = canvas.captureStream(25);

无

订阅指定的视频流

Plain Text

1BRTC_SubscribeStreaming(manualvideo, feedid);

介绍

订阅指定的视频流，并显示到指定的视频标签上。前置条件: 需要在调用BRTC_Start时设置 autosubscribe: false

参数

参数	类型	描述
manualvideo	string	用于显示视频的DOM标签ID值
feedid	string	要订阅的视频流ID，可以在BRTC_Start方法的回调函数remotevideocoming中获得，或者在BRTC_GetRemoteUsers中取得。

无

停止订阅视频流

Plain Text

1BRTC_StopSubscribeStreaming(feedid);

介绍

停止订阅的视频流。

参数

参数	类型	描述
feedid	string	要停止订阅的视频流的ID，标识一个特定视频流

无

获得房间中的远端用户列表

Plain Text

1BRTC_GetRemoteUsers();

介绍

获得房间中的远端用户列表

参数

无

房间中的远端用户列表数组。

返回结果示例：

Plain Text

1[
2    {"id":100219207,"display":"Tom","attribute":""},
3    {"id":100241823,"display":"brtc webclient","attribute":""}
4]

发布本地音视频流

Plain Text

1BRTC_StartPublish();

介绍

在BRTC_Start()中把autopublish 设置为false时，可以使用本函数发布音视频流

参数

无

停止发布本地音视频流

Plain Text

1BRTC_StopPublish();

介绍

可以使用本函数停止发布音视频流

参数

无

重新设置发布流的参数

Plain Text

1BRTC_SetParamSettings({
2            usingdatachannel: true,
3            usingaudio: true,
4            usingvideo: true，
5            videoprofile: "hires"});

介绍

重新设置发布流的参数，用于在BRTC_StopPublish后改变参数，然后调用BRTC_StartPublish进行重新发布流。

参数

无

麦克风静音

Plain Text

1BRTC_MuteMicphone(muted);

参数

参数	类型	描述
muted	bool	静音标识， true表示要静音， false 是取消静音

无

静默视频

Plain Text

1BRTC_MuteCamera(muted);

参数

参数	类型	描述
muted	bool	静默标识， true表示要静默， false 是取消静默

无

屏幕分享切换

Plain Text

1BRTC_SwitchScreen();

介绍

用于屏幕分享和摄像头之间切换视频源

参数

无

返回远端音频等级

Plain Text

1BRTC_GetRemoteAudioLevels();

参数

无

返回结果为一个数组，数组中每个元素表示一个远端流的audioLevel信息；audioLevel为0到1之间的浮点数，0表示静音，取值越大声音越大。

返回结果示例：

Plain Text

1[
2    {
3        "feedId":100123,               // 被listen的用户ID
4        "display":"brtc webclient",    // 用户展示名
5        "ssrcs":[                      // SSRC,一个audioReceiver中会存在多个ssrc，故使用数组表示
6            {
7                "audioLevel":0.00008912509381337459,      // audioLevel值
8                "rtpTimestamp":1665600,                
9                "source":1526252044,                      // source ID，一个流里面可能有多个source
10                "timestamp":1574051117355
11            }
12        ]
13    }
14]

返回远端视频信息

Plain Text

1BRTC_GetRemoteVideoInfo(feedid);

参数

参数	类型	描述
feedid	int	远端视频流的ID

返回结果为远端视频信息的对象，包含视频宽高，码率，帧率信息。

返回结果示例：

Plain Text

1{
2    id: 78757951,
3    bitrate: "1020 kbits/sec", 
4    fps: 15, 
5    width: 480, 
6    height: 640
7}

设置用户属性

Plain Text

1BRTC_SetUserAttribute(attribute);

介绍

属性事件回调会发生在BRTC_Start的onattribute 函数上。属性值保存在BRTC_Start回调函数 remotevideocoming返回的参数里面。

参数

attribute, 表示用户属性的字符串，比如: "{name:'aaa',tel:'12345'}";

无

获取用户属性值

Plain Text

1BRTC_GetUserAttribute();

介绍

根据用户ID获得特定用户的属性值。

参数 {onattribute: function (a){} ,feedid: id} onattribute, 设置的回调函数。 feedid，要获取的用户ID号。

返回的属性值在onattribute回调中。

发送用户消息

Plain Text

1BRTC_SendMessageToUser(msg,id);

介绍

本函数用来给特定ID用户发送消息或者向房间内发送广播消息。消息在接收端的onmessage回调函数中接收。发送用户消息的频率应小于10次/秒，超出的话用户消息可能会被丢弃。

前置条件: 在调用BRTC_Start登录成功后才能调用。

参数

msg, 需要发送的消息内容，为一个字符串，比如: "{name:'aaa',tel:'12345'}"

id, 需要发送消息给对端用户的ID值。 注意: 当id为0或没有id参数时表示在房间内发送广播消息。

无

开启RTMP直播流转推

Plain Text

1BRTC_StartLiveServerStreaming(url, mix, mixtemplate, level);

介绍

本函数用来向RTMP接流服务器转推数据流。

参数

参数	类型	描述
url	string	RTMP接流地址URL
mix	bool	是否混流， true表示要多路混流， false表示不要混流
mixtemplate	string	混流模板，取值详见下表
level	string	转推模式，取值有: "room" 表示聊天室模式，"anchor" 表示主播转推模式

混流模板名称	说明
side_by_side_primary_360p_4_3	主次平铺, 分辨率 480x360 (固定码率、帧率)
side_by_side_primary_360p_4_3-xx-xx	主次平铺, 分辨率 480x360 (自定义码率、帧率) 下面模板也可以设置
side_by_side_primary_360p_16_9	主次平铺, 分辨率640x360
side_by_side_primary_480p_4_3	主次平铺, 分辨率640x480
side_by_side_primary_480p_16_9	主次平铺, 分辨率854x480
side_by_side_primary_540p_16_9	主次平铺, 分辨率960x540
side_by_side_primary_720p_4_3	主次平铺, 分辨率960x720
side_by_side_primary_720p_16_9	主次平铺, 分辨率1280x720
side_by_side_equal_360p_4_3	平铺模式(大小相等), 分辨率480x360
side_by_side_equal_360p_16_9	平铺模式(大小相等), 分辨率640x360
side_by_side_equal_480p_4_3	平铺模式(大小相等), 分辨率640x480
side_by_side_equal_480p_16_9	平铺模式(大小相等), 分辨率854x480
side_by_side_equal_540p_16_9	平铺模式(大小相等), 分辨率960x540
side_by_side_equal_720p_4_3	平铺模式(大小相等), 分辨率960x720
side_by_side_equal_720p_16_9	平铺模式(大小相等), 分辨率1280x720
picture_in_picture_bottom_360p_4_3	画中画模式, 分辨率480x360
picture_in_picture_bottom_360p_16_9	画中画模式, 分辨率640x360
picture_in_picture_bottom_480p_4_3	画中画模式, 分辨率640x480
picture_in_picture_bottom_480p_16_9	画中画模式, 分辨率854x480
picture_in_picture_bottom_540p_16_9	画中画模式, 分辨率960x540
picture_in_picture_bottom_720p_4_3	画中画模式, 分辨率960x720
picture_in_picture_bottom_720p_16_9	画中画模式, 分辨率1280x720
side_by_side_primary_480p_9_16	主次平铺, 分辨率480x854（竖屏）
side_by_side_primary_540p_9_16	主次平铺, 分辨率540x960（竖屏）
side_by_side_primary_544p_9_16	主次平铺, 分辨率544x960（竖屏）
side_by_side_primary_720p_9_16	主次平铺, 分辨率720x1280（竖屏）
side_by_side_primary_1080p_9_16	主次平铺, 分辨率1080x1920（竖屏）
side_by_side_equal_480p_9_16	平铺模式, 分辨率480x854（竖屏）
side_by_side_equal_540p_9_16	平铺模式, 分辨率540x960（竖屏）
side_by_side_equal_544p_9_16	平铺模式，分辨率544x960（竖屏）
side_by_side_equal_720p_9_16	平铺模式，分辨率720x1280（竖屏）
side_by_side_equal_1080p_9_16	平铺模式，分辨率1080x1920（竖屏）
picture_in_picture_bottom_480p_9_16	画中画模式, 分辨率480x854（竖屏）
picture_in_picture_bottom_540p_9_16	画中画模式，分辨率540x960（竖屏）
picture_in_picture_bottom_544p_9_16	画中画模式，分辨率544x960（竖屏）
picture_in_picture_bottom_720p_9_16	画中画模式，分辨率720x1280（竖屏）
picture_in_picture_bottom_1080p_9_16	画中画模式，分辨率1080x1920（竖屏）

无

开启RTMP直播流转推增强接口

Plain Text

1BRTC_StartLiveServerStreamingEx(url, level, mixcfg);

介绍

本函数用来向RTMP接流服务器转推数据流，支持配置混流背景水印等。

参数

参数	类型	描述	参考值
url	string	RTMP接流地址URL	-
level	string	转推模式	取值 "room" 表示聊天室模式，"anchor" 表示主播转推模式
mixcfg	object	混流转码配置对象	-

mixcfg详解

成员	类型	描述	参考值
mode	string	混流模式	必选成员，单路音视频转推使用"single"；多路音视频转推使用 "mix"；纯音频混流使用 "pure_audio"，无视频输出
bgpUrl	string	背景图片	背景图片的URL地址
encodeCfg	object	混流编码配置	-
encodeCfg.audioChannel	int	混流音频编码通道数	音频通道数取值1表示单声道，2表示双声道
encodeCfg.audioClockRate	int	混流音频编码采样率	推荐值48000，支持取值 8000，12000，16000，22050，24000，32000，44100，48000，88200，96000
encodeCfg.width	int	混流视频宽度	默认值1280，取值范围0~1920，单位为像素值
encodeCfg.height	int	混流视频高度	默认值720，取值范围0~1920，单位为像素值
encodeCfg.videoBitrate	int	混流视频编码码率	默认值1200kbps
encodeCfg.fps	int	混流视频帧率	默认值20fps
layoutCfg	object	布局配置	-
layoutCfg.layout	string	布局模板	默认值为 "side_by_side_primary"，可取值 "side_by_side_primary"，"side_by_side_equal"，"picture_in_picture_bottom"，"custom"; 取值 "custom" 时表示采用自定义窗口布局
layoutCfg.windowCfgs	array	自定义窗口布局	为每一路输入流配置一个窗口
layoutCfg.windowCfgs[0].id	string	窗口ID	与用户加入房间时BRTC_Start()中的 rtmpmixlayoutindex一致
layoutCfg.windowCfgs[0].renderMode	int	窗口绘制模式	可取值0和1，0表示缩放后裁剪，1表示缩放并显示黑底，默认值为0
layoutCfg.windowCfgs[0].xpos	int	窗口X坐标	该窗口在输出时矩形左上角的X坐标，单位为像素值，窗口的 xpos 与 width之和不能超过混流输出的总宽度（encodeCfg 中 width），默认为0
layoutCfg.windowCfgs[0].ypos	int	窗口Y坐标	该窗口在输出时矩形左上角的Y坐标，单位为像素值，窗口的 ypos 与 height之和不能超过混流输出的总高度（encodeCfg 中 height），默认为0
layoutCfg.windowCfgs[0].zorder	int	窗口在输出时的Z层级	默认为0，zorder越大处于画面越上层，取值为0时窗口位于最底层
layoutCfg.windowCfgs[0].width	int	窗口宽度	-
layoutCfg.windowCfgs[0].height	int	窗口高度	-
watermarkCfgs	array	水印配置数组	-
watermarkCfgs[0].type	string	水印类型	"image" 表示图片水印，"text" 表示文字水印，"clock" 表示时间戳水印
watermarkCfgs[0].xpos	int	水印X坐标	-
watermarkCfgs[0].ypos	int	水印Y坐标	-
watermarkCfgs[0].width	int	水印宽度	-
watermarkCfgs[0].height	int	水印高度	-
watermarkCfgs[0].imageUrl	string	图片水印地址	水印type 为"image" 时必须携带，图片水印URL，水印图片只支持缩放
watermarkCfgs[0].text	string	水印文本内容	用于文字水印和时间戳水印
watermarkCfgs[0].font	string	水印字体	默认值"Normal"，用于文字水印和时间戳水印
watermarkCfgs[0].size	int	水印字体大小	默认值22，用于文字水印和时间戳水印
watermarkCfgs[0].color	string	水印字体颜色	用于文字水印和时间戳水印，采用big-endian ARGB的方式，并使用16进制表示。背景颜色取值共10位，前2位固定为0x，接下来2位表示透明度，后6位表示颜色值，例如"0xFF000000"
watermarkCfgs[0].timeFormat	string	时间戳水印的时间格式	默认 "%Y-%m-%d %H:%M:%S"，时间戳格式参考：https://man7.org/linux/man-pages/man3/strftime.3.html

mixcfg对象示例：

                JSON
                
            

                {
    "mode":"mix",
    "bgpUrl":"https://*.jpg",
    "encodeCfg":{
        "audioChannel":2,
        "audioClockRate":48000,
        "width":1280,
        "height":720,
        "videoBitrate":1200,
        "fps":20
    },
    "layoutCfg":{
        "layout":"custom",
        "windowCfgs":[
            {
                "id":"1",
                "renderMode":0,
                "xpos":200,
                "ypos":200,
                "zorder":1,
                "width":100,
                "height":100
            },
            {
                "id":"2",
                "renderMode":1,
                "xpos":400,
                "ypos":400,
                "zorder":2,
                "width":200,
                "height":200
            }
        ]
    },
    "watermarkCfgs":[
        {
            "type":"image",
            "imageUrl":"https://*.jpg",
            "xpos":0,
            "ypos":0,
            "width":200,
            "height":200
        },
        {
            "type":"text",
            "text":"Hello world!",
            "xpos":100,
            "ypos":200,
            "font":"Normal",
            "size":22,
            "color":"0xFF000000"
        },
        {
            "type":"clock",
            "timeFormat":"%Y-%m-%d %H:%M:%S",
            "text":"北京时间：",
            "xpos":300,
            "ypos":400,
            "font":"Normal",
            "size":22,
            "color":"0xFF000000"
        }
    ]
}
            

停止RTMP直播流转推

Plain Text

1BRTC_StopLiveServerStreaming(level);

介绍

本函数用来停止向RTMP接流服务器转推。

参数

参数	类型	描述
level	string	需要停止的转推模式，取值有: "anchor", "room"

无

开启录制

Plain Text

1BRTC_StartRecording(level, mixcfg, filecfg, storagecfg);

介绍

本函数用于开启服务端录制，支持配置混流背景水印，文件名称配置等。

注意: 此录制函数将废弃，可以使用服务端API进行录制-云端录制相关接口。

参数

参数	类型	描述	参考值
level	string	录制级别	取值 "room" 表示房间录制，"user" 表示用户录制模式
mixcfg	object	混流转码配置对象	必选参数，混流转码配置
filecfg	object	文件配置对象	默认值采用百度智能云控制台配置
storagecfg	object	存储配置对象	默认值采用百度智能云控制台配置

mixcfg详解

成员	类型	描述	参考值
mode	string	混流模式	必选成员，单路音视频转推使用"single"；多路音视频转推使用 'mix'；纯音频混流使用 "pure_audio"，无视频输出
encodeCfg	object	混流编码配置	-
encodeCfg.audioCodec	string	混流音频编码	音频编码，默认值为"aac", 该配置项只有在 mixcfg.mode="pure_audio" 时生效，支持取值 "aac"、"mp3"; 其它模式均为默认值 'aac'
encodeCfg.width	int	混流视频宽度	默认值1280，取值范围0～1920，单位为像素值
encodeCfg.height	int	混流视频高度	默认值720，取值范围0～1920，单位为像素值
encodeCfg.videoBitrate	int	混流视频编码码率	默认值1200Kbps
layoutCfg	object	布局配置	-
layoutCfg.layout	string	布局模板	默认值为 "side_by_side_primary"，可取值 "side_by_side_primary"，"side_by_side_equal"，"picture_in_picture_bottom"；
watermarkCfgs	array	水印配置数组	-
watermarkCfgs[0].type	string	水印类型	"image' 表示图片水印，"text" 表示文字水印，"clock" 表示时间戳水印
watermarkCfgs[0].xpos	int	水印X坐标	-
watermarkCfgs[0].ypos	int	水印Y坐标	-
watermarkCfgs[0].width	int	水印宽度	-
watermarkCfgs[0].height	int	水印高度	-
watermarkCfgs[0].imageUrl	string	图片水印地址	水印type 为"image" 时必须携带，图片水印URL，水印图片只支持缩放
watermarkCfgs[0].text	string	水印文本内容	用于文字水印和时间戳水印
watermarkCfgs[0].font	string	水印字体	默认值"Normal"，用于文字水印和时间戳水印
watermarkCfgs[0].size	int	水印字体大小	默认值22，用于文字水印和时间戳水印
watermarkCfgs[0].color	string	水印字体颜色	用于文字水印和时间戳水印，采用big-endian ARGB的方式，并使用16进制表示。背景颜色取值共10位，前2位固定为0x，接下来2位表示透明度，后6位表示颜色值，例如"0xFF000000"
watermarkCfgs[0].timeFormat	string	时间戳水印的时间格式	默认 "%Y-%m-%d %H:%M:%S"，时间戳格式参考：https://man7.org/linux/man-pages/man3/strftime.3.html

mixcfg对象示例：

                JSON
                
            

                {
    "mode":"mix",
    "encodeCfg":{
        "audioCodec": "aac",
        "width":1280,
        "height":720,
        "videoBitrate":1200,
    },
    "layoutCfg":{
        "layout":"side_by_side_primary",
    },
    "watermarkCfgs":[
        {
            "type":"image",
            "imageUrl":"https://*.jpg",
            "xpos":0,
            "ypos":0,
            "width":200,
            "height":200
        },
        {
            "type":"text",
            "text":"Hello world!",
            "xpos":100,
            "ypos":200,
            "font":"Normal",
            "size":22,
            "color":"0xFF000000"
        },
        {
            "type":"clock",
            "timeFormat":"%Y-%m-%d %H:%M:%S",
            "text":"北京时间：",
            "xpos":300,
            "ypos":400,
            "font":"Normal",
            "size":22,
            "color":"0xFF000000"
        }
    ]
}
            

filecfg详解

成员	类型	描述	参考值
type	string	录制文件格式	该配置项在 mixcfg.mode="mix" 时支持取值 "flv"、"mp4"； mixcfg.mode="pure_audio"时，支持取值为 "aac"、"mp3"，并且此时 type取值需要和 audioCodec 取值相同； mixcfg.mode="single" 时不可配置，只支持取值 "flv"
maxDuration	int	单文件录制时长	单位分钟，达到该阈值时将自动切割文件，默认值为60

filecfg对象示例：

                JSON
                
                {
    "type": "mp4",
    "maxDuration": 60
}

storagecfg详解

成员	类型	描述	参考值
vendor	string	存储平台名	目前只支持取值"0"，表示百度智能云 BOS存储
filenameFormat	string	录制文件命名模式	对应BOS平台上文件的路径和文件名。 mixcfg.mode="mix" 或者 mixcfg.mode="pure_audio" 时，默认值为 "%a/%r/%d/recording_%t.%f"，并且要求取值必须含有%t，必须以.%f结尾 mixcfg.mode='single'，默认值为 "%a/%r/%d/recording_%t_%u.%f"，并且要求取值必须含有%t_%u，必须以.%f结尾。

storagecfg对象示例：

                JSON
                
                {
    "vendor": "0",
    "filenameFormat": "%a/%r/%d/recording_%t.%f"
}

停止录制

Plain Text

1BRTC_StopRecording(level);

介绍

本函数用来停止服务器录制。

注意: 此函数将废弃，可以使用服务端API进行录制停止-云端停止录制接口。

参数

参数	类型	描述
level	string	需要停止的录制模式，取值有: "room", "user"

无

摄像头设备的回显测试启动

Plain Text

1BRTC_DeviceTest_Start({localvideoviewid:”testvideo”,videoprofile:"hires"});

介绍

测试摄像头设备的回显。

参数

localvideoviewid, 要进行视频回显的DOM ID名称。 videoprofile, 回显视频的分辨率设置。可以取值为： "lowres","stdres","hires","fhdres","4kres","480x480@15"

无

关闭摄像头设备的回显

Plain Text

1BRTC_DeviceTest_Stop();

介绍

关闭摄像头设备的回显。

参数

无

静默摄像头设备测试的回显

Plain Text

1BRTC_DeviceTest_MuteCamera(muted);

介绍

静默摄像头设备测试的回显。

参数

muted, 是否静默摄像头， true表示静默摄像，false表示打开摄像头。

无

概述

Windows SDK

百度智能云

RTC 实时音视频

RTC 实时音视频

API

启动BRTC SDK

停止BRTC

获得SDK的版本号

获得视频设备列表

切换视频设备

替换视频源

订阅指定的视频流

停止订阅视频流

获得房间中的远端用户列表

发布本地音视频流

停止发布本地音视频流

重新设置发布流的参数

麦克风静音

静默视频

屏幕分享切换

返回远端音频等级

返回远端视频信息

设置用户属性

获取用户属性值

发送用户消息

开启RTMP直播流转推

开启RTMP直播流转推增强接口

停止RTMP直播流转推

开启录制

停止录制

摄像头设备的回显测试启动

关闭摄像头设备的回显

静默摄像头设备测试的回显