CreateCommonMixStream

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-09-14 10:23:06

Download PDF

1. API Description

Domain name for API request: live.tencentcloudapi.com.

This API is used to create a general stream mix. It can be used basically in the same way as the legacy mix_streamv2.start_mix_stream_advanced API.
Note: currently, up to 16 streams can be mixed.
Best practice: https://intl.cloud.tencent.com/document/product/267/45566?from_cn_redirect=1

A maximum of 200 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: CreateCommonMixStream.
Version	Yes	String	Common parameter. The value used for this API: 2018-08-01.
Region	No	String	Common parameter. This parameter is not required for this API.
MixStreamSessionId	Yes	String	ID of stream mix session (from applying for stream mix to canceling stream mix).
InputStreamList.N	Yes	Array of CommonMixInputParam	Input stream list for stream mix.
OutputParams	Yes	CommonMixOutputParams	Output stream parameter for stream mix.
MixStreamTemplateId	No	Integer	Input template ID. If this parameter is set, the output will be generated according to the default template layout, and there is no need to enter the custom position parameters. If this parameter is left empty, 0 will be used by default. For two input sources, 10, 20, 30, 40, and 50 are supported. For three input sources, 310, 390, and 391 are supported. For four input sources, 410 is supported. For five input sources, 510 and 590 are supported. For six input sources, 610 is supported.
ControlParams	No	CommonMixControlParams	Special control parameter for stream mix. If there are no special needs, leave it empty.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Applying for stream mix - using template 40

This example shows you how to use a preset stream mix template to mix streams.

Input Example

https://live.tencentcloudapi.com/?Action=CreateCommonMixStream
&MixStreamSessionId=test_room
&MixStreamTemplateId=40
&OutputParams.OutputStreamName=test_stream1
&InputStreamList.0.InputStreamName=test_stream1
&InputStreamList.0.LayoutParams.ImageLayer=1
&InputStreamList.1.InputStreamName=test_stream2
&InputStreamList.1.LayoutParams.ImageLayer=2
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

Example2 Applying for stream mix - using custom layout parameters

This example shows you how to use a custom layout.

Input Example

https://live.tencentcloudapi.com/?Action=CreateCommonMixStream
&MixStreamSessionId=test_room
&OutputParams.OutputStreamName=test_stream1
&InputStreamList.0.InputStreamName=test_stream1
&InputStreamList.0.LayoutParams.ImageLayer=1
&InputStreamList.0.LayoutParams.ImageWidth = 1280
&InputStreamList.0.LayoutParams.ImageHeight= 720
&InputStreamList.1.InputStreamName=test_stream2
&InputStreamList.1.LayoutParams.ImageLayer=2
&InputStreamList.1.LayoutParams.ImageWidth = 240
&InputStreamList.1.LayoutParams.ImageHeight= 320
&InputStreamList.1.LayoutParams.LocationX= 100
&InputStreamList.1.LayoutParams.LocationY= 100
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

Example3 Applying for stream mix - using cropping parameters

This example shows you how to use cropping parameters.

Input Example

https://live.tencentcloudapi.com/?Action=CreateCommonMixStream
&MixStreamSessionId=test_room
&OutputParams.OutputStreamName=test_stream1
&InputStreamList.0.InputStreamName=test_stream1
&InputStreamList.0.LayoutParams.ImageLayer=1
&InputStreamList.0.LayoutParams.ImageWidth = 1280
&InputStreamList.0.LayoutParams.ImageHeight= 720
&InputStreamList.1.InputStreamName=test_stream2
&InputStreamList.1.LayoutParams.ImageLayer=2
&InputStreamList.1.LayoutParams.ImageWidth = 240
&InputStreamList.1.LayoutParams.ImageHeight= 320
&InputStreamList.1.LayoutParams.LocationX= 100
&InputStreamList.1.LayoutParams.LocationY= 100
&InputStreamList.1.CropParams.CropWidth= 240
&InputStreamList.1.CropParams.CropHeight= 320
&InputStreamList.1.CropParams.CropStartLocationX= 100
&InputStreamList.1.CropParams.CropStartLocationY= 100
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
FailedOperation.CallOtherSvrError	Failed to call the third-party service.
FailedOperation.CallOtherSvrFailed	Failed to call the internal service.
FailedOperation.GetPictureUrlError	Unable to get the watermark URL.
FailedOperation.GetStreamResolutionError	Failed to get the input stream length and width.
FailedOperation.ProcessMixError	Failed to start stream mix.
FailedOperation.StreamNotExist	The stream does not exist.
InternalError	Internal error.
InternalError.JiFeiOtherError	The billing platform returned other errors.
InvalidParameter	Invalid parameter.
InvalidParameter.CancelSessionNotExist	The canceled session does not exist.
InvalidParameter.InputNumLimitExceeded	The number of inputs exceeds the limit.
InvalidParameter.InvalidBackgroudResolution	Invalid background length and width.
InvalidParameter.InvalidBitrate	Invalid output bitrate.
InvalidParameter.InvalidCropParam	The cropped area overflows the original image.
InvalidParameter.InvalidLayerParam	Invalid layer parameter.
InvalidParameter.InvalidOutputStreamID	The output stream ID is already used.
InvalidParameter.InvalidOutputType	Invalid output type. Please check whether `OutputPram-StreamId` and `OutputType` match.
InvalidParameter.InvalidPictureID	The watermark ID was not set.
InvalidParameter.InvalidRoundRectRadius	Invalid corner radius of the rounded rectangle.
InvalidParameter.OtherError	Other errors.
InvalidParameter.SessionOutputStreamChanged	The output stream of the same session has changed.
InvalidParameter.TemplateNotMatchInputNum	The template does not match the number of input streams.

Recent Pages