@byomakase/omakase-player
    Preparing search index...

    Class SidecarTimeWindow

    Maps main media time to sidecar time.

    windowDuration = cutEndTime - cutStartTime
    inWindow       = playerStartTime <= mainTime < playerStartTime + windowDuration
    sidecarTime    = mainTime - playerStartTime + cutStartTime

    Warm-up is a part of main media timeline right before main media enters time window, so it follows main media playback direction:

    • forward - right before playerStartTime, mapped to sidecar media before cutStartTime. Limited by sidecar media available before cutStartTime, so cut starting at sidecar time 0 has no warm-up
    • reverse - right after playerEndTime, mapped to sidecar media after cutEndTime. Limited by sidecar media available after cutEndTime, so cut ending at sidecar end, or with unknown sidecar duration, has no warm-up
    Index

    Properties

    cutEndTime cutStartTime duration playerStartTime

    Accessors

    playerEndTime windowDuration

    Methods

    isInWindow resolvePosition resolveWarmUp toMainTime toSidecarTime warmUpIn resolve resolveWarmUpDuration

    Properties

    cutEndTime: number
    cutStartTime: number
    duration: number | undefined

    Sidecar duration, undefined when not known.

    playerStartTime: number

    Accessors

    Methods

    • Warm-up duration in main media playback direction, requested warm-up duration limited by sidecar media available before cutStartTime, or after cutEndTime when main media plays backwards.

      Parameters

      • warmUpDuration: number
      • reverse: boolean = false

        whether main media plays backwards

      Returns number

    • Maps main media time to sidecar time, clamped to [cutStartTime, cutEndTime]. With warm-up, bound main media enters time window at is extended to sidecar time warm-up starts at, lower bound, or upper bound when main media plays backwards.

      Parameters

      • mainTime: number
      • warmUpDuration: number = 0

        requested warm-up duration, warm-up is not resolved if omitted

      • reverse: boolean = false

        whether main media plays backwards

      Returns number

    • Main media time when warm-up starts, before playerStartTime, or after playerEndTime when main media plays backwards.

      Parameters

      • warmUpDuration: number
      • reverse: boolean = false

        whether main media plays backwards

      Returns number

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods