GCS SDK for H5

调用时机：实例化SDK后调用。用于初始化配置，返回初始化结果。

gcssdk.init({
  accessKey,           // 应用公钥
  token,                  // 用户token
  userId,                 // 用户ID
  sessionId,             // 唯一会话标识
}).then(ready => {
  console.log(ready); // true
}).catch(e => {
  console.log(ready); // false
});

调用时机：init异步结果返回true时调用。

gcssdk.prepare({
  appId, // 应用ID
  appVersion, // 应用版本号
  container, // Dom容器
  projectId, // 项目ID
  idleTime,
}).then(res => {
  console.log('plateformSessionId: ', res.plateformSessionId);
});

调用时机：实例化SDK后调用。监听SDK所有事件，根据消息下行处理相关逻辑。

gcssdk.on('GCSEvent', (res) => {
  const { type, code, message } = res;

  switch (code) {
    case '201010': // 应用运行环境准备完成
      console.log(message);
      break;
    case '902011': // 服务器连接成功
      console.log(message);
      break;
    case '902013': // 通道服务准备就绪
    case '902014': // 通道服务关闭
    default:
      break;
  }
});

调用时机：实例化SDK后调用。解除on方法挂载的事件监听

gcssdk.off('GCSEvent')

调用时机：在收到201010事件后调用。

gcssdk.start();

调用时机：用户需要手动关闭应用时调用。

gcssdk.stop();
gcssdk.stop({ switchContainer: true }); // 切换容器前关闭

调用时机：sdk建立连接后调用。用于建立自定义数据通道，且获得返回参数

function onMessage (evt) {
  console.log(`udpOnMessage: ${evt}`);
}

gcssdk.udpOpen(port, onMessage);

调用时机：自定义数据通道建立后调用。用于发送信息。

gcssdk.udpSend(msg);

调用时机：自定义数据通道建立后调用。用于关闭自定义数据通道

gcssdk.udpClose()

// 键盘按下
document.onkeydown = function(event) {
  const e = event || window.event || arguments.callee.caller.arguments[0];
  e.preventDefault();

  gcssdk.setKeyBoard({
    keyCode: e.keyCode,
    isPressed: true
  });
};

gcssdk.setSize(width, height);

// 鼠标移动
video.onmousemove = function(event) {
  const e = event || window.event || arguments.callee.caller.arguments[0];
  e.preventDefault();
  const x = e.clientX;
  const y = e.clientY;

  gcssdk.setMouse({
    x, y,
    isPressed: false,
    button: 10
  });
};

获取视频流信息，在收到902011事件后调用。

/**
 * 视频流参数stat
 * @param Mbps 
 * @param delay 
 * @param fps 
 * @param resolution 
 * @param rtt 
 */
const onMessage = (stat) => {
  console.log(stat)
}
gcssdk.onStat(onMessage);

创建虚拟摇杆，可在收到201010事件后调用。

const params = {
  joystickImage: {
    back: 'url',
    front: 'base64'
  }
}
// 需保证gcs-sdk-videoBox挂载点存在
gcssdk.JoystickCreate(params);

向虚拟摇杆按钮传入监听事件，在收到902012事件后调用。

const function = (e) => {
  console.log(e)
}
gcssdk.JoystickOn(type, function);

重新拉流。

gcssdk.replay();

设置全屏。

// 开启全屏（建议按需使用contrainterId）
gcssdk.setFullscreen({
  type: 2,
});   

// 取消全屏  
gcssdk.setFullscreen({
  type: 0
});

动态设置比特率，在902012事件后调用。

gcssdk.setBitrate(1000) // 启动时kbps默认值为3000

设置音量。

gcssdk.setVolume(volume);

关闭Rgc服务，在902011事件后调用。

gcssdk.disconnect()