Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StereoVideoFrame<I>

Type parameters

  • I = any

Hierarchy

Index

Constructors

  • Create a new data frame

    Type parameters

    • I = any

    Parameters

    • Optional frame: DataFrame

      Data frame to copy

    Returns StereoVideoFrame<I>

  • Create a new data frame

    Type parameters

    • I = any

    Parameters

    • Optional source: DataObject

      Source data object

    Returns StereoVideoFrame<I>

Properties

createdTimestamp: number

Data frame created timestamp (ISO 8601)

uid: string

Data frame unique identifier

Accessors

Methods

  • addObject(object: DataObject): void
  • Add a new object relevant to this data frame

    Parameters

    • object: DataObject

      Relevant object

    Returns void

  • addReferenceSpace(referenceSpace: ReferenceSpace): void
  • Add a new reference space relevant to this data frame.

    alias

    addObject Alias for addObject

    Parameters

    • referenceSpace: ReferenceSpace

      Relevant reference space

    Returns void

  • getObjectByUID<T>(uid: string): T
  • Get a specific object by its identifier

    Type parameters

    • T: DataObject<T>

    Parameters

    • uid: string

      Object UID

    Returns T

    Data object if found

  • getObjects<T>(dataType?: new () => T): T[]
  • 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(object: DataObject): boolean
  • Check if the data frame has an object

    Parameters

    • object: DataObject

      Data object to find

    Returns boolean

    Object exist

  • removeObject(object: DataObject): void
  • Remove an object from the data frame

    Parameters

    • object: DataObject

      Object to remove

    Returns void