@urtc/sdk-web

通用错误及代码

• 1000 - 非法参数
• 1001 - 非法操作
• 1002 - 不支持
• 1003 - 不存在
• 1004 - 请求失败
• 1999 - 其他错误

房间相关错误及代码

• 2000 - 网关不可达
• 2001 - 获取 Access Token 失败
• 2002 - Access Token 非法
• 2003 - Websocket 连接失败
• 2004 - 加入房间失败
• 2005 - 未加入房间
• 2006 - 正在加入房间
• 2007 - 正在离开房间
• 2008 - 角色类型不匹配
• 2009 - 信令服务器地址错误

流相关错误及代码

• 3000 - 流不存在
• 3001 - 同类型的流已存在
• 3002 - 音频不存在
• 3003 - 视频不存在
• 3004 - [中止错误] 尽管用户和操作系统都授予了访问设备硬件的权利，而且未出现可能抛出NotReadableError异常的硬件问题，但仍然有一些问题的出现导致了设备无法被使用。
• 3005 - [拒绝错误] 用户拒绝了当前的浏览器实例的访问请求；或者用户拒绝了当前会话的访问；或者用户在全局范围内拒绝了所有媒体访问请求。
• 3006 - [找不到错误] 找不到满足请求参数的媒体类型。
• 3007 - [无法读取错误] 尽管用户已经授权使用相应的设备，操作系统上某个硬件、浏览器或者网页层面发生的错误导致设备无法被访问。
• 3008 - [无法满足要求错误] 指定的要求无法被设备满足。
• 3009 - 流连接失败
• 3010 - 流正在重连
• 3011 - 流尚未发布
• 3012 - 流正在发布
• 3013 - 流正在取消发布
• 3014 - 流已经发布
• 3015 - 流尚未订阅
• 3016 - 流正在订阅
• 3017 - 流正在取消订阅
• 3018 - 流已经订阅
• 3019 - 自动播放被禁止错误

连接事件

• connection-state-changed - 连接状态改变

example

client.on('connection-state-changed', (event) => {
  console.log(`连接状态：${event.data.previous} => ${event.data.current}`);
});

example

stream.on('player-status-change', (event) => {
  const { data } = event;
  const { type, status } = data;
  console.log(`stream's ${type} status changed to ${status}`);
});

example

client.on('stream-add', (event) => {
  client.subscribe(event.data);
});

特别地，以下事件需在单条流上进行监听

• screenshare-stopped - 屏幕共享流被中止，此时事件中的 data 为 LocalStream 本地流
• first-key-frame - 接收到远端流的首帧

example

localStream.on('screenshare-stopped', (event) => {
  // 此事件只针对本地流有效，若本地流已发布，监听到此事件后，可以决定要不要取消发布
  client.unpublish(event.data);
  event.data.destroy();
});

example

stream.on('first-key-frame', (event) => {
  console.log(`stream ${event.data} got first key frame`);
});

用户事件

• user-joined - 有用户加入房间
• user-left - 有用户离开房间
• kick-off - 当前用户被踢出房间

example

client.on('user-joined', (event) => {
  console.log(`用户 ${event.data.id} 加入`);
});