Command line (console) via SSH protocol
Command line (console) via SSH protocol
Terminal command line
You can connect to the terminal via SSH protocol and control it with text commands in console mode. Login and password for SSH access is the same as for access to the web-interface.
The following command descriptions are valid starting with terminal version 2.9.2.
Command structure
mute | <id> | <on/off> | [<participant>] | <”name”> |
---|---|---|---|---|
keyword | mandatory argument, a user must specify its value | mandatory argument, which possesses only the specified set of values | optional argument, a user can specify it if necessary;
If it’s not specified, command affects only a terminal |
a mandatory string argument, if it contains spaces, it must be passed in quotes |
Examples
Task | Use case |
---|---|
Get information about the microphone status | mute get <participant>
response: mute <participant> <on/off> |
Enable/disable the microphone (bool) | mute <on/off>
mute <participant> <on/off> |
Get information about the camera status | video get <participant>
response: video <participant> <on/off> |
Enable/disable self camera (bool) | video get <on/off>
video get <participant> <on/off> |
Get the list of available cameras | camera list
response: camera {"cameras":[{"format":"YUYV","fps":"30","height":"1080","id":"00-00 Eco Capture Dual HDMI M.2","name":"00-00 Eco Capture Dual HDMI M.2","path":"/dev/video0","role":"main&presentation","width":"1920"},{"format":"YUYV","fps":"30","height":"1080","id":"00-01 Eco Capture Dual HDMI M.2","name":"00-01 Eco Capture Dual HDMI M.2","path":"/dev/video1","role":"not_set","width":"1920"}]} |
sends ICMP ECHO_REQUEST packets to a network host; | ping <ip address> |
outputs a packet route trace to the network host; | traceroute <ip address> |
clears the console screen; | clear |
a list of available commands; | help |
command line exit; | exit |
The example of the camera parameters request command
camera info "ImagePlus_UHD_Media_20200924173"
Format: MJPG
Size: 1920x1080
Interval: 30*
Interval: 25
Interval: 20
Format: H264
Size: 1920x1080
Interval: 30*
Interval: 25
Interval: 20
Format: HEVC
Size: 1920x1080
Interval: 30*
Interval: 25
Interval: 20
OK