Hall Technologies March 30, 2023
Page 5 of 10
Terminology & API Commands Overview
TERMINOLOGY
The terminology used in the API command’s description is listed as follows:
•
Device:
the unit being controlled
•
AirPlay Mirroring:
A screen mirroring approach developed by Apple and is supported by many
Apple devices such as MacBooks, iPads, and iPhones.
•
Miracast:
A screen mirroring approach developed by Wi-Fi alliance and is supported by all
Android devices and Windows PCs.
•
BYOD Source:
AirPlay and Miracast are BYOD solutions.
•
Hardware Source:
The physical hardware interface on the device, such as HDMI or USB Type-C.
•
Software Source:
Certain devices can display video content from a USB camera.
API COMMANDS OVERVIEW
API commands are mainly classified into the following types.
•
gbconfig: manages the configurations of the device
•
gbcontrol: controls the device
•
gblayout: adjusts the features related to the screen layout
•
Event: message from the device to report that the device’s state changed
Command syntax uses the command type followed by a space, two dashes, and then the command
plus the argument (as needed). For example:
gbconfig --camera-mode normal
Type
space
dash dash
Command
space
Argument
gbconfig
--
camera-mode
normal
This example changes the device’s configuration to be “normal” for the mode of the camera.
Note:
For the “show” command there is only a single dash: gbconfig -s camera-mode
