HOW TO: Create a marker using the REST API

With M|Replay, you can create markers in the user interface but also using a REST API. This means that you can create markers remotely from simple web page. 

Currently the only thing you can do with the REST API is to add new markers. If you have any additional request, please let us know.

M|Replay uses port 8082 by default, but this can be configured in the preferences of M|Replay.

Creating markers

To add a marker, you need to use the POST method and pass a json dictionary with "name" to set the title of the marker. The marker will be added at the same position that the "playhead is". So if the user is playing back something in the past, it will use the current TC, not the "Live" TC.

POST markers
    {
        "name" : "This is my Marker"
    }


About the authentication

If the user has enabled the option to require a password, then you need to specify it with your requests. The default password is "1234".

 POST markers?password={password}
    {
        "name" : "This is my Marker"
    }



Retrieving markers

You can also retrieve the list of markers that were already created:

GET markers

This will return a dictionary with the list of sources available for a MovieRecorder, which should look like this:

[
    {
        "name": "My First Marker",
        "start": 511090399.1733954
    },
    {
        "name": "My Second Marker",
        "start": 511090848.9727454
    },
        "name": "My Third Marker",
        "start": 511090850.8913287
    },
]
Have more questions? Submit a request

Comments

Powered by Zendesk