Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserDataSubscription

User Data Subscriptions allow client API users to perform actions, such as logging, when the client receives new User Data from the High Fidelity Audio API Server.

Hierarchy

  • UserDataSubscription

Index

Constructors

Properties

Constructors

constructor

  • Parameters

    • __namedParameters: { callback: Function; components: AvailableUserDataSubscriptionComponents[]; providedUserID?: string }
      • callback: Function

        The callback function to call when the client receives new User Data associated with the component from the server. The first and only argument to the callback function will be of type Array<ReceivedHiFiAudioAPIData>.

      • components: AvailableUserDataSubscriptionComponents[]

        The User Data components to which we want to subscribe, such as Position, OrientationEuler, or VolumeDecibels.

      • Optional providedUserID?: string

        The user's providedUserID associated with the Subscription. See HiFiAudioAPIData. Optional. If unset, the Subscription callback will be called for all users' data when it changes.

    Returns UserDataSubscription

Properties

callback

callback: Function

components

providedUserID

providedUserID: string