JRTC Dart API Reference for Flutter 4.0.3
概况
- JRTCExpressEngine SDK的核心接口类，实现实时音视频的主要功能
- JRTCErrorCode 错误码
初始化相关的前置功能
| 方法 | 描述 |
|---|---|
| createEngine | 初始化SDK |
| destroyEngine | 释放资源 |
| setMediaConfig | 设置媒体配置 |
设备管理
| 方法 | 描述 |
|---|---|
| getCamera | 获取当前已打开的摄像头或者默认摄像头 |
| getAllCameras | 获取摄像头列表 |
| switchCamera | 切换摄像头 |
| enableAudioOutput | 开启/关闭音频输出，本地禁音 |
| enableSpeaker | 开启/关闭扬声器 |
| setCameraFocus | 设置触屏对焦 |
| getCameraMaxZoom | 获取摄像头支持的最大变焦倍数 |
| setCameraZoom | 设置摄像头变焦倍数 |
| isCameraTorchSupported | 查询摄像头是否支持闪光灯 |
| setCameraTorchOn | 设置是否打开闪光灯 |
| setCameraExposureLevel | 设置手动曝光度 |
| getAudioRoute | 获取音频路由 |
频道管理
| 方法 | 描述 |
|---|---|
| joinChannel | 创建并加入频道 |
| leaveChannel | 离开频道 |
音视频管理
| 方法 | 描述 |
|---|---|
| startLocalVideoDevice | 启动视频模块，是否开启本地视频采集并渲染 |
| publishLocalAudioStream | 开启或关闭发送本地音频流 |
| publishLocalVideoStream | 开启或关闭发送本地视频流 |
| playRemoteAudioStream | 订阅或取消订阅指定用户音频，并播放 |
| playRemoteVideoStream | 开始或停止渲染视频对象 |
| muteLocalAudioStream | 是否发送静音包 |
| muteLocalVideoStream | 是否停止本地视频流 |
| getStatistics | 获得当前通话统计信息 |
频道消息管理
| 方法 | 描述 |
|---|---|
| sendMessage | 发送文本消息 |
屏幕共享
| 方法 | 描述 |
|---|---|
| enableScreenShare | 开关屏幕分享 |
| startScreenShareVideo | 启动屏幕共享视频渲染 |
日志
| 方法 | 描述 |
|---|---|
| uploadLog | 上传日志 |
| info | 打印info等级的日志 |
| debug | 打印debug等级的日志 |
| error | 打印error等级的日志 |
网络
| 方法 | 描述 |
|---|---|
| getNetType | 获取网络类型 |
| hasNet | 是否有网 |
媒体高级功能
| 方法 | 描述 |
|---|---|
| enableVideoFile | 启动视频文件输入源 |
| inputVideoFileFrame | 输入视频文件数据 |
| inputCustomAudioData | 将音频输入数据输入到媒体层 |
| getAudioOutputData | 获取音频输出数据 |
| setLocalCaptureAngle | 设置本地视频采集窗体角度 |
| setRenderMirror | 设置本地渲染的画面镜像 |
| setRenderEffect | 设置渲染特效 |
| freezeRenderEffect | 是否冻结渲染 |
| takeOnceSnapshot | 视频通话单次截图 |
| setRenderAngle | 设置远端视频在本地渲染的旋转角度 |
| getMinExposureCompensation | 获取摄像头曝光补偿最小值 |
| getMaxExposureCompensation | 获取摄像头曝光补偿最大值 |
| getExposureCompensationStep | 获取摄像头曝光补偿步长 |
频道事件
| 方法 | 描述 |
|---|---|
| onSelfJoinStateChange | 自身状态变化回调 |
| onChannelUpdate | 频道属性变化回调 |
| onSelfJoined | 加入频道结果回调 |
| onSelfLeft | 离开频道结果回调 |
| onOtherJoined | 成员加入回调 |
| onOtherLeft | 成员离开回调 |
| onUserUpdate | 成员更新回调 |
| onMessageReceived | 接收频道消息的回调 |
| onVolumeChange | 成员声音变化回调 |
| onError | SDK 运行时出现的错误回调 |
| onCameraUpdate | 摄像头变化回调 |
| onAudioOutputTypeChange | 音频输出类型变化回调 |
| onRenderReceived | 收到第一帧数据回调 |
| onRenderStart | 渲染开始回调 |
| onVideoError | 视频渲染错误回调 |
| onNeedKeyFrame | 标记下一次输入关键帧回调 |
其他
| 方法 | 描述 |
|---|---|
| getSdkVersion | 获取当前SDK的版本号 |