Class: ObsUtilsApi
obs-utils/src/utils/api.ObsUtilsApi
Constructors
constructor
• new ObsUtilsApi(): ObsUtilsApi
Returns
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
Name | Type |
---|---|
key | string |
readableName | string |
type | OverlayType |
Returns
void
registerUniqueOverlay
▸ registerUniqueOverlay(overlay
): void
Parameters
Name | Type |
---|---|
overlay | SvelteComponentConstructor |
Returns
void
setAVData
▸ setAVData(actorValueArray
): void
Parameters
Name | Type |
---|---|
actorValueArray | ActorValues |
Returns
void
setSelectedActors
▸ setSelectedActors(actorArray
): Promise
<void
>
Parameters
Name | Type |
---|---|
actorArray | string [] |
Returns
Promise
<void
>