REST API Quick start guide
Currently the only thing you can do with the REST API is to add new markers and change angle. If you have any additional request, please let us know.
Multicam Logger uses port 8888 by default, but this can be configured in the preferences of Multicam Logger.
Which document will "reply"?
As Multicam Logger is a "document based" application, you can have multiple documents opened. You should note that it's the front most document that will answer to your requests.
Changing angles
You can also change the selected angle in program and preview.
IMPORTANT NOTE: If you are working with an ATEM or Tricaster, changing in the UI of Multicam Logger also changes in the production switcher. So it means you can control your production switcher from a simple web page.
You can either set which input is in program, or which input is in preview, or both. Or you can jus task to do a "TAK3".
Note that the index is 0 based. This also can be done either with a POST or a GET.
Assigning Preview and Program
In this case, indicate which input should be used for program and which one for preview.
POST change_angle
{
"program" : "0",
"preview" : "1",
}
And here with a GET.
GET /change_angle?program=0&preview=1
Assigning just the Program, or the Preview
Here either indicate which input to use in program OR which one in preview (following example for program change only)
POST change_angle
{
"program" : "0",
}
And here with a GET.
GET /change_angle?program=0
Doing a "TAKE"
And finally if you just want to do a "TAKE" (swap program and preview), just do not specify any program or preview.
POST change_angle
And here with a GET.
GET /change_angle
Retrieving angles
You can also retrieve the list of angle changes that were done:
GET angle_changes
This will return a dictionary with the list of angle changes.
Example response:
[
{
{
"out_point" : "01:00:11;00",
"in_point" : "01:00:01;00",
"program" : 0,
"duration" : "00:00:10;00"
},
{
"out_point" : "01:00:20;29",
"in_point" : "01:00:11;00",
"program" : 1,
"duration" : "00:00:09;29"
},
{
"out_point" : "01:00:30;29",
"in_point" : "01:00:20;29",
"program" : 0,
"duration" : "00:00:10;00"
},
{
"out_point" : "01:00:40;29",
"in_point" : "01:00:30;29",
"program" : 1,
"duration" : "00:00:10;00"
},
{
"out_point" : "01:00:50;29",
"in_point" : "01:00:40;29",
"program" : 0,
"duration" : "00:00:10;00"
}
}
]
Note that the "program" value shows the index of the inputs that was used in program. You can use GET /inputs to retrieve the names of these.
If you need more info or support about Multicam Logger, you can find it on
our support desk. And if you need additional information on the API and/or the websockets, submit a ticket and we'll be happy to guide you.