Interface CompanionInputFieldBonjourDevice

An input field to list and select devices discovered with a bonjour query

Available for config

Note: Bonjour does not work in all environments, so the user is always able to select 'Manual' (null). You must make sure to handle this, we recommend using the isVisible function to hide the manual input fields when a bonjour device is selected.

Example

{
	id: 'my-device',
	type: 'bonjour-device',
	label: 'Device'
}
interface CompanionInputFieldBonjourDevice {
    id: string;
    isVisible?: ((options: CompanionOptionValues, data: any) => boolean);
    isVisibleData?: any;
    label: string;
    tooltip?: string;
    type: "bonjour-device";
}

Hierarchy (view full)

Properties

id isVisible? isVisibleData? label tooltip? type

Properties

id

id: string

The unique id of this input field within the input group

OptionalisVisible

isVisible?: ((options: CompanionOptionValues, data: any) => boolean)

A function called to check whether this input should be visible, based on the current options selections within the input group

Note: This function must not depend on anything outside of its scope. If it does it will fail to compile and will be skipped.

OptionalisVisibleData

isVisibleData?: any

JSON serializable data to provide to isVisible

label

label: string

The label of the field

Optionaltooltip

tooltip?: string

A hover tooltip for this field

type

type

The type of this input field

Settings

Member Visibility

On This Page

Example
Properties