Methods: info | upload | enable | download
info
Timecodes Information
Input parameters:
- String apikey (API key of your project)
- String media_code (Your media key)
Output parameters
- Array timecodes (List of timecodes)
- String enabled (Timecodes status: "yes" or "no")
Example request:
Text
https://boomstream.com/api/timecodes/info?apikey=[API_KEY]&code=[MEDIA_CODE]&format=json
Example response:
JSON
{
"timecodes": [
{
"position": 1,
"title": "first",
"time_from": "00:00:00.000",
"time_to": "00:00:05.000"
},
{
"position": 2,
"title": "second",
"time_from": "00:00:05.000",
"time_to": "00:00:20.000"
},
{
"position": 3,
"title": "third",
"time_from": "00:00:20.000",
"time_to": "00:00:30.000"
},
{
"position": 4,
"title": "fourth",
"time_from": "00:00:30.000",
"time_to": "00:00:45.000"
}
],
"enabled": "yes",
"Status": "Success",
"Version": "1.0"
}
upload
Upload timecodes using the POST method
Note: This is a POST method. To use it, you need to upload a file with timecodes.
Example request:
Text
https://boomstream.com/api/timecodes/upload
enable
Enable or disable timecodes
Input parameters:
Required parameters:
- String apikey (API key of your project)
- String media_code (Your media key)
- Boolean enable (Enable/disable timecodes, values: 1 or 0)
Output parameters
- String Message (Status message)
- String enable (Timecodes status: "yes" or "no")
Example request:
Text
https://boomstream.com/api/timecodes/enable?apikey=[API_KEY]&code=[MEDIA_CODE]&format=json&enable=1
Example response:
JSON
{
"Message": "Changes have been successfully saved",
"enable": "yes",
"Status": "Success",
"Version": "1.0"
}
download
Download timecodes
Input parameters:
- String apikey (API key of your project)
- String media_code (Your media key)
Example request:
Text
https://boomstream.com/api/timecodes/download?apikey=[API_KEY]&code=[MEDIA_CODE]