title: LocalStream

方法

attach

定义

  1. attach(element)

说明

将本地媒体流绑定到页面中的元素上。

参数

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

示例

  1. //将本地的媒体流绑定到id为'localStream'的页面元素上
  2. localStream.attach(document.getElementById('localStream'));



detach

定义

  1. detach(element)

说明

将本地媒体流从页面中的元素上解绑。

参数

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

示例

  1. //将本地媒体流从页面中的元素上解绑
  2. localStream.detach(document.getElementById('localStream'));



enableAudio

定义

  1. enableAudio(enabled)

说明

开启或禁用音频。

参数

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

示例

  1. //开启参与者的音频
  2. localStream.enableAudio(true);



enableVideo

定义

  1. enableVideo(enabled)

说明

开启或禁用视频。

参数

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

示例

  1. //开启参与者的视频
  2. localStream.enableVideo(true);



close

定义

  1. close()

说明

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

示例

  1. //开启参与者的视频
  2. localStream.close();



setAttributes

定义

  1. setAttributes(attributes);

说明

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

参数

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

示例

  1. //开启参与者的视频
  2. localStream.setAttributes({id123456});



getAttributes

定义

  1. getAttributes();

说明

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

示例

  1. //开启参与者的视频
  2. var atts = localStream.getAttributes();
  3. // atts == {id:123456} true

switchCamera

定义

  1. localStream.switchCamera()

说明

切换摄像头。

返回值

Promise

示例

  1. localStream.switchCamera().then(function (isSupportSwitch) {
  2. if (isSupportSwitch === true) {
  3. // 支持通话中动态切换
  4. } else {
  5. // 不支持通话中动态切换,需重新发起call
  6. }
  7. }).catch(function () {
  8. })


提示:

在多人通话的场景中,由于存在兼容性问题,远端的浏览器只有iOS11和Mac下的的safari、PC下的Firefox能平滑的收到本地切换摄像头后的流。