Type alias TimelinePluginOptions

TimelinePluginOptions: {
    container?: HTMLElement | string;
    duration?: number;
    formatTimeCallback?: ((seconds) => string);
    height?: number;
    insertPosition?: InsertPosition;
    primaryLabelInterval?: number;
    primaryLabelSpacing?: number;
    secondaryLabelInterval?: number;
    secondaryLabelOpacity?: number;
    secondaryLabelSpacing?: number;
    style?: Partial<CSSStyleDeclaration> | string;
    timeInterval?: number;
}

Type declaration

  • Optional container?: HTMLElement | string

    HTML element or selector for a timeline container, defaults to wavesufer's container

  • Optional duration?: number

    The duration of the timeline in seconds, defaults to wavesurfer's duration

  • Optional formatTimeCallback?: ((seconds) => string)
      • (seconds): string

      • Turn the time into a suitable label for the time.

        Parameters

        • seconds: number

        Returns string

  • Optional height?: number

    The height of the timeline in pixels, defaults to 20

  • Optional insertPosition?: InsertPosition

    Pass 'beforebegin' to insert the timeline on top of the waveform

  • Optional primaryLabelInterval?: number

    Interval between numeric labels in seconds

  • Optional primaryLabelSpacing?: number

    Interval between numeric labels in timeIntervals (i.e notch count)

  • Optional secondaryLabelInterval?: number

    Interval between secondary numeric labels in seconds

  • Optional secondaryLabelOpacity?: number

    Opacity of the secondary labels, defaults to 0.25

  • Optional secondaryLabelSpacing?: number

    Interval between secondary numeric labels in timeIntervals (i.e notch count)

  • Optional style?: Partial<CSSStyleDeclaration> | string

    Custom inline style to apply to the container

  • Optional timeInterval?: number

    Interval between ticks in seconds

Settings

Member Visibility

Theme

Generated using TypeDoc