Create a Live Package Channel for HLS Streaming via API - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Generates a real-time video stream processing channel that supports the HLS protocol and automatically assigns endpoints and keys.

Operation description

This operation creates a live video packaging service channel. Currently, only the HLS protocol is supported. The system automatically generates ingest endpoint addresses and the username and password required for authentication.

Before you begin

Channel group names and channel names can contain only uppercase and lowercase letters, digits, underscores, and hyphens.
Currently, only HLS is supported as the protocol.
The segment duration must be between 1 and 30 seconds.
The number of m3u8 segments must be between 2 and 100.

A successful response returns the details of the newly created channel, including the channel name, creation time, modification time, and ingest endpoint details.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:CreateLivePackageChannel

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GroupName	string	Yes	The channel group name. The name can contain only uppercase and lowercase letters, digits, hyphens, and underscores. The name must be 1 to 200 characters in length. Format: [A-Za-z0-9_-]+	channel-group-1
SegmentCount	integer	Yes	The number of m3u8 segments for the input stream. Valid values: 2 to 100.	3
Description	string	No	The description. The description can be up to 1000 characters in length.	This is a test channel.
SegmentDuration	integer	Yes	The segment duration of the input stream, in seconds. Valid values: 1 to 30.	6
ChannelName	string	Yes	The channel name. The name can contain only uppercase and lowercase letters, digits, hyphens, and underscores. The name must be 1 to 200 characters in length. Format: [A-Za-z0-9_-]+	channel-1
ClientToken	string	No	The idempotency token.	**12e8864746a0a398**
Protocol	string	Yes	The input protocol. Currently, only HLS is supported.	HLS

Response elements

Element	Type	Description	Example
	object	Schema of Response
LivePackageChannel	object	The details of the live packaging channel.
ChannelName	string	The channel name.	example-channel
CreateTime	string	The creation time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2023-04-01T12:00:00Z
Description	string	The description.	This is a test channel.
GroupName	string	The channel group name.	channel-group-1
IngestEndpoints	array<object>	The ingest endpoints.
	object	The ingest endpoint URL.
Id	string	The ingest endpoint ID.	ingest1
Password	string	The password.	2F9e******b569c8
Url	string	The ingest endpoint URL.	http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest
Username	string	The username.	us12******das
LastModified	string	The creation time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2023-04-01T12:00:00Z
Protocol	string	The input protocol. Valid value: HLS.	HLS
SegmentCount	integer	The number of m3u8 segments for the input stream.	3
SegmentDuration	integer	The segment duration of the input stream.	5
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****

Examples

Success response

JSON format

{
  "LivePackageChannel": {
    "ChannelName": "example-channel",
    "CreateTime": "2023-04-01T12:00:00Z",
    "Description": "This is a test channel.",
    "GroupName": "channel-group-1",
    "IngestEndpoints": [
      {
        "Id": "ingest1",
        "Password": "2F9e******b569c8",
        "Url": "http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest",
        "Username": "us12******das"
      }
    ],
    "LastModified": "2023-04-01T12:00:00Z",
    "Protocol": "HLS",
    "SegmentCount": 3,
    "SegmentDuration": 5
  },
  "RequestId": "******3B-0E1A-586A-AC29-742247******"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.