POST /api/digitalhuman/open/v1/liveRooms HTTP/1.1

Content-Type: application/json

{
    "liveRoom": "live room", // 直播间名称，长度小于 50，同一 app 下唯一
    "resolution": { // 画面输出分辨，比例需要和人像一致，否则会出现人像比例异常
        "width": 1080,
        "height": 1920
    },
    "elements": [ // IMAGE 和 DIGITAL_HUMAN 两个 element 的顺序固定不可调整
            {
            "type": "IMAGE",  // 背景图
            "image": {
                "location": { // 背景图位置和尺寸
                    "top": 0, // 固定填 0
                    "left": 0, // 固定填 0
                    "width": 1080, // 需要和画面宽度(resolution.width)保持一致
                    "height": 1920 // 需要和画面高度(resolution.height)保持一致
                },
                "url": "http://image url" // 图片地址，推荐使用 BOS（百度对象存储服务）地址，其他地址可能会因为网络原因加载图片失败导致会话打开失败
            },
        },
        {
            "type": "DIGITAL_HUMAN", 
            "digitalhuman": {
                "figureId": "figure id" // 数字人形象id，只支持 2D 小样本人像，可以使用系统公共人像[2D小样本数字人](AI_DH/数字人形象使用/公共形象库/2D小样本数字人.md)或定制人像[2D小样本数字人形象定制接口](AI_DH/定制服务/2D小样本数字人形象定制接口.md)
            }
        }
    ],
    "output": {
        "mode": "BRTC",  // 视频流输出模式：RTMP - 延迟较高，更适合直播场景; BRTC - 延迟较低，更适合交互场景
        "rtmp": { // mode 为 "RTMP" 时需要填写，BRTC 无需填写
            "pushUrl": "rtmp push url" // 可选，指定数字人 RTMP 推流地址，示例值:rtmp://show-pu.kaywang.cn/{app}/{steam}，如果不填写会返回平台提供的 RTMP 地址
        }
    },
    "audioFormat": {
        "sampleRate": 16000  // 可选，会话输入音频采样率，默认16000。TEXT_REDNER或AUDIO_RENDER对应的音频采样率和该值不一致，则不会进行播报，并返回event为ERROR的消息；AUDIO_STREAM上的采样率如果和该值不一致，会进行播报，但播报声音会有问题
    }
}

HTTP/1.1 200 OK

{
    "code": 0,
    "message": "error message",
    "result": {
        "liveRoom": "live room",
        "status": "OPEN",
        "output": {
            "rtmp": {
                "pullUrl": "rtmp pull url" // output mode 为 RTMP 且请求没有提供 RTMP 推流地址(pushUrl)，系统返回内置的 RTMP 地址供调用方进行拉流
            },
            "brtc": { // output mode 为 BRTC 时返回，参数使用参考文档直播流获取章节
                "appId": "app id", // BRTC 侧 appId，非数字人开放平台应用 ID
                "roomName": "room name", // BRTC 侧 roomName，非数字人直播间 name
                "userId": "user id", // 拉流需使用的 user id
                "userToken": "user token", // 拉流需填写的鉴权 token
                "feedId": "feed id", // 数字人推流侧的 user id
                "previewBrowseUrl": "preview url" // BRTC 模式下预览音视频 demo 网页链接
            }
        },
        "createTime": "2023-08-14 00:00:00",
        "updateTime": "2023-08-14 00:00:00"
    }
}

DELETE /api/digitalhuman/open/v1/liveRooms?liveRoom=${liveRoom} HTTP/1.1

HTTP/1.1 200 OK

{
    "code": 0,
    "message": "error message",
    "result": {
        "liveRoom": "live room",
        "status": "CLOSE",
        "output": {
            "rtmp": {
                "pullUrl": "rtmp pull url"
            }
        },
        "createTime": "2023-08-14 00:00:00",
        "updateTime": "2023-08-14 00:00:00"
    }
}

GET /api/digitalhuman/open/v1/liveRooms?liveRoom=${liveRoom} HTTP/1.1

{
    "code": 0,
    "message": null,
    "requestId": "cd46a9e2-8bc5-490b-9c76-d5122ddf2b7b",
    "result": {
        "liveRoom": "test",
        "sessionId": "sl-piehqauahma2vcfzp",
        "status": "CLOSED",
        "createTime": "2023-09-04T19:43:58Z",
        "updateTime": "2023-09-05T07:00:26Z"
    }
}

wss://open.xiling.baidu.com/live/2d/ws?appId=${app_id}&token=${app_token}&expire=${expire}&liveRoom=${live_room}

{
    "id": 1, // 大于 0 的整数，递增不能重复
    "type": "msg type",
    "body": "msg body in json"
}

{
    "id": 1, // 大于0的整数
    "type": "msg type",
    "code": 0, // 0 - 成功；非0 - 失败
    "message": "error msg" // 异常信息
    "body": "msg body in json"
}

{
    "status": "IDLE", // 后端状态：IDLE - 空闲；SPEAKING - 播报中
    "id": 1 // 最近一个正在播报（SPEAKING）或已经播报完（IDLE）的RENDER指令的 id
}

{
    "textId": "text id", // 自定义id，便于问题排查
    "text": "text", // 播报文本，长度不能超过 1000
    "tts": {
        "per": "5116", // 音色id，公共音色列表参考：[公共音色库](AI_DH/数字人形象使用/公共音色库.md)，定制音色参考：[音色克隆和查询接口](AI_DH/定制服务/音色克隆和查询接口.md)                
        "spd": "5", // 语速：5是正常值，0-15的取值范围。越大语速越快，默认值5 （字面量需要是整数）
        "vol": "5", // 音量：5是正常值，0-15的取值范围，越大音量越大，默认值5 （字面量需要是整数）
        "pit": "5" // 语调：5是正常值，0-15的取值范围，越大声音越尖，默认值5 （字面量需要是整数）
    },
    "insert": false, // 为 true 则插入到当前播报中 TEXT_RENDER 的未播报文本最近的一个标点符号后播报或当前播报中 AUDIO_RENDER 的音频后播报，默认 false，多个 TEXT_RENDER 消息排队播报
    "delayed": true // insert 为 false 时生效，为 true 则会在播报前延迟约 1 秒再播报，模拟真人播报的停顿
}

{
    "event": "START" // START, COMPLETE, ERROR, INTERRUPTED
}

{
    "audioId": "audio id", // 自定义id，便于问题排查
    "url": "audio url", // 音频需要满足：WAV格式，16k 采样率，通道数 1，位深 16 bit，WAV header 44 字节，推荐使用 BOS（百度对象存储服务）地址，其他地址可能会因为网络原因加载失败导致驱动失败
    "insert": false, // 为 true 则插入到当前播报中 TEXT_RENDER 的未播报文本最近的一个标点符号后播报或当前播报中 AUDIO_RENDER 的音频后播报，默认 false，多个 AUDIO_RENDER 消息排队播报
    "delayed": true // insert 为 false 时生效，为 true 则会在播报前延迟约 1 秒再播报，模拟真人播报的停顿 
 }

{
    "event": "START" // START, COMPLETE, ERROR, INTERRUPTED
}

{
    "streamId": "stream id", // 自定义id，便于问题排查
    "event": "START", // START, COMPLETE
    "sampleRate": 16000 // 默认 16000
}

{
    "streamId": "stream id", // stream id
    "event": "START" // READY, START, COMPLETE, ERROR, INTERRUPTED
}