Interface FunctionLayer

Hierarchy

Properties

content executeData? executeFcn? id inMessage? layerNo media? mixer? nextUp? noClear? oscDevice? outMessage? playTime? playing?

Properties

content

content: FUNCTION

Optional executeData

executeData?: any

Optional executeFcn

executeFcn?: string

id

id: string

Id of the original timelineObject

Optional inMessage

inMessage?: null | {
    args?: Record<string, unknown>;
    url: string;
}

layerNo

layerNo: number

What layer to put the content on

Optional media

media?: null | string | TransitionObject

Optional mixer

mixer?: Mixer

Mixer attributes to apply on the layer, like transform, rotate or opacity

Optional nextUp

nextUp?: NextUp

Optional noClear

noClear?: boolean

If true, we'll never send a CLEAR for this object when it stops. Might be useful in some cases where it's important to not kill the object (like when piping through a decklink input)

Optional oscDevice

oscDevice?: number

Optional outMessage

outMessage?: null | {
    args?: Record<string, unknown>;
    url: string;
}

Optional playTime

playTime?: null | number

[timestamp] If set, at what point in time the object started playing, null means "irrelevant"

Optional playing

playing?: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc