tencent cloud

Resume Room Mixed Stream Task
Last updated: 2025-08-07 11:40:09
Resume Room Mixed Stream Task
Last updated: 2025-08-07 11:40:09

Feature Description

App admins can use this API to resume the specified room's stream mixing layout visual.。
Note:
To use this capability, the prerequisite is: When you need to create a room, turn on the room's stream mixing capability, that is, set IsUnlimitedRoomEnabled to true, corresponding to the room created by the TUILiveKit Video Room add-on on the SDK side.
All the anchors involved in stream mixing must be on the seat.

API Call Description

Sample Request URL

https://xxxxxx/v4/live_engine_http_srv/resume_mcu_task?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The following table only lists the parameters involved in modification when calling this API and their descriptions. For more parameter details, please see REST API Introduction.
Parameters
Description
xxxxxx
Domain name corresponding to the country/region where your SDKAppID is located:
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
US: adminapiusa.im.qcloud.com
v4/live_engine_http_srv/set_mix_stream
Request API
sdkappid
Create an assigned SDKAppID for the Live application
identifier
Must be an App administrator account. For more details, see App Admin
usersig
The generated signature of the App administrator account. For specific operations, see Generating UserSig
random
Enter a random 32-bit unsigned integer in the range of [0,4294967295]
contenttype
The request format has a fixed value of json

Maximum Calling Frequency

20 times/second.

Sample Request Packet

{
	"RoomId":"mix1"
}

Request Packet Fields

Field
Type
Required
Description
RoomId
String
Required
room ID, up to 48 bytes

Sample Response Package Body

Basic form
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720"
}

Response Packet Fields

Field
Type
Description
ActionStatus
String
Request processing result. OK indicates successful processing. FAIL indicates failure
ErrorCode
Integer
Error code, 0 indicates success, non-zero indicates failure
ErrorInfo
String
Error message
RequestId
String
Unique request ID. It is returned for each request. RequestId is required for locating a problem

Error Code Description

Unless a network error (such as 502 error) occurs, the HTTP return code of this API is 200. The actual error code and error information are indicated by ErrorCode and ErrorInfo in the response packet body.
For common error codes (60000 to 79999), see the Error Code document.
The private error codes of this API are as follows:
Error Code
Description
100001
Internal server error, please retry
100002
Invalid parameter. Check whether the request is correct according to the error description
100006
The room type required is the Live room type. The room does not support microphone slots, and the IsUnlimitedRoomEnabled setting for the room is not set to true.
100004
Room does not exist or is dissolved
100007
The paid plan fails to satisfy
100422
Too many requests in a short time, subject to frequency control. The total mixing operations of each sdkappid are limited to 20 per second
100424
Mix stream task does not exist. Retry
100427
The mixing operation in this room is too fast. Please try again later
100428
Failed to pull the host information during mixed streaming.
100429
Invalid mixing mode.

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback