title: WilddogVideoRoom

wilddogVideo 是 WilddogVideoRoom SDK 的主入口，不能直接创建 WilddogVideoRoom 实例，必须要通过 wilddogVideo.room(roomId) 方式获取。 WilddogVideoRoom 表示一个多人的视频会话，多个用户可以加入同一个 Room 进行音视频通话。

属性

roomId

定义

  1. var roomInstance = wilddogVideo.room(roomId)

说明

Room 的唯一标识。


方法

connect

定义

  1.     roomInstance.connect();

说明

加入 Room。


disconnect

定义

  1.     roomInstance.disconnect();

说明

离开 Room。


publish

定义

  1. roomInstance.publish(localStream,function(error){
  2.      if(error == null){
  3.          console.log('publish success');
  4.          localStream.attach(localEl);
  5.      }
  6. });

说明

发布本地媒体流。发布成功后会触发其他客户端的 stream_added 事件。

参数

参数名 说明
localStream 本地媒体流。LocalStream


unpublish

定义

  1. roomInstance.unpublish(roomStream,function (error) {
  2.      if(error == null){
  3.           console.log('unpublish success');
  4.      }
  5. })

说明

取消发布本地媒体流。取消发布成功会触发其他客户端的 stream_removed 事件。

参数

参数名 说明
roomStream 远端媒体流。 RoomStream


subscribe

定义

  1. roomInstance.subscribe(roomStream,function (error) {
  2.     if(error == null){
  3.         console.log('subscribe success');
  4.     }
  5. })

说明

订阅在 stream_added 事件中获取的远端媒体流。订阅成功会触发本地的 stream_received 事件。

参数

参数名 说明
roomStream 远端媒体流 RoomStream


unsubscribe

定义

  1. roomInstance.unsubscribe(roomStream,function (error) {
  2.     if(error == null){
  3.         console.log('unsubscribe success');
  4.     }
  5. })

说明

取消订阅指定的远端媒体流。

参数

参数名 说明
roomStream 远端媒体流 RoomStream


startRecording()

定义

  1. roomInstance.startRecording(callback);

说明

使用默认录制布局并且开始服务端录制功能。


startRecording(options)

说明

设置录制布局并且开始服务端录制功能。

定义

  1. roomInstance.startRecording(options,callback) ;

参数

选项 类型 说明 示例
fps number 视频帧率 (fps) 15
bitrate number 比特率 (bps) 300
canvasWidth number 视频宽度 (<=1920) 960
canvasHeight number 视频高度 (<=1080) 640
bgColor number 背景颜色 (十六进制) 0xffffff
streams Object 媒体流布局 { “627620748239984100”: {“left”: 0 , “top”: 100, “width”: 300, “height”: 300, “zOrder”: 0-255}

对于每路需要录制的流的参数配置:

选项 类型 说明 示例
streamId string 流ID，在一个room中，每一路流都有一个唯一流ID 627620748239984100
left number 此路视频流相对左侧坐标 0
top number 此路视频流相对顶部坐标 0
width number 此路视频宽度 100
height number 此路视频高度 150
zOrder number 图像叠放层次顺序，高层次将遮挡低层次图像。该值越小，则叠放层次越低，该值越大，则叠放层次越高,从小到大绘制(0-255) 8

示例

  1. var options = {
  2.     "fps":10,
  3.     "canvasWidth":1000,
  4.     "canvasHeight":1000,
  5.     "streams": {
  6.         "627620748239984100":{"left":0,"top":100,"width":300,"height":300,"zOrder":1},
  7.         "627620748239984101":{"left":0,"top":100,"width":300,"height":300,"zOrder":2}
  8.     }
  9. }
  10. //其中"627620748239984100","627620748239984101"为具体的streamId，可以从localStream和roomStream对象中获取
  11. roomInstance.startRecording(options,function(url,error) {
  12.     if (error == null) {
  13.         console.log(url)
  14.     }
  15. }) ;


stopRecording

定义

  1. room.stopRecording(callback);

说明

结束服务端录制功能。


事件

WilddogVideoRoom 事件用于监听 Room 连接状态以及媒体流变化。

事件类型 事件 说明
连接事件 connected 成功连接到 Room。
连接事件 disconnected 断开到 Room 的连接。
媒体流事件 stream_added 有远端流加入到 Room，此时的RoomStream 中不包含真正的媒体流，需要使用 subscribe 方法进行订阅方可获取真正的媒体流。
媒体流事件 stream_removed 有远端流停止发布。
媒体流事件 stream_received 成功订阅远端流，此时获取到真正的媒体流对象，可以进行播放。
错误事件 error 错误事件。

connected

示例

  1.     roomInstance.on('connected',function(){
  2.         console.log('connected success');
  3.     })

disconnected

示例

  1.     roomInstance.on('disconnected',function(){
  2.         console.log('disconnected success');
  3.     })

stream_added

参数

参数名 说明
roomStream RoomStream 类型远端参与者发送的媒体流

示例

  1.     roomInstance.on('stream_added',function(roomStream){
  2.         console.log('rommStream added' + roomStream);
  3.     })

stream_removed

参数

参数名 说明
roomStream RoomStream 类型远端参与者发送的媒体流

示例

  1.     roomInstance.on('stream_removed',function(roomStream){
  2.         console.log('rommStream removed' + roomStream);
  3.     })

stream_received

参数

参数名 说明
roomStream RoomStream 类型远端参与者发送的媒体流

示例

  1.     roomInstance.on('stream_received',function(roomStream){
  2.         console.log('rommStream received' + roomStream);
  3.     })

error

示例

  1.     //错误信息回调
  2.     roomInstance.on('error',function(error){
  3.         console.log('error is' + error);
  4.     })