API ReferenceVideo Segment

Get Segment By Timestamp

Returns metadata for the segment within a video containing the requested absolute timestamp.

Path parameters

videoRidstringRequired

Unique resource identifier for a Video

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
timestampobjectRequired
viewRangeStartobjectOptional

The start of the view range used to dynamically calculate media timestamps. The first segment with an overlap with the time bounds will have its minimum media timestamp set to 0, with every subsequent segment building media time cumulatively from that offset. This will determine the starting media timestamp of the returned segment. The view range should be the same as the one requested to get the playlist and segment summaries.

Response

This endpoint returns an optional object.
ridstring

Unique resource identifier for a Video Segment

videoRidstring

Unique resource identifier for a Video

dataHandleobject
frameRatedouble

The average frame rate (FPS) of the segment calculated as total frames / duration in seconds.

durationSecondsdouble

The duration of a segment in media time.

timestampsobject

for videos with frame-level timestamps, we provide mappings, otherwise we just include a single list of timestamps.