API 概览
ArRTC
ArRTCClient
LocalTrack
RemoteTrack
状态码

类型别名

最近更新时间：2022-09-20 05:17:40

AudioEncoderConfigurationPreset
AudioSourceState
ClientRole
ConnectionState
DeviceState
EncryptionMode
SDK_CODEC
SDK_MODE
ScreenEncoderConfigurationPreset
ScreenSourceType
UID
VideoEncoderConfigurationPreset
Variables
Const AUDIO_ENCODER_CONFIG_SETTINGS
Const ArRTC
Const SUPPORT_SCREEN_ENCODER_CONFIG_LIST
Const SUPPORT_VIDEO_ENCODER_CONFIG_LIST

AudioEncoderConfigurationPreset

AudioEncoderConfigurationPreset: keyof object

SDK 预设的 AudioEncoderConfiguration 配置。

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

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

音频属性配置
"speech_low_quality"16 kHz 采样率，单声道，编码码率约 24 Kbps
"speech_standard"32 kHz 采样率，单声道，编码码率约 24 Kbps
"music_standard"48 kHz 采样率，单声道，编码码率约 40 Kbps
"standard_stereo"48 kHz 采样率，双声道，编码码率约 64 Kbps
"high_quality"48 kHz 采样率，单声道， 编码码率约 128 Kbps
"high_quality_stereo"48 kHz 采样率，双声道，编码码率约 192 Kbps

AudioSourceState

AudioSourceState: "stopped" | "playing" | "paused"

音频源数据处理状态，通过 BufferSourceAudioTrack.on("source-state-change") 获取。

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

ClientRole

ClientRole: "audience" | "host"

用户角色。

  • "host": 直播场景中的主播，可以发布和订阅音视频轨道。
  • "audience": 直播场景中的观众，只能订阅，不能发布音视频轨道。

ConnectionState

ConnectionState: "DISCONNECTED" | "CONNECTING" | "RECONNECTING" | "CONNECTED" | "DISCONNECTING"

SDK 和 anyRTC 服务器的连接状态，可以通过 connectionState 获取。

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

  • "DISCONNECTED": 连接断开。该状态表示用户处于以下任一阶段：

    • 尚未通过 join 加入频道。
    • 已经通过 leave 离开频道。
    • 被踢出频道或者连接失败等异常情况。

  • "CONNECTING": 正在连接中。当调用 join 时为此状态。

  • "CONNECTED": 已连接。该状态表示用户已经加入频道，可以在频道内发布或订阅媒体流。

  • "RECONNECTING": 正在重连中。因网络断开或切换而导致 SDK 与服务器的连接中断，SDK 会自动重连，此时连接状态变为 "RECONNECTING"。

  • "DISCONNECTING": 正在断开连接。在调用 leave 的时候为此状态。

DeviceState

DeviceState: "ACTIVE" | "INACTIVE"

采集设备当前的插拔状态。

  • "ACTIVE": 该设备已经插入。
  • "INACTIVE": 该设备已经被拔出。

EncryptionMode

EncryptionMode: "aes-128-ecb" | "none"

暂时仅支持 aes-128-ecb。

加密方案，在调用 setEncryptionConfig 时使用。包含以下几种：

  • "aes-128-ecb": 128 位 AES 加密，ECB 模式。
  • "none": 不加密。

SDK_CODEC

SDK_CODEC: "h264" | "vp8"

浏览器使用的编码格式，有以下两种选择：

  • "vp8": 浏览器使用 VP8 编码。
  • "h264": 浏览器使用 H.264 编码。

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

SDK_MODE

SDK_MODE: "live" | "rtc"

频道场景。

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

anyRTC 频道支持以下场景:

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

ScreenEncoderConfigurationPreset

ScreenEncoderConfigurationPreset: keyof object

SDK 预设的 VideoEncoderConfiguration 配置。

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

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

视频属性分辨率（宽×高）帧率（fps）
480p640 × 4805
480p_1640 × 4805
480p_2640 × 48030
720p1280 × 7205
720p_11280 × 7205
720p_21280 × 72030
1080p1920 × 10805
1080p_11920 × 10805
1080p_21920 × 108030

ScreenSourceType

ScreenSourceType: "screen" | "window" | "application"

屏幕共享源的类型。

  • "screen": 共享屏幕。
  • "application": 共享某一个 app 的所有窗口。
  • "window": 共享某一个 app 的某一个窗口。

UID

UID: number | string

用于标识用户的 ID。同一频道中每个用户都具有唯一的 ID，且数据类型相同。

VideoEncoderConfigurationPreset

VideoEncoderConfigurationPreset: keyof object

SDK 预设的 VideoEncoderConfiguration 配置。

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

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

视频属性分辨率（宽×高）帧率（fps）码率（Kbps）ChromeFirefoxSafari
120p160 × 1201565✓
120p_1160 × 1201565✓
120p_3120 × 1201550✓
180p320 × 18015140✓
180p_1320 × 18015140✓
180p_3180 × 18015100✓
180p_4240 × 18015120✓
240p320 × 24015200✓
240p_1320 × 24015200✓
240p_3240 × 24015140✓
240p_4424 × 24015220✓
360p640 × 36015400✓
360p_1640 × 36015400✓
360p_3360 × 36015260✓
360p_4640 × 36030600✓
360p_6360 × 36030400✓
360p_7480 × 36015320✓
360p_8480 × 36030490✓
360p_9640 × 36015800✓
360p_10640 × 36024800✓
360p_11640 × 360241000✓
480p640 × 48015500✓✓✓
480p_1640 × 48015500✓✓✓
480p_2640 × 480301000✓✓✓
480p_3480 × 48015400✓✓✓
480p_4640 × 48030750✓✓✓
480p_6480 × 48030600✓✓✓
480p_8848 × 48015610✓✓✓
480p_9848 × 48030930✓✓✓
480p_10640 × 48010400✓✓✓
720p1280 × 720151130✓✓✓
720p_11280 × 720151130✓✓✓
720p_21280 × 720302000✓✓✓
720p_31280 × 720301710✓✓✓
720p_5960 × 72015910✓✓✓
720p_6960 × 720301380✓✓✓
1080p1920 × 1080152080✓✓
1080p_11920 × 1080152080✓✓
1080p_21920 × 1080303000✓✓
1080p_31920 × 1080303150✓✓
1080p_51920 × 1080604780✓✓
1440p2560 × 1440304850✓✓
1440p_12560 × 1440304850✓✓
1440p_22560 × 1440607350✓✓
4K3840 × 2160308910✓✓
4K_13840 × 2160308910✓✓
4K_33840 × 21606013500✓✓

Variables

Const AUDIO_ENCODER_CONFIG_SETTINGS

AUDIO_ENCODER_CONFIG_SETTINGS: object

Type declaration

Const ArRTC

ArRTC: ArRTC

Const SUPPORT_SCREEN_ENCODER_CONFIG_LIST

SUPPORT_SCREEN_ENCODER_CONFIG_LIST: object

Type declaration

Const SUPPORT_VIDEO_ENCODER_CONFIG_LIST

SUPPORT_VIDEO_ENCODER_CONFIG_LIST: object

Type declaration