AddDelayLiveStream

Last updated: 2021-11-10 17:46:07

    1. API Description

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

    This API is used to set a delay in playing the images of large live streaming events, in case of emergencies.

    Note: if you are to set the delay before stream push, set it at least 5 minutes before the push. This API supports configuration only by stream.

    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: AddDelayLiveStream.
    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.
    AppName Yes String Push path, which is the same as the AppName in push and playback addresses and is live by default.
    DomainName Yes String Push domain name.
    StreamName Yes String Stream name.
    DelayTime Yes Integer Delay time in seconds, up to 600s.
    ExpireTime No String Expiration time of the configured delayed playback in UTC format, such as 2018-11-29T19:00:00Z.
    Notes:
    1. The configuration will expire after 7 days by default and can last up to 7 days.
    2. The Beijing time is in UTC+8. This value should be in the format as required by ISO 8601. For more information, please see ISO Date and Time Format.

    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 Sample request

    Input Example

    https://live.tencentcloudapi.com/?Action=AddDelayLiveStream
    &DomainName=5000.livepush.myqcloud.com
    &AppName=live
    &StreamName=stream1
    &DelayTime=30
    &ExpireTime=2018-12-30T11:00:00Z
    &<Common request parameters>
    

    Output Example

    {
    "Response": {
      "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
    }
    }
    

    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
    DryRunOperation DryRun operation. A request will not be successful if the DryRun parameter is passed in.
    FailedOperation.CallOtherSvrFailed Failed to call the internal service.
    InternalError Internal error.
    InternalError.CallOtherSvrError Error calling internal service.
    InternalError.ConfigNotExist The configuration does not exist.
    InternalError.GetBizidError Error getting user account.
    InternalError.GetStreamInfoError Failed to get the stream information.
    InternalError.NotPermmitOperat No permission to operate.
    InternalError.StreamStatusError Exceptional stream status.
    InternalError.UpdateDataError Failed to update data.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Parameter missing.
    ResourceNotFound The resource is not found.
    ResourceNotFound.UserNotExist The LVB service has not been activated.