Class BasicCasparCGAPI

Hierarchy

Constructors

Properties

_connection: Connection
_host: string
_port: number
_requestQueue: InternalRequest[] = []
_timeoutTime: number
_timeoutTimer: Timer
prefixed: string | boolean

Accessors

  • get host(): string
  • Returns string

  • set host(host: string): void
  • Parameters

    • host: string

    Returns void

  • get port(): number
  • Returns number

  • set port(port: number): void
  • Parameters

    • port: number

    Returns void

Methods

  • Returns Promise<void>

  • Parameters

    • Optional host: string
    • Optional port: number

    Returns void

  • Stops internal timers so that the class is ready for garbage disposal

    Returns void

  • Calls each of the listeners registered for a given event.

    Type Parameters

    Parameters

    Returns boolean

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (keyof ConnectionEvents)[]

  • Sends a command to CasparCG

    Returns

    if there was an error when sending the command (such as being disconnected)

    Returns

    a Promise that resolves when CasparCG replies after a command has been sent. If this throws, there's something seriously wrong :)

    Type Parameters

    Parameters

    • command: Command

    Returns Promise<SendResult<CReturnType<Command["command"]>>>

  • Parameters

    Returns undefined | InternalRequest

  • Return the number of listeners listening to a given event.

    Parameters

    Returns number

  • Return the listeners registered for a given event.

    Type Parameters

    Parameters

    • event: T

    Returns ((...args: ArgumentMap<ConnectionEvents>[Extract<T, keyof ConnectionEvents>]) => void)[]

Generated using TypeDoc