Get.list.vnodes:
Return the list of V-Node servers with properties
| Property | Description |
|---|---|
| blind | blind state of the V-Node |
| name | the name of the V-Node |
| objectType | type of object, here “V-Node” |
| renderSurfaceUuid | uuid of the linked rendersurface |
| state | state of the V-Node : 0 -> disconnected or error, 1 -> connection in progress , 2 -> ready |
| uiColor | color of the V-Node |
| uuid | unique uuid to control the V-Node |
| ip | Ip address of the V-Node |
| fps | current fps playback |
| version | version of the V-Node |
Example:
{"jsonrpc":"2.0","method":"get.list.vnodes","id": 1}Get.object.vnode:
Return the properties of one V-Node server.
You can use one of the following parameters:
| Param | B1 |
|---|---|
| uuid | unique uuid to control the V-Node |
| name | name of the V-Node. if several V-Nodes with same name, it will return the first one |
| Property | Description |
|---|---|
| blind | blind state of the V-Node |
| name | the name of the V-Node |
| objectType | type of object, here “V-Node” |
| renderSurfaceUuid | uuid of the linked rendersurface |
| state | state of the V-Node: 0 -> disconnected or error, 1 -> connection in progress , 2 -> ready |
| uiColor | color of the V-Node |
| uuid | unique uuid to control the V-Node |
| ip | Ip address of the V-Node |
| fps | current fps playback |
| version | version of the V-Node |
Example:
{"jsonrpc":"2.0","method":"get.object.vnode", "params": {"uuid": "{45c8566e-435d-4abb-ad3a-2800cb1ce1c5}"}}Set.property.vnode:
Use this command to set a V-Node property.
It is possible to set these properties:
| Property | Description |
|---|---|
| blind | set the blind state of a V-Node |
| name | the name of the V-Node |
| uiColor | color of the V-Node |
Example:
{"jsonrpc":"2.0","method":"set.property.vnode", "params":{"uuid":"{45c8566e-435d-4abb-ad3a-2800cb1ce1c5}","property":"blind","value":true}}Doaction.vnode:
Use this command to do an action on a V-Node.
| Action | Description |
|---|---|
| online | do an online action on a V-Node |
| offline | do an offline action on a V-Node |
| halt | halt the computer V-Node |
| reboot | reboot the computer V-Node |
| start | start the V-Node application |
| stop | stop the V-Node application |
Example:
{"jsonrpc":"2.0","method":"doaction.vnode", "params":{"uuid":"{45c8566e-435d-4abb-ad3a-2800cb1ce1c5}","action":"online"}}
Need more help with this?
Don’t hesitate to contact us here.