Agora Web API Reference

你可以在以下方法中传入预设值来控制本地音频的编码配置：

• AgoraRTC.createCustomAudioTrack
• AgoraRTC.createMicrophoneAudioTrack
• AgoraRTC.createBufferSourceAudioTrack

下表列出了 SDK 所有内置的音频属性配置，SDK 默认使用 "music_standard"。

• "stopped": 音频源数据处理停止。可能是因为数据处理完毕，也可能是手动触发了停止。
• "playing": 音频源数据正在处理。
• "paused": 音频源数据暂停处理。

可通过以下方法或事件获取：

• [localVideoTrack.on("video-element-visible-status")]{@link ILocalVideoTrack.event_video_element_visible_status}
• localVideoTrack.getVideoElementVisibleStatus
• remoteVideoTrack.on("video-element-visible-status")
• remoteVideoTrack.getVideoElementVisibleStatus

包含以下字段：

• visible: Boolean 型，<video> 标签是否可见。
• reason: 仅当 visible 为 false 时有效，不可见原因：
  • "SIZE": <video> 尺寸太小，导致 <video> 完全不可见或很难看到。
  • "STYLE": <video> 或其祖先元素的 CSS 样式导致 <video> 不可见、颜色暗淡或模糊不清。
  • "POSITION": <video> 或其祖先元素被定位到视口区域外，导致 <video> 只有小面积区域在视口内或全部不在视口内。
  • "COVERED": <video> 被其他元素遮挡。

SDK 和服务器有以下 5 种连接状态:

• "DISCONNECTED": 连接断开。该状态表示用户处于以下任一阶段：
  • 尚未通过 join 加入频道。
  • 已经通过 leave 离开频道。
  • 被踢出频道或者连接失败等异常情况。
• "CONNECTING": 正在连接中。当调用 join 时为此状态。
• "CONNECTED": 已连接。该状态表示用户已经加入频道，可以在频道内发布或订阅媒体流。
• "RECONNECTING": 正在重连中。因网络断开或切换而导致 SDK 与服务器的连接中断，SDK 会自动重连，此时连接状态变为 "RECONNECTING"。
• "DISCONNECTING": 正在断开连接。在调用 leave 的时候为此状态。

• accessPoints：访问节点，包含以下属性：
  • serverList：IP 地址列表或 hostname（主机名，用于指定 SDK 访问的 Agora SD-RTN™ 边缘节点）列表。
  • domain：域名。如果传入的 serverList 为 IP 地址列表，SDK 会拼接传入的 IP 地址和 domain 生成 hostname 列表。此时 domain 用于指定 SDK 接入 Agora SD-RTN™ 的网关。
  • port：（可选）端口号。如果传入，端口号会和 hostname 拼在一起。
• log：（可选）日志上传服务。包含可选属性 hostname 和 port。如果要设置日志上传服务，请确保你已经调用 enableLogUpload 开启 SDK 的日志上传功能。
• report：（可选）事件上报服务。默认关闭。包含可选属性 hostname 和 port。
• cds：预留参数，暂不支持。

可选属性如果不填，将使用对应的默认值：

client.setLocalAccessPointsV2({
  accessPoints: {
    serverList:["192.168.1.1","192.168.2.2"],
    domain: 'test.agora.io'
  },
  // 必须先调用 enableLogUpload，下面的日志服务设置才生效
  log:{
     hostname:"abc.com",
     port: 3000
  },
  // 开启事件上报服务且使用默认值
  report:{}
})

Safari 12.1 之前版本不支持 VP8 编码。

Agora Web SDK 需知道 app 的使用场景（例如通信模式或直播模式），从而使用不同的优化手段。

声网频道支持以下场景:

• "live": 直播场景，有主播和观众两种用户角色，可以通过 setClientRole 方法设置主播和观众的角色。主播可以收发音视频流，而观众只能接收音视频流，无法发送。
• "rtc": 通信场景，用于常见的一对一通话或群聊，频道中的任何用户可以自由说话。

你可以在 AgoraRTC.createScreenVideoTrack 方法中传入以下预设值来控制屏幕共享视频编码配置。

下表列出了 SDK 所有预设的屏幕共享视频属性配置。

为保证最佳的用户体验，声网强烈建议你不要使用字符串作为用户 ID。详见 join 方法中的说明。

你可以在 AgoraRTC.createCameraVideoTrack 方法中传入预设的视频编码配置。

下表列出了 SDK 所有内置的视频属性配置，SDK 默认使用 "480p_1"。