Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace <internal>

Index

Namespaces

Classes

Interfaces

Type aliases

Type aliases

APIAnnouncementStatus

APIAnnouncementStatus: { current_time: number; is_running: boolean }

Type declaration

  • current_time: number
  • is_running: boolean

APIAudio

APIAudio: { artist: string; duration: number; id: APIId; type: MediaType }

Type declaration

APICaptureSettings

APICaptureSettings: { audio_routing: [number[]]; disk?: APIDiskCaptureSettings; resi?: APIResiCaptureSettings; rtmp?: APIRTMPCaptureSettings; source: string }

Type declaration

APICaptureStatus

APICaptureStatus: { capture_time: string; status: StatusType; status_description: string }

Type declaration

  • capture_time: string
  • status: StatusType
  • status_description: string

APIDiskCaptureSettings

APIDiskCaptureSettings: { encoding?: string; file_location: string; frame_rate: string; resolution: Resolution }

Type declaration

  • Optional encoding?: string
  • file_location: string
  • frame_rate: string
  • resolution: Resolution

APIId

APIId: { index: number; name: string; uuid: string }

Type declaration

  • index: number
  • name: string
  • uuid: string

APIMacro

APIMacro: { color: Color; id: APIId }

Type declaration

APIMessage

APIMessage: { id: APIId; message: string; theme: APIId; tokens: [APIMessageText | APIMessageClock | APIMessageTimer] }

Type declaration

APIMessageClock

APIMessageClock: { clock: { date: DateTimeStyle; is_24_hours: boolean; time: DateTimeStyle }; name: string }

Type declaration

APIMessageText

APIMessageText: { name: string; text: { text: string } }

Type declaration

  • name: string
  • text: { text: string }
    • text: string

APIMessageTimer

APIMessageTimer: { name: string; timer: { allows_overrun: boolean; count_down_to_time?: { period: TimeOfDay; time_of_day: number }; countdown?: { duration: number }; elapsed?: { end_time?: number; start_time: number }; format: APIMessageTimerFormat; id: APIId } }

Type declaration

  • name: string
  • timer: { allows_overrun: boolean; count_down_to_time?: { period: TimeOfDay; time_of_day: number }; countdown?: { duration: number }; elapsed?: { end_time?: number; start_time: number }; format: APIMessageTimerFormat; id: APIId }
    • allows_overrun: boolean
    • Optional count_down_to_time?: { period: TimeOfDay; time_of_day: number }
    • Optional countdown?: { duration: number }
      • duration: number
    • Optional elapsed?: { end_time?: number; start_time: number }
      • Optional end_time?: number
      • start_time: number
    • format: APIMessageTimerFormat
    • id: APIId

APIMessageTimerFormat

APIMessageTimerFormat: { hour: TimerStyle; millisecond: TimerStyle; minute: TimerStyle; second: TimerStyle }

Type declaration

APIPlaylist

APIPlaylist: { id: APIId; items: APIAudio[] }

Type declaration

APIPlaylistFolder

APIPlaylistFolder: { children: APIPlaylistFolder[]; id: APIId; type: PlaylistFolderType }

Type declaration

APIProp

APIProp: { id: APIId; is_active: boolean }

Type declaration

  • id: APIId
  • is_active: boolean

APIRTMPCaptureSettings

APIRTMPCaptureSettings: { encoding: string; file_location?: string; key: string; save_local: boolean; url: string }

Type declaration

  • encoding: string
  • Optional file_location?: string
  • key: string
  • save_local: boolean
  • url: string

APIResiCaptureSettings

APIResiCaptureSettings: { destination_group: string; encoding: string; event_description?: string; event_name?: string }

Type declaration

  • destination_group: string
  • encoding: string
  • Optional event_description?: string
  • Optional event_name?: string

APISlideData

APISlideData: { notes: string; text: string; uuid: string }

Type declaration

  • notes: string
  • text: string
  • uuid: string

APISlideStatus

APISlideStatus: { current: APISlideData; next: APISlideData }

Type declaration

APISystemInfo

APISystemInfo: { api_version: string; host_description: string; name: string; os_version: string; platform: SystemPlatform }

Type declaration

  • api_version: string
  • host_description: string
  • name: string
  • os_version: string
  • platform: SystemPlatform

APITimer

APITimer: { allows_overrun: boolean; count_down_to_time?: { period: TimeOfDay; time_of_day: number }; countdown?: { duration: number }; elapsed?: { end_time?: number; start_time: number }; id: APIId; state?: TimerState; time?: string }

Type declaration

  • allows_overrun: boolean
  • Optional count_down_to_time?: { period: TimeOfDay; time_of_day: number }
  • Optional countdown?: { duration: number }
    • duration: number
  • Optional elapsed?: { end_time?: number; start_time: number }
    • Optional end_time?: number
    • start_time: number
  • id: APIId
  • Optional state?: TimerState
  • Optional time?: string

ClientOptions

ClientOptions: { debug?: boolean; ip: string; port: string; requestDebug?: boolean; url: string; version?: string }

Type declaration

  • Optional debug?: boolean
  • ip: string
  • port: string
  • Optional requestDebug?: boolean
  • url: string
  • Optional version?: string

Color

Color: { alpha: number; blue: number; green: number; red: number }

Type declaration

  • alpha: number
  • blue: number
  • green: number
  • red: number

Comparator

Comparator<K, V>: (firstValue: V, secondValue: V, firstKey: K, secondKey: K) => number

Type parameters

  • K

  • V

Type declaration

    • (firstValue: V, secondValue: V, firstKey: K, secondKey: K): number
    • internal

      Parameters

      • firstValue: V
      • secondValue: V
      • firstKey: K
      • secondKey: K

      Returns number

CountdownSet

CountdownSet: { allowOverrun?: boolean; duration?: number; format?: APIMessageTimerFormat }

Type declaration

DateTimeStyle

DateTimeStyle: "none" | "short" | "medium" | "long" | "full"

Exclude

Exclude<T, U>: T extends U ? never : T

Exclude from T those types that are assignable to U

Type parameters

  • T

  • U

FetchId

FetchId: string | number
remarks

This is what is used in several parts of the API to fetch by either UUID, name, or by index

IteratorResult

IteratorResult<T, TReturn>: IteratorYieldResult<T> | IteratorReturnResult<TReturn>

Type parameters

  • T

  • TReturn = any

MediaType

MediaType: "audio" | "video" | "image"

Method

Method: "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "purge" | "PURGE" | "link" | "LINK" | "unlink" | "UNLINK"

Omit

Omit<T, K>: Pick<T, Exclude<keyof T, K>>

Construct a type with the properties of T except for those in type K.

Type parameters

  • T

  • K: keyof any

Pick

Pick<T, K>: { [ P in K]: T[P] }

From T, pick a set of properties whose keys are in the union K

Type parameters

  • T

  • K: keyof T

PlaylistFolderType

PlaylistFolderType: "playlist" | "folder"

ReadonlyCollection

ReadonlyCollection<K, V>: ReadonlyMap<K, V> & Omit<Collection<K, V>, "forEach" | "ensure" | "reverse" | "sweep" | "sort" | "get" | "set" | "delete">

Represents an immutable version of a collection

Type parameters

  • K

  • V

Resolution

Resolution: { height: number; width: number }

Type declaration

  • height: number
  • width: number

StatusType

StatusType: "active" | "inactive" | "caution" | "error"

SystemPlatform

SystemPlatform: "win" | "mac" | "unknown"

TimeOfDay

TimeOfDay: "am" | "pm" | "24_hour"

TimerState

TimerState: "stopped" | "running" | "complete" | "overrun"

TimerStyle

TimerStyle: "none" | "short" | "long" | "remove_short" | "remove_long"

Generated using TypeDoc