使用个人资产形象建流
下载
聚焦模式
字号
用于新建视频流，获取数智人画面的流播放地址。
调用协议
HTTPS + JSON
POST /v2/ivh/sessionmanager/sessionmanagerservice/createsessionbyasset
Header Content-Type: application/json;charset=utf-8
请求参数
参数名称 | 类型 | 必选 | 描述 |
ReqId | String | 是 | 单次请求唯一标识，长度为32的 uuid。 |
SessionId | String | 否 | 会话唯一标识。SaaS 环境不允许传入，由云端分配，私有化环境可传入。 |
AssetVirtualmanKey | String | 是 | 个人资产形象 ID。从数智人平台的资产管理中获取，如图：  |
UserId | String | 是 | 用户的唯一标识，由调用方自己维护。以相同的 UserId 创建新流，会导致上一个该 UserId 流关闭。 |
Protocol | String | 是 | 当前支持参数：rtmp、trtc、webrtc |
DriverType | int | 是 | 数智人驱动方式。 1：纯文本驱动； 3：音频驱动（原声），此模式下支持发送音频和文本两种驱动模式； |
ProtocolOption | 否 | 协议自定义参数，不使用 trtc 时不用关注。 | |
SpeechParam | 否 | 音色相关参数。 | |
ExtraInfo | 否 | 建流扩展参数。 | |
Backgrounds | 否 | 背景图列表，背景和前景总数不能超过5。 说明： 对于未抠除拍摄背景的主播，此参数无法生效。 对于抠除拍摄背景的主播，背景生效优先顺序为：此参数设置的背景 > 绿幕。 | |
Foregrounds | 否 | 前景图列表，背景和前景总数不能超过5。 | |
AnchorParam | 否 | 主播相关参数。 |
ProtocolOption
名称 | 类型 | 必选 | 描述 |
TrtcUseExternalApp | boolean | 否 | 是否使用外部 trtc appid，如果不使用，将使用数智人平台统一的 trtc appid。 注意： 使用数智人平台统一的 trtc 时，仅限于调试阶段，不可用于投产阶段。 |
TrtcAppId | string | 否 | trtc appid（使用外部 trtc appid 时必填）。 |
TrtcRoomId | int | 否 | trtc 房间号（不指定则由云端分配房间号）。 |
TrtcUserSig | string | 否 | trtc 数字人用户签名（使用外部 trtc appid 时必填）。 |
TrtcPrivateMapKey | string | 否 | trtc 数字人用户权限密钥（使用外部 trtc appid 时必填）。 |
CssCustomPushUrl | string | 否 | 自定义云直播推流地址，推流协议固定使用 rtmp，使用 rtmp 推流给云直播，可以使用云直播支持的各类拉流协议进行拉流播放。 要求的推流地址格式为： rtmp://xyz.com/cssAppName/streamid?txSecret={0}&txTime={1}txSecret 和 txTime 计算方式参考： https://www.tencentcloud.com/document/product/267/32720?from_cn_redirect=1 |
SpeechParam
名称 | 类型 | 必选 | 描述 |
Speed | float | 否 | 语音速度，取值范围[50,200], 50表示默认速度的50%； 不填写的话，默认为100，建议使用默认值 |
TimbreKey | string | 否 | 音色 key。 |
Volume | int | 否 | 音量大小，取值范围为[-10, 10], -10表示音量相对默认值小10dB；不填写的话，默认为0，建议使用默认值 |
TimbreLanguage | string | 否 |
VideoLayer
参数名称 | 类型 | 必选 | 描述 |
URL | String | 是 | 图层资源地址。 图片格式：支持 jpg、jpeg、png、mjpeg、gif。 图片大小：建议不超过2MB。 |
X | int | 是 | 资源放置的左上 X 坐标。 |
Y | int | 是 | 资源放置的左上 Y 坐标。 |
Width | int | 是 | 资源输出的宽度。 |
Height | int | 是 | 资源输出的高度。 |
ExtraInfo
名称 | 类型 | 必选 | 描述 |
AlphaChannelEnable | bool | 否 | 是否开启原始视频拼接 alpha 输出拼接视频流。 说明： 假设原始输出宽度为 iW，则实际视频流宽度为：iW + pW + iW pW 为中间间隔(pad)宽度：(16 - iW%16) % 16 alpha 视频宽度起始点：iW + pW alpha 视频宽度：iW 2D 小样本（高精）形象暂不支持该特性。 |
AnchorParam
参数名称 | 类型 | 必选 | 描述 |
SilenceActionDisabled | bool | 否 | 交互对话模式开关（默认 False）：适用于 2D 小样本数智人，如该形象素材录制时符合交互场景录制要求，可将此开关打开，从而实现数字人在静默时无额外手部动作，交互更真实自然。 注意： 如果形象本身不支持该特性，则该配置项不生效。 |
返回参数
名称 | 类型 | 必选 | 描述 |
ReqId | String | 是 | 单次请求唯一标识。 |
SessionId | String | 是 | 会话的唯一标识 |
SessionStatus | int | 是 | 状态： 1: 进行中(已就绪)，命中缓存直接得到播流地址 |
PlayStreamAddr | String | 否 | 播放地址，格式为： rtmp://liveplay.ivh.qq.com/live/m789如果通过 CssCustomPushUrl 参数指定了自定义云直播推流地址，则不返回此字段 |
请求示例
{"Header": {},"Payload": {"ReqId": "d7aa08da33dd4a662ad5be508c5b77cf","AssetVirtualmanKey": "d7aa08da33dd4a662ad5be508c5b77cf","DriverType": 1,"UserId": "henry","Protocol": "rtmp"}}
返回示例
{"Header": {"Code": 0,"Message": "","RequestID": "123"},"Payload": {"ReqId": "d7aa08da33dd4a662ad5be508c5b77cf","SessionId": "m789","SessionStatus": 1,"PlayStreamAddr": "rtmp://live.qq.com/live/m789"}}
文档反馈