AliRtcEngine接口

目录

基础接口

频道相关接口

发布相关接口

订阅相关接口

视频相关接口

音频相关接口

预览接口

远端用户查询接口

其他接口

接口详情

AliRtcSDK Web端接口信息如下所示。

• isSupport()：检测浏览器是否支持。

  AliRtcEngine.isSupport().then((re)=> {
        console.log(re);
      }).catch(error => {
        console.log(error);
      })

  返回参数：

  参数	类型	描述
  audioDevice	Boolean	true表示音频设备可用，false表示音频设备不可用。
  browser	String	浏览器名称。
  browser_version	String	浏览器版本。
  isSupported	Boolean	是否支持webRTC。
  message	String	错误信息。
  supportH264	Boolean	true表示支持H264，false表示不支持H264。
  supportScreenShare	Boolean	true表示支持屏幕分享，false表示不支持屏幕分享。
  videoDevice	Boolean	true表示支持摄像头可用，false表示摄像头不可用。

• getDevices()：获取设备信息，返回摄像头和音频输入设备，在Safari浏览器下面，如果外接设备重插拔后获取不到，请尝试重新启动电脑。

  aliwebrtc.getDevices().then((re)=>{
  }).catch((error)=>{ 
    console.log(error.message)
  });

• getAvailableResolutions(deviceId)：获取可支持的分辨率。返回支持分辨率的Array数组信息。

  aliwebrtc.getAvailableResolutions(deviceId).then((re)=>{
  }).catch((error)=>{ 
    console.log(error.message)
  });

  参数：

  参数	类型	描述
  deviceId	String	摄像头ID。

• joinChannel(config,displayName)：加入频道。

  aliwebrtc.joinChannel({
      userid,         // 用户ID，只能由数字、字母、下划线组成
      channel,        // 频道
      appid,          // 应用ID
      nonce,          // nonce
      timestamp,      // 时间戳
      gslb,           // gslb
  },displayName).then(()=>{
      // 入会成功
  } ,(error)=>{
      // 入会失败，这里console下error内容，可以看到失败原因
      console.log(error.message);
  });

  参数：

  参数		类型	描述
  config	—	Object	鉴权频道信息。
  	userid	String	用户ID（只能包含数字和字母）。
  	channel	String	频道。
  	appid	String	应用ID。
  	nonce	String	nonce。
  	timestamp	String	时间戳。
  	gslb	Array	Global Server Load Balancing（简称gslb）。
  displayName		String	用户名字。

• leaveChannel()：离开频道。

  aliwebrtc.leaveChannel().then(()=>{
  } ,(error)=>{
      console.log(error.message);
  });

• configLocalAudioPublish：设置是否允许发布音频流。
  说明 默认为允许发布音频流，需要调用publish才能生效。

  aliWebrtc.configLocalAudioPublish=enable;

  参数：

  参数	类型	描述
  enable	Boolean	true表示允许发布音频流；false表示不允许。

• configLocalCameraPublish：设置是否允许发布相机流。
  说明 默认为允许发布相机流，需要调用publish才能生效。

  aliWebrtc.configLocalCameraPublish=enable;

  参数：

  参数	类型	描述
  enable	Boolean	true表示允许发布音频流，false表示不允许。

• configLocalScreenPublish：设置是否允许发布屏幕共享流。
  说明 默认为允许发布音频流，需要调用publish才能生效。

  aliWebrtc.configLocalAudioPublish=enable;

  参数：

  参数	类型	描述
  enable	Boolean	true表示允许发布音频流；false表示不允许。

• publish()：发布本地视频流，如果需要让远程订阅本地的流，需要调用publish接口，发布本地流，远程会接收到onPublisher事件。

  aliwebrtc.publish().then(()=>{
  } ,(error)=>{
      console.log(error.message);
  });

• unPublish()：结束发布本地流，当您取消发布本地流时，远程会收到onUnPublisher事件。

  aliwebrtc.unPublish().then(()=>{
  } ,(error)=>{
      console.log(error.message);
  });

• configRemoteAudio：设置是否订阅远端音频流。
  说明 默认为订阅远端音频流，需要调用subscribe才能生效。

  aliWebrtc.configRemoteAudio(userId,enable);

  参数：

  参数	类型	描述
  userId	String	用户ID。
  enable	Boolean	true为订阅远端音频流，false为停止订阅远端音频流。

• configRemoteCameraTrack：设置是否订阅远端相机流。

  相机流包含大流和小流，大流分辨率更高，小流分辨率较低。

  说明 默认为订阅大流，需要调用subscribe才能生效。

  aliWebrtc.configRemoteCameraTrack(userId,preferMaster,enable);

  参数：

  参数	类型	描述
  userId	String	用户ID。
  preferMaster	Boolean	是否优先订阅大流。true为订阅大流，false为订阅次小流。
  enable	Boolean	true为订阅远端相机流，false为停止订阅远端相机流。

• configRemoteScreenTrack：设置是否订阅远端屏幕流。
  说明 默认为不订阅远端屏幕流，需要调用subscribe才能生效。

  aliWebrtc.configRemoteScreenTrack(userId,enable);

  参数：

  参数	类型	描述
  userId	String	用户ID。
  enable	Boolean	true为订阅远端屏幕流，false为停止订阅远端屏幕流。

• subscribe(userId)：订阅远程发布流，通过subscirbe方法可以订阅远程的流，默认订阅相机流和音频流，可以通过调用configRemoteAudio、configRemoteCameraTrack、configRemoteScreenTrack来设置订阅内容。

  aliwebrtc.subscribe(userId).then((userId)=>{
  },(error)=>{
      console.log(error.message);
  });

  参数：

  参数	类型	描述
  userId	String	用户ID。

• unSubscribe(userId)：取消订阅该用户所有的流。

  aliwebrtc.unSubscribe(userId).then(() => {
  },(error)=>{
      console.log(error.message);
  });

  参数：

  参数	类型	描述
  userId	String	用户ID。

• currentCamera：指定摄像头设备。暂不支持热切换，需要在预览和推流之前设置 。

  //pc端
  aliWebrtc.currentCamera = {
    deviceId: deviceId
  };
  //手机端 facingMode指定user时启用前摄像头、指定environment时启用后置摄像头
  aliWebrtc.currentCamera = {
    facingMode:"user"
  };

  参数：

  参数	类型	描述
  deviceId	String	摄像头ID。

• videoProfile：设置视频流参数。您要设置的分辨率需要调用getAvailableResolutions()返回，然后调用publish()才能生效。
  说明 如果您设置的分辨率不合适，系统会自动进行调整。

  aliWebrtc.videoProfile = { 
    frameRate:20,
    width: 640,
    height: 480
  };

  参数：

  参数	类型	描述
  frameRate	int	帧率（5~30）。
  width	int	视频宽度。
  height	int	设备高度。

• muteLocalCamera(mute)：是否停止本地视频采集。

  aliwebrtc.muteLocalCamera(true);

  参数：

  参数	类型	描述
  mute	Boolean	true为视频采集，false为恢复正常。

• setDisplayRemoteVideo：为远端的视频设置渲染窗口以及绘制参数。

  aliwebrtc.setDisplayRemoteVideo(
      subscriber,        // onMediaStream中返回的参数
      video,               // html中用于显示stream对象的video元素
      stream             // onMediaStream中返回的参数
  )

• currentAudioCapture：指定麦克风设备。暂不支持热切换，需要在预览和推流之前设置。

  aliWebrtc.currentAudioCapture = {
    deviceId: deviceId
  };

  参数：

  参数	类型	描述
  deviceId	String	麦克风ID。

• muteLocalMic(mute)：是否停止本地音频采集。

  aliwebrtc.muteLocalMic(true);

  参数：

  参数	类型	描述
  mute	Boolean	true为停止视频采集，false为恢复正常。

• startPreview(video)：预览本地摄像头，通过video标签播放。

  aliwebrtc.startPreview(
      video    // html中的video元素
  ).then(()=>{
  }).catch((error) => {
      // 预览失败
  });

• stopPreview()：结束预览本地摄像头。

  aliwebrtc.stopPreview().then(()=>{
  }).catch((error) => {
      // 结束预览失败
  });

• getUserList()：获取当前房间在线用户。返回当前房间的在线用户列表信息。

  aliWebrtc.getUserList();

  返回参数：

  参数	类型	描述
  displayName	String	用户名称。
  userId	String	用户ID。

• getUserInfo(userId)：获取用户信息。

  aliWebrtc.getUserInfo(userId);

  返回参数：

  参数		类型	描述
  displayName		String	用户名称。
  streamConfigs	——	Array	音视频流数组。
  	label	String	流标签。
  	state	String	active表示流可用，inactive表示流不可用。
  	subscribed	Boolean	true表示已订阅，false表示未订阅。
  	type	String	audio表示音频，video表示视频。
  userId		String	用户ID。

• on(name, handler)：订阅事件。
  参数：

  参数	类型	描述
  name	String	事件名字。
  handler	String	处理事件的方法。

• off(name, handler)：取消订阅事件。
  参数：

  参数	类型	描述
  name	String	事件名字。
  handler	String	处理事件的方法。