casparcg-state
    Preparing search index...

    Interface TemplateLayer

    interface TemplateLayer {
        cgStop?: boolean;
        content: TEMPLATE;
        id: string;
        layerNo: number;
        media: string | TransitionObject | null;
        mixer?: Mixer;
        nextUp?: NextUp;
        noClear?: boolean;
        playing: boolean;
        playTime: number | null;
        templateData?: string | Record<string, any> | null;
        templateFcn?: string;
        templateType?: "flash" | "html";
    }

    Hierarchy (View Summary)

    Index

    Properties

    cgStop? content id layerNo media mixer? nextUp? noClear? playing playTime templateData? templateFcn? templateType?

    Properties

    cgStop?: boolean

    True if the template supports CG STOP, otherwise the template will be cleared with a CLEAR

    content

    content: TEMPLATE
    id: string

    Id of the original timelineObject

    layerNo: number

    What layer to put the content on

    media: string | TransitionObject | null

    Template name / file path

    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)

    playing: boolean

    If the graphics is playing or not (is paused)

    playTime: number | null

    [timestamp] If set, at what point in time the object started playing

    templateData?: string | Record<string, any> | null

    Template data to send to the template

    templateFcn?: string
    templateType?: "flash" | "html"

    Settings

    Member Visibility

    On This Page

    Properties