---
title: "Vaddio AV Bridge 2x1"
canonical: "https://docs.cuesystem.com/space/CVCDD/784990233/Vaddio%20AV%20Bridge%202x1"
format: markdown
---
> Macro (toc)
---
# Description
This is the documentation of the XPL device drivers for Vaddio AV Bridge 2x1 device. If the device is connected by TCP, then use the driver AV Bridge 2x1 (TCP). If the device is connected by SERIAL, then use the driver AV Bridge 2x1 (SERIAL).
Functions implements AV Bridge 2x1 serial api commands. Some functions use constants according to the documentation. For convenience, these constants are available via a driver structured variable (see AvBridgeConstants).
# Resources
Original Vaddio [AV Bridge 2x1](https://www.legrandav.com/products/av_to_usb_bridges/production_switcher/av-bridge-2x1/999-8250-000) documentation.
# Properties
## Properties common for both drivers
| | | | |
| --- | --- | --- | --- |
| Property name | Data type | Default value | Description |
| |
| LoginPassword | Ascii text | | Admin password of the AV Bridge device. |
| LoginName | Ascii text | | Admin user name of the AV Bridge device. |
| AnswerTimeout | Time | :0.3 | Wait timeout between command and answer. If the connection is very slow, then try larger value. |
| DebugCommunication | Boolean | False | This property can be set to true if the developer wants to see the communication between controller and AV Bridge device in the CUE Visual Composer debug window. |
## Properties for TCP connection
| | | | |
| --- | --- | --- | --- |
| Property name | Data type | Default value | Description |
| |
| IpAddress | Text | | Ip address of the AV Bridge device. |
| ConnectTimeout | Time | :3.00 seconds | Timeout for connecting to the AV Bridge 2x1 telnet server. |
## Properties for SERIAL connection
The AV Bridge 2x1 (SERIAL) driver does not have any special properties.
# Errors
Functions returns value true or false. If the false value is returned, then developer can check the error by GetLastError() function. Next are errors from the device driver.
| **Error name** | **Error number** | **Error description** |
| --- | --- | --- |
| ERR_CANNOTCONNECT | 4000001 | Unable to connect to telnet server. Probably an incorrectly set ip address or the server is in another subnet or the connection time is too short or the device is not running. |
| ERR_CANNOTLOGIN | 4000002 | Unable to login. Maybe the admin user name and/or password is wrong. |
| ERR_COMMANDPROMPTNOTDETECTED | 4000003 | Telnet server command prompt not recognized. Maybe the AV Bridge firmware is incompatible with the XPL device driver. Please, contact technical support. |
| ERR_COMMANDSUCCESSANSWERNOTDETECTED | 4000004 | OK answer not recognised. Maybe invalid command parameters. |
| ERR_ANSWERNOTVALID | 5000001 | OK answer was recognised, but the answer can not be parsed by the device driver. Maybe AVBridge firmware incompatibility. |
#
Functions
Al functions returns value true on success. If the function returns false, the the error can be checked by the GetLastError() function. Functions use parameters with dedicated values by the [AV Bridge 2x1 documentation](https://www.legrandav.com/products/av_to_usb_bridges/production_switcher/av-bridge-2x1/999-8250-000). For convenience are this values available by the driver structured variable AvBridgeConstants.
## AudioVolumeGet
Function returns the actual volume of the selected channel.
#### Syntax
```visualbasic
Function AudioVolumeGet(channl As ByteString, ByRef volume As Double) As Boolean
```
#### Parameters
channl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Audio channel.
volume
[Double](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Double) ByRef variable for returning the value.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var volume As Double
If Matrix_Switcher1.AudioVolumeGet(Matrix_Switcher1.AvBridgeConstants.audio_line_in_1,volume) Then
DebugPrintFormat("audio line in 1 volume: {n}", volume)
End If
End Process
```
## AudioVolumeSet
Function set volume of the selected channel.
#### Syntax
```visualbasic
Function AudioVolumeSet(channl As ByteString, volume As Double) As Boolean
```
#### Parameters
channl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Audio channel.
volume
[Double](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Double) Value of the required volume in decibels (-12db .. +12db).
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.AudioVolumeSet(Matrix_Switcher1.AvBridgeConstants.audio_line_in_1,-11.2) Then
DebugPrint("audio line in 1 volume set to -11.2 db")
End If
End Process
```
## AudioVolumeUp
Function increments volume of the selected channel by 1dB.
#### Syntax
```visualbasic
Function AudioVolumeUp(channl As ByteString) As Boolean
```
#### Parameters
channl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Audio channel.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.AudioVolumeUp(Matrix_Switcher1.AvBridgeConstants.audio_line_in_1) Then
DebugPrint("audio line in 1 volume incremented by 1db")
End If
End Process
```
## AudioVolumeDown
Function decrements volume of the selected channel by 1dB.
#### Syntax
```visualbasic
Function AudioVolumeDown(channl As ByteString) As Boolean
```
#### Parameters
channl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Audio channel.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.AudioVolumeDown(Matrix_Switcher1.AvBridgeConstants.audio_line_in_1) Then
DebugPrint("audio line in 1 volume decremented by 1db")
End If
End Process
```
## AudioMuteGet
Function returns the actual mute status of the selected channel.
#### Syntax
```visualbasic
Function AudioMuteGet(channl As ByteString, ByRef on As Boolean) As Boolean
```
#### Parameters
channl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Audio channel.
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) ByRef variable for returning the value.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var mute As Boolean
If Matrix_Switcher1.AudioMuteGet(Matrix_Switcher1.AvBridgeConstants.audio_line_in_1,mute) Then
DebugPrintFormat("audio line in 1 mute is {L 'on' 'off'}", mute)
End If
End Process
```
## AudioMuteSet
Function set mute status of the selected channel.
#### Syntax
```visualbasic
Function AudioMuteSet(channl As ByteString, on As Boolean) As Boolean
```
#### Parameters
channl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Audio channel.
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) Mute status to set.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.AudioMuteSet(Matrix_Switcher1.AvBridgeConstants.audio_line_in_1,true) Then
DebugPrint("audio line in 1 mute is set to true")
End If
End Process
```
## AudioMuteToggle
Function toggles the actual mute status of the selected channel.
#### Syntax
```visualbasic
Function AudioMuteToggle(channl As ByteString) As Boolean
```
#### Parameters
channl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Audio channel.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.AudioMuteToggle(Matrix_Switcher1.AvBridgeConstants.audio_line_in_1) Then
DebugPrint("audio line in 1 mute was toggled")
End If
End Process
```
## AudioRouteGet
Function returns the actual route to the selected output channel.
#### Syntax
```visualbasic
Function AudioRouteGet(ouputchannl As ByteString, ByRef inputchannl As ByteString) As Boolean
```
#### Parameters
outputchannl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Audio channel.
`inputchannl `
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef variable for returning the input channel routed.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var inp As Bytestring[100]
If Matrix_Switcher1.AudioRouteGet(Matrix_Switcher1.AvBridgeConstants.usb3_record_left,inp) Then
DebugPrintFormat("Input {s} routed to audio usb 3 record left", inp)
End If
End Process
```
## AudioRouteSet
Function set the route between input and selected output channel.
#### Syntax
```visualbasic
Function AudioRouteSet(inputchannl As ByteString, ouputchannl As ByteString) As Boolean
```
#### Parameters
outputchannl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Output routed to input channel.
`inputchannl `
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Input channel routed to output.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.AudioRouteSet(Matrix_Switcher1.AvBridgeConstants.audio_line_in_1, Matrix_Switcher1.AvBridgeConstants.usb3_record_left) Then
DebugPrint("Input line in 1 routed to audio usb 3 record left")
End If
End Process
```
## AudioCrossPointGainGet
Function returns the actual cross-point gain between selected input and output channel.
#### Syntax
```visualbasic
Function AudioCrossPointGainGet(inputchannl As ByteString, outputchannl As ByteString, ByRef gain As Double) As Boolean
```
#### Parameters
inputchannl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Input audio channel.
outputchannl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Output audio channel.
gain
[Double](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Double) ByRef variable for returning the value.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var gainAs Double
If Matrix_Switcher1.AudioCrossPointGainGet(Matrix_Switcher1.AvBridgeConstants.audio_line_in_1,Matrix_Switcher1.AvBridgeConstants.usb3_record_left,gain) Then
DebugPrintFormat("cross-point gain: {n}", gain)
End If
End Process
```
## AudioCrossPointGainSet
Function set actual cross-point gain between selected input and output channel.
#### Syntax
```visualbasic
Function AudioCrossPointGainSet(inputchannl As ByteString, outputchannl As ByteString, gain As Double) As Boolean
```
#### Parameters
inputchannl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Input audio channel.
outputchannl
[Bytestring](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Output audio channel.
gain
[Double](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Double) Cross-point gain value to set.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var gainAs Double
If Matrix_Switcher1.AudioCrossPointGainSet(Matrix_Switcher1.AvBridgeConstants.audio_line_in_1,Matrix_Switcher1.AvBridgeConstants.usb3_record_left,10.8) Then
DebugPrint("cross-point gain set to 10.8 dB.")
End If
End Process
```
## CameraHome
Function moves connected camera to the home position.
#### Syntax
```visualbasic
Function CameraHome(camera As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraHome(Matrix_Switcher1.AvBridgeConstants.camera_2) Then
DebugPrint("camera 2 moves to the home position")
End If
End Process
```
## CameraPanLeft
Function moves camera to the left.
#### Syntax
```visualbasic
Function CameraPanLeft(camera As Long, Optional speed As Long := 0) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
speed
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Move speed selection. If zero, then camera moves at default speed.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraPanLeft(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 pans left at speed 3")
End If
End Process
```
## CameraPanRight
Function moves camera to the right.
#### Syntax
```visualbasic
Function CameraPanLeft(camera As Long, Optional speed As Long := 0) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
speed
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Move speed selection. If zero, then camera moves at default speed.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraPanRight(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 pans right atspeed 3")
End If
End Process
```
## CameraPanStop
Function stops camera pan.
#### Syntax
```visualbasic
Function CameraPanStop(camera As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraPanStop(Matrix_Switcher1.AvBridgeConstants.camera_2) Then
DebugPrint("camera 2 pan was stopped")
End If
End Process
```
## CameraTiltUp
Function tilts camera up.
#### Syntax
```visualbasic
Function CameraTiltUp(camera As Long, Optional speed As Long := 0) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
speed
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Speed selection. If zero, then camera tilts at default speed.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraTiltUp(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 tilts up at speed 3")
End If
End Process
```
## CameraTiltDown
Function tilts camera down.
#### Syntax
```visualbasic
Function CameraTiltDown(camera As Long, Optional speed As Long := 0) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
speed
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Speed selection. If zero, then camera tilts at default speed.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraTiltDown(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 tilts down at speed 3")
End If
End Process
```
## CameraTiltStop
Function stops camera tilt.
#### Syntax
```visualbasic
Function CameraTiltStop(camera As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraTiltStop(Matrix_Switcher1.AvBridgeConstants.camera_2) Then
DebugPrint("camera 2 tilt stopped")
End If
End Process
```
## CameraZoomIn
Function zooms camera in.
#### Syntax
```visualbasic
Function CameraZoomIn(camera As Long, Optional speed As Long := 0) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
speed
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Speed selection. If zero, then camera zooms at default speed.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraZoomIn(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 zooms in at speed 3")
End If
End Process
```
## CameraZoomOut
Function zooms camera out.
#### Syntax
```visualbasic
Function CameraZoomOut(camera As Long, Optional speed As Long := 0) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
speed
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Speed selection. If zero, then camera zooms at default speed.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraZoomOut(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 zooms out at speed 3")
End If
End Process
```
## CameraZoomStop
Function stops camera zoom.
#### Syntax
```visualbasic
Function CameraZoomStop(camera As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraZoomStop(Matrix_Switcher1.AvBridgeConstants.camera_2) Then
DebugPrint("camera 2 zoom stopped")
End If
End Process
```
## CameraPresetStore
Function zooms camera out.
#### Syntax
```visualbasic
Function CameraPresetStore(camera As Long, preset As Long, Optional saveccu As Boolean := False, Optional trisync As Long := 0) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
preset
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Preset number (1-16).
saveccu
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) If true - saves the current CCU settings as part of the preset. If not specified, the last color settings are used when recalled.
trisync
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Preset number (1-24). Specifies that the camera uses Tri-Synchronous Motion to move to this position, using the specified speed. Valid only for cameras that have the Tri-Synchronous Motion feature.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraPresetStore(Matrix_Switcher1.AvBridgeConstants.camera_2, 3, true, 5) Then
DebugPrint("camera 2 preset stored as preset 3")
End If
End Process
```
## Camera CCU Parameters
The parameters returned by the camera ccu get command and available to the camera ccu set command depend on the capabilities of the specific camera. The following parameters are
typically available.
Refer to the camera's manual for detailed information. Note that some command parameters may be unavailable to the AV Bridge device, although they are available when controlling the camera
directly via Telnet.
| **Parameter** | **Value** | **Description** |
| --- | --- | --- |
| auto_iris | on or off | Allows the camera to compensate automatically for light level. |
| iris | integer | Manual aperture adjustment for light level. Range varies depending on camera. |
| gain | integer | (Iris gain) Adjusts for light level without changing the iris setting. Range varies depending on camera. |
| backlight_compensation
. | on or off | Reduces contrast to adjust for bright light behind the main subject of the shot.
wide_dynamic_range must be off to use backlight_compensation. |
| wide_dynamic_range | on or off | Automatically darkens bright areas and brightens dark areas to provide a more properly exposed image in challenging lighting conditions.
backlight_compensation must be off to use wide_dynamic_range. |
| detail | integer | Image sharpness. Range varies depending on camera. |
| auto_white_balance | on or off | Adjusts color automatically. Red and blue gain settings are ignored if auto_white_balance is on. |
| red_gain and blue_gain | integer | Adjust color when auto_white_balance is off. Range varies depending on camera. |
| chroma | integer | Color intensity. Range varies depending on camera. |
| gamma | integer | Range (gray density) between bright areas and shadows. Range varies depending on camera. |
## Camera Ccu command structures
Structures for camera color command CameraCcuGet.
```
Const MAXIDENTIFIERLEN As Long := 100
Structure BoolVal
Var Val As Boolean
Var Valid As Boolean
End Structure
Structure LongVal
Var Val As Long
Var Valid As Boolean
End Structure
Structure DoubleVal
Var Val As Double
Var Valid As Boolean
End Structure
Structure BstrVal
Var Val As ByteString[MAXIDENTIFIERLEN]
Var Valid As Boolean
End Structure
Public Structure CameraCcuParams
Var AutoIris As BoolVal
Var Iris As LongVal
Var Gain As LongVal
Var BacklightCompensation As BoolVal
Var WideDynamicRange As BoolVal
Var Detail As LongVal
Var AutoWhiteBalance As BoolVal
Var RedGain As LongVal
Var BlueGain As LongVal
Var Chroma As LongVal
Var Gama As LongVal
End Structure
```
## CameraCcuGet
Function returns camera color parameters in the parameter ccuparams.
#### Syntax
```visualbasic
Function CameraCcuGet(camera As Long, ByRef ccuparams As CameraCcuParams) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
ccuparams
[Structure](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Structure) ByRef value fo returning camera color parameters..
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var ccuparams as Namespace "CUE.Devices.VADDIO.AVBridge2x1Base".CameraCcuParams
If Matrix_Switcher1.CameraCcuGet(Matrix_Switcher1.AvBridgeConstants.camera_2, ccuparams) Then
If ccuparams.AutoIris.Valid then
DebugPrintFormat("camera 2 Autoiris is {L}", ccuparams.AutoIris.Val)
End If
End If
End Process
```
## CameraCcuSetAutoIris
Function set autoiris property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetAutoIris(camera As Long, on As Boolean) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) Set value of autoiris property.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraSetAutoIris(Matrix_Switcher1.AvBridgeConstants.camera_2, true) Then
DebugPrint("camera 2 autoiris property set to true")
End If
End Process
```
## CameraCcuSetIris
Function set iris property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetIris(camera As Long, iris As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
iris
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera iris value.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraSetIris(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 iris property set to 3")
End If
End Process
```
## CameraCcuSetGain
Function set gain property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetGain(camera As Long, gain As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
gain
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera iris gain value.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraSetGain(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 iris gain property set to 3")
End If
End Process
```
## CameraCcuSetBacklightCompensation
Function set backlight_compensation property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetGain(camera As Long, on As Boolean) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) If true, backlight_compensation property will be set.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraSetBacklightCompensation(Matrix_Switcher1.AvBridgeConstants.camera_2, true) Then
DebugPrint("camera 2 backlight compensation property set to true")
End If
End Process
```
## CameraCcuSetWideDynamicRange
Function set wide_dynamic_range property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetWideDynamicRange(camera As Long, on As Boolean) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) If true, wide_dynamic_range property will be set.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCcuSetWideDynamicRange(Matrix_Switcher1.AvBridgeConstants.camera_2, true) Then
DebugPrint("camera 2 wide dynamic range property set to true")
End If
End Process
```
## CameraCcuSetGain
Function set gain property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetGain(camera As Long, gain As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
gain
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera iris gain value.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraSetGain(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 iris gain property set to 3")
End If
End Process
```
## CameraCcuSetBacklightCompensation
Function set backlight compensation property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetBacklightCompensation(camera As Long, on As Boolean) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) Camera backlight compensation value.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCcuSetBacklightCompensation(Matrix_Switcher1.AvBridgeConstants.camera_2, true) Then
DebugPrint("camera 2 backlight compensation is active")
End If
End Process
```
## CameraCcuSetWideDynamicRange
Function set wide dynamic range property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetWideDynamicRange(camera As Long, on As Boolean) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) Camera wide dynamic range value.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCcuSetWideDynamicRange(Matrix_Switcher1.AvBridgeConstants.camera_2, true) Then
DebugPrint("camera 2 wide dynamic range is active")
End If
End Process
```
## CameraCcuSetDetail
Function set detail property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetDetail(camera As Long, detail As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
detail
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera detail property value.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraSetDetail(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 detail property set to 3")
End If
End Process
```
## CameraCcuSetAutoWhiteBalance
Function set auto white balance property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetAutoWhiteBalance(camera As Long, on As Boolean) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) Camera auto white balance property value.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCcuSetAutoWhiteBalance(Matrix_Switcher1.AvBridgeConstants.camera_2, true) Then
DebugPrint("camera 2 auto white balance is active")
End If
End Process
```
## CameraCcuSetRedGain
Function set red gain property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetRedGain(camera As Long, gain As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
gain
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera red gain value.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCcuSetRedGain(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 red gain property set to 3")
End If
End Process
```
## CameraCcuSetBlueGain
Function set blue gain property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetBlueGain(camera As Long, gain As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
gain
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera blue gain value.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCcuSetBlueGain(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 blue gain property set to 3")
End If
End Process
```
## CameraCcuSetChroma
Function set blue chroma property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetChroma(camera As Long, chroma As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
chroma
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera chroma value.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCcuSetChroma(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 chroma property set to 3")
End If
End Process
```
## CameraCcuSetGamma
Function set blue chroma property of the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSetGamma(camera As Long, gamma As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
gamma
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera gamma value.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCcuSetGamma(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 gamma property set to 3")
End If
End Process
```
## CameraCcuSceneRecallFactory
Function recalls factory scene for the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSceneRecallFactory(camera As Long, scene As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
scene
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Scene identifier number .
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCcuSceneRecallFactory(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 factory scene nr.3 activated")
End If
End Process
```
## CameraCcuSceneRecallCustom
Function recalls previous stored custom scene for the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSceneRecallCustom(camera As Long, scene As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
scene
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Scene identifier number .
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCcuSceneRecallCustom(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("camera 2 custom scene nr.3 activated")
End If
End Process
```
## CameraCcuSceneStoreCustom
Function stores selected camera actual CCU scene as custom scene for the selected camera.
#### Syntax
```visualbasic
Function CameraCcuSceneStoreCustom(camera As Long, scene As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera number.
scene
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Scene identifier number .
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCcuSceneStoreCustom(Matrix_Switcher1.AvBridgeConstants.camera_2, 3) Then
DebugPrint("actual CCU scene of camera 2 stored as custom scene nr.3")
End If
End Process
```
## CameraFocusModeGet
Function returns the actual autofocus status of the selected camera.
#### Syntax
```visualbasic
Function CameraFocusModeGet(camera As Long, ByRef autofocus As Boolean) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera.
autofocus
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) ByRef Variable for returning the value.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var autofocus as boolean
If Matrix_Switcher1.CameraFocusModeGet(Matrix_Switcher1.AvBridgeConstants.camera_2, autofocus) Then
DebugPrintFormat("camera 2 autofocusmode is {L}",autofocus)
End If
End Process
```
## CameraFocusModeAuto
Function sets autofocus mode of the selected camera.
#### Syntax
```visualbasic
Function CameraFocusModeAuto(camera As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraFocusModeAuto(Matrix_Switcher1.AvBridgeConstants.camera_2) Then
DebugPrint("camera 2 autofocusmode is true")
End If
End Process
```
## CameraFocusModeManual
Function resets autofocus mode of the selected camera.
#### Syntax
```visualbasic
Function CameraFocusModeManual(camera As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraFocusModeManual(Matrix_Switcher1.AvBridgeConstants.camera_2) Then
DebugPrint("camera 2 autofocusmode is false")
End If
End Process
```
## CameraFocusNear
Function sets focus near.
#### Syntax
```visualbasic
Function CameraFocusNear(camera As Long, Optional speed As Long := 0) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera.
speed
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Optional moving speed. If zero, default speed will be used.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraFocusNear(Matrix_Switcher1.AvBridgeConstants.camera_2) Then
DebugPrint("camera 2 focuses near at default speed")
End If
End Process
```
## CameraFocusFar
Function sets focus far.
#### Syntax
```visualbasic
Function CameraFocusFar(camera As Long, Optional speed As Long := 0) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera.
speed
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Optional moving speed. If zero, default speed will be used.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraFocusFar(Matrix_Switcher1.AvBridgeConstants.camera_2,3) Then
DebugPrint("camera 2 focuses far at speed 3")
End If
End Process
```
## CameraFocusStop
Function stops focusing.
#### Syntax
```visualbasic
Function CameraFocusFar(camera As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Selected camera.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraFocusStop(Matrix_Switcher1.AvBridgeConstants.camera_2) Then
DebugPrint("camera 2 focus stopped")
End If
End Process
```
## VideoMuteGet
Function returns the actual mute status of the selected channel.
#### Syntax
```visualbasic
Function VideoMuteGet(videoinputchannl As ByteString, ByRef on As Boolean) As Boolean
```
#### Parameters
videoinputchannl
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Video input channel.
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) ByRef Variable for returning the value.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var on as boolean
If Matrix_Switcher1.VideoMuteGet(Matrix_Switcher1.AvBridgeConstants.video_source_input1,on) Then
DebugPrintFormat("HDMI input1 mute is {L 'on' 'off'}",on)
End If
End Process
```
## VideoMuteSet
Function sets the actual mute status of the selected channel.
#### Syntax
```visualbasic
Function VideoMuteSet(videoinputchannl As ByteString, on As Boolean) As Boolean
```
#### Parameters
videoinputchannl
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Video input channel.
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) Required mute status.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.VideoMuteSet(Matrix_Switcher1.AvBridgeConstants.video_source_input1,true) Then
DebugPrint("HDMI input1 mute is on")
End If
End Process
```
## VideoMuteToggle
Function toggles the actual mute status of the selected channel.
#### Syntax
```visualbasic
Function VideoMuteToggle(videoinputchannl As ByteString) As Boolean
```
#### Parameters
videoinputchannl
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Video input channel.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.VideoMuteSet(Matrix_Switcher1.AvBridgeConstants.video_source_input1,true) Then
DebugPrint("HDMI input1 mute is on")
If Matrix_Switcher1.VideoMuteToggle(Matrix_Switcher1.AvBridgeConstants.video_source_input1) Then
DebugPrint("And now is HDMI input1 mute toggled to off")
End If
End If
End Process
```
## VideoProgramSourceGet
Function gets the actual program source.
#### Syntax
```visualbasic
Function VideoProgramSourceGet(ByRef channl As ByteString) As Boolean
```
#### Parameters
channl
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef Variable to get actual source.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var channl as Bytestring[100]
If Matrix_Switcher1.VideoProgramSourceGet(channl) Then
DebugPrintFormat("Actual source is {s}",channl)
End If
End Process
```
## VideoProgramSourceSet
Function sets the actual program source.
#### Syntax
```visualbasic
Function VideoProgramSourceSet(channl As ByteString) As Boolean
```
#### Parameters
channl
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Required source.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.VideoProgramSourceSet(Matrix_Switcher1.AvBridgeConstants.video_source_input1) Then
DebugPrint("Actual source is HDMI input1")
End If
End Process
```
## VideoPipEnableGet
Function returns the actual pip enable status.
#### Syntax
```visualbasic
Function VideoPipEnableGet(ByRef on As Boolean) As Boolean
```
#### Parameters
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) ByRef Variable for returning the value.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var on as boolean
If Matrix_Switcher1.VideoPipEnableGet(on) Then
DebugPrintFormat("Pip enable status is {L 'on' 'off'}",on)
End If
End Process
```
## VideoPipEnableSet
Function sets the actual pip enable status.
#### Syntax
```visualbasic
Function VideoPipEnableSet(on As Boolean) As Boolean
```
#### Parameters
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) Required pip enable status.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.VideoPipEnableSet(true) Then
DebugPrint("Pip enable is on")
End If
End Process
```
## VideoPipEnableToggle
Function toggles the actual pip enable status.
#### Syntax
```visualbasic
Function VideoPipEnableToggle() As Boolean
```
#### Parameters
No parameters.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.VideoPipEnableSet(true) Then
DebugPrint("Pip enable is on")
If Matrix_Switcher1.VideoPipEnableToggle() Then
DebugPrint("And now is pip enable toggled to off")
End If
End If
End Process
```
## VideoPipLayoutSet
Function sets the actual pip layout.
#### Syntax
```visualbasic
Function VideoPipLayoutSet(layout As Bytestring) As Boolean
```
#### Parameters
layout
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Required pip layout.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.VideoPipLayoutSet(Matrix_Switcher1.AvBridgeConstants.video_pip_layout_lower_left) Then
DebugPrint("Pip is displayed in the lower left corner")
End If
End Process
```
## VideoTypeGet
Function gets the channel actual video type.
#### Syntax
```visualbasic
Function VideoTypeGet(videoinputchannl As ByteString, ByRef videotype As ByteString) As Boolean
```
#### Parameters
videoinputchannl
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Input channel.
videotype
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef Variable for the return value.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var videotype As Bytestring[100]
If Matrix_Switcher1.VideoTypeGet(Matrix_Switcher1.AvBridgeConstants.video_source_input1,videotype) Then
DebugPrint("Video type of the HDMI input1 is {s}",videotype)
End If
End Process
```
## VideoTypeSet
Function sets the channel actual video type.
#### Syntax
```visualbasic
Function VideoTypeSet(videoinputchannl As ByteString, videotype As ByteString) As Boolean
```
#### Parameters
videoinputchannl
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Input channel.
videotype
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Video type value.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.VideoTypeSet(Matrix_Switcher1.AvBridgeConstants.video_source_input1,Matrix_Switcher1.AvBridgeConstants.video_type_camera) Then
DebugPrint("Video type of the HDMI input1 is camera")
End If
End Process
```
## GraphicsEnableGet
Function returns the actual graphics enable status.
#### Syntax
```visualbasic
Function GraphicsEnableGet(ByRef on As Boolean) As Boolean
```
#### Parameters
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) ByRef Variable for returning the value.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var on as boolean
If Matrix_Switcher1.GraphicsEnableGet(on) Then
DebugPrintFormat("Graphics enable status is {L 'on' 'off'}",on)
End If
End Process
```
## GraphicsEnableSet
Function sets the actual graphics enable status.
#### Syntax
```visualbasic
Function GraphicsEnableSet(on As Boolean) As Boolean
```
#### Parameters
on
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) Required graphics enable status.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.GraphicsEnableSet(true) Then
DebugPrint("Graphics enable is on")
End If
End Process
```
## GraphicsEnableToggle
Function toggles the actual graphics enable status.
#### Syntax
```visualbasic
Function GraphicsEnableToggle() As Boolean
```
#### Parameters
No parameters.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.GraphicsEnableSet(true) Then
DebugPrint("Graphics enable is on")
If Matrix_Switcher1.GraphicsEnableToggle() Then
DebugPrint("And now is graphics enable toggled to off")
End If
End If
End Process
```
## GraphicsSourceGet
Function gets the actual graphic source file.
#### Syntax
```visualbasic
Function GraphicsSourceGet(ByRef graphicfile As ByteString) As Boolean
```
#### Parameters
graphicfile
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef Variable for the return value.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var grfileAs Bytestring[100]
If Matrix_Switcher1.GraphicsSourceGet(grfile) Then
DebugPrint("Graphic file name is {s}",grfile)
End If
End Process
```
## GraphicsSourceSet
Function sets the actual graphic file. The file has to preloaded by the web administration page of the device.
#### Syntax
```visualbasic
Function GraphicsSourceSet(grfile As ByteString) As Boolean
```
#### Parameters
grfile
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Preloaded graphic file name.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.GraphicsSourceSet(&S"icon1.png") Then
DebugPrint("Graphic file name is icon1.png")
End If
End Process
```
## CameraCommHostGet
Function gets the information about selected camera ip address.
#### Syntax
```visualbasic
Function CameraCommHostGet(camera As Long, ByRef host As ByteString, ByRef connected As Boolean) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera number.
host
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef variable for returning Ip address or host name value.
connected
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) ByRef Variable for returning connected status of the camera.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var ip As Bytestring[100]
Var connected As boolean
If Matrix_Switcher1.CameraCommHostGet(Matrix_Switcher1.AvBridgeConstants.camera_1,ip,connected) Then
DebugPrintFormat("Camera 1 ip address: {s}, connected: {L}",ip,connected)
End If
End Process
```
## CameraCommHostSet
Function sets the information about ip address of the camera.
#### Syntax
```visualbasic
Function CameraCommHostSet(camera As Long, host As ByteString) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera number.
host
[ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) Ip address or host name value. It must match the actual address set on the camera.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCommHostSet(Matrix_Switcher1.AvBridgeConstants.camera_1,&S"192.168.1.15") Then
DebugPrint("Camera 1 ip address info set to 192.168.1.15")
End If
End Process
```
## CameraCommHostUnset
Function unsets the information about ip address of the camera.
#### Syntax
```visualbasic
CameraCommHostUnset(camera As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera number.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraCommHostUnset(Matrix_Switcher1.AvBridgeConstants.camera_1) Then
DebugPrint("Camera 1 ip address info deleted from AV Bridge device")
End If
End Process
```
## StreamingIpEnableGet
Function gets the enable information about ip streaming enable property.
#### Syntax
```visualbasic
Function StreamingIpEnableGet(ByRef enabled As Boolean) As Boolean
```
#### Parameters
enabled
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) ByRef Variable for returning streaming ip enable status of the camera.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var enabled As boolean
If Matrix_Switcher1.StreamingIpEnableGet(enabled) Then
DebugPrintFormat("Ip streaming is {L 'enabled' 'disabled'}",enabled)
End If
End Process
```
## StreamingIpEnableSet
Function enables/disables ip streaming.
#### Syntax
```visualbasic
Function StreamingIpEnableSet(enabled As Boolean) As Boolean
```
#### Parameters
enabled
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) Required ip streaming enable status.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.StreamingIpEnableSet(True) Then
DebugPrint("Ip streaming is enabled")
End If
End Process
```
## StreamingIpEnableToggle
Function toggles ip streaming enable property.
#### Syntax
```visualbasic
Function StreamingIpEnableToggle() As Boolean
```
#### Parameters
No parameters.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.StreamingIpEnableToggle() Then
DebugPrint("Ip streaming enable was toggled")
End If
End Process
```
## CameraStandbyGet
Function gets the information about camera standby status.
#### Syntax
```visualbasic
Function CameraStandbyGet(camera As Long, ByRef standby As Boolean) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera number.
standby
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) ByRef Variable for returning camera standby status.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var standby As Boolean
If Matrix_Switcher1.CameraStandbyGet(Matrix_Switcher1.AvBridgeConstants.camera_1, standby) Then
DebugPrintFormat("Camera 1 standby status is {L}",standby)
End If
End Process
```
## CameraStandbySet
Function enables/disables camera standby.
#### Syntax
```visualbasic
Function CameraStandbySet(camera As Long, standby As Boolean) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera number.
standby
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) Required standby status.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraStandbySet(Matrix_Switcher1.AvBridgeConstants.camera_1,True) Then
DebugPrint("Camera 1 is in standby mode")
End If
End Process
```
## CameraStandbyToggle
Function toggles camera standby status.
#### Syntax
```visualbasic
Function CameraStandbyToggle(camera As Long) As Boolean
```
#### Parameters
camera
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Camera number.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.CameraStandbyToggle(Matrix_Switcher1.AvBridgeConstants.camera_1) Then
DebugPrint("Camera 1 standby mode was toggled")
End If
End Process
```
## SystemStandbyGet
Function gets the enable information about system standby status.
#### Syntax
```visualbasic
Function SystemStandbyGet(ByRef standby As Boolean) As Boolean
```
#### Parameters
standby
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) ByRef Variable for returning camera standby status.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
Var standby As Boolean
If Matrix_Switcher1.SystemStandbyGet(standby) Then
DebugPrintFormat("System standby status is {L}",standby)
End If
End Process
```
## SystemStandbySet
Function enables/disables system standby status.
#### Syntax
```visualbasic
Function SystemStandbySet(standby As Boolean) As Boolean
```
#### Parameters
standby
[Boolean](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean) Required standby status.
#### Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.SystemStandbySet(True) Then
DebugPrint("System is in standby mode")
End If
End Process
```
## SystemStandbyToggle
Function toggles system standby status.
#### Syntax
```visualbasic
Function SystemStandbyToggle() As Boolean
```
#### Parameters
No parameters.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.SystemStandbyToggle() Then
DebugPrint("System standby mode was toggled")
End If
End Process
```
## SystemReboot
Function reboots system.
#### Syntax
```visualbasic
Function SystemReboot(Optional delayseconds As Long := 0) As Boolean
```
#### Parameters
delayseconds
[Long](/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long) Number of seconds to reboot. If zero, then reboots immediatelly.
Return value
True on success or false if failed.
#### Example
```visualbasic
Private Process Autoexec()
If Matrix_Switcher1.SystemReboot(5) Then
DebugPrint("System will reboot in 5 seconds")
End If
End Process
```
# Events
The driver does not have any events.