casparcg-connection
    Preparing search index...

    Interface PlayParameters

    interface PlayParameters {
        aFilter?: string;
        channel: number;
        channelLayout?: string;
        clearOn404?: boolean;
        clip?: string;
        customParams?: Record<string, string | number | boolean | null>;
        inPoint?: number;
        layer: number;
        length?: number;
        loop?: boolean;
        scaleMode?: ProducerScaleMode;
        seek?: number;
        transition?: TransitionParameters;
        vFilter?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    aFilter? channel channelLayout? clearOn404? clip? customParams? inPoint? layer length? loop? scaleMode? seek? transition? vFilter?

    Properties

    aFilter?: string

    2.2+ only option, specifify a channelLayout for backwards compatibility

    channel: number
    channelLayout?: string

    Channel layout is a 2.1 only option

    clearOn404?: boolean
    clip?: string
    customParams?: Record<string, string | number | boolean | null>

    Optional custom parameters that will be appended to any command

    inPoint?: number
    layer: number
    length?: number
    loop?: boolean
    scaleMode?: ProducerScaleMode

    FFmpeg and image producer scale mode. Since 2.5.0

    seek?: number
    transition?: TransitionParameters
    vFilter?: string

    Ffmpeg video filter, serialized as vfilter in 2.2+ and filter before 2.2

    Settings

    Member Visibility

    On This Page

    Properties