Skip to main content

Class: ObsUtilsApi

obs-utils/src/utils/api.ObsUtilsApi

Constructors

constructor

new ObsUtilsApi(): ObsUtilsApi

Returns

ObsUtilsApi

Properties

overlayTypeNames

overlayTypeNames: Map<string, string>


overlayTypes

overlayTypes: Map<string, OverlayType>


singleInstanceOverlays

singleInstanceOverlays: Set<SvelteComponentConstructor>

Methods

getOBSWebsocketClient

getOBSWebsocketClient(): Promise<any>

Returns

Promise<any>


getSelectedActors

getSelectedActors(): any

Returns

any


isOBS

isOBS(): boolean

Returns

boolean


registerOverlayType

registerOverlayType(key, readableName, type): void

Parameters

NameType
keystring
readableNamestring
typeOverlayType

Returns

void


registerUniqueOverlay

registerUniqueOverlay(overlay): void

Parameters

NameType
overlaySvelteComponentConstructor

Returns

void


setAVData

setAVData(actorValueArray): void

Parameters

NameType
actorValueArrayActorValues

Returns

void


setSelectedActors

setSelectedActors(actorArray): Promise<void>

Parameters

NameType
actorArraystring[]

Returns

Promise<void>