实时音视频 SPARKRTC-流对象(Stream):close

时间:2024-09-26 12:51:29

close

close(option?: CloseOption): void

【功能说明】

关闭音视频的播放。对于本地流,该方法在关闭播放的同时会关闭音视频采集,释放设备资源占用。

【请求参数】

option:可选,CloseOption类型,表示关闭音视频的选项。如果option不填写,则关闭音频和所有分辨率的视频。

CloseOption类型定义如下:{

  • audio:可选,boolean类型。表示是否关闭音频。默认为false。
  • video:可选,boolean类型。表示是否关闭视频。默认为false。
  • resolutionIds:可选,string[]类型。在video为true的时候有效。指定关闭播放的分辨率Id的视频,如果不传resolutionIds,默认关闭所有分辨率的视频。

}

【返回参数】

support.huaweicloud.com/csdk-rtc/rtc_05_0140.html