Web API文档
基本功能方法
基本功能事件方法可点击 ChuangLiveEngine查看。
初始化
| 方法 | 描述 |
|---|---|
| initEngine | SDK初始化方法 | uninitEngine | SDK取消初始化(销毁)方法 |
房间管理
| 方法 | 描述 |
|---|---|
| loginRoom | 登录房间 |
| logoutRoom | 登出房间 |
推流功能
| 方法 | 描述 |
|---|---|
| startPublishStream | 开始推本端视频流,参数ChuangStreamConfig详情看ChuangStreamConfig |
| stopPublishStream | 停止推本端音视频流 |
| muteLocalAudio | 设置本端音频是否静音 |
| muteLocalVideo | 设置本端视频是否静音 |
| 注意:调用推流接口startPublishStream,如果推流的同时开启rtmp推流,则需要给推流接口的streamConfig中的RtmpAddress传rtmp地址,不开启则地址传空 | |
播流功能
| 方法 | 描述 |
|---|---|
| startPlayStream | 开始播远端音视频流 |
| stopPlayStream | 停止播远端音视频流 | muteRemoteAudio | 设置远端音频是否静音 |
| muteRemoteVideo | 设置远端视频是否静音 |
进阶功能【可选】
混流功能
适用于多人互动直播场景,需要将多路流混成一路流然后转推出去。
| 方法 | 描述 |
|---|---|
| startMixStream | 开始混流,参数mixConfig详情看ChuangMixStreamConfig |
| stopMixStream | 停止混流 |
| updateMixStream | 更新混流布局方法,混流期间房间流变化需更新混流布局 |
| 注意:调用上面混流接口startMixStream,如果混流后转推rtmp,则需要给混流接口的mixStreams传混流的rtmp地址,不开启则地址传空 | |
跨房间播流
| 方法 | 描述 |
|---|---|
| startPlayRoomStream | 开始跨房间播流 |
| stopPlayRoomStream | 停止跨房间播流 |
事件回调
设置事件监听
在demo层调用 on (eventType, callback)方法注册回调事件, 调用off (eventType, callback)销毁回调事件。
| 方法 | 描述 |
|---|---|
| on | 注册SDK回调事件 |
| off | 注销SDK回调事件 |
接口链接: