Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeneralState

Read out of General state of vMix instance

Hierarchy

  • GeneralState

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_data

_data: Document

Raw data from last known state of vmix instance

Methods

externalOutput

  • externalOutput(xmlDocument?: Document): boolean

fadedToBlack

  • fadedToBlack(xmlDocument?: Document): boolean

fullscreenOutput

  • fullscreenOutput(xmlDocument?: Document): boolean

multiCorder

  • multiCorder(xmlDocument?: Document): boolean

  • Is the multicorder module currently recording?

    Parameters

    • Optional xmlDocument: Document

    Returns boolean

playlistActive

  • playlistActive(xmlDocument?: Document): boolean

  • Is currently playing back using the playlist module?

    Parameters

    • Optional xmlDocument: Document

    Returns boolean

preset

  • preset(xmlDocument?: Document): undefined | string

  • Preset file path (if present)

    Parameters

    • Optional xmlDocument: Document

    Returns undefined | string

recording

  • recording(xmlDocument?: Document): boolean

softwareEdition

  • softwareEdition(xmlDocument?: Document): string

  • Software edition

    Parameters

    • Optional xmlDocument: Document

    Returns string

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

softwareVersion

  • softwareVersion(xmlDocument?: Document): string

streaming

  • streaming(xmlDocument?: Document): boolean

update

  • update(xmlDocument: Document): void

Generated using TypeDoc