音视频通话

影音共享

功能介绍

将本地影音文件或同源网络媒体流播放给房间内其他成员观看,支持暂停、跳转进度等控制。

  • 本地文件:浏览器环境下常用 mp4、mp3、webm 等(具体以各浏览器解码能力为准)
  • 网络地址:支持传入与页面同源的媒体 URL(String)
  • 同一房间内,同一时间仅支持一路影音共享

相比用屏幕共享播放影音,影音共享可在组件内完成解码与推流,无需将画面先显示再抓屏,也无需将声音经系统播放再采集,有利于画质与性能。

注意:

须在成功进入房间后,方可开始影音共享。

须先调用 CRVideo_CreatMediaObj 创建影音 UI 组件,再调用 CRVideo_StartPlayMedia。

播放端

1. 创建影音 UI 组件

无论本端播放共享还是观看他人共享,均需先创建 CRVideo_MediaObj:

var mediaObj = CRVideo_CreatMediaObj({
  controls: true,  // 是否显示浏览器自带控制条
  loop: false,     // 是否循环(也可由 bPauseWhenFinished 控制播完行为)
});

相关 API 请参考:

2. 配置参数并开始播放

每次只能播放一路影音,须停止当前播放后再播放下一个。开始共享前可通过 CRVideo_SetMediaCfg 设置分享到房间内的编码尺寸、帧率、码率等(参见 CRVideo_MediaCfg)。

var cfg = CRVideo_GetMediaCfg();
cfg.size = "1280*720";
cfg.fps = 15;
CRVideo_SetMediaCfg(cfg);

// file:File 对象或同源媒体 URL
// locPlay:0 房间内共享(默认),1 仅本端播放
// bPauseWhenFinished:0 播完结束共享,1 播完停在最后一帧,2 循环播放
var ret = CRVideo_StartPlayMedia(mediaObj, file, 0, 0);

播放端在 CRVideo_NotifyMediaStart 中挂载组件 DOM 即可观看本端画面:

CRVideo_NotifyMediaStart.callback = function (UID) {
  document.getElementById("mediaContainer").appendChild(mediaObj.handler());
};

文件打开后可监听 CRVideo_NotifyMediaOpened 获取总时长等信息,用于实现进度条。

相关 API 请参考:

3. 设置播放进度

可拖动组件自带控制条,或调用接口设置进度(单位:毫秒):

CRVideo_SetMediaplaypos(2000);  // 跳转到 2 秒处

相关 API 请参考:

4. 暂停、停止播放

CRVideo_PausePlayMedia(true);   // true:暂停,false:恢复
CRVideo_StopPlayMedia();

主动调用 CRVideo_StopPlayMedia,或按 bPauseWhenFinished 配置播放到结尾,都会触发 CRVideo_NotifyMediaStop,房间内成员均会收到。

CRVideo_NotifyMediaPause.callback = function (UID, status) {
  // status:0 播放中,1 暂停中
};

CRVideo_NotifyMediaStop.callback = function (UID) {
  // 停止播放,可移除 DOM、销毁组件
};

相关 API 请参考:

观看端

1. 创建影音 UI 组件

var mediaObj = CRVideo_CreatMediaObj({
  controls: true,
});

相关 API 请参考:

2. 观看影音

收到 CRVideo_NotifyMediaStart 后,将组件挂入页面并 setVideo 绑定共享者:

CRVideo_NotifyMediaStart.callback = function (UID) {
  document.getElementById("mediaContainer").appendChild(mediaObj.handler());
  mediaObj.setVideo(UID);  // 观看他人共享时必设;本端自己发起的共享可不设
};

相关 API 请参考:

3. 停止通知与销毁组件

CRVideo_NotifyMediaStop.callback = function (UID) {
  mediaObj.destroy();
  mediaObj = null;
};

相关 API 请参考:

其它接口

  • CRVideo_GetMediaInfo — 查询当前影音共享状态
  • CRVideo_SetMediaVolume — 设置本端播放音量(0~100)

相关 API 请参考: