• Shotcut QML Scripting API
  • org.shotcut.qml
  • Producer

    • Contents

    Producer QML Type

    Represents the clip currently loaded in the Filters panel, accessed via the producer context property. More...

    Import Statement: import org.shotcut.qml

    Properties

    Signals

    Methods

    Detailed Description

    producer describes the clip that the currently displayed filter is attached to. It is available in the Filters panel as the producer context property.

    var startFrame = producer.in
var endFrame   = producer.out
var fps        = profile.fps

    Property Documentation

    aspectRatio : real

    The pixel aspect ratio of the producer's media.


    displayAspectRatio : real

    The display aspect ratio (DAR) of the producer's media.


    duration : int

    The duration of the clip in frames (out - in + 1).


    fadeIn : int

    Duration in frames of the clip's fade-in, or 0 if none.


    fadeOut : int

    Duration in frames of the clip's fade-out, or 0 if none.


    hash : string

    A content-based hash of the producer's media, used for caching.


    in : int

    The in-point of the clip in frames (absolute timeline position).


    length : int

    The total length of the underlying source media in frames.


    mlt_service : string

    The MLT service name of the producer (e.g. "avformat", "color").


    name : string

    The display name of the clip as shown in the timeline.


    out : int

    The out-point of the clip in frames (absolute timeline position).


    position : int

    The current playhead position within the clip, in frames relative to in. Setting this seeks the preview to that position.


    resource : string

    The file path or resource string of the underlying media.


    speed : real

    The playback speed multiplier of the clip (1.0 = normal speed).


    Signal Documentation

    durationChanged()

    Emitted when the clip's duration changes.

    Note: The corresponding handler is onDurationChanged.


    inChanged(int delta)

    Emitted when the clip's in-point changes. delta is the frame offset.

    Note: The corresponding handler is onInChanged.


    lengthChanged()

    Emitted when the source media length changes.

    Note: The corresponding handler is onLengthChanged.


    outChanged(int delta)

    Emitted when the clip's out-point changes. delta is the frame offset.

    Note: The corresponding handler is onOutChanged.


    positionChanged(int position)

    Emitted when the playhead position within the clip changes.

    Note: The corresponding handler is onPositionChanged.


    producerChanged()

    Emitted when the underlying producer or its properties change.

    Note: The corresponding handler is onProducerChanged.


    seeked(int position)

    Emitted when the clip is seeked to time position.

    Note: The corresponding handler is onSeeked.


    Method Documentation

    string get(string name, int position = -1)

    Returns the value of MLT property name as a string. If time position is -1, returns the current value.


    real getDouble(string name, int position = -1)

    Returns the value of MLT property name as a floating-point number. If time position is -1, returns the current value.


    rect getRect(string name, int position = -1)

    Returns the value of MLT property name as a rect. If time position is -1, returns the current value.


    bool outOfBounds()

    Returns true if the clip's in/out points fall outside the media's available length.