Sigma API developers
1. Authentication
First, you access the Figma application, select the App management menu then select the Credential tab:
Next, you enter the Username and select the corresponding permission group (here you group the Sigma Livestream Full permission ):
After you select Submit , the Sigma system will generate a Username and Secret Key . You need to save this password or download the credential file by selecting Download as .env file.
After having Username and Secret Key , you use Base64Encode tool to create token for Authorization header with the following syntax:
Finally, you get App ID information by selecting the App management menu, selecting the General tab , then you can see App ID information as shown below.
2. API Create live transcode channel
To create a live transcode channel with the following settings:
Ultra-low-latency
Available in 03 profiles 1080p, 720p, 480p
Catchup live session saved to S3 storage (Note: re-enter channel name and S3 configuration)
You can use the following API:
If the API call is successful, the HTTP Response code will be 201 , along with the response body being a json object in which the most important information is the id of the newly created channel as in the example below. This ID is used in the APIs to start/stop live sessions or delete channels.
3. Get information of a channel
After creating a channel, you can get the details of a channel by calling the following API:
If the API call is successful, the HTTP Response code will be 200 . It contains some important information such as:
currentSessionId: if the channel is in a livestream session, we will receive the session id.For channels with catchup for VOD configured to be saved to S3, the endpoint to access the master.m3u8 file will look like this:
<s3>/sigma-livestream/<session_id>/catchup/master-catchup.m3u8rtmpServer: rtmp url to push stream.streamToken: stream key.liveStreamUrl: URL to watch live.
The received data will be as follows:b
4. API start live channel
Use the API as follows to start a live channel:
If the API call is successful, the HTTP Response code will be 200 .
5. API stop live channel
Use the API as follows to stop a live channel:
If the API call is successful, the HTTP Response code will be 200 .
6. Delete a channel
To delete a channel, use the API as follows:
If the API call is successful, the HTTP Response code will be 200 .
7. List live sessions of a channel
Each livestream session of a channel will be tracked as a session. We can use the following API to get a list of sessions of a channel:
If the API call is successful, the HTTP Response code will be 200. The result will be as shown in the following sample:
8. View the status of a session
We can get the active status of a live session by calling the following API:
If the API call is successful, the HTTP Response code will be 200. The result will be as shown in the following sample:
9. List the events of a session
During the operation of a session, actions such as: initialize, stop, start, signal interrupted, signal restored, etc. will be generated and tracked as events. We can use the API below to get a list of events:
If the API call is successful, the HTTP Response code will be 200. The result will be as shown in the following sample:
Last updated