混流

简介

混流是把多路音视频流从云端混合成单流的技术。

主播端和观众端均可主动触发混流。SDK 既支持音视频混流，也支持纯音频混流。本文主要以主播端及观众端推流后混流为例，其他时机时设置混流的步骤类似，不再赘述。

SDK 对设置混流的时机没有硬性要求，建议开发者在拉流/推流后，或根据需求，在其他合适时机进行混流。

混流方式分类

ZEGO 支持手动混流、自动混流和全自动混流三种方式，三种混流方式的区别如下：

前提条件

在设置混流前，请确保已在项目中实现了基本的音视频推拉流功能，详情请参考 微信小程序 - 集成 SDK 和 微信小程序 - 实现流程。

手动混流步骤

按照上述流程，SDK API 调用过程如下所示。

1 设置混流配置

1.1 混流配置参数

开发者可以调用 ZegoMixStreamConfig 设置混流相关的参数。taskID 为混流任务 ID，由开发者自定义，须保证是唯一的。inputList 为输入流列表，列表中是 ZegoMixStreamInput 对象，表示为 streamID 的流，根据所需的输入流个数构建 N 个 ZegoMixStreamInput 放入输入流列表。

1.2 输入流使用示例

ZegoMixStreamInput 的使用示例：假设指定某条流的左上角坐标为（50，300），右下角坐标为（200，450），这条流在最终的输出混流中的位置如下所示：

下面代码仅供参考：

 /**
     *  原点在左上角，top/bottom/left/right 定义如下：
     *
     *  (left, top)-----------------------
     *  |                                |
     *  |                                |
     *  |                                |
     *  |                                |
     *  -------------------(right, bottom)
     */


const inputList = [{
        streamID: this.data.pushStreamID,
        layout: {
                top: 0,
                left: 0,
                bottom: 480,
                right: 640,
        }
}];
if (this.data.livePlayerList.length > 0) {
        const playerStream = this.data.livePlayerList[0]
        inputList.push({
                streamID: playerStream.streamID,
                layout: {
                        top: 480,
                        left: 0,
                        bottom: 960,
                        right: 640
                }
        });
}

1.3 输出流类型

在混流参数outputList中，输出流的target 可为流名（streamID）或 URL，如果需要将流推到 CDN 上，采用 URL；不需要将流推到 CDN 上时，由调用者决定采用 URL 或者流名。

2 开始混流

在推流成功后，调用 startMixerTask 将混流配置发送至 Zego 混流服务器，并触发混流。

Demo 中演示源代码如下：

const inputList = [{
    streamID: this.data.pushStreamID,
    contentType    : 'video',
    layout: {
        top: 0,
        left: 0,
        bottom: 480,
        right: 640,
    }
}];
if (this.data.livePlayerList.length > 0) {
    const playerStream = this.data.livePlayerList[0]
    inputList.push({
        streamID: playerStream.streamID,
        contentType    : 'video',
        layout: {
            top: 480,
            left: 0,
            bottom: 960,
            right: 640
        }
    });
}
const outputList = [{
    target: this.data.mixStreamID,
}]
const outputConfig = {
    outputBitrate: 800 * 1000,
    outputFPS: 15,
    outputWidth: 640,
    outputHeight: 960,
}
const mixParam = {
    taskID: this.data.mixTaskID,
    inputList: inputList,
    outputList,
    outputConfig
};
console.log('mixParam', mixParam);
try {
    const result = await zg.startMixerTask(mixParam)
    console.log('mixPlayInfoList: ', result);
    const _mixPlayerUrls = []
    if (result.errorCode !== 0) {
        console.error('mix fail', result);
    }
    //2.12.1 及以前版本，支持通过 startPlayingStream 接口设置 isMix 参数为 true，此时只能从 CDN 拉混流。
    //2.12.2 及以后版本，支持通过 startPlayingStream 接口设置 sourceType 参数，此时可设置拉混流来源为 CDN 或 BGP。
    const { streamID, url } = await zg.startPlayingStream(this.data.mixStreamID, { isMix: true, sourceType: "BGP" })
    console.log('>>>[liveroom-room] startPlayingStream, streamID: ', streamID, ' url: ', url);
    _mixPlayerUrls.push({ streamID, url })
    this.setData({
        mixPlayerUrls: _mixPlayerUrls
    })
} catch (err) {
    console.log('err: ', err);
};

3 混流配置更新通知

混流请求发送成功后，调用者可在成功回调中获取混流配置的结果及混流 ID。

常见错误码及含义如下

4 停止混流

停止混流是通过调用 stopMixerTask 实现。

参考代码如下：

try {
    const { errorCode } = await zg.stopMixerTask(this.data.mixTaskID)
    console.log('stopMixerTask ', errorCode)
    if (this.data.mixPlayerUrls.length > 0) {
        this.data.mixPlayerUrls.forEach((item) => {
            zg.stopPlayingStream(item.streamID);
        })
        this.setData({
            mixPlayerUrls: []
        })
    }
} catch (error) {
    console.error('error: ', error);
}

自动混流使用步骤

1 初始化并登录房间

请参考 快速开始 - 实现流程 的 “创建引擎” 和 “登录房间”。

2 设置混流配置，开始自动混流

ZegoAutoMixerTask 是 SDK 中定义的自动混流任务配置对象，通过配置该对象可定制化自动混流任务。

2.1 设置混流配置，开始自动混流

新建一个自动混流任务对象，然后分别设置输入、输出等参数。

• 一个房间内只能存在一个自动混流任务 ID，即保证自动混流任务 ID 的唯一性，建议自动混流任务 ID 与房间 ID 关联，可直接使用房间 ID 作为自动混流任务 ID。
• 需要自动混流的房间 ID，如果房间不存在则无法自动混流。

zg.startAutoMixerTask({
    taskID, // 自动混流任务的任务 ID
    roomID: "room1", // 自动混流任务的房间 ID
    audioConfig: {
        bitrate: 64,
        channel: 2,
        codecID: 6
    },
    outputList: [
        // 自动混流输出列表
        {
            target: mixStreamID
        }
    ]
})
    .then(res => {
        console.warn("startAutoMixer", res);
    })
    .catch(e => {
        console.error("startAutoMixer", e);
    });
}

2.2 （可选）设置自动混流音频配置

zg.startAutoMixerTask({
    taskID, // 自动混流任务的任务 ID
    roomID: "room1", // 自动混流任务的房间 ID
    // 音频配置
    audioConfig: {
        bitrate: 64, // 音频码率
        channel: 2, // 音频声道数
        codecID: 6
    },
    outputList: [
        // 自动混流输出列表
        {
            target: mixStreamID
        }
    ]
})
    .then(res => {
        console.warn("startAutoMixer", res);
    })
    .catch(e => {
        console.error("startAutoMixer", e);
    });

3 停止自动混流

调用 stopAutoMixerTask 接口停止自动混流。

// 传入之前创建的混流任务对象
zg.stopAutoMixerTask({
    taskID: taskID,
    roomID: "room1",
})
    .then(res => {
        console.warn("stopAutoMixerTask", res);
    })
    .catch(e => {
        console.error("stopAutoMixerTask", e);
    });

全自动混流使用步骤

通过 ZEGO 服务端的配置实现每个房间都自动混音频流，详情请联系 ZEGO 技术支持。