GPIO
Trigger GPIO Output
POST /api/gpio/[IndexOrName]/outputs/[Output]/write
Request Body
{
"value": true,
}
Parameter | Value | Description |
---|---|---|
value | Boolean | The value to set the output |
Simulate GPIO Trigger
POST /api/gpio/[IndexOrName]/inputs/[Output]/simulate
Get Info of the Erizos Server
GET /api/info
Returns all the information regarding the Erizos Server.
Response
The response is the information of the Studio Server
{
"info": {
"shortName": "Studio Server",
"longName": "Erizos Studio Server",
"version": "0.0.0.13778",
"buildDate": "2024-03-11T07:57:50.873Z",
"startTime": "2024-03-15 01:23:34",
"license": {
"expiry": "2025-07-31",
"features": {}
},
"session": "246bc8c57fde089d57a57c8dcaf715d8",
"mode": "SERVER"
}
}
Get Settings of Erizos Server
GET /api/settings
Returns all the information regarding the Erizos Server settings
Response
The response is the information of the Studio Server Settings
{
"log": {
"level": "VERBOSE",
"daysToKeep": 30
},
"redundancy": {
"enabled": false,
"replica": "",
"machines": []
},
"general": {
"name": "",
"address": ""
},
"systems": {
"ue": {
"enabled": true,
"source": "FOLDER",
"creativehub": {
"server": "DESKTOP-CVIC5J6",
"username": "admin",
"password": "ENC:7fab6adc9420ff1dddb8f7476859"
},
"root": "D:\\My\\Project\\Directory",
"runInEditor": false,
"livePreview": true,
"routeCommands": true
}
...
...
}
Get all Servers
GET /api/servers
Returns all the Erizos Servers found in the network.
Response
The response is an array of Servers
[
{
"app": "Agent",
"hostname": "DESKTOP-CVIC5J6",
"name": "DESKTOP-CVIC5J6 - Agent",
"port": 5510,
"addresses": [
"192.168.56.1",
"172.22.158.135",
"192.168.1.194"
]
},
{
"app": "Studio Server",
"hostname": "DESKTOP-CVIC5J6",
"name": "DESKTOP-CVIC5J6 - Studio Server",
"port": 5550,
"addresses": [
"192.168.56.1",
"172.22.158.135",
"192.168.1.194"
]
}
]
Restart the App
Restarts the App
POST /api/restart
Response
{
"message": "Restarting"
}
Get all UI Mappings
GET /api/uimappings
Returns all the UI Mappings
Response
The response is an array of UI Mapping
[
{
"_id": "65e884f19d3c19dde220c2db",
"ui": "65e884e89d3c19dde220c2d2",
"key": "65e70de4e26a8da333766cf7",
"show": "65e70de4e26a8da333766cf7",
"disabled": false,
"createdAt": "2024-03-06T15:00:01.038Z",
"updatedAt": "2024-03-11T13:52:37.463Z",
"__v": 0,
"_type": "UIMAPPING"
}
]