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:

List of all members.

Public Member Functions

 FrameEventArg (SoRemoteVizClient *source, uint64_t id, uint64_t dataLength, bool isLossless, const SbString &message)
SoRemoteVizClientgetSource () const
uint64_t getId () const
uint64_t getDataLength () const
bool isLossless () const
const SbStringgetMessage () const

Detailed Description

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

Please refer to onReceivedFrame, onDecodedFrame event.

Constructor & Destructor Documentation

SoRemoteVizClient::FrameEventArg::FrameEventArg ( SoRemoteVizClient source,
uint64_t  id,
uint64_t  dataLength,
bool  isLossless,
const SbString message 
) [inline]

Default constructor.

Member Function Documentation

uint64_t SoRemoteVizClient::FrameEventArg::getDataLength (  )  const [inline]

Returns the frame data length.

uint64_t SoRemoteVizClient::FrameEventArg::getId (  )  const [inline]

Returns the frame ID.

const SbString& SoRemoteVizClient::FrameEventArg::getMessage (  )  const [inline]

Returns the attached message.

SoRemoteVizClient* SoRemoteVizClient::FrameEventArg::getSource (  )  const [inline]

Returns the SoRemoteVizClient node that triggered the event.

bool SoRemoteVizClient::FrameEventArg::isLossless (  )  const [inline]

Returns if the frame encoding is lossless.

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

Open Inventor Toolkit reference manual, generated on 15 Mar 2023
Copyright © Thermo Fisher Scientific All rights reserved.