Class GeneralState

constructor

• new GeneralState(xmlDocument): GeneralState

• Parameters

  • xmlDocument: Document

  Returns GeneralState

_data

externalOutput

• externalOutput(xmlDocument?): boolean

• Is external output enabled?

  Parameters

  • OptionalxmlDocument: Document

  Returns boolean

fadedToBlack

• fadedToBlack(xmlDocument?): boolean

• Is currently faded to black?

  Parameters

  • OptionalxmlDocument: Document

  Returns boolean

fullscreenOutput

• fullscreenOutput(xmlDocument?): boolean

• Is fullscreen output currently enabled?

  Parameters

  • OptionalxmlDocument: Document

  Returns boolean

multiCorder

• multiCorder(xmlDocument?): boolean

• Is the multicorder module currently recording?

  Parameters

  • OptionalxmlDocument: Document

  Returns boolean

playlistActive

• playlistActive(xmlDocument?): boolean

• Is currently playing back using the playlist module?

  Parameters

  • OptionalxmlDocument: Document

  Returns boolean

preset

• preset(xmlDocument?): undefined | string

• Preset file path (if present)

  Parameters

  • OptionalxmlDocument: Document

  Returns undefined | string

recording

• recording(xmlDocument?): boolean

• Is currently recording?

  Parameters

  • OptionalxmlDocument: Document

  Returns boolean

softwareEdition

• softwareEdition(xmlDocument?): string

• Software edition

  Parameters

  • OptionalxmlDocument: Document

  Returns string

  One of following values: Free, Basic, HD, 4K, Pro

softwareVersion

• softwareVersion(xmlDocument?): string

• Software version

  Parameters

  • OptionalxmlDocument: Document

  Returns string

  I.e. 24.0.0.50

streaming

• streaming(xmlDocument?): boolean

• Is currently streaming?

  Parameters

  • OptionalxmlDocument: Document

  Returns boolean

update

• update(xmlDocument): void

• Parameters

  • xmlDocument: Document

  Returns void