casparcg-state
    Preparing search index...

    Interface MediaLayer

    interface MediaLayer {
        afilter?: string;
        channelLayout?: string;
        clearOn404?: boolean;
        content: MEDIA;
        id: string;
        inPoint?: number;
        layerNo: number;
        length?: number;
        looping?: boolean;
        media: string | TransitionObject | null;
        mixer?: Mixer;
        nextUp?: NextUp;
        noClear?: boolean;
        pauseTime?: number | null;
        playing: boolean;
        playTime?: number | null;
        scaleMode?: ProducerScaleMode;
        seek?: number;
        vfilter?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    afilter? channelLayout? clearOn404? content id inPoint? layerNo length? looping? media mixer? nextUp? noClear? pauseTime? playing playTime? scaleMode? seek? vfilter?

    Properties

    afilter?: string
    channelLayout?: string
    clearOn404?: boolean

    content

    content: MEDIA
    id: string

    Id of the original timelineObject

    inPoint?: number

    [time in ms] The time in the video the video starts playing at (and loops to, when looping)

    layerNo: number

    What layer to put the content on

    length?: number

    [time in ms] The duration the video will be playing until freezing (or looping)

    looping?: boolean

    If the media should be looping, otherwise it'll freeze on last frame

    media: string | TransitionObject | null

    Media clip name. Could be a filename, a path, or even a color

    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)

    pauseTime?: number | null

    [timestamp] If set, at what point in time the object was paused

    playing: boolean

    If the media is playing or not (is paused)

    playTime?: number | null

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

    scaleMode?: ProducerScaleMode

    FFmpeg and image producer scale mode. Since 2.5.0

    seek?: number

    [time in ms] If set, the time in the video the video starts playing at

    vfilter?: string

    Settings

    Member Visibility

    On This Page

    Properties