Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IClient

Hierarchy

  • EventEmitter
    • IClient

Implemented by

Index

Properties

clientType

clientType: ClientType

state

state: IState

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

createControls

createGroups

createScene

createScenes

deleteControls

deleteGroup

deleteScene

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

execute

  • execute<T>(method: string, params: T, discard: boolean): Promise<any>
  • Type parameters

    • T

    Parameters

    • method: string
    • params: T
    • discard: boolean

    Returns Promise<any>

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getTime

  • getTime(): Promise<number>

giveInput

  • giveInput<T>(_: T): Promise<void>

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: "open", listener: function): this
  • on(event: "send", listener: function): this
  • on(event: "message", listener: function): this
  • on(event: "error", listener: function): this
  • on(event: "hello", listener: function): this
  • on(event: string, listener: Function): this
  • Parameters

    • event: "open"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "send"
    • listener: function
        • (payload: string): void
        • Parameters

          • payload: string

          Returns void

    Returns this

  • Parameters

    • event: "message"
    • listener: function
        • (payload: string): void
        • Parameters

          • payload: string

          Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hello"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: string
    • listener: Function

    Returns this

once

  • once(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

ready

  • ready(isReady: boolean): Promise<void>
  • Parameters

    • isReady: boolean

    Returns Promise<void>

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

updateControls

  • updateControls(controls: ISceneData): Promise<void>

updateGroups

updateParticipants

updateScenes

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc