Product Overview
Purchase Guide
Introduction of Avatar
- Introduction to Image Categories
- Basic Image Library
- Guide on Avatar and Voice Clone
Digital Human Platform Operation Guide
- Accessing Platform
- Avatar Production and Asset Management
- Digital Human Conversation Interaction Application and Management
- Broadcast Digital Human Video Generation and Management
- Operations Management and Analysis
Broadcast Service
- Video Generation Service API Documentation
Interactive Service
- API (Cloud Rendering, Client Rendering)
- SDK (Client-Side Rendering)
- Interactive Digital Human Hands-on Tutorial (Cloud Rendering)
Customizing Services
- Avatar Image Customization and Voice Clone API Documentation
- Process for Customizing, Downloading, and Using 2D End Rendered Avatars
Other Supporting Components
- Avatar aPaas API Calling Methods
- Personal Asset Management API Documentation
Digital Human SSML Markup Language Specification
Related Agreement
- Privacy Policy
- DSA (Data Sharing Agreement)
FAQs

Real-time Update of Digital Human Visual Parameters

Download

Focus Mode

Font Size

Last updated: 2026-07-16 09:56:05

AI-Translated

It is used for real-time updating of the character's size, position, and background image in the video stream.
Notes:
This API is no longer recommended for use, and there is no further iteration of new features. For adjusting the background and the size of the figure, it is recommended to use the following method: set up green screen background streaming and use streaming software to chroma key and overlay foreground and background, and adjust character size.
Request frequency limit for this API: One request every 5 seconds per individual session.
Calling Protocol
HTTPS + JSON
POST /v2/ivh/sessionmanager/sessionmanagerservice/updatesessionconfig
Header Content-Type: application/json;charset=utf-8
Request Parameters
Parameter Name
Type
Required
Description
ReqId
String
Yes
Unique identifier for a single request.
SessionId
String
Yes
Session ID.
SpaceParam
SpaceParam
No
Spatial information, supported by Avatar.
ImageParam
ImageParam
No
Avatar information, supported by 3D avatars.
﻿SpaceParam
﻿
Name
Type
Required
Description
BackgroundUrl
String
No
Background URL (less than 1 MB in size, preferably aligned with the output resolution, otherwise it will be stretched to fill). Supported formats: jpg, jpeg, png (other formats are not supported). If not provided, the last used background image will be used.
ImagePosition
float
Yes
The X position of the character in the background image. The X coordinate is 0 when the character image is centered horizontally. The value range is [-0.5, 0.5]. The character cannot be moved out of the background image area. This is a linear value.
ImagePositionVertical
float
Yes
The Y position of the character in the background image. The Y coordinate is 0 when the character image is aligned to the bottom. The value range is [-0.5, 0.25]. The character can be moved downward out of the background image area. This is a linear value.
ImageZoom
float
Yes
The zoom ratio of a character relative to the original material image, calculated based on the size after zooming and the original character material image. The calculation formula is: width of the zoomed character image / (background width of the preview area / target resolution width) / width of the original character material image. The recommended value range is [0.25, 2].
Backgrounds
Arrays of [VideoLayer]
No
A list of background images. The total number of background and foreground images cannot exceed 5.
Notes:
1. For streamers whose shooting background has not been removed, this parameter cannot take effect.
2. For streamers whose shooting background has been removed, the background takes effect in the following priority order:
2.1 The background set by this parameter.
2.2 Green screen.
3. If this parameter is used, it will override the BackgroundUrl.
Foregrounds
Arrays of [VideoLayer]
No
A list of foreground images. The total number of background and foreground images cannot exceed 5. To clear previously set foreground images, set the array to []. If this parameter is not provided during an update, the foreground data will be retained.
﻿ImageParam
﻿
Name
Type
Required
Description
ImageVerticalOffset
float
No
The vertical rotation angle of the 3D avatar's upper body
ImageHorizontalOffset
float
No
The horizontal rotation angle of the 3D avatar's upper body.
ImageExtraParam
float
No
The color-changing parameter for 3D avatars. For specific parameters, refer to the Interactive Digital Human platform.
﻿VideoLayer
﻿
Parameter Name
Type
Required
Description
URL
String
Yes
URL of the layer resource.
Image formats: jpg, jpeg, png, mjpeg, and gif are supported.
Image size: It is recommended that it does not exceed 2 MB.
X
int
Yes
The X-coordinate of the top-left corner for resource placement.
Y
int
Yes
The Y-coordinate of the top-left corner for resource placement.
Width
int
Yes
The width of the resource output.
Height
int
Yes
The height of the resource output.
Response Parameter
Name
Type
Required
Description
ReqId
String
Yes
Unique identifier for a single request.
Request Sample
{
    "Header": {},
    "Payload": {
        "ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
        "SessionId": "m123adfafvbadsafd",
        "ImageParam": {
            "ImageVerticalOffset": 10,
            "ImageHorizontalOffset": 10,
            "ImageExtraParam": "{\\"JacketColor\\":{\\"colorValue\\":10491928},\\"DressColor\\": {\\"colorValue\\":10491928},\\"shoeColor\\": {\\"colorValue\\": 10491928}}"
        },
        "SpaceParam": {
            "BackgroundUrl": "https://virtualhuman-cos-prod-1251316161.cos.ap-nanjing.myqcloud.com/ai-resource/1518804312073965568",
            "ImagePosition": -0.01,
            "ImagePositionVertical": -0.01,
            "ImageZoom": 1
        }
    }
}
Response Sample
{
    "Header": {
        "Code": 0,
        "Message": "",
        "RequestID": "123",
    },
    "Payload": {
        "ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
    }
}
﻿

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Tencent Cloud AI Digital Human

Real-time Update of Digital Human Visual Parameters

Calling Protocol

Request Parameters

Response Parameter

Request Sample

Response Sample

Help and Support

Parameter Name	Type	Required	Description
ReqId	String	Yes	Unique identifier for a single request.
SessionId	String	Yes	Session ID.
SpaceParam	SpaceParam	No	Spatial information, supported by Avatar.
ImageParam	ImageParam	No	Avatar information, supported by 3D avatars.

Name	Type	Required	Description
BackgroundUrl	String	No	Background URL (less than 1 MB in size, preferably aligned with the output resolution, otherwise it will be stretched to fill). Supported formats: jpg, jpeg, png (other formats are not supported). If not provided, the last used background image will be used.
ImagePosition	float	Yes	The X position of the character in the background image. The X coordinate is 0 when the character image is centered horizontally. The value range is [-0.5, 0.5]. The character cannot be moved out of the background image area. This is a linear value.
ImagePositionVertical	float	Yes	The Y position of the character in the background image. The Y coordinate is 0 when the character image is aligned to the bottom. The value range is [-0.5, 0.25]. The character can be moved downward out of the background image area. This is a linear value.
ImageZoom	float	Yes	The zoom ratio of a character relative to the original material image, calculated based on the size after zooming and the original character material image. The calculation formula is: width of the zoomed character image / (background width of the preview area / target resolution width) / width of the original character material image. The recommended value range is [0.25, 2].
Backgrounds	Arrays of [VideoLayer]	No	A list of background images. The total number of background and foreground images cannot exceed 5. Notes: 1. For streamers whose shooting background has not been removed, this parameter cannot take effect. 2. For streamers whose shooting background has been removed, the background takes effect in the following priority order: 2.1 The background set by this parameter. 2.2 Green screen. 3. If this parameter is used, it will override the BackgroundUrl.
Foregrounds	Arrays of [VideoLayer]	No	A list of foreground images. The total number of background and foreground images cannot exceed 5. To clear previously set foreground images, set the array to []. If this parameter is not provided during an update, the foreground data will be retained.