zby-live-sdk/QUICKSTART.md

This is a live SDK for weclassroom.

```javascript
import zbysdk from 'zby-live-sdk'

// 初始化sdk
zbysdk.init({
    ...configs
}, ({type, data}) => {
    // callbacks
    if (type === 'sdk_status') {
        // sdk状态相关通知
        if (data.status === 'before_init') {
            // 准备初始化
        } else if (data.status === 'init_finished') {
            // 初始化完成
        } else if (data.status === OTHER_STATUS) {
            // 其他状态，具体取值可以搜在zby-live-sdk.js里搜sdkStatus查看
        }
    } else if (type === 'firstVideoSize') {
        // 首帧回调
    }
})
// 打开摄像头
zbysdk.openOrCloseCamera(true);
// 开始预览
zbysdk.getOrLocateVideo({
    domId: 'video-dom-id',
    isLocal: true,
    streamId: '2020_roomId_userId_1'
});
// 推摄像头流
zbysdk.startPushFlow();

// 推屏幕流，屏幕流streamId为五段式固定格式，idx固定为1
zbysdk.startPushFlow('2020_roomId_userId_liveId_1', 1);

// 拉流, 
zbysdk.initPullFlow({
    userId: 'userId', // 不传streamId时必须传
    groupId: 'groupId', // 不传streamId时必须传
    streamId: '2020_roomId_userId_1', // 可选项，有值时优先级高于userId + groupId
    domId: 'video-dom-id', // 如果传了domId，自动播放视频
    audioOnly: false, // 只拉音频
    mute: false, // 只拉视频
    notAutoPlay: false // 自动拉流，对应底层StartPlay，true不调用，false调用
});

// 停止拉流
zbysdk.stopPullFlow(userId, groupId, recovery, streamId)
```