API Reference for windows - 概览
更新时间: 2023-10-23 16:45:52
# 概览
# 核心方法
| 名称 | 描述 |
|---|---|
| initWithToken() | 引擎创建 |
| joinRoom() | 加入频道 |
| leaveRoom() | 离开频道 |
| publish() | 开始推流 |
| setClientRole() | 设置用户的角色 |
# 核心事件
| 名称 | 描述 |
|---|---|
| registerAudioFrameObserver() | 注册音频帧观察对象 |
| registerVideoFrameObserver() | 注册视频帧观察对象 |
| getVersion() | 获取版本号 |
| registerLogFunc() | 此接口暂不支持 |
| registerEventHandler() | 注册事件处理器 |
| enableLastmileTest() | 启动网络测试 |
| disableLastmileTest() | 停止网络测试 |
| enableLoopbackRecording() | 是否开启声卡采集 |
| initChannelToken() | 初始化token获取仅用于拉流的channel对象 |
| setConfig() | 设置私有接口 |
| setLogFileConfig() | 设置日志存储路径和日志大小 |
# 音视频控制
| 名称 | 描述 |
|---|---|
| enableLocalVideo() | 开启/关闭本地视频采集。 |
| enableLocalAudio() | 开启/关闭本地音频采集。 |
| muteLocalVideo() | 是否发送视频 |
| muteLocalAudio() | 是否发送音频 |
| muteRemoteVideo() | 是否接受远程视频 |
| muteRemoteAudio() | 是否接受远程音频 远方用户加入 |
| muteAllRemoteVideo() | 是否接受所有远程视频 |
| muteAllRemoteAudio() | 是否接受所有远程音频 |
| setRemoteVolume() | 控制本地播放远端的音量 |
# 跨频道媒体流转发
| 名称 | 描述 |
|---|---|
| startChannelMediaRelay() | 开始跨房间推流 |
| updateChannelMediaRelay() | 更新跨房间推流 |
| stopChannelMediaRelay() | 停止跨房间推流 |
# 入会控制
| 名称 | 描述 |
|---|---|
| onJoinedRoom() | 加入频道回调 |
| onLeaveRoom() | 退出频道回调 |
| onClientRoleChanged() | 自己在房间的角色发生变化 |
| onUserJoined() | 有用户加入房间 |
| onUserOffline() | 有用户退出房间 |
# 数据统计事件
| 名称 | 描述 |
|---|---|
| onConnectionStateChanged() | 网络连接状态已改变回调 |
| onAudioDeviceStateChanged() | 音频设备状态 |
| onVideoDeviceStateChanged() | 视频设备状态 |
| onError() | LiveRoom 内部一些处理结果通知 |
| onRTCStats() | 每两秒钟报告一次当前呼叫会话的统计信息 |
# 本地媒体事件
| 名称 | 描述 |
|---|---|
| onFirstLocalVideoFrame() | 在引擎收到并绘制第一视频帧的时候调用 |
| onFirstLocalAudioFrame() | 发送第一个本地音频帧时调用 |
| onFirstRemoteVideoFrame() | 收到远程用户共享的第一帧视频 |
| onFirstRemoteAudioFrame() | 收到远程用户共享的第一帧音频 |
# 数据统计事件
| 名称 | 描述 |
|---|---|
| onStopCloudRecordStateChanged() | 云录制状态回调 |
| onEngineChangeNotify() | 用户被踢通知 |
| onNetworkQuality() | 网络上下行last mile 质量报告回调 |
| onLocalVideoStats() | 本地视频流统计信息回调 |
| onStreamMessage() | irc信息 |
| onChannelMediaRelayStateChanged() | 跨频道媒体流转发状态发生改变回调 |
| onChannelMediaRelayEvent() | 跨频道媒体流转发事件回调 |
| onRemoteStreamSubscribeAdvice() | 建议设置的流类型 |
| onAudioDeviceVolumeChanged() | 本地音频设备音量回调 |
| onAudioPublishStateChange() | 音频发布状态改变回调 |
| onVideoPublishStateChange() | 视频发布状态改变回调。 |
| onAudioSubscribeStateChange() | 音频订阅状态发生改变回调 |
| onStopCloudRecordStateChanged() | 云录制状态回调 |
| onVideoSubscribeStateChange() | 视频订阅状态发生改变回调 |
| onLocalAudioStats() | 通话中本地音频流的统计信息回调 |
