Hawkeye (1.0.0)

Download OpenAPI specification:Download

License: MIT

Detect images in a video stream and execute automated actions.

List all watchers

Responses

Response samples

200

Content type

application/json

A list of Wachers as it is returned by the API.

[{"id": "ad128d51-9a1c-407d-9edb-d590eb9c3d74",
"description": "Test watcher",
"slate_url": "https://github.com/cbsinteractive/hawkeye/raw/master/resources/slate_120px.jpg",
"source": {"ingest_ip": "uniqueservername.example.com",
"ingest_port": 5000,
"container": "raw-video",
"codec": "h264",
"transport": {"protocol": "rtp"
}
},
"status": "ready",
"transitions": [{"from": "content",
"to": "slate",
"actions": [{"description": "Trigger AdBreak using API",
"type": "http_call",
"method": "POST",
"retries": 3,
"timeout": 10,
"url": "http://api.example.com/v1/organization/cbsa6fhh/channel/slate4g85/ad-break",
"authorization": {"basic": {"username": "myusername",
"password": "somepassword"
}
},
"headers": {"Content-Type": "application/json"
},
"body": "{\"duration\":300}"
}
]
},
{"from": "slate",
"to": "content",
"actions": [{"description": "Use dump out of AdBreak API call",
"type": "http_call",
"method": "DELETE",
"timeout": 10,
"url": "http://api.example.com/v1/organization/cbsa6fhh/channel/slate4g85/ad-break",
"authorization": {"basic": {"username": "myusername",
"password": "somepassword"
}
}
}
]
}
]
}
]

Create a new Watcher

Request Body schema: application/json

description	string A human readable description of the watcher.
slate_url required	string <uri> The slate image url, needs to be publicly accessible.
required	object Sepecify the video source configurations.
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

A valid JSON payload that can be used to create a Watcher.

{"description": "Test watcher",
"slate_url": "https://github.com/cbsinteractive/hawkeye/raw/master/resources/slate_120px.jpg",
"source": {"ingest_port": 5000,
"container": "raw-video",
"codec": "h264",
"transport": {"protocol": "rtp"
}
},
"transitions": [{"from": "content",
"to": "slate",
"actions": [{"description": "Trigger AdBreak using API",
"type": "http_call",
"method": "POST",
"retries": 3,
"timeout": 10,
"url": "http://api.example.com/v1/organization/cbsa6fhh/channel/slate4g85/ad-break",
"authorization": {"basic": {"username": "myusername",
"password": "somepassword"
}
},
"headers": {"Content-Type": "application/json"
},
"body": "{\"duration\":300}"
}
]
},
{"from": "slate",
"to": "content",
"actions": [{"description": "Use dump out of AdBreak API call",
"type": "http_call",
"method": "DELETE",
"timeout": 10,
"url": "http://api.example.com/v1/organization/cbsa6fhh/channel/slate4g85/ad-break",
"authorization": {"basic": {"username": "myusername",
"password": "somepassword"
}
}
}
]
}
]
}

Response samples

201

Content type

application/json

{"id": "string",
"status": "ready",
"status_description": "string",
"source": {"ingest_ip": "dc401bafb-15a.elb.us-east-1.amazonaws.com",
"codec": "h264",
"container": "mpeg-ts",
"ingest_port": 0,
"transport": {"protocol": "rtp"
}
},
"description": "string",
"slate_url": "http://example.com",
"transitions": [{"actions": [{"description": "string",
"type": "http_call",
"authorization": {"basic": {"username": "string",
"password": "string"
}
},
"body": "string",
"headers": { },
"method": "POST",
"retires": 0,
"timeout": 0
}
],
"from": "content",
"to": "content"
}
]
}

Get a Watcher

path Parameters

watcher_id

required

string

The Watcher ID.

Responses

Response samples

200

Content type

application/json

Watcher that is returned by the API.

{"id": "ad128d51-9a1c-407d-9edb-d590eb9c3d74",
"description": "Test watcher",
"slate_url": "https://github.com/cbsinteractive/hawkeye/raw/master/resources/slate_120px.jpg",
"source": {"ingest_ip": "uniqueservername.example.com",
"ingest_port": 5000,
"container": "raw-video",
"codec": "h264",
"transport": {"protocol": "rtp"
}
},
"status": "ready",
"transitions": [{"from": "content",
"to": "slate",
"actions": [{"description": "Trigger AdBreak using API",
"type": "http_call",
"method": "POST",
"retries": 3,
"timeout": 10,
"url": "http://api.example.com/v1/organization/cbsa6fhh/channel/slate4g85/ad-break",
"authorization": {"basic": {"username": "myusername",
"password": "somepassword"
}
},
"headers": {"Content-Type": "application/json"
},
"body": "{\"duration\":300}"
}
]
},
{"from": "slate",
"to": "content",
"actions": [{"description": "Use dump out of AdBreak API call",
"type": "http_call",
"method": "DELETE",
"timeout": 10,
"url": "http://api.example.com/v1/organization/cbsa6fhh/channel/slate4g85/ad-break",
"authorization": {"basic": {"username": "myusername",
"password": "somepassword"
}
}
}
]
}
]
}

Delete a Watcher

path Parameters

watcher_id

required

string

The Watcher ID.

Responses

Response samples

200

Content type

application/json

{"message": "string"
}

Start the Watcher

path Parameters

watcher_id

required

string

The Watcher ID.

Responses

Response samples

200

Content type

application/json

{"message": "string"
}

Stop the Watcher

path Parameters

watcher_id

required

string

The Watcher ID.

Responses

Response samples

200

Content type

application/json

{"message": "string"
}

Latest video frame

Expose the latest video frame the Watcher has captured.

path Parameters

watcher_id

required

string

The Watcher ID.