Module components/overlay

Index

Type aliases

Functions

Overlay

Type aliases

overlayProps

overlayProps: object

Props for the overlay component, containing info on what camera feed the overlay belongs to and wether to draw boxes.

Type declaration

autoplay: boolean
hiddenObjectTypes: string[]
onPrimary: function
- - (): void
  - Returns void
showBoxes: indicator
source: stream
sources: source[]

source

source: object

Defines the properties of a single stream URL.

Type declaration

src: string
type: string

stream

stream: object

Defines the properties of a single camera feed. Contains an identifier, a name, and the stream URL.

Type declaration

id: string
name: string
srcObject: source

Functions

Overlay

Overlay(props: overlayProps): Element

- Defined in components/overlay.tsx:53
Component that takes a videoplayer component, and creates an overlay on top of it to draw the bounding boxes received from the orchestrator.

Parameters
- props: overlayProps
  
  Properties for the overlay.
Returns Element

An overlay containing a videojs player and a component that receives and draws bounding boxes over it.

Made by Horyus. Documentation generated by TypeDoc.