CreateStreamLiveChannel

Last updated: 2021-08-23 14:31:35

1. API Description

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

This API is used to create a StreamLive channel.

A maximum of 20 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: CreateStreamLiveChannel.
Version Yes String Common parameter. The value used for this API: 2020-03-26.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Name Yes String Channel name, which can contain 1-32 case-sensitive letters, digits, and underscores and must be unique at the region level
AttachedInputs.N Yes Array of AttachedInput Inputs to attach. You can attach 1-5 inputs.
OutputGroups.N Yes Array of StreamLiveOutputGroupsInfo Configuration information of the channel’s output groups. Quantity: [1, 10]
AudioTemplates.N No Array of AudioTemplateInfo Audio transcoding templates. Quantity: [1, 20]
VideoTemplates.N No Array of VideoTemplateInfo Video transcoding templates. Quantity: [1, 10]
AVTemplates.N No Array of AVTemplate Audio/Video transcoding templates. Quantity: [1, 10]

3. Output Parameters

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

4. Example

Example1 Sample request

Input Example

https://mdl.tencentcloudapi.com/?Action=CreateStreamLiveChannel
&Name=channel
&AttachedInputs.0.Id=EEEEE
&AttachedInputs.0.AudioSelectors.0.Name=eng
&AttachedInputs.0.AudioSelectors.0.AudioPidSelection.Pid=256
&AudioTemplates.0.Name=test1
&AudioTemplates.0.Acodec=AAC
&AudioTemplates.0.AudioBitrate=112000
&AudioTemplates.0.AudioSelectorName=eng
&AudioTemplates.0.LanguageCode=eng
&VideoTemplates.0.Name=test2
&VideoTemplates.0.Vcodec=H264
&VideoTemplates.0.VideoBitrate=1000000
&VideoTemplates.0.Width=1920
&VideoTemplates.0.Height=1080
&VideoTemplates.0.Fps=60
&OutputGroups.0.Name=outputGroup
&OutputGroups.0.Type=HLS
&OutputGroups.0.HlsRemuxSettings.SegmentDuration=2000
&OutputGroups.0.HlsRemuxSettings.SegmentNumber=3
&OutputGroups.0.HlsRemuxSettings.PdtInsertion=OPEN
&OutputGroups.0.HlsRemuxSettings.PdtDuration=600
&OutputGroups.0.DashRemuxSettings.SegmentDuration=2000
&OutputGroups.0.DashRemuxSettings.SegmentNumber=3
&OutputGroups.0.DashRemuxSettings.PeriodTriggers=OPEN
&OutputGroups.0.DrmSettings.State=OPEN
&OutputGroups.0.DrmSettings.ContentId=12312dsde2
&OutputGroups.0.Outputs.0.Name=output
&OutputGroups.0.Outputs.0.Scte35Settings.Behavior=PASSTHROUGH
&OutputGroups.0.Destinations.0.OutputUrl=http://domain/live/1233
&OutputGroups.0.Destinations.0.AuthKey=aaaa
&OutputGroups.0.Destinations.0.Username=bbbb
&OutputGroups.0.Destinations.0.Password=cccc
&<Common request parameters>

Output Example

{
  "Response": {
    "Id": "sda",
    "RequestId": "11-222-222"
  }
}

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

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
InternalError Internal error.
InvalidParameter.AVTemplates Audio/Video transcoding template error
InvalidParameter.AlreadyAssociatedChannel Channel already associated.
InvalidParameter.AttachedInputs Invalid AttachedInputs.
InvalidParameter.AudioTemplates Incorrect audio transcoding template.
InvalidParameter.ExceededQuantityLimit The quantity exceeds the limit.
InvalidParameter.Id Invalid Id.
InvalidParameter.Name Invalid Name.
InvalidParameter.NotFound Not found.
InvalidParameter.OutputGroups Invalid OutputGroups.
InvalidParameter.VideoTemplates Incorrect video transcoding template.