PresentationTimeline class - shaka.media library

Constructors

PresentationTimeline(num? presentationStartTime, num presentationDelay, [bool autoCorrectDrift = true])

Properties

hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

getDelay() → num: Gets the presentation delay in seconds.
getDuration() → num: The presentation's duration in seconds. Infinity indicates that the presentation continues indefinitely.
getMaxSegmentDuration() → num: The presentation's max segment duration in seconds.
getPresentationStartTime() → num: The presentation's start time in seconds.
getSafeSeekRangeStart(num offset) → num: The current seek start time, in seconds, relative to the start of the presentation.
getSeekRangeEnd() → num: Gets the seek range end.
getSeekRangeStart() → num: Gets the seek range start time.
getSegmentAvailabilityEnd() → num: Gets the presentation's current segment availability end time. Segments starting after this time should be assumed to be unavailable. Returns: The current segment availability end time, in seconds, relative to the start of the presentation. For VOD, the availability end time is the content's duration. If the Player's playRangeEnd configuration is used, this can override the duration.
getSegmentAvailabilityStart() → num: Gets the presentation's current segment availability start time. Segments ending at or before this time should be assumed to be unavailable. Returns: The current segment availability start time, in seconds, relative to the start of the presentation.
isInProgress() → bool: True if the presentation is in progress (meaning not live, but also not completely available); otherwise, return false.
isLive() → bool: True if the presentation is live; otherwise, return false.
lockStartTime() → void: Lock the presentation timeline's start time. After this is called, no further adjustments to presentationStartTime_ will be permitted. This should be called after all Periods have been parsed, and all calls to notifySegments() from the initial manifest parse have been made. Without this, we can get assertion failures in SegmentIndex for certain DAI content. If DAI adds ad segments to the manifest faster than real-time, adjustments to presentationStartTime_ can cause availability windows to jump around on updates.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
notifyMaxSegmentDuration(num maxSegmentDuration) → void: Gives PresentationTimeline a Stream's maximum segment duration so it can size and position the segment availability window. This function should be called once for each Stream (no more, no less), but does not have to be called if notifySegments() is called instead for a particular stream.
notifyMinSegmentStartTime(num startTime) → void: Gives PresentationTimeline a Stream's minimum segment start time.
notifySegments(List<SegmentReference> startTime) → void: Gives PresentationTimeline an array of segments so it can size and position the segment availability window, and account for missing segment information. These segments do not necessarily need to all be from the same stream.
notifyTimeRange(List<TimeRange> timeline, num startOffset) → void: Gives PresentationTimeline a Stream's timeline so it can size and position the segment availability window, and account for missing segment information.
offset(num offset) → void: Offsets the segment times by the given amount.
setAvailabilityTimeOffset(num offset) → void: Sets the presentation's segment availability time offset. This should be only set for Low Latency Dash. The segments are available earlier for download than the availability start time, so we can move closer to the live edge.
setClockOffset(num offset) → void: Sets the clock offset, which is the difference between the client's clock and the server's clock, in milliseconds (i.e., serverTime = Date.now() + clockOffset).
setDelay(num delay) → void: Sets the presentation delay in seconds.
setDuration(num duration) → void: Sets the presentation's duration. The presentation's duration in seconds. Infinity indicates that the presentation continues indefinitely.
setPresentationStartTime(num presentationStartTime) → void: Sets the presentation's start time. The wall-clock time, in seconds, when the presentation started or will start. Only required for live.
setSegmentAvailabilityDuration(num segmentAvailabilityDuration) → void: Sets the presentation's segment availability duration. The segment availability duration should only be set for live. The presentation's new segment availability duration in seconds.
setStatic(bool isStatic) → void: Sets the presentation's static flag. If true, the presentation is static, meaning all segments are available at once.
setUserSeekStart(num time) → void: Sets the start time of the user-defined seek range. This is only used for VOD content.
toString() → String: A string representation of this object.
inherited
usingPresentationStartTime() → bool: Sets the start time of the user-defined seek range. This is only used for VOD content.

Operators

operator ==(Object other) → bool: The equality operator.
inherited