Get a list of captured keyframes from the stream. Under normal circumstances, ten frames are captured per minute and images a retained for an hour. The returned time is accurate down to a few seconds.

The method also return a Bayeux/Faye server and channel that allow you to listen for further events on the stream, including information about new keyframes being captured.

Parameters

Permission level

The minimum required permission level is:

read

Example XML Response

<response status="ok" permission_level="read" p="1" size="716" total_count="716" cached="0" realtime_url="//realtime.23video.com/faye" realtime_channel="/c9d3363200168fd59514a47b5576a4c292f7e39e/events" timezone_offset="2">
  <keyframe url="/live/keyframe/1429659286.1429659293-cf281043b1a92654d0bfc57130443f5dea492aca.jpg" time="1429659286"/>
  <keyframe url="/live/keyframe/1429659281.1429659293-fdc61578ee1f0ef767747ea44a3ba12864c55e3c.jpg" time="1429659281"/>
  ...
</response>

Example JSON Response

{
  "status": "ok", 
  "permission_level":"read",
  "cached":"0",
  "keyframes":[
      {"url": "/live/keyframe/1429659362.1429659364-ec6c12ce35ec7f73d2788db745908fcc50d289fe.jpg", "time": "1429659362"},
      {"url": "/live/keyframe/1429659362.1429659364-ae761e486ea2038517aa70f2d2f458d309b37c89.jpg", "time": "1429659362"},
      ...
   ],
  "realtime_url":"//realtime.23video.com/faye",
  "realtime_channel":"/09c1de3aa9fdc82befa9fec9cf5b29e0dd9dee62/events",
  "timezone_offset":"1",
  "p": "1",
  "size": "716",
  "total_count": "716",
  "site": {...},
  "endpoint": "/api/live/keyframes"
}