所有文档

          实时音视频 RTC

          API

          启动BRTC SDK

          BRTC_Start() 

          介绍

          启动SDK时使用。

          参数

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

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

          返回

          参数详解

          参数 类型 描述 默认值
          server string 百度的RTC 服务器, 使用默认值即可。 "wss://rtc2.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
          recording bool 直播转推是否录制 默认false
          autosubscribe bool 是否自动订阅流 默认true
          autopublish bool 是否自动发布流 默认true
          waitpermissiontimeoutms int 等待权限超时大小,单位是毫秒 默认值是180000毫秒
          candidateip string 代理服务器的IP 默认值null
          mediaserverip string 代理指向的媒体服务器IP 默认值null
          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

          BRTC_Stop()

          介绍

          停止BRTC

          参数

          返回

          获得SDK的版本号

           BRTC_Version();   

          介绍

          获得SDK的版本号信息。

          参数

          返回

          返回BRTC SDK的版本号

          获得视频设备列表

           BRTC_GetVideoDevices() 

          介绍

          获得视频设备列表

          返回

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

          参数详解

          var callback = {
          success: function (devices) { 
              const str = JSON.stringify(devices);
              }
          }
          BRTC_GetVideoDevices(callback);

          切换视频设备

          BRTC_ReplaceVideo(DeviceID)   

          介绍

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

          参数

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

          返回

          订阅指定的视频流

          BRTC_SubscribeStreaming("manualvideo",feedid);

          介绍

          订阅指定的视频流,并显示到指定的视频标签上

          参数

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

          返回

          停止订阅视频流

          BRTC_StopSubscribeStreaming(feedid);

          介绍

          停止订阅的视频流。

          参数

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

          返回

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

          BRTC_GetRemoteUsers();

          介绍

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

          参数

          返回

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

          返回结果示例:

          [
              {"id":100219207,"display":"Tom","attribute":""},
              {"id":100241823,"display":"brtc webclient","attribute":""}
          ]

          发布本地音视频流

          BRTC_StartPublish();

          介绍

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

          参数

          返回

          停止发布本地音视频流

          BRTC_StopPublish();

          介绍

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

          参数

          返回

          重新设置发布流的参数

          BRTC_SetParamSettings({
                      usingdatachannel: true,
                      usingaudio: true,
                      usingvideo: true,
                      videoprofile: "hires"});

          介绍

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

          参数

          返回

          麦克风静音

          BRTC_MuteMicphone(muted);

          参数

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

          返回

          静默视频

          BRTC_MuteCamera(muted);

          参数

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

          返回

          屏幕分享切换

          BRTC_SwitchScreen();

          介绍

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

          参数

          返回

          返回远端音频等级

          BRTC_GetRemoteAudioLevels();

          参数

          返回

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

          返回结果示例:

          [
              {
                  "feedId":100123,               // 被listen的用户Id
                  "display":"brtc webclient",    // 用户展示名
                  "ssrcs":[                      // SSRC,一个audioReceiver中会存在多个ssrc,故使用数组表示
                      {
                          "audioLevel":0.00008912509381337459,      // audioLevel值
                          "rtpTimestamp":1665600,                
                          "source":1526252044,                      // source id,一个流里面可能有多个source
                          "timestamp":1574051117355
                      }
                  ]
              }
          ]

          返回远端视频信息

          BRTC_GetRemoteVideoInfo(feedid);

          参数

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

          返回

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

          返回结果示例:

          {
              id: 78757951,
              bitrate: "1020 kbits/sec", 
              fps: 15, 
              width: 480, 
              height: 640
          }

          设置用户属性

          BRTC_SetUserAttribute(attribute);

          介绍

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

          参数

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

          返回

          获取用户属性值

          BRTC_GetUserAttribute();

          介绍

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

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

          返回

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

          发送用户消息

          BRTC_SendMessageToUser(msg,id);

          介绍

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

          参数

          msg, 需要发送的消息内容, 为一个字符串, 比如: "{name:'aaa',tel:'12345'}" id, 需要发送消息给对端用户的id值。 注意: 当id为0或没有id参数时表示在房间内发送广播消息。

          返回

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

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

          介绍

          测试摄像头设备的回显。

          参数

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

          返回

          关闭摄像头设备的回显

          BRTC_DeviceTest_Stop();

          介绍

          关闭摄像头设备的回显。

          参数

          返回

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

          BRTC_DeviceTest_MuteCamera(muted);

          介绍

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

          参数

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

          返回

          上一篇
          集成SDK
          下一篇
          Windows-SDK