Skip to main content

Class: ObsUtilsApi

Defined in: api.ts:18

Constructors

Constructor

new ObsUtilsApi(): ObsUtilsApi

Defined in: api.ts:23

Returns

ObsUtilsApi

Properties

overlayTypeNames

overlayTypeNames: Map<string, string>

Defined in: api.ts:20


overlayTypes

overlayTypes: Map<string, OverlayType>

Defined in: api.ts:19


singleInstanceOverlays

singleInstanceOverlays: Set<SvelteComponentConstructor>

Defined in: api.ts:21

Methods

getOBSWebsocketClient()

getOBSWebsocketClient(): undefined | Promise<any>

Defined in: api.ts:50

Returns

undefined | Promise<any>


getSelectedActors()

getSelectedActors(): any

Defined in: api.ts:38

Returns

any


isOBS()

isOBS(): any

Defined in: api.ts:58

Returns

any


registerOverlayType()

registerOverlayType(key, readableName, type): void

Defined in: api.ts:29

Parameters

key

string

readableName

string

type

OverlayType

Returns

void


registerUniqueOverlay()

registerUniqueOverlay(overlay): void

Defined in: api.ts:34

Parameters

overlay

SvelteComponentConstructor

Returns

void


setAVData()

setAVData(actorValueArray): void

Defined in: api.ts:46

Parameters

actorValueArray

ActorValues

Returns

void


setSelectedActors()

setSelectedActors(actorArray): Promise<void>

Defined in: api.ts:42

Parameters

actorArray

string[]

Returns

Promise<void>