Project.Blackmagic_VideoHub(deviceName or ID)

Example:
Project.Blackmagic_VideoHub("Blackmagic_VideoHub1").SubMember

Alternative Example:
Project.Blackmagic_VideoHub(1).SubMember

This gives access to all further members of the device "Blackmagic_VideoHub" from the Configuration dialog.
Using the Project object is an alternative to addressing the device directly by entering its name. The Project object allows you to address the device through its name or ID.

Substituting the ID with a dynamic variable allows automation. Actions can be performed on many devices of the same type simultaneously, e.g. by using for-loops:

For i = 1 to 10 {
  Project.Blackmagic_VideoHub(i).Enable
}

Blackmagic_VideoHub_Name.CustomCommand(command)

Example:
Blackmagic_VideoHub1.CustomCommand("string")

Alternative Example:
Project.Blackmagic_VideoHub(1).CustomCommand("string")

This sends a custom command to the device "Blackmagic VideoHub". Please check the manual of your Blackmagic VideoHub device for information on which commands it supports.

Blackmagic_VideoHub_Name.Disable

Example:
Blackmagic_VideoHub1.Disable

Alternative Example:
Project.Blackmagic_VideoHub(1).Disable

This disables the device "Blackmagic VideoHub" in the Configuration dialog as if the "Enable" check box in the window was unchecked. Use the .Enable member to reverse this command.

Blackmagic_VideoHub_Name.Enable

Example:
Blackmagic_VideoHub1.Enable

Alternative Example:
Project.Blackmagic_VideoHub(1).Enable

This enables the device "Blackmagic VideoHub" in the Configuration dialog as if the "Enable" check box in the window was checked. Use the .Disable member to reverse this command.

Blackmagic_VideoHub_Name.GetInputLabel

Example:
Blackmagic_VideoHub1.GetInputLabel(2)

Alternative Example:
Project.Blackmagic_VideoHub(1).GetInputLabel(2)

This returns the second input channel label. Notice that the index is a 1 based index, so the first input channel has the index 1 whereas the device uses a zero based index for the channel.

Parameters:
- inputIndex / Integer

Blackmagic_VideoHub_Name.GetOutputLabel

Example:
Blackmagic_VideoHub1.GetOutputLabel(3)

Alternative Example:
Project.Blackmagic_VideoHub(1).GetOutputLabel(3)

This returns the third output channel label. Notice that the index is a 1 based index, so the first output channel has the index 1.

Parameters:
- outputIndex / Integer

Blackmagic_VideoHub_Name.GetProductType

Example:
var xString = Blackmagic_VideoHub1.GetProductType

Alternative Example:
Project.Blackmagic_VideoHub(1).GetProductType

This returns the product type from the device "Blackmagic_VideoHub1" as a string value. The result could look as follows:
Model name: ATEM 2 M/E Constellation HD
Video inputs: 45
Video outputs: 16

This first example shows how to use it with a string variable named "xString".

You can also write it into a Widget, e.g. a Label via the script: Label1.Text = Blackmagic_VideoHub1.GetProductType
or display it in the Debug Logger: DebugMessage(Blackmagic_VideoHub1.GetProductType)

An alternative command is as follows: ProductType

Blackmagic_VideoHub_Name.GetRoute

Example:
Blackmagic_VideoHub1.GetRoute(4)

Alternative Example:
Project.Blackmagic_VideoHub(1).GetRoute(4)

This returns the input channel index that is routed to the fourth output channel. Notice that the index is a 1 based index, so the first input channel has the index 1.

Parameters:
- outputIndex / Integer

Blackmagic_VideoHub_Name.InputLabels

Example:
Blackmagic_VideoHub1.InputLabels

Alternative Example:
var xList = vlist = Project.Blackmagic_VideoHub(1).InputLabels

This member returns the labels of all input channels as a list.

The result could look as follows: [["","Black","Cam 1 - Chip","Cam 2 - Chip","Cam 3 - Chip","","","",""]]

The first example shows how to use it with a list variable named "vlist".

You can also write it into a Widget, e.g. a Dropdown List via the script and a local variable "list":
var list = Blackmagic_VideoHub1.InputLabels
DropDownList1.SetItemsFromArray("list")
or display it in the Debug Logger: DebugMessage(Blackmagic_VideoHub1.InputLabels)

Blackmagic_VideoHub_Name.IpAddress

Example:
var xString = Blackmagic_VideoHub1.IpAddress

Alternative Example:
var xString = Project.Blackmagic_VideoHub(1).IpAddress

This returns the IP address of the device "Blackmagic_VideoHub1" as a string. The result could look as follows: 10.169.80.10

The first example shows how to use it with a string variable named "xString".

You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Blackmagic_VideoHub1.IpAddress
or display it in the Debug Logger: DebugMessage(Blackmagic_VideoHub1.IpAddress)

You can also assign an IP address to the connected Blackmagic VideoHub device. WD automatically connects to it afterwards.

Blackmagic_VideoHub1.IpAddress = "10.169.80.10"

Blackmagic_VideoHub_Name.IsConnected

Example:
var xString = Blackmagic_VideoHub1.IsConnected

Alternative Example:
var xString = Project.Blackmagic_VideoHub(1).IsConnected

This member returns the connection status for the device "Blackmagic_VideoHub1" as a Boolean value. The result is "True" if the device is connected and "False" if it is currently disconnected.

The first example shows how to use it with a string variable named "xString".

You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Blackmagic_VideoHub1.IsConnected
or display it in the Debug Logger: DebugMessage(Blackmagic_VideoHub1.IsConnected)

Blackmagic_VideoHub_Name.IsEnabled

Example:
var xString = Blackmagic_VideoHub1.IsEnabled

Alternative Example:
var xString = Project.Blackmagic_VideoHub(1).IsEnabled

This member returns the status of the check box "Enable" for the device "Blackmagic_VideoHub1" in the Configuration dialog as a string or Boolean value. The result is "True" if the device is enabled and "False" if it is currently not enabled.

The first example shows how to use it with a string variable named "xString".

You can also write it into a Widget, e.g. a Label via the script: Label1.Text = Blackmagic_VideoHub1.IsEnabled
or display it in the Debug Logger: DebugMessage(Blackmagic_VideoHub1.IsEnabled)

Blackmagic_VideoHub_Name.LastMessageReceived

Example:
var xString = Blackmagic_VideoHub1.LastMessageReceived

Alternative Example:
Project.Blackmagic_VideoHub(1).LastMessageReceived

This returns the last message that was received from the device "Blackmagic_VideoHub1" as a string value.

The first example shows how to use it with a string variable named "xString".

You can also write it into a Widget, e.g. a Label via the script: Label1.Text = Blackmagic_VideoHub1.LastMessageReceived
or display it in the Debug Logger: DebugMessage(Blackmagic_VideoHub1.LastMessageReceived)

Blackmagic_VideoHub_Name.OutputLabels

Example:
Blackmagic_VideoHub1.OutputLabels

Alternative Example:
var xList = Project.Blackmagic_VideoHub(1).OutputLabels

This member returns the labels of all output channels as a list.

The result could look as follows: [["","Output 1", "Output 2","Output 3","Output 4","Output 5","Output 6","","",""]]

The first example shows how to use it with a list variable named "xList".

You can also write it into a Widget, e.g. a DropDown List via the script and a local variable "xList":
var xList = Blackmagic_VideoHub1.OutputLabels
DropDownList1.SetItemsFromArray("xList")
or display it in the Debug Logger: DebugMessage(Blackmagic_VideoHub1.OutputLabels)

Blackmagic_VideoHub_Name.ProductType

Example:
var xString = Blackmagic_VideoHub1.ProductType

Alternative Example:
Project.Blackmagic_VideoHub(1).ProductType

This returns the product type from the device "Blackmagic_VideoHub1" as a string value. The result could look as follows:
Model name: ATEM 2 M/E Constellation HD
Video inputs: 45
Video outputs: 16

This first example shows how to use it with a string variable named "xString".

You can also write it into a Widget, e.g. a Label via the script: Label1.Text = Blackmagic_VideoHub1.ProductType
or display it in the Debug Logger: DebugMessage(Blackmagic_VideoHub1.ProductType)

An alternative command is as follows: GetProductType

Blackmagic_VideoHub_Name.Routes

Example:
var xList = Blackmagic_VideoHub1.Routes

Alternative Example:
var xList = Project.Blackmagic_VideoHub(1).Routes

This member returns all routes as a list. Each member value is the input channel, and the index is the output channel to which this input is routed.

The result could look as follows: [0,11,42,42,42,42,42,42,42,42,42,42,42,2,2,2,2,0,0]

The first example shows how to use it with a list variable named "xList".

You can also get the input channel routed to a given output channel like this:
var xList = Blackmagic_VideoHub1.Routes
var fourthOutputIChannel = xList[4]

This returns the input channel that is routed to the fourth output channel.

Notice, this list is a 1 based index list, so the first output can be accessed by the index 1.

Alternative command: GetRoute

Blackmagic_VideoHub_Name.SetInputLabel

Example:
Blackmagic_VideoHub1.SetInputLabel(2, "Camera 3")

Alternative Example:
Project.Blackmagic_VideoHub(1).SetInputLabel(2, "Camera 3")

This member sets the label of a given input channel.

The first example sets the label of the second input channel to "Camera 3".

Notice, this method works on a 1 based index array, so the first input can be accessed by the index 1.

Blackmagic_VideoHub_Name.SetOutputLabel

Example:
Blackmagic_VideoHub1.SetOutputLabel(3, "Monitor 1")

Alternative Example:
Project.Blackmagic_VideoHub(1).SetOutputLabel(3, "Monitor 1")

This member sets the label of a given output channel.

The first example sets the label of the third output channel to "Monitor 1".

Notice, this method works on a 1 based index array, so the first output can be accessed by the index 1.