Class StereoVideoFrame<I>

Type parameters

I = any

Hierarchy

StereoImageFrame<I>
- StereoVideoFrame

Index

Constructors

constructor

Properties

Accessors

source

Methods

Constructors

constructor

new StereoVideoFrame<I>(frame?: DataFrame): StereoVideoFrame<I>
new StereoVideoFrame<I>(source?: DataObject): StereoVideoFrame<I>

Inherited from StereoImageFrame.constructor
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:50
Create a new data frame

Type parameters
- I = any
Parameters
- Optional frame: DataFrame
  
  Data frame to copy
Returns StereoVideoFrame<I>
Inherited from StereoImageFrame.constructor
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:56
Create a new data frame

Type parameters
- I = any
Parameters
- Optional source: DataObject
  
  Source data object
Returns StereoVideoFrame<I>

Properties

createdTimestamp

createdTimestamp: number

Data frame created timestamp (ISO 8601)

left

left: ImageFrame<I, PerspectiveCameraObject>

right

right: ImageFrame<I, PerspectiveCameraObject>

uid

uid: string

Data frame unique identifier

Accessors

source

get source(): StereoCameraObject
set source(object: StereoCameraObject): void

Inherited from StereoImageFrame.source
- Defined in src/StereoImageFrame.ts:17
Source object clone that captured the data frame

Returns StereoCameraObject
Source data object
Inherited from StereoImageFrame.source
- Defined in src/StereoImageFrame.ts:26
Set the source object clone that captured the data frame

Parameters
- object: StereoCameraObject
  
  Source data object
Returns void
Source data object

Methods

addObject

addObject(object: DataObject): void

Inherited from StereoImageFrame.addObject
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:95
Add a new object relevant to this data frame

Parameters
- object: DataObject
  
  Relevant object
Returns void

addReferenceSpace

addReferenceSpace(referenceSpace: ReferenceSpace): void

Inherited from StereoImageFrame.addReferenceSpace
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:102
Add a new reference space relevant to this data frame.

alias
addObject Alias for addObject

Parameters
- referenceSpace: ReferenceSpace
  
  Relevant reference space
Returns void

clone

clone(): StereoVideoFrame<I>

Inherited from StereoImageFrame.clone
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:114
Clone the data frame

Returns StereoVideoFrame<I>
Cloned data frame

getObjectByUID

getObjectByUID<T>(uid: string): T

Inherited from StereoImageFrame.getObjectByUID
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:82
Get a specific object by its identifier

Type parameters
- T: DataObject<T>
Parameters
- uid: string
  
  Object UID
Returns T
Data object if found

getObjects

getObjects<T>(dataType?: new () => T): T[]

Inherited from StereoImageFrame.getObjects
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:75
Get known objects used in this data frame

Type parameters
- T: DataObject<T>
Parameters
- Optional dataType: new () => T
  
  Data object type
  - - new (): T
    - Returns T
Returns T[]
Array of found data objects

hasObject

hasObject(object: DataObject): boolean

Inherited from StereoImageFrame.hasObject
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:89
Check if the data frame has an object

Parameters
- object: DataObject
  
  Data object to find
Returns boolean
Object exist

removeObject

removeObject(object: DataObject): void

Inherited from StereoImageFrame.removeObject
- Defined in node_modules/@openhps/core/dist/types/data/DataFrame.d.ts:108
Remove an object from the data frame

Parameters
- object: DataObject
  
  Object to remove
Returns void