CreateCommonMixStream

Last updated: 2021-01-27 15:18:18

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 100 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