接口说明
创建直播间。
调用协议
HTTPS + JSON
POST /v2/ivh/liveroom/liveroomservice/openliveroom
Header Content-Type: application/json;charset=utf-8
请求参数
参数名称 | 类型 | 必选 | 描述 |
ReqId | string | 是 | 请求 Id，长度为32的 uuid |
VideoStreamReq | 是 | 创建会话的参数 | |
CycleTimes | int | 是 | 循环次数（不支持无限循环），取值范围：(0,500) |
Scripts | 是 | 直播间脚本的参数，当前数组只支持一条数据 | |
CallbackUrl | string | 否 | 注意： 回调签名使用的 signKey 通过线下方式提供。 |
VideoStreamReq
参数参数名称 | 类型 | 必选 | 描述 |
VirtualmanProjectId | string | 否 | 数智人平台项目 ID，与 AssetVirtualmanKey 二选一。获取方式如下  |
AssetVirtualmanKey | string | 否 | 资产形象 ID，与 VirtualmanProjectId 二选一。获取方式如下  |
Protocol | string | 是 | 视频流协议，当前支持参数：rtmp、trtc、webrtc |
SpeechParam | 否 | 音色相关参数，使用 AssetVirtualmanKey 建流时，可以选择指定这个参数 | |
AnchorParam | 否 | 数智人相关参数，使用 AssetVirtualmanKey 建流时，可以选择指定这个参数来调整位置、大小 | |
ExtraInfo | 否 | 创建会话扩展参数 |
SpeechParam
参数参数名称 | 类型 | 必选 | 描述 |
Speed | float | 否 | 语速（1.0为正常语速，范围[0.5-1.5]，值为0.5时播报语速最慢，值为1.5时播报语速最快） |
TimbreKey | string | 否 | |
Volume | int | 否 | 音量大小，范围[0，10]，对应音量大小。默认为0，代表正常音量，值越大音量越高 |
AnchorParam
参数参数名称 | 类型 | 必选 | 描述 |
HorizontalPosition | float | 否 | 定义主播横向位置（0为中间位置，推荐范围为［-0.5, 0.5］，-0.5为最左，0.5为最右） |
VerticalPosition | float | 否 | 定义主播纵向位置（0为中间位置，推荐范围［-0.5, 0.5］，-0.5为向上，0.5为向下） |
Scale | float | 否 | 缩放比例，（1是默认大小，推荐范围(0,10]） |
ExtraInfo
参数名称 | 类型 | 必选 | 描述 |
AlphaChannelEnable | bool | 否 | 是否开启原始视频拼接 alpha 输出拼接视频流。 说明： 假设原始输出宽度为iW，则实际视频流宽度为：iW + pW + iW pW 为中间间隔(pad)宽度：(16 - iW%16) % 16 alpha 视频宽度起始点：iW + pW alpha 视频宽度：iW |
ScriptReq
参数参数名称 | 类型 | 必选 | 描述 |
Content | string | 是 | 文本内容，上限40万个字符（字符数按 unicode 字符数计算） |
Backgrounds | 否 | 背景，背景和前景总数不能超过5 说明： 1. 对于未抠除拍摄背景的主播，此参数无法生效。 2. 对于抠除拍摄背景的主播，背景生效优先顺序为： 2.1 此参数设置的背景; 2.2 数智人平台项目配置的背景（使用数智人平台项目场景）; 2.3 绿幕。 | |
Foregrounds | 否 | 前景，背景和前景总数不能超过5 |
VideoLayer
参数参数名称 | 类型 | 必选 | 描述 |
Url | string | 是 | 图层资源地址 图片格式：支持jpg、jpeg、png、mjpeg、gif 图片大小：建议不超过2M |
X | int | 是 | 资源放置的左上x坐标 |
Y | int | 是 | 资源放置的左上y坐标 |
Width | int | 是 | 资源输出的宽度 |
Height | int | 是 | 资源输出的高度 |
返回参数
参数名称 | 类型 | 必须 | 描述 |
ReqId | string | 是 | 单次请求 Id，和入参 ReqId 一致 |
LiveRoomId | string | 是 | 直播间 id |
Status | int | 是 | 直播间状态，0-初始状态；1-视频流创建中；2-视频流创建完成；3-拆句完成；4-调度中；5-调度完成；6-关闭 |
VideoStreamPlayUrl | string | 否 | 视频流播放地址（视频流创建完成才会返回，即Status=2） |
请求示例
{"Header": {},"Payload": {"ReqId": "3429db2406c04a5e94a3f63478e8778f","VideoStreamReq": {"VirtualmanProjectId": "12b24hub97f447f28ec17c26cc17c985","Protocol": "webrtc"},"CycleTimes": 10,"Scripts": [{"Content": "直播文本内容：Tencent Cloud AI Digital Human，TCADH）采用语音交互、虚拟形象模型生成等多项 AI 技术，实现唇形语音同步和表情动作拟人等效果，广泛应用于虚拟形象播报和实时语音交互两大场景。虚拟形象播报根据文本内容快速合成音视频文件，落地于媒体、教育、会展服务等场景，实时语音交互支持即时在线对话，可赋能智能客服、语音助理等场景。"}]}}
返回示例
{"Header": {"RequestID": "3c5a8d999d8e1fbc6c574595a1b31d5d","SessionID": "gz92439a3317234609262925106","DialogID": "","Code": 0,"Message": ""},"Payload": {"LiveRoomId": "lm16406256654745613158","Status": 1,"ReqId": "3429db2406c04a5e94a3f63478e8778f"}}
