A property manager is a class that manages the source properties for a particular source. It shares the same lifetime of the source, and may automatically change settings on the source if it wants to. It is also responsible for deciding which properties are exposed to the user, and for managing any custom UI that may be exposed.

Hierarchy

Implements

Index

Constructors

constructor

  • new PropertiesManager(obsSource: ISource, settings: Dictionary<any>): PropertiesManager

Properties

blacklist

blacklist: string[] = []

The blacklist is a list of OBS property names that should not be displayed to the user.

customUIComponent

customUIComponent: string

The name of a custom component that will be shown in the source properties window.

displayOrder

displayOrder: string[] = []

displayOrder will be used as a list of property names to used when ordering properties displayed to the user. Properties not appearing in the list will be shown at the end in the order they are defined.

obsSource

obsSource: ISource

The source this class manages

settings

settings: Dictionary<any>

These are settings for the properties manager that are stored in the application configuration.

Methods

applySettings

  • applySettings(settings: Dictionary<any>): void

destroy

  • destroy(): void

getPropertiesFormData

  • getPropertiesFormData(): input.TFormData

init

  • init(): void

setPropertiesFormData

  • setPropertiesFormData(properties: input.TFormData): void