Class: OverlayData
@faeyumbrea/obs-utils-api-types
@faeyumbrea/obs-utils-api-types / OverlayData
Defined in: public-api.d.ts:160
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OverlayData(
type?,components?,style?,config?,name?,enabled?):OverlayData
Defined in: public-api.d.ts:175
Parameters
Section titled “Parameters”string
components?
Section titled “components?”never[]
style?
Section titled “style?”string
config?
Section titled “config?”Record<string, any>
string
enabled?
Section titled “enabled?”boolean
Returns
Section titled “Returns”OverlayData
Properties
Section titled “Properties”animation?
Section titled “animation?”
optionalanimation?:OverlayAnimationData
Defined in: public-api.d.ts:171
Tracks + transitions + zones. Drives all reactive visibility and transform behavior. Absent ⇒ overlay is fully ambient (no animation).
components
Section titled “components”components:
OverlayComponentData[]
Defined in: public-api.d.ts:162
config
Section titled “config”config:
Record<string,any>
Defined in: public-api.d.ts:164
customCSS?
Section titled “customCSS?”
optionalcustomCSS?:string
Defined in: public-api.d.ts:174
enabled?
Section titled “enabled?”
optionalenabled?:boolean
Defined in: public-api.d.ts:166
optionalid?:string
Defined in: public-api.d.ts:173
optionalname?:string
Defined in: public-api.d.ts:165
style:
string
Defined in: public-api.d.ts:163
tileBy?
Section titled “tileBy?”
optionaltileBy?:OverlayTileMode
Defined in: public-api.d.ts:172
type:
string
Defined in: public-api.d.ts:161