Starting a Virtual Human Intelligent Livestreaming Task
Function
Starts a virtual human intelligent livestreaming task.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
room_id |
Yes |
String |
Script ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. You can obtain the token by calling the IAM API used to obtain a user token. Value of X-Subject-Token in the response header. |
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory for AK/SK authentication. The format is YYYYMMDD'T'HHMMSS'Z'. |
X-Project-Id |
No |
String |
Project ID. This parameter is mandatory for AK/SK authentication. |
X-App-UserId |
No |
String |
Third-party user ID, which does not allow Chinese characters. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
video_config |
No |
VideoConfig object |
Video output configuration. |
play_policy |
No |
PlayPolicy object |
Script playback policy. |
output_urls |
No |
Array of strings |
Details: Address of the third-party livestreaming platform for RTMP video stream push. The command REFRESH_OUTPUT_URL needs to be executed to refresh the URL during the livestream. Constraints: N/A Options: Currently, only one RTMP stream output address is supported. Default value: N/A |
stream_keys |
No |
Array of strings |
Details: Stream key of the third-party livestreaming platform for RTMP video stream push, which corresponds to the ingest URL. The command REFRESH_OUTPUT_URL needs to be executed to refresh the URL during the livestream. Constraints: N/A Options: Currently, only one RTMP stream output address is supported. Default value: N/A |
interaction_callback_url |
No |
String |
Details: Interactive callback URL, including authentication information. This parameter is mandatory when trigger.reply_mode is set to CALLBACK. Constraints: N/A Options: The value contains 0 to 2,048 characters. Default value: N/A |
live_event_callback_config |
No |
LiveEventCallBackConfig object |
Live event HTTPS callback notification configuration |
rtc_callback_config |
No |
RTCLiveEventCallBackConfig object |
RTC callback event configuration. Compatible processing. If the configuration is not carried, LIVE_PROGRESS is subscribed by default. |
view_mode |
No |
String |
Details: Landscape or portrait mode. Constraints: You do not need to set this parameter. The value is determined by the resolution in video_config. Options:
Default value: VERTICAL |
co_streamer_config |
No |
CoStreamerConfig object |
Co-streamer configuration |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
clip_mode |
No |
String |
Details: Clipping mode of the output video. Constraints: N/A Options:
Default value: RESIZE |
codec |
Yes |
String |
Details: Video encoding format and video file format. Constraints: Only virtual avatar video production supports VP8 encoding. Options:
Default value: N/A |
bitrate |
Yes |
Integer |
Details: Average output bitrate. Unit: kbit/s Constraints:
Default value: N/A Value range: 40-30000 |
width |
Yes |
Integer |
Details: Video width. Unit: pixel. Constraints:
Default value: N/A Value range: 0-3840 |
height |
Yes |
Integer |
Details: Video height. Unit: pixel. Constraints:
Default value: N/A Value range: 0-3840 |
frame_rate |
No |
String |
Details: Frame rate. Unit: FPS Constraints: The virtual avatar video frame rate is fixed at 25 FPS. Default value: 25 |
is_subtitle_enable |
No |
Boolean |
Details: Whether the output video is subtitled. Constraints: Subtitles are not supported for virtual avatar livestreaming. Options:
Default value: false |
subtitle_config |
No |
SubtitleConfig object |
Subtitle configuration. |
disable_system_watermark |
No |
Boolean |
Details: Indicates whether the system watermark is disabled for the output video. Constraints: Currently, this parameter takes effect only for trustlisted tenants. Value range:
Default value: false |
dx |
No |
Integer |
Details: Horizontal coordinate of the pixel in the upper left corner of the cropped video. The image layout size is based on the model resolution. For example, for a model with the resolution of 1920 x 1080, the value of dx ranges from 0 to 1920. Constraints: This parameter takes effect when clip_mode is set to CROP. Default value: N/A Value range: -1920-3840 |
dy |
No |
Integer |
Details: Vertical coordinate of the pixel in the upper left corner of the cropped video. The image layout size is based on the model resolution. For example, for a model with the resolution of 1920 x 1080, the value of dy ranges from 0 to 1080. Constraints: This parameter takes effect when clip_mode is set to CROP. Default value: N/A Value range: -1920-3840 |
is_enable_super_resolution |
No |
Boolean |
Details: Whether super resolution is enabled for a video. Constraints: This parameter is available only for virtual avatar video production. Options:
Default value: false |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dx |
No |
Integer |
Details: Coordinates of the pixel in the lower left corner of the subtitle box. Constraints: N/A Default value: N/A Value range: 0-1920 |
dy |
No |
Integer |
Details: Coordinates of the pixel in the lower left corner of the subtitle box. Constraints: N/A Default value: N/A Value range: 0-1920 |
font_name |
No |
String |
Details: Font. The following fonts are supported:
Constraints: N/A Options: The value contains 0 to 64 characters. Default value: HarmonyOS_Sans_SC_Black |
font_size |
No |
Integer |
Details: Font size. The interface value ranges from 0 to 120. The actual value range is 4 to 120. Use the actual value range. Constraints: N/A Value range: 0-120 Default value: 54 |
h |
No |
Integer |
Details: Subtitle box height. Constraints: The parameter h is used to facilitate the calculation of the coordinates in the upper left corner of the subtitle box. This parameter is not used in the background. Value range: 0-1920 |
w |
No |
Integer |
Details: Subtitle box width. Constraints:
Value range: 0-1920 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
repeat_count |
No |
Integer |
Details: Number of times that a script is played repeatedly.
Constraints: N/A Value range: -1-100 Default value: 0 |
auto_play_script |
No |
Boolean |
Details: Indicates whether to automatically play a script. Constraints: N/A Options:
Default value: true |
play_mode |
No |
String |
Details: Virtual avatar control method. Constraints: N/A Options: TEXT: text control, that is, using TTS AUDIO: speech control NO_PRESET: no preset script, manual control Default value: TEXT |
random_play_mode |
No |
String |
Details: Method of random script reading. Constraints: Random script reading starts from the second round of reading. Options:
Default value: SCRIPT_ITEM |
need_independent_capture_client |
No |
Boolean |
Details: Whether an independent data collection device is required. This parameter is used when the client playback is separated from the command. Constraints: N/A Options:
Default value: false |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
live_event_type_callback_url |
No |
String |
Details: Live event callback address, which is an HTTPS address. Constraints: N/A Options: The value contains 0 to 2,048 characters. Default value: N/A |
auth_type |
No |
String |
Details: Authentication type. Constraints: N/A Options:
Default value: NONE |
key |
No |
String |
Details: Key. Constraints: N/A Options: The value contains 0 to 32 characters. Default value: N/A |
callback_event_type |
No |
Array of strings |
Details: Live event types in callbacks. Constraints: N/A Options: Currently, only the following options are supported:
The callback event structure is defined as follows:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
rtc_callback_event_type |
No |
Array of strings |
Live event types in RTC callbacks. Currently, only the following options are supported:
The callback event structure is defined as follows:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
voice_config |
No |
VoiceConfig object |
Voice configuration parameter. |
streamer_action |
No |
String |
Details: Behavior of the streamer when the co-streamer speaks. Constraints: N/A Options:
Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
voice_asset_id |
Yes |
String |
Details: Timbre asset ID, which can be queried from the asset library. Constraints: N/A Options: The value contains 1 to 256 characters. Default value: N/A |
speed |
No |
Integer |
Details: Speaking speed. 50 indicates 0.5x speaking speed, 100 indicates normal speaking speed, and 200 indicates 2x speaking speed. The value 100 indicates the normal speaking speed of an adult, which is about 150 words per minute. Constraints: N/A Value range: 50-200 Default value: 100 |
pitch |
No |
Integer |
Details: Pitch. Constraints: N/A Value range: 50-200 Default value: 100 |
volume |
No |
Integer |
Details: Volume. Constraints: N/A Value range: 90-240 Default value: 140 |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
X-Request-Id |
String |
Request ID. |
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Livestreaming task ID. |
rtc_room_info |
RTCRoomInfoList object |
RTC room information. |
live_event_report_url |
String |
URL for reporting livestreaming events. Users report their own livestreaming events to this URL to trigger intelligent interaction and automatic reply. |
live_event_callback_config |
LiveEventCallBackConfig object |
Live event HTTPS callback notification configuration |
live_warning_info |
Array of LiveWarningItem objects |
List of livestreaming risk alarms. |
Parameter |
Type |
Description |
---|---|---|
app_id |
String |
RTC application ID. |
room_id |
String |
RTC room ID. |
users |
Array of RTCUserInfo objects |
Information about users joining an RTC room. |
Parameter |
Type |
Description |
---|---|---|
user_type |
String |
User type.
|
user_id |
String |
RTC user ID. |
signature |
String |
RTC authentication token. |
ctime |
Long |
Validity period. Timestamp, in seconds. Value range: 0-4294967295 |
Parameter |
Type |
Description |
---|---|---|
live_event_type_callback_url |
String |
Details: Live event callback address, which is an HTTPS address. Constraints: N/A Options: The value contains 0 to 2,048 characters. Default value: N/A |
auth_type |
String |
Details: Authentication type. Constraints: N/A Options:
Default value: NONE |
key |
String |
Details: Key. Constraints: N/A Options: The value contains 0 to 32 characters. Default value: N/A |
callback_event_type |
Array of strings |
Details: Live event types in callbacks. Constraints: N/A Options: Currently, only the following options are supported:
The callback event structure is defined as follows:
|
Parameter |
Type |
Description |
---|---|---|
warning_type |
String |
Alarm type.
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-rooms/24bad716-87b1-45e5-8912-6102f7693265/smart-live-jobs { "output_urls" : [ "rtmp://vfxpush.hwcloudvr.cn/live/lysa" ] }
Example Responses
Status code: 202
Succeeded.
{ "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66" }
Status code: 400
{ "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" }
Status code: 401
{ "error_code" : "MSS.00000001", "error_msg" : "Unauthorized" }
Status code: 500
{ "error_code" : "MSS.00000004", "error_msg" : "Internal Error" }
Status Codes
Status Code |
Description |
---|---|
202 |
Succeeded. |
400 |
Parameters error, including the error code and its description. |
401 |
Authentication is not performed or fails. |
500 |
Internal service error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot