Options
All
  • Public
  • Public/Protected
  • All
Menu

Module classes/HiFiAudioAPIData

This Module contains classes relevant to data about a user in the virtual 3D environment.

Index

Type aliases

OtherUserGainMap

OtherUserGainMap: {}

Instantiations of this class define a map between hashed visit IDs and the gains of other users. You can use this in HiFiCommunicator.setOtherUserGainsForThisConnection to change the gains of other users as perceived by the current connection, providing a more comfortable listening experience for the client. If you need to perform moderation actions on the server side, use the Administrative REST API.

Internally, this class is used to keep track of which other user gain changes need to be sent to the server.

Type declaration

  • [key: string]: number

Functions

eulerFromQuaternion

  • Compute the orientation euler decomposition from the specified quaternion. The resulting euler is the rotation transforming from combining the euler angles rotations in the specified order

    For example, the order YawPitchRoll is computed as follow: starting from the base 3d frame, 1/ Yaw, rotating around the vertical axis 2/ Pitch, rotating around the right axis 3/ Roll, rotating around the front axis the resulting 3d frame orientation is relative to the base frame. The resulting rotation is defining the 'rotated' space relative to the 'base' space. A vector Vr in "rotated' space and its equivalent value Vb in the'base' space is computed as follow: Vb = [P][Y][R] Vr

    Parameters

    Returns OrientationEuler3D

    The end resulting quaternion defined from the euler angles combination

eulerToQuaternion

  • Compute the orientation quaternion from the specified euler angles. The resulting quaternion is the rotation transforming from combining the euler angles rotations in the specified order

    For example, the order YawPitchRoll is computed as follow: starting from the base 3d frame, 1/ Yaw, rotating around the vertical axis 2/ Pitch, rotating around the right axis 3/ Roll, rotating around the front axis the resulting 3d frame orientation is relative to the base frame. The resulting rotation is defining the 'rotated' space relative to the 'base' space. A vector Vr in "rotated' space and its equivalent value Vb in the'base' space is computed as follow: Vb = [P][Y][R] Vr

    Parameters

    Returns OrientationQuat3D

    The end resulting quaternion defined from the euler angles combination