Table of contents

Slates API

The Slates API provides an overview of open/closed slates for a video.

GET /api/data/items/{id}/slates
  • id - (string) The identifier of the item

The response is a histogram containing an item for frame interval bucket that indicates whether a slate is seen.

{
    "histogram": [
        {
            "start_at": 0,
            "end_at": 0,
            "duration": 0
        }, {
            "start_at": 2,
            "end_at": 2,
            "duration": 0
        }
    ]
}
  • histogram[].start_at - (float) The start time of the frame
  • histogram[].end_at - (float) same as start
  • histogram[].duration - always 0

Open Slates

Returns only slates detected to be open

GET /api/data/items/{id}/slates/open
  • id - (string) The identifier of the item

The response is a histogram containing an item for frame interval bucket that indicates whether an open slate is seen.

{
    "histogram": [
        {
            "start_at": 0,
            "end_at": 0,
            "duration": 0
        }, {
            "start_at": 2,
            "end_at": 2,
            "duration": 0
        }
    ]
}
  • histogram[].start_at - (float) The start time of the frame
  • histogram[].end_at - (float) same as start
  • histogram[].duration - always 0

Closed Slates

Returns only slates detected to be closed

GET /api/data/items/{id}/slates/closed
  • id - (string) The identifier of the item

The response is a histogram containing an item for frame interval bucket that indicates whether a closed slate is seen.

{
    "histogram": [
        {
            "start_at": 0,
            "end_at": 0,
            "duration": 0
        }, {
            "start_at": 2,
            "end_at": 2,
            "duration": 0
        }
    ]
}
  • histogram[].start_at - (float) The start time of the frame
  • histogram[].end_at - (float) same as start
  • histogram[].duration - always 0

This documentation is generated from the latest version of GrayMeta Platform. For documentation relevant to your own deployed version, please use the documentation inside the application.