Script API - v26.60.25
    Preparing search index...

    Interface ITimelinePlayerOptions

    Optional properties for a Timeline Player pane

    interface ITimelinePlayerOptions {
        duration?: number;
        enable?: boolean;
        groups?: ITimelinePlayerGroup[];
        hideGroupDropdown?: boolean;
        onDurationChanged?: (duration: number) => void;
        onGroupChanged?: (groupId: string) => void;
        onPlayStopToggled?: () => void;
        onRedistributeClicked?: () => void;
        onTimeChanged?: (current: number, prev: number) => void;
        playbackState?: TimelinePlayerPlaybackState;
        playTooltip?: BasicTooltipContent;
        precision?: number;
        redistributeTooltip?: BasicTooltipContent;
        selectedGroupId?: string;
        style?: PaneItemStyle;
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    duration? enable? groups? hideGroupDropdown? onDurationChanged? onGroupChanged? onPlayStopToggled? onRedistributeClicked? onTimeChanged? playbackState? playTooltip? precision? redistributeTooltip? selectedGroupId? style? visible?

    Properties

    duration?: number

    Total duration in seconds.

    enable?: boolean

    Initial enabled state of property item. If undefined, it will default to true.

    Group entries for the dropdown.

    hideGroupDropdown?: boolean

    Hides the group dropdown. Use when there is only ever one group, so the dropdown would offer the user nothing to choose between.

    onDurationChanged?: (duration: number) => void

    Callback triggered when the total duration changes (e.g. via the timeline drag handle).

    onGroupChanged?: (groupId: string) => void

    Callback triggered when the group selection changes.

    onPlayStopToggled?: () => void

    Callback triggered when the play/stop toggle is clicked.

    onRedistributeClicked?: () => void

    Callback triggered when the redistribute button is clicked.

    onTimeChanged?: (current: number, prev: number) => void

    Callback triggered when the playhead time changes.

    Initial playback state.

    playTooltip?: BasicTooltipContent

    Tooltip shown when hovering the play/stop toggle.

    precision?: number

    Decimal precision for keyframe time values.

    redistributeTooltip?: BasicTooltipContent

    Tooltip shown when hovering the redistribute button.

    selectedGroupId?: string

    Initially selected group identifier.

    Optional styling overrides for the item.

    visible?: boolean

    Initial visibility state of property item. If undefined, it will default to true.

    Settings

    Member Visibility

    On This Page

    Properties