VB342Pro API List

PageFunctionAPI NameOptionAPI ValueUsage Notes
SettingTracking Modeptz_smart_framingOff2Requires pressing Confirm in the dialog; Adjustable/effective only when Audio Fence = Off
ptz_smart_framingManual Frame0Requires pressing Confirm in the dialog; Adjustable/effective only when Audio Fence = Off
ptz_smart_framingAuto Frame - PTZ1Requires pressing Confirm in the dialog; Adjustable/effective only when Audio Fence = Off
ptz_smart_framingAudio Tracking4Adjustable/effective only when Audio Fence = Off
ptz_smart_framingAudio Frame5Adjustable/effective only when Audio Fence = Off
ptz_smart_framingPresentation Mode7Requires pressing Confirm in the dialog; Adjustable/effective only when Audio Fence = Off
Framing Speedsys_tracking_speedSlow Speed3
sys_tracking_speedMiddle Speed2
sys_tracking_speedHigh Speed1
Framing Sizeptz_framing_sizeNarrow1
ptz_framing_sizeMedium2
ptz_framing_sizeWide3
Smart Frame Preset Pointptz_frame_starting_presetCentral Of The Screen Image0Adjustable/effective only when Tracking Mode = Off or Manual Frame or Auto Frame - PTZ or Audio Tracking or Presentation Mode
ptz_frame_starting_presetPreset01Adjustable/effective only when Tracking Mode = Off or Manual Frame or Auto Frame - PTZ or Audio Tracking or Presentation Mode
ptz_frame_starting_presetPreset12Adjustable/effective only when Tracking Mode = Off or Manual Frame or Auto Frame - PTZ or Audio Tracking or Presentation Mode
ptz_frame_starting_presetPreset23Adjustable/effective only when Tracking Mode = Off or Manual Frame or Auto Frame - PTZ or Audio Tracking or Presentation Mode
ptz_frame_starting_presetPreset34Adjustable/effective only when Tracking Mode = Off or Manual Frame or Auto Frame - PTZ or Audio Tracking or Presentation Mode
ptz_frame_starting_presetPreset45Adjustable/effective only when Tracking Mode = Off or Manual Frame or Auto Frame - PTZ or Audio Tracking or Presentation Mode
ptz_frame_starting_presetPreset56Adjustable/effective only when Tracking Mode = Off or Manual Frame or Auto Frame - PTZ or Audio Tracking or Presentation Mode
ptz_frame_starting_presetPreset67Adjustable/effective only when Tracking Mode = Off or Manual Frame or Auto Frame - PTZ or Audio Tracking or Presentation Mode
ptz_frame_starting_presetPreset78Adjustable/effective only when Tracking Mode = Off or Manual Frame or Auto Frame - PTZ or Audio Tracking or Presentation Mode
ptz_frame_starting_presetPreset89Adjustable/effective only when Tracking Mode = Off or Manual Frame or Auto Frame - PTZ or Audio Tracking or Presentation Mode
ptz_frame_starting_presetPreset910Adjustable/effective only when Tracking Mode = Off or Manual Frame or Auto Frame - PTZ or Audio Tracking or Presentation Mode
Audio Tracking Response Speedado_delay_timeSlow Speed2
ado_delay_timeMiddle Speed1
ado_delay_timeHigh Speed0
Audio Tracking Idle Intervalado_ai_idle_intervalOff5
ado_ai_idle_interval15 sec0
ado_ai_idle_interval30 sec1
ado_ai_idle_interval40 sec2
ado_ai_idle_interval50 sec3
ado_ai_idle_interval60 sec4
Gesture Controlptz_gesture_enableOff0To operate camera PTZ control, please disable AI function.
ptz_gesture_enableOn1To operate camera PTZ control, please disable AI function.
Audio Fenceado_fence_enableOff01.When Off, microphone pick up the sound all around the video bar. 2.When choosing either Narrow or Wide view Fence, microphone only picks up the sound within viewing area and all the AI tracking functions (such as auto framing)will be disabled.
ado_beamformingOn1Sets multiple APIs at once; 1.When Off, microphone pick up the sound all around the video bar. 2.When choosing either Narrow or Wide view Fence, microphone only picks up the sound within viewing area and all the AI tracking functions (such as auto framing)will be disabled.
ado_fence_enable1Sets multiple APIs at once; 1.When Off, microphone pick up the sound all around the video bar. 2.When choosing either Narrow or Wide view Fence, microphone only picks up the sound within viewing area and all the AI tracking functions (such as auto framing)will be disabled.
Audio Fence Modeado_fenceNarrow View Fence1Prerequisite: ado_fence_enable=1 (verified on device); 1.When Off, microphone pick up the sound all around the video bar. 2.When choosing either Narrow or Wide view Fence, microphone only picks up the sound within viewing area and all the AI tracking functions (such as auto framing)will be disabled.; Adjustable/effective only when Audio Fence = On
ado_fenceWide View Fence3Prerequisite: ado_fence_enable=1 (verified on device); 1.When Off, microphone pick up the sound all around the video bar. 2.When choosing either Narrow or Wide view Fence, microphone only picks up the sound within viewing area and all the AI tracking functions (such as auto framing)will be disabled.; Adjustable/effective only when Audio Fence = On
Auto Focusimg_focus_scdPTZ0
img_focus_scdContinuous1
Camera Focusimg_focus_modeManual0
img_focus_modeAuto1
ptz_f_relyslidebar0~255Adjustable/effective only when Camera Focus = Manual
Home Positionsys_home_posLast Operation Position11
sys_home_posFactory Center Position10
sys_home_posPreset 00
Sleep Positionsys_suspend_posFactory Downside Position0
sys_suspend_posPreset 91
Sleep Timersys_sleep_timeOff0
sys_sleep_time10 sec10
sys_sleep_time5 min300
sys_sleep_time10 min600
sys_sleep_time20 min1200
On Screen Menuptz_preset_msgOff0
ptz_preset_msgOn1
ptz_preset_msgLoad Preset Off2
Save Presetptz_preset_settingOff0
ptz_preset_settingOn1
Image Flipimg_flipOff0
img_flipOn1
Image Mirrorimg_mirrorOff0
img_mirrorOn1
True WDRimg_expo_wdrOff0While in WDR mode, Flicker decrease function will be disabled automatically.
img_flicker_modeOn0Sets multiple APIs at once; While in WDR mode, Flicker decrease function will be disabled automatically.
img_expo_wdr1Sets multiple APIs at once; While in WDR mode, Flicker decrease function will be disabled automatically.
Flicker Decrease on IFP / Monitorimg_flicker_modeOff0While in On mode, WDR, Brightness and Low Light Compensation functions will be disabled automatically.
img_expo_wdrOn0Sets multiple APIs at once; While in On mode, WDR, Brightness and Low Light Compensation functions will be disabled automatically.
img_lowlight_comp0Sets multiple APIs at once; While in On mode, WDR, Brightness and Low Light Compensation functions will be disabled automatically.
img_flicker_mode1Sets multiple APIs at once; While in On mode, WDR, Brightness and Low Light Compensation functions will be disabled automatically.
img_flicker_mode=1img_flickerslidebar0~254While in On mode, WDR, Brightness and Low Light Compensation functions will be disabled automatically.; Adjustable/effective only when img_flicker_mode=1
Frequencyimg_pwln_freq50 HZ1
img_pwln_freq60 HZ2
White Balanceimg_wb_temp_modeManual8
img_wb_temp_modeAuto0
img_wb_tempslidebar2800~10000Adjustable/effective only when White Balance = Manual
Noise Reductionimg_nrOff0
img_nrLow1
img_nrMiddle2
img_nrHigh3
Brightnessimg_brightness11When enabling Flicker Decrease on IFP / Monitor, Brightness function will be disabled automatically.; Adjustable/effective only when Flicker Decrease on IFP / Monitor = Off
img_brightness22When enabling Flicker Decrease on IFP / Monitor, Brightness function will be disabled automatically.; Adjustable/effective only when Flicker Decrease on IFP / Monitor = Off
img_brightness33When enabling Flicker Decrease on IFP / Monitor, Brightness function will be disabled automatically.; Adjustable/effective only when Flicker Decrease on IFP / Monitor = Off
img_brightness44When enabling Flicker Decrease on IFP / Monitor, Brightness function will be disabled automatically.; Adjustable/effective only when Flicker Decrease on IFP / Monitor = Off
img_brightness55When enabling Flicker Decrease on IFP / Monitor, Brightness function will be disabled automatically.; Adjustable/effective only when Flicker Decrease on IFP / Monitor = Off
img_brightness66When enabling Flicker Decrease on IFP / Monitor, Brightness function will be disabled automatically.; Adjustable/effective only when Flicker Decrease on IFP / Monitor = Off
img_brightness77When enabling Flicker Decrease on IFP / Monitor, Brightness function will be disabled automatically.; Adjustable/effective only when Flicker Decrease on IFP / Monitor = Off
img_brightness88When enabling Flicker Decrease on IFP / Monitor, Brightness function will be disabled automatically.; Adjustable/effective only when Flicker Decrease on IFP / Monitor = Off
img_brightness99When enabling Flicker Decrease on IFP / Monitor, Brightness function will be disabled automatically.; Adjustable/effective only when Flicker Decrease on IFP / Monitor = Off
Sharpnessimg_sharpnessOff0
img_sharpnessLow1
img_sharpnessMiddle2
img_sharpnessHigh3
Saturationimg_saturation11
img_saturation22
img_saturation33
img_saturation44
img_saturation55
img_saturation66
img_saturation77
img_saturation88
img_saturation99
Low Light Compensationimg_lowlight_compOff0When enabling Flicker Decrease on IFP / Monitor, Low Light Compensation function will be disabled automatically.
img_flicker_modeOn0Sets multiple APIs at once; When enabling Flicker Decrease on IFP / Monitor, Low Light Compensation function will be disabled automatically.
img_lowlight_comp1Sets multiple APIs at once; When enabling Flicker Decrease on IFP / Monitor, Low Light Compensation function will be disabled automatically.
Low resolution under 720psys_res_ctrlDisable0Requires reboot to take effect; 1. While disable/enable low resolution, the system will reboot automatically and it will take around 20~60 seconds, depending on different models. Please wait. 2. In some video conference software, such as Teams, they may get lower resolution (360p) video streaming from camera to lower down the bandwidth loading during video call. If you'd like to get better image quality during video call,
sys_res_ctrlEnable1Requires reboot to take effect; 1. While disable/enable low resolution, the system will reboot automatically and it will take around 20~60 seconds, depending on different models. Please wait. 2. In some video conference software, such as Teams, they may get lower resolution (360p) video streaming from camera to lower down the bandwidth loading during video call. If you'd like to get better image quality during video call,
Enlarge Total Zoom Up To 15xsys_enlarge_zoom_enDisable0
sys_enlarge_zoom_enEnable1
Video Frame Ratesys_fps_ctrl30Fps0Requires reboot to take effect; 1. 30Fps supports better image quality. 2. It will take around 20~60 seconds to reboot system, depending on different models.
sys_fps_ctrl60Fps1Requires reboot to take effect; 1. 30Fps supports better image quality. 2. It will take around 20~60 seconds to reboot system, depending on different models.
ADDRvsc_addr11Requires pressing Confirm in the dialog
vsc_addr22Requires pressing Confirm in the dialog
vsc_addr33Requires pressing Confirm in the dialog
vsc_addr44Requires pressing Confirm in the dialog
vsc_addr55Requires pressing Confirm in the dialog
vsc_addr66
vsc_addr77
vsc_addr88
Baud Ratevsc_baud24000Requires pressing Confirm in the dialog
vsc_baud48001Requires pressing Confirm in the dialog
vsc_baud96002Requires pressing Confirm in the dialog
vsc_baud1152003
Protocolvsc_protoVisca0Requires pressing Confirm in the dialog
vsc_protoPelco-P1Requires pressing Confirm in the dialog
vsc_protoPelco-D2Requires pressing Confirm in the dialog
Visca Over IPvsc_over_ipOff0Requires pressing Confirm in the dialog
vsc_over_ipOn1Requires pressing Confirm in the dialog
Video FormatH.264 Profilevdo_net_profileBaseline Profile0
vdo_net_profileHigh Profile2
IP Stream Resolutionvdo_net_stm_res1080P0
vdo_net_stm_res720P1
vdo_net_stm_res480P2
vdo_net_stm_res360P3
Frame Ratevdo_net_stm_fr60 FPS60
vdo_net_stm_fr30 FPS30
vdo_net_stm_fr15 FPS15
Bit Ratevdo_net_stm_bitrateAuto7
vdo_net_stm_bitrate512 Kbps0
vdo_net_stm_bitrate1 Mbps1
vdo_net_stm_bitrate2 Mbps2
vdo_net_stm_bitrate4 Mbps3
vdo_net_stm_bitrate8 Mbps4
vdo_net_stm_bitrate16 Mbps5
vdo_net_stm_bitrate32 Mbps6
Video Formatvdo_net_stm_codecH2640
vdo_net_stm_codecH2651
SystemUSB Displaysys_dsplink_enOff0
sys_dsplink_enOn1
Date Formatsys_time_formatyyyy-mm-dd0
sys_time_formatmm-dd-yyyy1
sys_time_formatdd-mm-yyyy2
Time Formatsys_time_24hour24-Hour0
sys_time_24hour12-Hour1
AudioNoise Suppressionado_noise_suppression_enOff0
ado_noise_suppression_enOn1
Noise Suppression Valueado_noise_suppressionslidebar1~40Adjustable/effective only when Noise Suppression = On
Beamforming Microphoneado_fence_enableOff0Sets multiple APIs at once; Off : Microphone picks up all people's sound in the meeting room, Audio Fence will be disabled. On : Microphone enhances the main speaker's sound and depresses the rest.
ado_beamforming0Sets multiple APIs at once; Off : Microphone picks up all people's sound in the meeting room, Audio Fence will be disabled. On : Microphone enhances the main speaker's sound and depresses the rest.
ado_beamformingOn1Off : Microphone picks up all people's sound in the meeting room, Audio Fence will be disabled. On : Microphone enhances the main speaker's sound and depresses the rest.
Automatically Gain Controlado_auto_gainOff0
ado_auto_gainOn1
Echo Cancellationado_echo_cancelOff0
ado_echo_cancelOn1
AI Noise-Cancelingado_ai_noise_cancelOff0
ado_ai_noise_cancelOn1
Reduce Reverberationado_cdr_enableOff0
ado_cdr_enableOn1
Phone In Jackado_phone_in_jackPhone In0
ado_phone_in_jack3.5mm External Microphone Only1
ado_phone_in_jack3.5mm External Microphone Mix In2
ado_phone_in_jackLine Out3