SoRemoteVizClient::FrameEventArg Struct Reference

Structure given when a received and decoded frame event is raised. More...

#include <RemoteViz/Clients/nodes/SoRemoteVizClient.h>

Inheritance diagram for SoRemoteVizClient::FrameEventArg:

Public Member Functions
	FrameEventArg (SoRemoteVizClient *source, uint64_t id, uint64_t dataLength, bool isLossless, const SbString &message)
	Default constructor.
SoRemoteVizClient *	getSource () const
	Returns the SoRemoteVizClient node that triggered the event.
uint64_t	getId () const
	Returns the frame ID.
uint64_t	getDataLength () const
	Returns the frame data length.
bool	isLossless () const
	Returns if the frame encoding is lossless.
const SbString &	getMessage () const
	Returns the attached message.

Detailed Description

Structure given when a received and decoded frame event is raised.

Please refer to onReceivedFrame, onDecodedFrame event.

Definition at line 441 of file SoRemoteVizClient.h.

Constructor & Destructor Documentation

FrameEventArg()

SoRemoteVizClient::FrameEventArg::FrameEventArg ( SoRemoteVizClient * source, uint64_t id, uint64_t dataLength, bool isLossless, const SbString & message )

inline

Default constructor.

Definition at line 444 of file SoRemoteVizClient.h.

Member Function Documentation

getDataLength()

uint64_t SoRemoteVizClient::FrameEventArg::getDataLength ( ) const

inline

Returns the frame data length.

Definition at line 454 of file SoRemoteVizClient.h.

getId()

uint64_t SoRemoteVizClient::FrameEventArg::getId ( ) const

inline

Returns the frame ID.

Definition at line 451 of file SoRemoteVizClient.h.

getMessage()

const SbString & SoRemoteVizClient::FrameEventArg::getMessage ( ) const

inline

Returns the attached message.

Definition at line 460 of file SoRemoteVizClient.h.

getSource()

SoRemoteVizClient * SoRemoteVizClient::FrameEventArg::getSource ( ) const

inline

Returns the SoRemoteVizClient node that triggered the event.

Definition at line 448 of file SoRemoteVizClient.h.

isLossless()

bool SoRemoteVizClient::FrameEventArg::isLossless ( ) const

inline

Returns if the frame encoding is lossless.

Definition at line 457 of file SoRemoteVizClient.h.

---

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

• RemoteViz/Clients/nodes/SoRemoteVizClient.h