Pro Audio Video Manufacturer
Instructions for infobit models including: VB80, iCam VB80 Platform API Commands, iCam VB80, Platform API Commands, Platform Commands, API Commands, iCAM VB80 Commands, Commands
infobit iCam VB80
File Info : application/pdf, 22 Pages, 1.13MB
DocumentDocumentiCam VB80
Platform API Commands Manual
Document Version: V1.0.3
www.infobitav.com info@infobitav.com
Revision History
Doc Version
V1.0.0
V1.0.1
V1.0.2
V1.0.3
Date
Contents
2022/ 04/02 2022/ 04/22 2023/ 06/05 2024/ 03/22
initial Revised typo Add new API Modified
Remarks
Contents
Revision History ................................................................................................2
1 Introduction....................................................................................................5
1.1
Preparation ..........................................................................................................5
1.1.1 Setting IP Address in Your Computer ..................................................................5
1.1.2 Enabling Telnet Client ..........................................................................................5
1.2
Logging In via Command-line Interface ...............................................................5
1.3
API Commands Overview ....................................................................................6
1.3.1 gbconfig Commands ............................................................................................7
1.3.2 gbcontrol Commands ..........................................................................................7
2 Command Sets ................................................................................................8
2.1
gbconfig Commands ............................................................................................8
Camera: ..............................................................................................................................8
2.1.1 gbconfig --camera-mode .....................................................................................8
2.1.2 gbconfig -s camera-mode ....................................................................................8
2.1.3 gbconfig --camera-zoom......................................................................................8
2.1.4 gbconfig -s camera-zoom ....................................................................................9
2.1.5 gbconfig --camera-savecoord ..............................................................................9
2.1.6 gbconfig -s --camera-savecoord ..........................................................................9
2.1.7 gbconfig --camera-loadcoord ........................................................................... 10
2.1.8 gbconfig --camera-mirror ................................................................................. 10
2.1.9 gbconfig -s camera-mirror ................................................................................ 10
2.1.10 gbconfig --camera-powerfreq........................................................................... 11
2.1.11 gbconfig --s camera-powerfreq ........................................................................ 11
Video:............................................................................................................................... 12
2.1.12 gbconfig --hdcp-enable..................................................................................... 12
2.1.13 gbconfig -s hdcp-enable.................................................................................... 12
2.1.14 gbconfig --cec-enable ....................................................................................... 12
2.1.15 gbconfig -s cec-enable ...................................................................................... 13
2.1.16 gbcontrol --sinkpower ...................................................................................... 13
2.1.17 gbconfig --cec-cmd hdmi .................................................................................. 13
2.1.18 gbconfig -s cec-cmd .......................................................................................... 14
2.1.19 gbcontrol --send-cmd hdmi .............................................................................. 14
3
2.1.20 gbconfig --mice-enable..................................................................................... 15 2.1.21 gbconfig -s mice-enable.................................................................................... 15 2.1.22 gbconfig --display-mode ................................................................................... 15 2.1.23 gbconfig -s display-mode.................................................................................. 16 2.1.24 gbcontrol --set-layout-video............................................................................. 16 2.1.25 gbcontrol --get-layout-video............................................................................. 16 Audio: .............................................................................................................................. 16 2.1.26 gbconfig --mic-mute ......................................................................................... 16 2.1.27 gbconfig -s mic-mute ........................................................................................ 16 2.1.28 gbconfig autovolume ...................................................................................... 17 2.1.29 gbconfig --volume ............................................................................................. 17 2.1.30 gbconfig -s volume............................................................................................ 17 2.1.31 gbconfig --speaker-mute .................................................................................. 18 2.1.32 gbconfig -s speaker-mute ................................................................................. 18 2.1.33 gbconfig --vb10-mic-disable ............................................................................. 18 2.1.34 gbconfig -s vb10-mic-disable ............................................................................ 19 System: ............................................................................................................................ 19 2.1.35 gbcontrol --device-info ..................................................................................... 19 2.1.36 gbconfig --hibernate ......................................................................................... 19 2.1.37 gbconfig -s hibernate ........................................................................................ 20 2.1.38 gbconfig --show-guide ...................................................................................... 20 2.1.39 gbconfig -s show-guide ..................................................................................... 20 3 Appendix ......................................................................................................22
4
1 Introduction 1.1 Preparation
This section takes a third-party control device windows 7 as an example. You may also use other control devices.
1.1.1 Setting IP Address in Your Computer
The detailed operation steps are omitted here.
1.1.2 Enabling Telnet Client
Before logging in to the device via command-line interface, make sure that Telnet Client is enabled. By default, Telnet Client is disabled in Windows OS. To turn on Telnet Client, do as follows. 1. Choose Start > Control Panel > Programs. 2. In Programs and Features area box, click Turn Windows features on or off. 3. In Windows Features dialog box, select Telnet Client check box.
1.2 Logging In via Command-line Interface
1. Choose Start > Run. 2. In the Run dialog box, enter cmd then click OK.
5
3. Input telnet x.x.x.x 23. "23" is the port number. For example, if the device's IP address is 192.168.20.140, input telnet 192.168.20.140 23 and then press Enter.
4. When the device prompts login, input admin and press Enter, then the device prompts password, just press Enter directly because the user admin has no default password.
"The device is ready to execute the CLI API command. The status will show Welcome to VB10/ VB80."
1.3 API Commands Overview
This device's API commands are mainly classified into the following types. gbconfig: manage the configurations of the device.
6
gbcontrol: control the device to do something.
1.3.1 gbconfig Commands
gbconfig commands are mainly classified into two types gbconfig and gbconfig --s commands.
Commands
Description
gbconfig --camera-mode gbconfig -s camera-mode gbconfig --camera-zoom gbconfig -s camera-zoom gbconfig --camera-savecoord gbconfig -s --camera-savecoord gbconfig --camera-loadcoord gbconfig --camera-mirror gbconfig -s camera-mirror gbconfig --camera-powerfreq gbconfig -s camera-powerfreq gbconfig --camera-geteptz gbconfig --hdcp-enable hdmi gbconfig -s hdcp-enable gbconfig --cec-enable gbconfig -s cec-enable gbconfig --cec-cmd hdmi gbconfig -s cec-cmd gbcontrol --send-cmd hdmi gbconfig --mic-mute gbconfig -s mic-mute gbconfig --volume gbconfig -s volume gbconfig --autovolume
Set the camera's tracking mode for the device. Get the camera's tracking mode for the device. Set the camera's zoom. Get the camera's zoom. Save the coordinates as preset 1 or preset 2. Get which preset corresponds to the coordinates. Load specific preset to the camera. Turn on/off camera's mirroring. Get the camera's mirroring status. Set powerline frequency. Get powerline frequency. Get eptz information. Set HDCP on/off for HDMI Out Get HDCP status for HDMI out Set CEC enable/disable. Get CEC status. Configure CEC commands for controlling display on/off. Get CEC commands for controlling display on/off. Send CEC commands for controlling display on/off. Set microphone mute on/off. Get microphone mute on/off status. Set audio volume. Get audio volume. Adjust audio volume (increase/decrease).
1.3.2 gbcontrol Commands
Command gbcontrol --send-cmd hdmi
Description To send CEC command to the display immediately.
7
2 Command Sets
2.1 gbconfig Commands
Camera:
2.1.1 gbconfig --camera-mode
Command
gbconfig --camera-mode {normal | autoframing | speakertracking | presentertracking}
Response The camera will change to specified tracking mode.
Set camera's tracking mode from the following:
· normal: Users need to adjust the camera to appropriate angle manually.
· autoframing: Camera automatically tracks the people based on face
Description
recognition.
· speakertracking: Camera automatically tracks the speaker based on speech
recognition.
· presentertracking: Camera automatically tracks the presenter always.
Example:
To set the tracking mode to autoframing:
Command:
gbconfig --camera-mode autoframing
Response:
The camera tracking mode will be set to autoframing.
2.1.2 gbconfig -s camera-mode
Command gbconfig -s camera-mode Response {normal | autoframing | speakertracking | presentertracking} Description Get camera's tracking mode. Example: To get the camera's tracking mode: Command:
gbconfig -s camera-mode Response:
normal This indicates that the tracking mode is set as "normal".
2.1.3 gbconfig --camera-zoom
Command gbconfig --camera-zoom {[100, gbconfig -s camera-phymaxzoom]}
8
Response The camera zoom will be changed. Set camera's zoom. The available value ranges from 100%1x to the camera's maximum physical zoom.
Description For example, if the camera's maximum physical zoom is 500, the available range of the zoom is [100, 500]. 1x to 5x
Example:
To set the camera zoom as 100: Command:
gbconfig --camera-zoom 100 Response: The camera zoom will be set to 1x.
2.1.4 gbconfig -s camera-zoom
Command gbconfig -s camera-zoom Response xxx Description Get camera's zoom.
Example:
To get the camera zoom: Command:
gbconfig -s camera-zoom Response:
100 The camera zoom is 1x.
2.1.5 gbconfig --camera-savecoord
Command Response Description
gbconfig --camera-savecoord {1|2} Current coordinates will be saved to preset 1 or 2. Save current coordinates to specified preset. Preset 1 and 2 are offered.
Example:
To set current coordinates to preset 1: Command:
gbconfig --camera-savecoord 1 Response: The coordinates will be saved to preset 1.
2.1.6 gbconfig -s --camera-savecoord
Command Response
Description
gbconfig --s camera-savecoord {1 | 2} true/false To get if the coordinates are saved to the specified preset. · True: The coordinates have been saved to the specified preset already. · False: The coordinates are not saved to the specified preset.
9
Example:
To get if current coordinates are save to preset 1: Command:
gbconfig --s camera-savecoord 1 Response:
false The coordinates are not saved to preset 1.
2.1.7 gbconfig --camera-loadcoord
Command Response Description
gbconfig --camera-loadcoord {1 | 2} The specified preset will be loaded to the camera. Load preset 1/2 to the camera.
Example:
To load preset 1 to the camera: Command:
gbconfig --camera-loadcoord 1 Response: Preset 1 will be loaded to the camera.
2.1.8 gbconfig --camera-mirror
Command Response
Description
gbconfig --camera-mirror {n | y}
The camera mirroring function will be turned on or off. To turn on or off the camera's mirroring function. · n: Mirroring off. · y: Mirroring on.
Example:
To turn on mirroring: Command:
gbconfig --camera-mirror y Response: Camera mirroring function will be turned on.
2.1.9 gbconfig -s camera-mirror
Command Response
Description
gbconfig -s camera-mirror
n/y To get the mirroring status. · n: Mirroring off. · y: Mirroring on.
Example:
To get the mirroring status: Command:
10
gbconfig -s camera-mirror Response:
y Camera mirroring function is turned on.
2.1.10 gbconfig --camera-powerfreq
Command Response
Description
gbconfig --camera-powerfreq {50 | 60}
The frequency will be changed to 50/60. To change the powerline frequency to prevent flicker in the video. · 50: Change the frequency to 50Hz. · 60: Change the frequency to 60Hz.
Example:
To change the powerline frequency to 60Hz: Command:
gbconfig --camera-powerfreq 60 Response: The powerline frequency will be changed to 60Hz.
2.1.11 gbconfig --s camera-powerfreq
Command Response
Description
gbconfig --s camera-powerfreq
n/50/60 Get the powerline frequency. · 50: Change the frequency to 50Hz. · 60: Change the frequency to 60Hz.
Example:
To get the powerline frequency: Command:
gbconfig --s camera-powerfreq Response:
60 The anti-flicker function is 60Hz.
11
Video:
2.1.12 gbconfig --hdcp-enable
Command gbconfig --hdcp-enable hdmi { n | auto | hdcp14 | hdcp22}
Response The HDCP of HDMI Out will be enabled or disabled.
Configure HDCP capability for HDMI Out.
· n: Turn off HDCP.
· auto: HDCP will be turned on/off automatically based on actual situation. e.g.
Description
when "auto" is set, if both the source and HDMI display support HDCP 2.2, the HDMI output signal will be HDCP 2.2 encrypted; if the source doesn't support
HDCP, the HDCP of HDMI output signal will be off.
· hdcp14: The HDCP of HDMI Out will be set as 1.4.
· hdcp22: The HDCP of HDMI Out will be set as 2.2.
Example:
To set HDCP of HDMI out as 2.2: Command:
gbconfig --hdcp-enable hdmi hdcp22 Response: The HDCP of HDMI out is set as 2.2.
2.1.13 gbconfig -s hdcp-enable
Command gbconfig -s hdcp-enable Response n/auto/hdcp14/hdcp22 Description Get HDCP status of HDMI Out.
Example:
To get HDCP status of HDMI out: Command:
gbconfig -s hdcp-enable Response:
n The HDCP of HDMI out is turned off.
2.1.14 gbconfig --cec-enable
Command gbconfig --cec-enable {n | y}
Response The CEC will be turned on or off.
Description
Set the CEC on/off. n: Turn off CEC. y: Turn on CEC.
12
Example:
To turn on CEC: Command:
gbconfig --cec-enable y Response: CEC will be turned on.
2.1.15 gbconfig -s cec-enable
Command gbconfig -s cec-enable
Response n/y
Get CEC status.
Description
n: CEC is off. y: CEC is on. Note: Once CEC is off, the command "gbcontrol --sinkpower" will be unavailable,
and the switching between normal working and standby for VB10 will be invalid as
well.
Example:
To get CEC status: Command:
gbconfig -s cec-enable Response:
y CEC is turned on.
2.1.16 gbcontrol --sinkpower
Command gbcontrol --sinkpower {on | off}
Response
CEC command for controlling display on/off will be sent from HDMI Out to connected display.
Description
To send CEC command for controlling display on or off. on: Send CEC command for controlling display on. Off: Send CEC command for controlling display off.
Example:
To send CEC command for controlling display on: Command:
gbcontrol --sinkpower on Response: The CEC command to power on CEC-enabled display will be sent from HDMI out.
2.1.17 gbconfig --cec-cmd hdmi
Command Response
gbconfig --cec-cmd hdmi {on | off} {CmdStr} CEC commands for controlling display on/off will be configured and saved on the
13
device.
To configure and save CEC commands for controlling display on or off on the
Description
device. on: Configure CEC command for controlling display on. off: Configure CEC command for controlling display off. CmdStr: CEC command in string or hex format. For example, the CEC
command to power on display may be "40 04".
Example:
To configure and save CEC command "40 04" for powering on display on the device: Command:
gbconfig --cec-cmd hdmi on 4004 Response: The CEC command to power on CEC-enabled display "40 04" will be saved on the device.
2.1.18 gbconfig -s cec-cmd
Command gbconfig -s cec-cmd
Response
HDMI ON: xxxx HDMI OFF: xxxx
Description
Get CEC commands for controlling display on and off. on: Configure CEC command for controlling display on. Off: Configure CEC command for controlling display off. CmdStr: CEC command in string or hex format. For example, the CEC
command to power on display may be "40 04".
Example:
To get CEC commands for controlling display on and off: Command:
gbconfig -s -cec-cmd Response:
HDMI ON: 4004 HDMI OFF: ff36 The CEC command to power on CEC-enabled display: "40 04"; command to power off display: "ff 36".
2.1.19 gbcontrol --send-cmd hdmi
Command gbcontrol --send-cmd hdmi {CmdStr} Response The CEC command {CmdStr} will be sent to the display immediately for testing.
To send CEC command {CmdStr} to the display immediately. Description
Note: This command will not be saved on the device.
Example:
To send CEC commands "44 04" to the display: Command:
gbcontrol --send-cmd hdmi 4004 Response: The CEC command "40 04" will be sent to the display immediately.
14
2.1.20 gbconfig --mice-enable
Command gbconfig --mice-enable {n |y} Response Miracast over Infrastructure feature enabled or disabled
ndisabled. Description
yenabled. Example: To set Miracast over Infrastructure as enabled: Command:
gbconfig --mice-enable y Response: Miracast over Infrastructure feature will be enabled.
2.1.21 gbconfig -s mice-enable
Command gbconfig -s mice-enable Response n/y
ndisabled. Description
yenabled. Example: To get Miracast over Infrastructure status: Command:
gbconfig -s mice-enable Response:
n The Miracast over Infrastructure is disabled.
2.1.22 gbconfig --display-mode
Command gbconfig --display-mode {single | dual} Response Set Display layout to single, split Description Single and Split are auto layout, Example: To Set Display layout to manual mode: Command:
gbconfig --display-mode single Response: The display layout mode turned to single.
15
2.1.23 gbconfig -s display-mode
Command gbconfig -s display-mode Response single/ dual/manual
single, auto single layout Description dual, auto split layout
manual, for manual layout setting Example: To get display mode status: Command:
gbconfig -s display-mode Response:
single The display mode is single.
Audio:
2.1.24 gbconfig --mic-mute
Command gbconfig --mic-mute {n | y}
Response All microphones will be set as mute on/off.
Description
Set all microphones (including VB10's and expansible microphones) mute on/off. n: mute off. y: mute on.
Example:
To set all microphone mute off: Command:
gbconfig --mic-mute n Response: The microphones will be set as mute off.
2.1.25 gbconfig -s mic-mute
Command gbconfig -s mic-mute
Response n/y
To get all microphones (including VB10's and expansible microphones) mute
Description
on/off status. n: mute off. y: mute on.
Example:
To get all microphone mute on/off status: Command:
gbconfig -s mic-mute
16
Response: n
The microphones are mute off.
2.1.26 gbconfig autovolume
Command gbconfig --autovolume {inc | dec}
Response The volume gain will be increased or decreased by 2 per step.
Description
To increase or decrease the volume. inc: To increase the gain of the output volume by 2 per step. dec: To decrease the gain of the output volume by 2 per step.
Example:
To increase volume: Command:
gbconfig --autovolume inc Response: The volume will be increased by 2 per step.
2.1.27 gbconfig --volume
Command gbconfig --volume {0,12,24,36,50,62,74,88,100} Response Set the volume values. Description Volume can only be configured to specified values Example: To set the volume: Command:
gbconfig --volume 50 Response: The volume will be set to 50.
2.1.28 gbconfig -s volume
Command gbconfig -s volume Response 0~100 Description Get the volume values. Example: To get the volume: Command:
gbconfig -s volume Response:
50 The volume is 50.
17
2.1.29 gbconfig --speaker-mute
Command gbconfig --speaker-mute {n | y} Response Set the speaker mute/unmute.
n, unmute Description
y, mute Example: To set the speaker mute: Command:
gbconfig --speaker-mute y Response: The speaker will be mute.
2.1.30 gbconfig -s speaker-mute
Command gbconfig -s speaker-mute Response n/y Description Get the speaker status. Example: To get the mute status of the speaker: Command:
gbconfig -s speaker-mute Response:
n The speaker is unmute.
2.1.31 gbconfig --vb10-mic-disable
Command gbconfig --vb10-mic-disable {n |y} Response Set the internal mic of vb10 enabled/disabled.
n, enabled Description
y, disabled Example: To set the mic disabled: Command:
gbconfig --vb10-mic-disable y Response: The mic of vb10 will be disabled.
18
2.1.32 gbconfig -s vb10-mic-disable
Command gbconfig -s vb10-mic-disable Response n/y Description Get the mic status. Example: To get the mic status: Command:
gbconfig -s vb10-mic-disable Response:
n The mic is enabled.
System:
2.1.33 gbcontrol --device-info
Command gbcontrol --device-info Response Get the firmware version Description The firmware version for VB10 Example: To get the firmware version: Command:
gbcontrol --device-info Response:
V1.3.10
2.1.34 gbconfig --hibernate
Command gbconfig --hibernate {n |y} Response Set the device to sleep.
n, wake up Description
y, sleep Example: To set the device sleep: Command:
gbconfig --hibernate y Response:
19
The device will sleep.
2.1.35 gbconfig -s hibernate
Command gbconfig -s hibernate Response n/y Description Get the sleep status. Example: To get the sleep status of the device: Command:
gbconfig -s hibernate Response:
n The device is working.
2.1.36 gbconfig --show-guide
Command gbconfig --show-guide {n |y} Response Show the guide screen manual.
n, close Description
y, show Example: To show the guide screen: Command:
gbconfig --show-guide y Response: The guide screen will show.
2.1.37 gbconfig -s show-guide
Command gbconfig -s show-guide Response n/y
Get the guide screen status. Description
Note that only the status of the manually set guide screen is fed back. Example: To get the guide screen status of the device: Command:
gbconfig -s hibernate Response:
n The guide screen is not show.
20
21
3 Appendix
[To be added] [To be added]
22