Electron API文档

基本功能方法

基本功能事件方法可点击 ChuangLiveEngine查看。

初始化

描述 方法
ChuangLiveEngine::initEngine 初始化SDK
ChuangLiveEngine::unInitEngine 释放SDK资源

房间管理

方法 描述
ChuangLiveEngine::loginRoom 登录房间
ChuangLiveEngine::logoutRoom 登出房间

播流

方法 描述
ChuangLiveEngine::startPlayStream 播流.
ChuangLiveEngine::stopPlayStream 停止播流
eventtype::onPlayStreamStateUpdate 播流状态回调

推流

方法 描述
ChuangLiveEngine::startPublishStream 开始推流.
ChuangLiveEngine::stopPublishStream 停止推流
eventtype::onPublishStreamStateUpdate 推流状态回调
ChuangLiveEngine::startPublishStream(ChuangVideoCanvas)，ChuangVideoCanvas.rtmpAddress值为存在的RTMP服务器地址，在推流时会同时RTMP推流。

SDK相关设置参数

方法 描述
ChuangLiveEngine::setVideoConfig 设置视频信息
ChuangLiveEngine::setAudioConfig 设置音频信息

流附加消息

方法 描述
ChuangLiveEngine::sendStreamAttachedMessage 发送流附加消息
eventtype::onReceiveStreamAttchedMessage 流附加消息接收回调

音频前控制

方法 描述
ChuangLiveEngine::enableAEC 开/关回声消除
ChuangLiveEngine::enableAGC 开/关自动增益
ChuangLiveEngine::enableANS 开/关噪声抑制

进阶功能【可选】

混流功能

适用于多人互动直播场景，需要将多路视频流混成一路流然后转推出去。

方法 描述
ChuangLiveEngine::startMixStream 开始混流
ChuangLiveEngine::stopMixStream 停止混流
ChuangLiveEngine::startMixStream(mixConfig)，参数 mixConfig.target值为存在的RTMP服务器地址，ChuangLiveEngine::startMixStream()会推RTMP流。

自定义外部视频采集

方法 描述
ChuangLiveEngine::enableCustomVideoCapture 视频自定义采集开关及参数设置
ChuangLiveEngine::setCustomVideoCaptureHandler 设置视频自定义采集接口回调
ChuangLiveEngine::sendCustomVideoCaptureRawData 向sdk发送视频帧数据
ChuangLiveEngine::sendCustomVideoCaptureEncodedData 向sdk发送h264数据

自定义外部音频采集

方法 描述
ChuangLiveEngine::enableCustomAudioCapture 音频自定义采集开关及参数设置
ChuangLiveEngine::sendCustomAudioCapturePCMData 向sdk发送音频数据

外部视频渲染

方法 描述
ChuangLiveEngine::enableCustomLocalVideoRender 开启本地流外部渲染
ChuangLiveEngine::enableCustomRemoteVideoRender 开/关远端流外部视频渲染
ChuangLiveEngine::setCustomVideoRenderHandler 设置外部渲染视频接口句柄

外部音频渲染

方法 描述
ChuangLiveEngine::enableCustomAudioRender 开/关外部音频渲染
ChuangLiveEngine::fetchCustomAudioRenderPCMData 从sdk获取音频数据

基本事件回调方法

方法 描述
eventtype::onAudioRouteChange 音频路由变化回调
eventtype::onCaptureSoundLevelUpdate 采集音量大小回调
eventtype::onFirstLocalAudioFramePublished 发送本地首帧音频回调
eventtype::onFirstLocalVideoFramePublished 发送本地首帧视频回调
eventtype::onNetworkSpeedTestQualityUpdate 网络测速回调
eventtype::onNetworkTypeChanged 网络状态变化回调
eventtype::onPlayStreamEvent 播流回调通知
eventtype::onPlayStreamFirstAudio 播流收到第一帧音频回调
eventtype::onPlayStreamFirstAudioDecoded 当前流解码第一帧音频回调
eventtype::onPlayStreamFirstVideo 播流收到第一帧视频回调
eventtype::onPlayStreamQualityUpdate 播流质量通知
eventtype::onPlayStreamStateChanged 播流状态改变通知
eventtype::onPlayStreamStateUpdate 播流状态回调
eventtype::onPlayStreamVideoRotationChanged 播流视频方向旋转改变通知
eventtype::onPlayStreamVideoSizeChanged 播流宽高改变通知
eventtype::onPublishStreamQualityUpdate 推流质量回调
eventtype::onPublishStreamStateUpdate 推流状态变化通知
eventtype::onPublishStreamVideoSizeChanged 推流宽高变化通知
eventtype::onReceiveStreamAttchedMessage 收到推流附加消息
eventtype::onRoomStateUpdate 房间状态变化通知
eventtype::onRoomStreamUpdate 房间流状态变化通知
eventtype::onMixStreamResult 混流结果回调

接口链接：

results matching ""

    No results matching ""