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

Stream of SR_videoFrame objects. More...

#include <videostream.h>

Public Types

using Frame = SR::VideoFrame
 

Public Member Functions

 VideoStream (Camera *sense, VideoListener *listener)
 Construct a new VideoStream. More...
 
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_videoFrame objects.

Connects an Camera Sense to a VideoListener object.

Member Typedef Documentation

◆ Frame

Constructor & Destructor Documentation

◆ VideoStream()

SR::VideoStream::VideoStream ( Camera sense,
VideoListener listener 
)

Construct a new VideoStream.

Parameters
senserefers to the Camera providing updates
listenerrefers to the VideoListener receiving updates

Called by the Camera when requested for an VideoListener through an openVideoStream call.

Member Function Documentation

◆ close()

void SR::VideoStream::close ( )

Close the stream. (Called by sense)

◆ stopListening()

void SR::VideoStream::stopListening ( )

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

◆ update()

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

Send new frame to listener.

Parameters
framerepresents a single update

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