Skip to main content

Frame

GET 
/qlibs/:qlibid/q/:qhit/rep/frame/:offering/:stream

Produces a frame from a storyboard, or a low-quality frame if no storyboard is present.

There should be an offering section of the path after rep/frame, which is used to select the media offering.

The metadata is first checked for frame sets. By default, frame sets will be named based on the interval between frames if specified. For instance, the truncated metadata may look something like

{
  "frame_sets": {
    "default_video_i48": {
     "frame_height": 1080,
     "frame_width": 1920,
     "frames_dir": "/frame_sets/default/video/i48",
     "frame_count": 27
    }
   }
 }

If a frame is found, it will be rescaled and returned. If a frame from multiple storyboards is found, the frame closest to the requested start time is returned. If no frame is found, a low-resolution frame is generated from the most recent 3-second mark and returned. If that is the case, the header X-Content-Fabric-Frame-Timestamp will be set to the timestamp of the actual frame returned.

Watermarks will never be applied to frames, even if they are specified in the metadata.

Request​

Responses​

Frame