Help Center/ MetaStudio/ API Reference/ Virtual Avatar Livestreaming/ Livestreaming Task Management/ Controlling Virtual Human Intelligent Livestreaming
Updated on 2024-07-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Controlling Virtual Human Intelligent Livestreaming

Function

Controls virtual human intelligent livestreaming.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs/{job_id}/command

Table 1 Path Parameters

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.

job_id

Yes

String

Task ID.

Request Parameters

Table 2 Request header 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

command

Yes

String

Command name.

  • INSERT_PLAY_SCRIPT: inserts a performance script. It is used for interactive reply. The virtual human and background remain unchanged. Definition of the params structure: PlayTextInfo.

  • REWRITE_PLAY_SCRIPT: dynamically edits a script that has not been played. Definition of the params structure: scene_scripts.

  • INSERT_PLAY_AUDIO: inserts an audio for control. It is used to directly control a virtual human. The virtual human and background remain unchanged. Definition of the params structure: PlayAudioInfo.

  • REWRITE_INTERACTION_RULES: dynamically modifies an interaction rule. Definition of the params structure: interaction_rules.

  • GET_CURRENT_PLAYING_SCRIPTS: queries the script list of the current round. The response is in the LivePlayingScriptList structure.

  • SHOW_LAYER: displays materials for live broadcast. Definition of the params structure: LiveGuideRuleInfo.

  • REFRESH_OUTPUT_URL: updates the RTMP stream push information of the current task. Definition of the params structure: RefreshOutputUrlConfig.

  • GET_LIVE_JOB_CONFIG_INFO: obtains room information in a task. Definition of the params structure: SmartLiveRoomInfo.

params

No

Object

Command parameter.

review_config

No

ReviewConfig object

Content review configuration.
Table 4 ReviewConfig

Parameter

Mandatory

Type

Description

no_need_review

No

Boolean

Content review whitelist. This feature is available only for users in the whitelist. The auto review policies apply to other users.

Response Parameters

Status code: 200

Table 5 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.
Table 6 Response body parameters

Parameter

Type

Description

command_id

String

Control command ID

command

String

Command name.

  • INSERT_PLAY_SCRIPT: inserts a performance script. It is used for interactive reply. The virtual human and background remain unchanged. Definition of the params structure: ShootScript.

  • REWRITE_PLAY_SCRIPT: dynamically edits a script that has not been played. Definition of the params structure: scene_scripts.

  • INSERT_PLAY_AUDIO: inserts an audio for control. It is used to directly control a virtual human. The virtual human and background remain unchanged. Definition of the params structure: PlayAudioInfo.

  • GET_CURRENT_PLAYING_SCRIPTS: queries the script list of the current round. The response is in the LivePlayingScriptList structure.

  • REFRESH_OUTPUT_URL: updates the RTMP stream push information of the current task. Definition of the params structure: RefreshOutputUrlConfig.

  • REWRITE_INTERACTION_RULES: dynamically modifies an interaction rule. Definition of the params structure: interaction_rules.

  • GET_LIVE_JOB_CONFIG_INFO: obtains room information in a task. Definition of the params structure: SmartLiveRoomInfo.

result

String

Command execution result.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 9 Response body parameters

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/26f06524-4f75-4b3a-a853-b649a21aaf66/command

{
  "command" : "INSERT_PLAY_SCRIPT",
  "params" : {
    "text_config" : {
      "text" : "I'll answer the questions raised by the audience in the comment area."
    },
    "play_type" : "APPEND",
    "rule_index" : "test-rule-index"
  }
}

Example Responses

Status code: 200

Succeeded.

{
  "command" : "GET_CURRENT_PLAYING_SCRIPTS",
  "result" : ""
}

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

200

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.

Parent Topic: Livestreaming Task Management