title: WilddogRoom

title: WilddogRoom
常量
- CodecType
属性
- getRoomId()
方法

WilddogRoom 是多人视频通话的主入口，表示一个多人的视频会话，多个用户可以加入同一个 Room 进行音视频通话。

常量

CodecType

优先编码选项。

定义

    H264, 
    VP8

属性

getRoomId()

定义

    public String getRoomId()

说明

Room 的唯一标识。

方法

WilddogRoom(roomId,roomEvents)

定义

    WilddogRoom(String roomId, Listener roomEvents)

说明

使用 roomId 初始化 Room，同时指定接收 Room 事件的监听。

如果 Room 不存在，则服务端创建新 Room；否则加入已有 Room。

参数

参数名	说明
roomId	字符串类型，代表一个 Room 的唯一标识。
roomEvents	接收 Room 事件的监听，请参考 WilddogRoom.Listener。

返回值

WilddogRoom 实例。

WilddogRoom(roomId,url,roomEvents)

定义

    WilddogRoom(String roomId, String url, Listener roomEvents)

说明

使用 roomId 初始化 Room，同时指定接收 Room 事件的监听。

如果 Room 不存在，则服务端创建新 Room；否则加入已有 Room。

参数

参数名	说明
roomId	字符串类型，代表一个 Room 的唯一标识。
url	字符串类型，代表连接的服务器海内外节点地址。
roomEvents	接收 Room 事件的监听，请参考 WilddogRoom.Listener。

返回值

WilddogRoom 实例。

connect()

定义

    public void connect()

说明

加入 Room。成功加入 Room 会触发本地 onConnected 事件，否则触发 onError()) 事件。

disconnect()

定义

    public void disconnect()

说明

离开 Room。调用后触发本地 onDisconnected 事件。

publish(localStream)

定义

    public void publish(LocalStream localStream)

说明

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

参数

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

publish(localStream, codecType)

定义

    public void publish(LocalStream localStream, CodecType codecType)

说明

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

参数

参数名	说明
localStream	本地媒体流，请参考 LocalStream。
codecType	优先编码选项。

publish(localStream,listener)

定义

    public void publish(LocalStream localStream, CompleteListener listener)

说明

发布本地媒体流，操作完成执行完成回调。发布成功后会触发其他客户端的 onStreamAdded 事件。

参数

参数名	说明
localStream	本地媒体流，请参考 LocalStream。
listener	发布操作完成执行的回调监听。

publish(localStream, codecType, listener)

定义

    public void publish(LocalStream localStream, CodecType codecType, CompleteListener listener)

说明

发布本地媒体流，操作完成执行完成回调。发布成功后会触发其他客户端的 onStreamAdded 事件。

参数

参数名	说明
localStream	本地媒体流，请参考 LocalStream。
codecType	优先编码选项。
listener	发布操作完成执行的回调监听。

unpublish()

定义

    public void unpublish()

说明

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

unpublish(listener)

定义

    public void unpublish(CompleteListener listener)

说明

取消发布本地媒体流，操作完成执行完成回调并触发其他客户端的 onStreamRemoved 事件。

参数

参数名	说明
block	取消发布操作完成执行的回调监听。

subscribe(roomStream)

定义

    public void subscribe(RoomStream roomStream)

说明

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

参数

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

subscribe(roomStream,listener)

定义

    public void subscribe(RoomStream roomStream, CompleteListener listener)

说明

订阅在 onStreamAdded 事件中获取的远端媒体流，操作完成执行完成回调。订阅成功会触发本地的 onStreamReceived) 事件。

参数

参数名	说明
roomStream	远端媒体流，请参考 RoomStream。
listener	订阅操作完成执行的回调监听。

unsubscribe(roomStream)

定义

    public void unsubscribe(RoomStream roomStream)

说明

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

参数

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

unsubscribe(roomStream,listener)

定义

    public void unsubscribe(RoomStream roomStream, CompleteListener listener)

说明

取消订阅指定的远端媒体流，操作完成执行完成回调。

参数

参数名	说明
roomStream	远端媒体流，请参考 RoomStream。
listener	取消订阅操作完成执行的回调监听。

startRecording(listener)

定义

    public void startRecording(RecordingListener listener)

说明

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

参数

参数名	说明
listener	开始录制操作完成执行的回调监听。

startRecording(options,listener)

定义

    public void startRecording(Map<String,Object> options,RecordingListener listener)

说明

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

参数

参数名	说明
options	设置录制布局的集合对象。
listener	开始录制操作完成执行的回调监听。

stopRecording(listener)

定义

    public void stopRecording(RecordingListener listener)

说明

结束服务端录制功能。

参数

参数名	说明
listener	结束录制操作完成执行的回调监听。