tencent cloud

All product documents
APIs
DocumentationAPIsStreamLiveChannel Management APIsCreateStreamLiveChannel
CreateStreamLiveChannel
Last updated: 2024-12-09 14:31:29
CreateStreamLiveChannel
Last updated: 2024-12-09 14:31:29

1. API Description

Domain name for API request: mdl.intl.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 Params. The value used for this API: CreateStreamLiveChannel.
Version Yes String Common Params. The value used for this API: 2020-03-26.
Region Yes String Common Params. 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 to 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]
CaptionTemplates.N No Array of SubtitleConf Subtitle template configuration, only AVTemplates are valid.
PlanSettings No PlanSettings Event settings
EventNotifySettings No EventNotifySetting The callback settings.
InputLossBehavior No InputLossBehaviorInfo Complement the last video frame settings.
PipelineInputSettings No PipelineInputSettingsInfo Pipeline configuration.
InputAnalysisSettings No InputAnalysisInfo Recognition configuration for input content.
Tags.N No Array of Tag Console tag list.
FrameCaptureTemplates.N No Array of FrameCaptureTemplate Frame capture templates.

3. Output Parameters

Parameter Name Type Description
Id String Channel ID
TagMsg String Tag prompt information, this information will be attached when the tag operation fails.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

POST / HTTP/1.1
Host: mdl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateStreamLiveChannel
<Common request parameters>

{
    "AudioTemplates": [
        {
            "AudioBitrate": "112000",
            "AudioSelectorName": "eng",
            "LanguageCode": "eng",
            "Name": "test1",
            "Acodec": "AAC"
        }
    ],
    "OutputGroups": [
        {
            "Name": "outputGroup",
            "Outputs": [
                {
                    "Scte35Settings": {
                        "Behavior": "PASSTHROUGH"
                    },
                    "Name": "output"
                }
            ],
            "DrmSettings": {
                "ContentId": "12312dsde2",
                "State": "OPEN"
            },
            "DashRemuxSettings": {
                "SegmentNumber": "3",
                "PeriodTriggers": "OPEN",
                "SegmentDuration": "2000"
            },
            "Type": "HLS",
            "HlsRemuxSettings": {
                "SegmentNumber": "3",
                "PdtInsertion": "OPEN",
                "SegmentDuration": "2000",
                "PdtDuration": "600"
            },
            "Destinations": [
                {
                    "AuthKey": "aaaa",
                    "Username": "bbbb",
                    "OutputUrl": "http://domain/live/1233",
                    "Password": "cccc"
                }
            ]
        }
    ],
    "VideoTemplates": [
        {
            "Name": "test2",
            "VideoBitrate": "1000000",
            "Vcodec": "H264",
            "Height": "1080",
            "Width": "1920",
            "Fps": "60"
        }
    ],
    "Name": "channel",
    "AttachedInputs": [
        {
            "AudioSelectors": [
                {
                    "AudioPidSelection": {
                        "Pid": "256"
                    },
                    "Name": "eng"
                }
            ],
            "Id": "EEEEE"
        }
    ],
    "Tags": [
        {
            "TagKey": "tagkey",
            "TagValue": "tagvalue"
        }
    ]
}

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.FrameCaptureTemplates
InvalidParameter.Id Invalid Id.
InvalidParameter.Name Invalid Name.
InvalidParameter.NotFound Not found.
InvalidParameter.NotifyKey Callback key format error.
InvalidParameter.NotifyUrl Callback URL format error.
InvalidParameter.OutputGroups Invalid OutputGroups.
InvalidParameter.VideoTemplates Incorrect video transcoding template.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon