Appearance
AliRtcEngine
AliRtcEngine 是阿里云 ARTC Web SDK 的核心类，提供所有 RTC 功能的入口。
静态方法
静态方法可以在不创建实例的情况下直接调用。
浏览器兼容性检查
- isSupported - 检查浏览器是否支持 WebRTC
设备列表获取
- getCameraList - 获取摄像头设备列表
- getMicrophoneList - 获取麦克风设备列表
- getSpeakerList - 获取扬声器设备列表
SDK 信息
- getSdkVersion - 获取 SDK 版本号
- setLogLevel - 设置日志输出等级
实例管理
- getInstance - 获取 AliRtcEngine 实例（单例模式）
频道管理
加入频道
- joinChannel - 加入频道的主要方法
离开频道
- leaveChannel - 离开当前频道
频道配置
- setChannelProfile - 设置频道模式
- setClientRole - 设置用户角色（仅互动直播模式）
- setDefaultSubscribeAllRemoteAudioStreams - 设置是否默认订阅所有远端音频流
- setDefaultSubscribeAllRemoteVideoStreams - 设置是否默认订阅所有远端视频流
- setRemoteDefaultVideoStreamType - 设置默认订阅的视频流类型
- setRemoteUserVideoStreamType - 设置特定用户的视频流类型
用户信息
- getOnlineRemoteUsers - 获取在线远端用户列表
- getUserInfo - 获取指定用户的信息
- isUserOnline - 检查指定用户是否在线
- channel - 获取当前频道号（属性）
- userId - 获取当前用户的 userId（属性）
- remoteUsers - 获取远端用户列表（属性）
媒体流管理
设备管理
音频设备
- getCurrentMicDeviceId - 获取当前使用的麦克风设备 ID
- switchMicrophone - 切换麦克风设备
- startAudioCapture - 开始音频采集
- stopAudioCapture - 停止音频采集
- setAudioConstraints - 设置音频采集参数
视频设备
- switchCamera - 切换摄像头
- startPreview - 开始本地视频预览
- stopPreview - 停止本地视频预览
- setCameraCapturerConfiguration - 设置摄像头采集配置
- enableLocalVideo - 启用或禁用本地视频
- setCameraCapturerContentHint - 设置摄像头采集内容提示
- getCurrentCameraDeviceId - 获取当前摄像头设备 ID
- isCameraOn - 检查摄像头是否开启
- muteLocalCamera - 静音/取消静音本地摄像头
媒体流发布
音频发布
- publishLocalAudioStream - 设置是否推送音频流
- isLocalAudioStreamPublished - 查询是否设置推送音频流
- muteLocalMic - 静音/取消静音本地麦克风
视频发布
- publishLocalVideoStream - 设置是否推送视频流
- isLocalVideoStreamPublished - 查询是否设置推送视频流
- muteLocalCamera - 静音/取消静音本地摄像头
- setLocalViewConfig - 设置本地预览视图
- muteLocalScreen - 静音/取消静音本地屏幕共享
- setEnableDualVideoStream - 设置是否开启大小流
屏幕共享发布
- publishLocalScreenShareStream - 控制屏幕共享流的发布状态
音频参数设置
- setAudioProfile - 设置音频编码属性
媒体流订阅
音频订阅
- setDefaultSubscribeAllRemoteAudioStreams - 设置是否默认订阅所有远端音频流
- subscribeAllRemoteAudioStreams - 订阅/取消订阅所有远端音频流
- subscribeRemoteAudioStream - 订阅/取消订阅指定远端用户的音频流
- setRemoteAudioVolume - 设置远端用户的音频播放音量
视频订阅
- setDefaultSubscribeAllRemoteVideoStreams - 设置是否默认订阅所有远端视频流
- subscribeAllRemoteVideoStreams - 订阅/取消订阅所有远端视频流
- subscribeRemoteVideoStream - 订阅/取消订阅指定远端用户的视频流
- setRemoteViewConfig - 设置远端视频渲染视图
- setRemoteVideoStreamType - 设置订阅的视频流类型
媒体设置
通用设置
- setAudioOnlyMode - 设置纯音频模式
- isAudioOnly - 检查当前是否为纯音频模式
音频设置
- setAudioRedEnabled - 设置是否启用音频冗余
- setRecordingVolume - 设置录音音量
视频设置
- setVideoCodec - 设置视频编解码器
- enableAudioVolumeIndication - 启用音量提示
屏幕共享
- startScreenShare - 开始屏幕共享
- stopScreenShare - 停止屏幕共享
- setScreenShareConfiguration - 设置屏幕共享编码配置
- setScreenShareContentHint - 设置屏幕共享内容提示
- publishLocalScreenShareStream - 控制屏幕共享流的发布状态
- isScreenSharePublished - 查询是否正在发布屏幕共享
- startPreviewScreen - 开始屏幕共享预览
- stopPreviewScreen - 停止屏幕共享预览
- setAudioShareVolume - 设置共享音频的音量大小
数据通道
- sendDataChannelMessage - 通过数据通道发送消息
- sendMediaExtensionMsg - 发送媒体扩展消息
美颜与特效
- setBeautyEffect - 设置美颜效果
事件监听
连接事件
- connectionStatusChange - 监听连接状态变化事件
- bye - 被服务器踢出/会议结束频道的消息
用户事件
- remoteUserOnLineNotify - 远端用户上线通知事件
- remoteUserOffLineNotify - 远端用户下线通知事件
- remoteUserAudioMuted - 远端用户音频静音状态变化事件
- remoteUserVideoMuted - 远端用户视频静音状态变化事件
- remoteUserScreenShareMuted - 远端用户屏幕共享状态变化事件
发布订阅事件
- audioPublishStateChanged - 音频推流变更回调
- videoPublishStateChanged - 视频推流变更回调
- dualStreamPublishStateChanged - 次要流推流变更回调
- screenSharePublishStateChanged - 屏幕分享推流变更回调
- dataPublishStateChanged - DataChannel 推流变更回调
- audioSubscribeStateChanged - 音频订阅情况变更回调
- videoSubscribeStateChanged - 相机流订阅情况变更回调
- subscribeStreamTypeChanged - 大小流订阅情况变更回调
- screenShareSubscribeStateChanged - 屏幕分享流订阅情况变更回调
- dataSubscribeStateChanged - DataChannel 订阅情况变更回调
媒体事件
- audioVolume - 音量指示事件
- localDeviceException - 本地设备异常事件
用户媒体事件
- remoteTrackAvailableNotify - 远端用户的音视频流发生变化回调
- userAudioMuted - 远端用户静音/取消静音回调
- userVideoMuted - 对端用户发送视频黑帧数据发送通知
- userScreenMuted - 对端用户发送屏幕黑帧数据发送通知
- remoteAudioAutoPlayFail - 远程用户的音频自动播放失败
- remoteVideoAutoPlayFail - 远程用户的视频自动播放失败
- remoteAudioPlayError - 远程用户的音频播放出错
- remoteVideoPlayError - 远程用户的视频播放出错
数据通道事件
- mediaExtensionMsgReceived - 收到媒体扩展信息回调
- remoteUserSubscribedDataChannel - 远程用户订阅数据通道
- dataChannelMsg - 收到数据通道消息
统计事件
- rtcStats - rtc 传输数据统计
- rtcLocalVideoStats - 发布视频流的数据统计
- rtcLocalAudioStats - 发布音频流的数据统计
- rtcRemoteVideoStats - 订阅视频流的数据统计
- rtcRemoteAudioStats - 订阅远端音频流的数据统计
错误事件
- occurError - 错误通知
鉴权事件
- authInfoWillExpire - 用户鉴权信息即将过期通知
- authInfoExpired - 用户调用需要鉴权的接口，服务端返回信息过期
直播转码
转码配置
- updateLiveTranscoding - 更新直播转码配置