All Products
Search

This Product

    ApsaraVideo Live:AddLivePackageConfig

    Document Center

    ApsaraVideo Live:AddLivePackageConfig

    Last Updated:Dec 05, 2024

    Adds a live stream encapsulation configuration.

    Operation description

    • The first time you configure encapsulation for a domain name, domain acceleration is automatically configured and takes effect in 3 to 5 minutes.
    • If the streaming domain resides in a region outside China, including Singapore, Germany (Frankfurt), Japan (Tokyo), and Indonesia (Jakarta), you may encounter high latency issues. We recommend that you test and verify whether the settings meet expectations.
    • You can call this operation to add a live stream encapsulation configuration. The configuration takes effect only after you re-ingest the stream.

    QPS limit

    You can call this operation up to 300 times per minute per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    live:AddLivePackageConfig
    *Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DomainNamestringYes

    The main streaming domain.

    		example.com
    AppNamestringYes

    The application name. The value of this parameter must be the same as the application name that is specified in the ingest URL. Otherwise, the configuration does not take effect. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). The name cannot start with a hyphen (-) or underscore (_). You can also specify an asterisk (*) as the value to match all applications.

    		AppName
    StreamNamestringYes

    The stream name. The value of this parameter must be the same as the stream name that is specified in the ingest URL. Otherwise, the configuration does not take effect. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). The name cannot start with a hyphen (-) or underscore (_). You can also specify an asterisk (*) as the value to match all streams.

    		StreamName
    ProtocolstringYes

    The streaming protocol and encapsulation format. Valid values:

    • HLS_CMAF
    • LLHLS_TS (low latency)
    • LLHLS_CMAF (low latency)
    • DASH_CMAF
    • HLSDASH_CMAF
    		HLS_CMAF
    SegmentNumintegerNo

    The number of segments.

    • Valid values: 3 to 10.
    • Default value: 3.
    		3
    SegmentDurationintegerNo

    The segment length. Unit: seconds.

    • If Protocol is set to HLS_CMAF: Valid values: 1 to 10. Default value: 5.
    • If Protocol is set to LLHLS_TS or LLHLS_CMAF: Valid values: 1 to 2. Default value: 1.
    		5
    PartDurationintegerNo

    The part length. Unit: milliseconds.

    • If the value of SegmentDuration is 1, the valid values of this parameter are 100 to 500 and the default value of this parameter is 350.
    • If the value of SegmentDuration is 2, the valid values of this parameter are 100 to 1000 and the default value of this parameter is 700.
    • This parameter takes effect only if Protocol is set to LLHLS_TS or LLHLS_CMAF.
    		350
    IgnoreTranscodebooleanNo

    Specifies whether to ignore the transcoded stream. Valid values:

    • true (default)
    • false
    		true

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		05D00B48-DF50-5DC0-A07D-A250DFAE****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "05D00B48-DF50-5DC0-A07D-A250DFAE****"
}

    Error codes

    HTTP status codeError codeError message
    400MissingParam%s
    400InvalidParams%s
    400ConfigAlreadyExists%s
    400InvalidProtocol%s
    400InvalidSegmentNum%s
    400InvalidSegmentDuration%s
    400InvalidPartDuration%s
    409ConfigConflicts%s
    500InternalErr%s
    500DomainConfigFailed%s

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history