Simulated Reality SDK 7500c78d v1.30.2.51085 2024-04-26T11:23:03Z
Stable
Public Types | Public Member Functions | List of all members
SR::HeadStream Class Reference

Stream of SR_head objects. More...

#include <headstream.h>

Public Types

using Frame = SR_head
 

Public Member Functions

 HeadStream (HeadTracker *sense, HeadListener *listener)
 Construct a new HeadStream. More...
 
 ~HeadStream ()
 
void stopListening ()
 Stop listening and notify sense to stop sending new frames. (Called by listener) More...
 
void close ()
 Close the stream. (Called by sense) More...
 
void update (Frame &frame)
 Send new frame to listener. More...
 

Detailed Description

Stream of SR_head objects.

Connects an HeadTracker Sense to a HeadListener object.

Member Typedef Documentation

◆ Frame

Constructor & Destructor Documentation

◆ HeadStream()

SR::HeadStream::HeadStream ( HeadTracker sense,
HeadListener listener 
)

Construct a new HeadStream.

Parameters
senserefers to the HeadTracker providing updates
listenerrefers to the HeadListener receiving updates

Called by the HeadTracker when requested for an HeadListener through an openHeadStream call.

◆ ~HeadStream()

SR::HeadStream::~HeadStream ( )

Member Function Documentation

◆ close()

void SR::HeadStream::close ( )

Close the stream. (Called by sense)

◆ stopListening()

void SR::HeadStream::stopListening ( )

Stop listening and notify sense to stop sending new frames. (Called by listener)

◆ update()

void SR::HeadStream::update ( Frame frame)

Send new frame to listener.

Parameters
framerepresents a single update

The documentation for this class was generated from the following file: