Object Timecodes

Methods: info | upload | enable | download

info

Timecodes Information

Parameters:

  • String apikey (apikey of your project)
  • String media_code (your media key)

Sample query:

https://boomstream.com/api/timecodes/info?apikey=[API_KEY]&code=[MEDIA_CODE]&format=json

Sample response:

    "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

Sample query:

https://boomstream.com/api/timecodes/upload

This is a POST method, to use it you need to upload a file with timecodes.

enable

Enable Timecodes

Parameters:

  • String apikey (apikey of your project)
  • String media_code (your media key)
  • Boolean enable (enable/disable timecodes, values are 1 and 0)

Sample query:

https://boomstream.com/api/timecodes/enable?apikey=[API_KEY]&code=[MEDIA_CODE]&format=json&enable=1

Sample response:

"Message": "Changes have been successfully saved",
"enable": "yes",
"Status": "Success",
"Version": "1.0"

download

Download timecodes

Parameters:

  • String apikey (apikey of your project)
  • String media_code (your media key)

Sample query:

https://boomstream.com/api/timecodes/download?apikey=[API_KEY]&code=[MEDIA_CODE]