tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

StartStreamIngest

Last updated: 2024-08-13 11:43:41

    1. API Description

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

    Push an online media stream to the TRTC room.

    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: StartStreamIngest.
    Version Yes String Common Params. The value used for this API: 2019-07-22.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-guangzhou, ap-jakarta, ap-mumbai, ap-singapore, ap-tokyo.
    SdkAppId Yes Integer TRTC's SdkAppId, the same as the SdkAppId corresponding to the Record room.
    RoomId Yes String TRTC's RoomId, the RoomId corresponding to the Record TRTC room.
    RoomIdType Yes Integer Type of TRTC RoomId. [*Note] Must be the same as the RoomId type corresponding to the Record room: 0: String type RoomId 1: 32-bit Integer type RoomId (default)
    UserId Yes String UserId of the Pull stream Relay Robot, used to enter the room and initiate the Pull stream Relay Task.
    UserSig Yes String UserSig corresponding to the Pull stream Relay Robot UserId, i.e., UserId and UserSig are equivalent to the Robot's Login password for entering the room. For the specific Calculation method, please refer to the TRTC UserSig Scheme.
    StreamUrl No String The Url of the media resource.
    PrivateMapKey No String TRTC room permission Encryption ticket, only needed when advanced permission control is enabled in the Console. After enabling advanced permission control in the TRTC Console, TRTC's backend service system will verify a so-called [PrivateMapKey] 'Permission ticket', which contains an encrypted RoomId and an encrypted 'Permission bit list'. Since PrivateMapKey contains RoomId, providing only UserSig without PrivateMapKey does not allow entry into the specified room.
    SeekSecond No Integer
    AutoPush No Boolean Enable auto relay to cdn, please make sure that this feature has been enabled in the console.
    RepeatNum No Integer Loop playback count, value range: [-1, 1000], default is 1 time. - 0 is an invalid value - -1 is for loop playback, task termination requires actively calling the stop interface or setting MaxDuration.
    MaxDuration No Integer Loop playback maximum duration, only effective when RepeatNum is set to -1, valid value range: [1, 10080], unit: minutes

    3. Output Parameters

    Parameter Name Type Description
    TaskId String The Task ID of the Pull stream Relay. The Task ID is a unique identifier for a Pull stream Relay lifecycle process, and it loses its meaning when the task ends. The Task ID needs to be saved by the business as a parameter for the next operation on this task.
    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 Push an online media stream to the TRTC room.

    Start an Input Online Media Stream Task, input the online media stream "https://a.b/test.mp4" into the TRTC room, use the default Codec values for Audio and Video, and return the TaskId after the Relay is successful.

    Input Example

    POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartStreamIngest
<common request parameters>

{
    "SdkAppId": 1234567890,
    "RoomId": "room123",
    "UserId": "robot123",
    "UserSig": "xxxxxxxxxxxxxxx",
    "PrivateMapKey": "xxxxxxxxxxxxxxx",
    "RoomIdType": 1,
    "StreamUrl": "https://a.b/test.mp4"
}

    Output Example

    {
    "Response": {
        "TaskId": "-gCTFWtU7t7DUlo7A8IswFszO9z2O-rbERqJAoK-4pycoZXKjIAAnasdcasdOEycyX4CnzhIm4RAQ..",
        "RequestId": "71993312-6ab8-4768-9124-118e0a20c45f"
    }
}

    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
    FailedOperation.NotAllowed
    FailedOperation.NotRtmpFunction
    FailedOperation.RestrictedConcurrency Maximum number of concurrent on-cloud recording tasks reached. Contact us to raise the limit.
    FailedOperation.TaskExist Task already exists
    InternalError.HttpParseFailed HTTP request parsing failed.
    InternalError.InternalError Internal error, please retry.
    InvalidParameter.BodyParamsError Failed to parse body parameters.
    InvalidParameter.RoomId RoomId is incorrect.
    InvalidParameter.SdkAppId SdkAppId is incorrect.
    InvalidParameter.StrRoomId StrRoomId parameter error.
    InvalidParameter.StreamUrl Invalid StreamUrl format
    InvalidParameter.TaskId TaskId parameter error.
    InvalidParameter.UserSig
    MissingParameter.RoomId RoomId is missing.
    MissingParameter.SdkAppId SdkAppId is missing.
    MissingParameter.TaskId TaskId parameter missing.
    ResourceInsufficient.RequestRejection Insufficient resources.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy