casparcg-state
    Preparing search index...

    Interface FunctionLayer

    interface FunctionLayer {
        content: FUNCTION;
        executeData?: any;
        executeFcn?: string;
        id: string;
        inMessage?: { args?: Record<string, unknown>; url: string } | null;
        layerNo: number;
        media?: string | TransitionObject | null;
        mixer?: Mixer;
        nextUp?: NextUp;
        noClear?: boolean;
        oscDevice?: number;
        outMessage?: { args?: Record<string, unknown>; url: string } | null;
        playing?: boolean;
        playTime?: number | null;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    content

    content: FUNCTION
    executeData?: any
    executeFcn?: string
    id: string

    Id of the original timelineObject

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

    What layer to put the content on

    media?: string | TransitionObject | null
    mixer?: Mixer

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

    nextUp?: NextUp
    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)

    oscDevice?: number
    outMessage?: { args?: Record<string, unknown>; url: string } | null
    playing?: boolean
    playTime?: number | null

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

    Settings

    Member Visibility

    On This Page

    Properties