Skip to main content

Class: ObsUtilsApi

Defined in: api.ts:19

Constructors​

Constructor​

new ObsUtilsApi(): ObsUtilsApi

Defined in: api.ts:25

Returns​

ObsUtilsApi

Properties​

overlayTypeNames​

overlayTypeNames: Map<string, string>

Defined in: api.ts:21

overlayTypes​

overlayTypes: Map<string, OverlayType>

Defined in: api.ts:20

singleInstanceOverlays​

singleInstanceOverlays: Set<Component>

Defined in: api.ts:22

singleInstanceOverlaysSvelte5​

singleInstanceOverlaysSvelte5: Set<Component>

Defined in: api.ts:23

Methods​

getOBSWebsocketClient()​

getOBSWebsocketClient(): undefined | Promise<any>

Defined in: api.ts:59

Returns​

undefined | Promise<any>

getSelectedActors()​

getSelectedActors(): any

Defined in: api.ts:47

Returns​

any

isOBS()​

isOBS(): any

Defined in: api.ts:67

Returns​

any

registerOverlayType()​

registerOverlayType(key, readableName, type): void

Defined in: api.ts:32

Parameters​

key​

string

readableName​

string

type​

OverlayType

Returns​

void

registerUniqueOverlay()​

registerUniqueOverlay(overlay): void

Defined in: api.ts:38

Parameters​

overlay​

Component

Returns​

void

registerUniqueOverlaySvelte5()​

registerUniqueOverlaySvelte5(overlay): void

Defined in: api.ts:43

Parameters​

overlay​

Component

Returns​

void

setAVData()​

setAVData(actorValueArray): void

Defined in: api.ts:55

Parameters​

actorValueArray​

ActorValues

Returns​

void

setSelectedActors()​

setSelectedActors(actorArray): Promise<void>

Defined in: api.ts:51

Parameters​

actorArray​

string[]

Returns​

Promise<void>