Android API文档
基本功能方法
基本功能事件方法可点击 ChuangLiveEngine查看。
SDK初始化
| 方法 | 描述 |
|---|---|
| initEngine | 初始化引擎 |
| uninitEngine | SDK销毁方法 |
房间管理
| 方法 | 描述 |
|---|---|
| loginRoom | 登录房间 |
| logoutRoom | 退出房间 |
推流功能
| 方法 | 描述 |
|---|---|
| setPreviewCanvas | 设置预览参数 |
| startPreview | 开始预览 |
| stopPreview | 停止预览本地视图 |
| startPublishStream | 开始推本端视频流 |
| stopPublishStream | 停止推本端视频流 |
| muteLocalVideo | 静本地视频流 |
| muteLocalAudio | 静本地音频 |
| enablePublishDirectToCDN | 是否推流至CDN,开始推流前设置有效，推流后设置对当前推流无效 |
| enableTrafficControl | 是否使用流量控制 |
| switchCamera | 前后摄像头切换 |
| setVideoMirrorMode | 预览或拉流端的镜像模式 |
播流功能
| 方法 | 描述 |
|---|---|
| startPlayStream | 开始播远端视频流 |
| stopPlayStream | 停止播远端视频流 |
| muteRemoteAudio | 静远端音频 |
| muteRemoteVideo | 静远端视频流 |
进阶功能【可选】
混流功能
适用于多人互动直播场景，需要将多路视频流混成一路流然后转推出去。
| 方法 | 描述 |
|---|---|
| startMixStream | 开始混流 |
| stopMixStream | 停止混流 |
自定义采集
| 方法 | 描述 |
|---|---|
| enableCustomVideoCapture | 是否启用自定义视频采集及参数设置 |
| enableCustomAudioCapture | 是否启用自定义音频采集及参数设置 |
自定义渲染
| 方法 | 描述 |
|---|---|
| enableCustomAudioRender | 是否启用自定义音频渲染 |
| enableCustomVideoRender | 是否启用自定义视频渲染 |
| enableAEC | 开/关回声消除 |
| enableAGC | 开/关自动增益 |
| enableANS | 开/关噪声抑制 |
音频混音
| 方法 | 描述 |
|---|---|
| enableAudioMixing | 设置是否启动音频混音功能 开启混音后，通过设置 setAudioMixingHandler，为 SDK 提供用于混音的音频数据 |
| setAudioMixingHandler | 设置音频混音回调接口 |
跨房间播流
| 方法 | 描述 |
|---|---|
| startPlayStream | 跨房间播放远端视频流 |
| stopPlayStream | 停止播远端视频流 |
发送流附加消息
| 方法 | 描述 |
|---|---|
| sendStreamAttachedMessage | 发送流附加消息 |
其他
| 方法 | 描述 |
|---|---|
| getSDKVersion | 获取SDK版本号 |
| getRoomConnectState | 主动获取当前连接状态 |
基本事件回调方法
主要回调方法
实现回调接口IChuangEventHandler，会收到回调方法。以下为所有的回调方法：
| 方法 | 描述 |
|---|---|
| onRoomStateUpdate | 房间状态变化通知 |
| onRoomStreamUpdate | 房间流状态变化通知 |
| onPublishStreamStateUpdate | 推流状态变化通知 |
| onPublishStreamVideoSizeChanged | 推流视频分辨率发生改变 |
| onPublishStreamQualityUpdate | 推流质量回调 |
| onPlayStreamQualityUpdate | 播流质量回调 |
| onCaptureSoundLevelUpdate | 推流音量大小回调 |
| onRemoteSoundLevelUpdate | 播流音量大小回调 |
| onPlayStreamStateUpdate | 播流状态回调 |
| onPlayStreamEvent | 播流状态改变回调 |
| onPlayStreamFirstVideo | 播流首帧视频回调 |
| onPlayStreamFirstAudio | 播流首帧音频回调 |
| onPlayStreamStateChanged | 音视频流状态改变回调 |
| onPlayStreamVideoSizeChanged | 播放流视频分辨率改变回调（首次播放时也会回调） |
| onPlayStreamVideoRotationChanged | 播放流视频方向发生改变 |
| onReceiveStreamAttchedMessage | 收到推流附加消息 |
| onMixStreamResult | 混流回调 |
| onNetworkSpeedTestQualityUpdate | 网络测速回调 |
| onNetworkTypeChanged | 网络状态变化回调 |
| onPublishStreamRenderFirstVideo | 当sdk内部渲染出第一帧推流视频时回调 |
| onPublishStreamFirstVideo | 发送首帧视频时回调 |
| onPublishStreamFirstAudio | 发送首帧音频时回调 |
接口链接：