Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReceivedHiFiAudioAPIData

Instantiations of this class contain all of the data that is possible to receive from the High Fidelity Audio API Server. See below for more details.

See HiFiAudioAPIData for data that can both be sent to and received from the Server (i.e. position).

Hierarchy

Index

Constructors

constructor

  • Parameters

    • params: { hashedVisitID?: string; hiFiGain?: number; orientationEuler?: OrientationEuler3D; orientationQuat?: OrientationQuat3D; position?: Point3D; providedUserID?: string; volumeDecibels?: number } = ...
      • Optional hashedVisitID?: string

        This string is a hashed version of the random UUID that is generated automatically. A connecting client sends this value as the session key inside the argument to the audionet.init command. It is used to identify a given client across a cloud of mixers and is guaranteed ("guaranteed" given the context of random UUIDS) to be unique. Application developers should not need to interact with or make use of this value, unless they want to use it internally for tracking or other purposes. This value cannot be set by the application developer.

      • Optional hiFiGain?: number
      • Optional orientationEuler?: OrientationEuler3D
      • Optional orientationQuat?: OrientationQuat3D
      • Optional position?: Point3D
      • Optional providedUserID?: string

        This User ID is an arbitrary string provided by an application developer which can be used to identify the user associated with a client. We recommend that this providedUserID is unique across all users, but the High Fidelity API will not enforce uniqueness across clients for this value.

      • Optional volumeDecibels?: number

        The current volume of the user in decibels. ❌ The client never sends volumeDecibels data to the server. ✔ The server sends volumeDecibels data to all clients connected to a server during "peer updates".

    Returns ReceivedHiFiAudioAPIData

Properties

hashedVisitID

hashedVisitID: string

hiFiGain

hiFiGain: number

orientationEuler

orientationEuler: OrientationEuler3D

orientationQuat

orientationQuat: OrientationQuat3D

position

position: Point3D

providedUserID

providedUserID: string

userAttenuation

userAttenuation: number

userRolloff

userRolloff: number

volumeDecibels

volumeDecibels: number

volumeThreshold

volumeThreshold: number

Methods

diff

  • Used internally for getting the minimal set of data to transmit to the server.

    Parameters

    • otherHiFiData: HiFiAudioAPIData

      The "other" Audio API Data against which we want to compare.

    Returns HiFiAudioAPIData

    The differences between this Audio API Data and the "other" Audio API Data in HiFiAudioAPIData format.