Required Permissions: slobs.vision

initiateSubscription `method`

initiateSubscription(): void

This function must be called before any events or state can be received.

streamlabsOBS.v1.Vision.initiateSubscription();

UserStateTree `object`

{
  "vision": {
    "fortnite": {
      "eliminations": {
        "session": 152
      }
    }
  }
}

{
  "vision.fortnite.eliminations.session": 152
}

Property	Type	Description
vision_event_id	string	A persistent, immutable, and unique identifier for this payload
events	VisionEvent[]
game	string
timestamp	number

Property	Type	Description
name	string
data?	VisionEventData[]

Property	Type	Description
value	number

This event is emitted whenever the user's state changes. Your callback will be called with a UserStateTree object.

streamlabsOBS.v1.Vision.userStateTree(userStateTree => {

});

This event is emitted whenever the user's state changes. Your callback will be called with a UserState object.

=streamlabsOBS.v1.Vision.userState(userState => {

});

This event is emitted whenever there is a new Vision event. Your callback will be called with a VisionEventsPayload object.

streamlabsOBS.v1.Vision.visionEvent(visionEventsPayload => {

});