RoomStream

远端流媒体描述信息及媒体流数据

属性

streamId

定义

roomStream.streamId

说明

远端媒体流的唯一标识

streamOwners

定义

roomStream.streamOwners

说明
远端媒体流的发布者。

方法

attach

定义

roomStream.attach(element)

说明

将远端媒体流绑定到页面中的元素上。

参数

参数名	说明
element	`document.Element` 类型。页面中的元素。

示例

//将远端的媒体流绑定到id为'remoteStream'的页面元素上
roomStream.attach(document.getElementById('remoteStream'));

detach

定义

detach(element)

说明

将远端媒体流从页面中的元素上解绑。

参数

参数名	说明
element	`document.Element` 类型。页面中的元素。

示例

//将远端媒体流从页面中的元素上解绑
roomStream.detach(element);

enableAudio

定义

enableAudio(enabled)

说明

开启或禁用音频。

参数

参数名	说明
enabled	`Boolean` 类型。 `true` 为启用音频，`false` 为禁用音频。

示例

//开启远端音频
roomStream.enableAudio(true);

enableVideo

定义

enableVideo(enabled)

说明

开启或禁用视频。

参数

参数名	说明
enabled	`Boolean` 类型。`true` 为启用视频，`false` 为禁用视频。

示例

//开启远端视频
roomStream.enableVideo(true);

close

定义

close()

说明

关闭媒体流，关闭后不能继续使用。

示例

//开启参与者的视频
roomStream.close();

setAttributes

定义

setAttributes(attributes);

说明

用户设置媒体流的自定义属性，自定义属性只有在发布时才会同步到远端。

参数

参数名	说明
attributes	`json` 类型。大小限制：json 字符串长度不大于 2048 位。

示例

//开启参与者的视频
roomStream.setAttributes({id：123456});

getAttributes

定义

getAttributes();

说明

获取媒体流的自定义属性。

示例

//开启参与者的视频
var atts = roomStream.getAttributes();
// atts == {id：123456}  true

上次更新：2018-06-21