The following methods are available on cues and layers :
- add.cue
- replace.cue
- delete.cue
- get.property.cue
- set.property.cue
- get.property.layer
- set.property.layer
add.cue
Syntax
{"jsonrpc":"2.0","method":"add.cue","params":{"playlistname":"My Playlist", "aftercuename":"My Cue", "data":{"enableLoop": true,"loopItemUuid": "","name": "Added Cue","objectType": "cue","tag": "","taskUuid": "","triggerMode": 0,"triggerParam": 0,"uiColor": "", "uuid": ""}}, "id":1}Indented display
{
"jsonrpc": "2.0",
"method": "add.cue",
"params": {
"playlistname": "My Playlist",
"aftercuename": "My Cue",
"data": {
"enableLoop": true,
"loopItemUuid": "",
"name": "Added Cue",
"objectType": "cue",
"tag": "",
"taskUuid": "",
"triggerMode": 0,
"triggerParam": 0,
"uiColor": "",
"uuid": ""
}
},
"id": 1
}Parameters
| Parameter | Description | Information |
|---|---|---|
| playlistuuid | uuid of the playlist | Target the playlist either by name or by uuid. |
| playlistname | Name of the playlist | If several playlists have the same name, the first one will be targeted. |
| aftercueuuid | uuid of the cue after which to create the new cue | Target the cue either by name or by uuid. |
| aftercuename | Name of the cue after which to create the new cue | If several cues have the same name, the first one will be targeted. |
| data | JSON Object Litteral containing the data of the cue to create | Do not fill the uuid property. It will be automatically generated by the server. |
Returns
Currently this method always returns an error message : missing playlist uuid or name
replace.cue
Syntax
{"jsonrpc":"2.0","method":"replace.cue","params":{"playlistname":"My Playlist", "data":{"enableLoop": true,"loopItemUuid": "","name": "Replaced Cue","objectType": "cue","tag": "","taskUuid": "","triggerMode": 0,"triggerParam": 0,"uiColor": "", "uuid": "{d3f8d341-633c-4574-b25f-02004b1a345e}"}}, "id":1}Indented display
{
"jsonrpc": "2.0",
"method": "replace.cue",
"params": {
"playlistname": "My Playlist",
"data": {
"enableLoop": true,
"loopItemUuid": "",
"name": "Replaced Cue",
"objectType": "cue",
"tag": "",
"taskUuid": "",
"triggerMode": 0,
"triggerParam": 0,
"uiColor": "",
"uuid": "{d3f8d341-633c-4574-b25f-02004b1a345e}"
}
},
"id": 1
}Parameters
| Parameter | Description | Information |
|---|---|---|
| playlistuuid | uuid of the playlist | Target the playlist either by name or by uuid. |
| playlistname | Name of the playlist | If several playlists have the same name, the first one will be targeted. |
| data | JSON Object Litteral containing the data of the cue to create |
Returns
The "result" property in the JSON response will contain true if the instruction was executed correctly.
If the payload is not properly formatted, the server will respond by sending back the payload.
delete.cue
Syntax
{"jsonrpc":"2.0","method":"delete.cue","params":{"playlistname":"My Playlist", "uuid":"{d3f8d341-633c-4574-b25f-02004b1a345e}"},"id": 1}Indented display
{
"jsonrpc": "2.0",
"method": "delete.cue",
"params": {
"playlistname": "My Playlist",
"uuid": "{d3f8d341-633c-4574-b25f-02004b1a345e}"
},
"id": 1
}Parameters
| Parameter | Description | Information |
|---|---|---|
| playlistuuid | uuid of the playlist | Target the playlist either by name or by uuid. |
| playlistname | Name of the playlist | If several playlists have the same name, the first one will be targeted. |
| uuid | uuid of the target cue to delete |
Returns
Currently this method returns an error message : missing playlist uuid or name if targeting using playlist name
get.property.cue
Syntax
{"jsonrpc":"2.0","method":"get.property.cue","params":{"playlistname":"My Playlist", "uuid":"{d3f8d341-633c-4574-b25f-02004b1a345e}", "property":"enableloop"},"id": 1}Indented display
{
"jsonrpc": "2.0",
"method": "get.property.cue",
"params": {
"playlistname": "My Playlist",
"uuid": "{d3f8d341-633c-4574-b25f-02004b1a345e}",
"property": "enableloop"
},
"id": 1
}Parameters
| Parameter | Description | Information |
|---|---|---|
| playlistuuid | uuid of the playlist | Target the playlist either by name or by uuid. |
| playlistname | Name of the playlist | If several playlists have the same name, the first one will be targeted. |
| uuid | uuid of the cue to target | Target the cue either by name or by uuid. |
| name | Name of the cue to target | If several cues have the same name, the first one will be targeted. |
| property | Name of the property whose value to retrieve | The get.list.playlists method can be called with "level" : "cue" as a parameter for full list of available properties. More info here. |
Available properties
The following properties are available for a cue in a Playlist :
| Property | Description | Information |
|---|---|---|
| enableLoop | Indicates if the Loop mode is enabled on this cue. | – |
| loopItemUuid | Indicates the uuid of the cue on which to loop. | If this property is empty then the cue does not loop. |
| name | Name of the cue | – |
| objectType | For this method, this field contains cue |
– |
| tag | Tag of the cue | This field in the Remote accepts only numbers and is designed to facilitate piloting the Modulo Player server using a lighting console. |
| taskUuid | uuid of the task to trigger when this cue plays | – |
| triggerMode | Index of the Trigger mode for the cue | 0 Go ║ 1 Follow 1 ║ 2 Wait ║ 3 TC ║ 4-12 Follow 2-10 |
| triggerParam | Only active for Waitand TC trigger modes. Contains time parameter for theses modes |
Time in ms. |
| uiColor | Color assigned to the cue | – |
| uuid | uuid of the cue | – |
Returns
If Playlist is specified by uuid
This method returns an error message : "message": "missing cue uuid or name" when cue is called by name.
This method returns an error message : "message": "Invalid property" when cue is called by uuid.
If Playlist is specified by name
This method returns an error message : "message": "missing playlist" systematically.
set.property.cue
Syntax
{"jsonrpc":"2.0","method":"set.property.cue","params":{"playlistname":"My Playlist", "uuid":"{d3f8d341-633c-4574-b25f-02004b1a345e}", "property":"name", "value":"Name has changed"},"id":1}Indented display
{
"jsonrpc": "2.0",
"method": "set.property.cue",
"params": {
"playlistname": "My Playlist",
"uuid": "{d3f8d341-633c-4574-b25f-02004b1a345e}",
"property": "name",
"value": "Name has changed"
},
"id": 1
}Parameters
| Parameter | Description | Information |
|---|---|---|
| playlistuuid | uuid of the playlist | Target the playlist either by name or by uuid. |
| playlistname | Name of the playlist | If several playlists have the same name, the first one will be targeted. Currently does not work when palylistname is used. |
| uuid | uuid of the cue to target | Target the cue either by name or by uuid. |
| name | Name of the cue to target | If several cues have the same name, the first one will be targeted. |
| property | Name of the property whose value to retrieve | The get.list.playlists method can be called with "level" : "cue" as a parameter for full list of available properties. More info here. |
| value | The new value to give to the property |
Returns
The "result" property in the JSON response will contain true if the instruction was executed correctly.
If the payload is not properly formatted, the server will respond by sending back the payload.
This method returns an error message : "message": "missing playlist" if playlist is targeted by name. This will be fixed shortly
get.property.layer
Syntax
{"jsonrpc":"2.0","method":"get.property.layer","params":{"playlistname":"My Playlist", "uuid":"{bffca085-7f42-480b-ab53-795b5326cedc}", "property":"color"},"id":1}Indented display
{
"jsonrpc": "2.0",
"method": "get.property.layer",
"params": {
"playlistname": "My Playlist",
"uuid": "{bffca085-7f42-480b-ab53-795b5326cedc}",
"property": "color"
},
"id": 1
}Parameters
| Parameter | Description | Information |
|---|---|---|
| playlistuuid | uuid of the playlist | Target the playlist either by name or by uuid. |
| playlistname | Name of the playlist | If several playlists have the same name, the first one will be targeted. Currently does not work when palylistname is used. |
| uuid | uuid of the target layer | |
| property | Name of the target property whose value to retrieve | The get.list.playlists method can be called with "level" : "layer" as a parameter for full list of available properties. More info here. |
Available properties
The following properties are available for a layer in a cue:
| Property | Description | Information |
|---|---|---|
| active | Indicates if the layer is active or if it is crossed out (playing from previous cues) | – |
| audioPatch | Gives a text representation of the audio patch (Inputs/Outputs) for the audio of the layer | More information soon. |
| audioUuid | uuid of the audio media set on the layer | – |
| blendingMode | Index of the Blend Mode set in the Properties tab for the layer |
0 Alpha ║ 1 Additive ║ 2 Multiply ║ 3 Multiply x2 ║ 4 Screen |
| color | Color value set in the Properties tab for the layer |
– |
| enableFadeOut | Indicates the status of Fade Out | true if Fade out is enabled. false if disabled |
| enableInOutMovie | Indicates if trim mode is active | true if trim has been enabled, false otherwise |
| endMovieMode | Index of the Media Mode set in the Media tab for the layer |
0 Last Frame ║ 1 Loop ║ 2 None |
| fadeInTime | Fade In time | Time in ms |
| fadeOutTime | Fade Out time | Time in ms |
| inMovie | Time set for In Point in trim mode | Time in ms |
| maskMode | Index of Mask Mode | 0 None ║ 1 Alpha ║ 2 Grey |
| maskUuid | uuid of media set as Mask in the Advanced tab, Mask subtab of the layer |
– |
| mediaUuid | uuid of image/video media of the layer | – |
| objectType | For this method, this field contains cue |
– |
| opacity | Opacity set for the layer | Note this value is between 0 and 1 and not between 0 and 100 |
| outMovie | Time set for Out Point in trim mode | Time in ms |
| rotationZ | Rotation value set in the Properties tab for the layer |
– |
| scaleX | Scale value along X axis | Note this value is between 0 and 1 and not between 0 and 100 |
| scaleY | Scale value along Y axis | Note this value is between 0 and 1 and not between 0 and 100 |
| showMask | Indicates if Mask mode is active in the Advanced tab, Mask subtab |
– |
| speed | Indicates speed value set in Advanced tab, Frame edit subtab |
– |
| startTime | Indicates the offset value for starting playback of the layer in the Media tab |
Time in ms |
| topLeft | Index of the Mode set in the Properties tab |
0 Center ║ 1 Top Left ║ 2 Virtual |
| uuid | uuid of the layer | – |
| x | X coordinate of the layer | – |
| y | Y coordinate of the layer | – |
Returns
The "result" property in the JSON response will contain the value of the target property if the instruction was executed correctly.
If the payload is not properly formatted, the server will respond by sending back the payload.
This method returns an error message : "message": "missing playlist" if playlist is targeted by name. This will be fixed shortly
set.property.layer
Syntax
{"jsonrpc":"2.0","method":"set.property.layer","params":{"playlistname":"My Playlist", "uuid":"{bffca085-7f42-480b-ab53-795b5326cedc}", "property":"color", "value":"#0099ff"},"id":1}Indented display
{
"jsonrpc": "2.0",
"method": "set.property.layer",
"params": {
"playlistname": "My Playlist",
"uuid": "{bffca085-7f42-480b-ab53-795b5326cedc}",
"property": "color",
"value": "#0099ff"
},
"id": 1
}Parameters
| Parameter | Description | Information |
|---|---|---|
| playlistuuid | uuid of the playlist | Target the playlist either by name or by uuid. |
| playlistname | Name of the playlist | If several playlists have the same name, the first one will be targeted. Currently does not work when palylistname is used. |
| uuid | uuid of the target layer | |
| property | Name of the target property whose value to modify | The get.list.playlists method can be called with "level" : "layer" as a parameter for full list of available properties. More info here. |
| value | The new value to give to the property |
Returns
The "result" property in the JSON response will contain true if the instruction was executed correctly.
If the payload is not properly formatted, the server will respond by sending back the payload.
This method returns an error message : "message": "missing playlist" if playlist is targeted by name. This will be fixed shortly
Need more help with this?
Don’t hesitate to contact us here.