Class VideoFrame<I, C>

constructor

• new VideoFrame<I, C>(frame?): VideoFrame<I, C>

• Create a new data frame

  Type Parameters

  • I = any

  • C extends CameraObject = CameraObject

  Parameters

  • Optional frame: DataFrame

    Data frame to copy

  Returns VideoFrame<I, C>
• new VideoFrame<I, C>(source?): VideoFrame<I, C>

• Create a new data frame

  Type Parameters

  • I = any

  • C extends CameraObject = CameraObject

  Parameters

  • Optional source: DataObject

    Source data object

  Returns VideoFrame<I, C>

createdTimestamp

Optional phenomenonTimestamp

uid

addObject

• addObject(object): VideoFrame<I, C>

• Add a new object relevant to this data frame

  Parameters

  • object: DataObject

    Relevant object

  Returns VideoFrame<I, C>

  instance

addReferenceSpace

• addReferenceSpace(referenceSpace): void

• Add a new reference space relevant to this data frame.

  Parameters

  • referenceSpace: ReferenceSpace

    Relevant reference space

  Returns void

  Alias

  addObject Alias for addObject

addSensor

• addSensor(object): VideoFrame<I, C>

• Add a new sensor relevant to this data frame

  Parameters

  • object: SensorObject<Object | SensorValue<Unit> | Orientation>

    Relevant sensor

  Returns VideoFrame<I, C>

  instance

clearObjects

• clearObjects(objectFilter?): void

• Clear all objects

  Parameters

  • Optional objectFilter: ((object) => boolean)

    object filter

    • • (object): boolean

      • Parameters

        • object: DataObject

        Returns boolean

  Returns void

clone

• clone(): VideoFrame<I, C>

• Clone the data frame

  Returns VideoFrame<I, C>

  Cloned data frame

getObjectByUID

• getObjectByUID<T>(uid): T

• Get a specific object by its identifier

  Type Parameters

  • T extends DataObject

  Parameters

  • uid: string

    Object UID

  Returns T

  Data object if found

getObjects

• getObjects<T>(dataType?): T[]

• Get known objects used in this data frame

  Type Parameters

  • T extends DataObject

  Parameters

  • Optional dataType: (new () => T)

    Data object type

    • • new (): T

      • Returns T

  Returns T[]

  Array of found data objects

getSensor

• getSensor<T>(type, defaultUID?): T

• Get known sensor objects used in this data frame

  Type Parameters

  • T extends SensorObject<Object | SensorValue<Unit> | Orientation>

  Parameters

  • type: (new (uid?) => T)

    Sensor type

    • • new (uid?): T

      • Parameters

        • Optional uid: string

        Returns T

  • Optional defaultUID: string

    Default UID. When sensor is not added, it will be created

  Returns T

  Found data objects

hasObject

• hasObject(object): boolean

• Check if the data frame has an object

  Parameters

  • object: DataObject

    Data object to find

  Returns boolean

  Object exist

removeObject

• removeObject(object): void

• Remove an object from the data frame

  Parameters

  • object: string | DataObject

    Object to remove

  Returns void