class TraceClient

Trace Client. More...

Full nameCoral::TraceClient
Definition#include <traceclient.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods


Detailed Description

This class is a trace client.

 TraceClient (const char* receiverName)

Constructor for a new trace client.

Parameters:
receiverNameString with the receiver name or NULL for default.

TraceClient ()

Destructor.

bool  play (const char* server, const char* mediaName, const card32 sessionDescriptor = 0)

Start playing given media from given server.

Parameters:
serverServer address (e.g. gaffel:7500).
mediaNameMedia name (e.g. ../TraceFiles/Test1.list)
sessionDescriptorSession descriptor.

Returns: true, if play request has been sent to server.

void  change (const char* mediaName)

Change media of an established connection.

Parameters:
mediaNameNew media name (e.g. ../TraceFiles/Test2.list)

void  stop ()

Stop playing.

card64  getPosition ()

Get current media position. This will automatically the RestartPosition value in the next TraceClientAppPacket. The server will restart from the current position, if the server is restarted.

Returns: Position in nanoseconds.

inline card64  getMaxPosition ()

[const]

Get maximum media position.

Returns: Maximum position in nanoseconds.

MediaInfo  getMediaInfo ()

[const]

Get MediaInfo.

Returns: MediaInfo.

inline card8  getErrorCode ()

[const]

Get error code.

Returns: Error code.

inline const char*  getEncoding ()

[const]

Get encoding name.

Returns: Encoding name.

inline cardinal  getMinWantedBandwidth ()

[const]

Get minimum wanted bandwidth.

Returns: Minimum wanted bandwidth.

inline cardinal  getMaxWantedBandwidth ()

[const]

Get maximum wanted bandwidth.

Returns: Maximum wanted bandwidth.

inline double  getMaxWantedDelay ()

[const]

Get maximum wanted delay.

Returns: Maximum wanted delay.

inline double  getWantedUtilization ()

[const]

Get wanted utilization.

Returns: Wanted utilization.

inline int8  getStreamPriority ()

[const]

Get stream priority.

Returns: Stream priority;

inline int8  getSessionPriority ()

[const]

Get session priority.

Returns: Session priority;

inline Range<cardinal>  getBandwidth ()

[const]

Get bandwidth range of last transmission.

Returns: Bandwidth range.

inline double  getFrameRate ()

[const]

Get frame rate of last transmission.

Returns: Frame rate.

inline double  getUtilization ()

[const]

Get utilization of last transmission.

Returns: Utilization.

inline cardinal  getLayers ()

[const]

Get number of layers of last transmission.

card8  getIPVersion ()

[const]

Get IP version.

Returns: IP Version.

inline bool  playing ()

[const]

Check, if trace client is playing.

Returns: true, if client is playing; false otherwise.

String  getServerAddressString (InternetAddress::PrintFormat format = InternetAddress::PF_Address)

[const]

Get server address string.

Parameters:
formatPrint format.

Returns: Server address.

String  getOurAddressString (InternetAddress::PrintFormat format = InternetAddress::PF_Address)

[const]

Get client address string.

Parameters:
formatPrint format.

Returns: Client address.

inline card64  getBytesReceived (const cardinal layer = 0)

[const]

Get number of bytes received.

Parameters:
layerLayer number or (cardinal)-1 for sum of all layers.

Returns: Number of bytes received

inline card64  getPacketsReceived (const cardinal layer = 0)

[const]

Get number of packets received in given layer.

Parameters:
layerLayer number or (cardinal)-1 for sum of all layers.

Returns: Number of packets received

inline InternetFlow  getInternetFlow (const cardinal layer = 0)

[const]

Get InternetFlow of last received packet in given layer.

Parameters:
layerLayer number.

Returns: InternetFlow.

inline card32  getFlowLabel (const cardinal layer = 0)

[const]

Get flow label of last received packet in given layer.

Parameters:
layerLayer number.

Returns: Flow label.

inline card8  getTrafficClass (const cardinal layer = 0)

[const]

Get traffic class of last received packet in given layer.

Parameters:
layerLayer number.

Returns: Traffic class.

card32  getServerSSRC (const cardinal layer = 0)

[const]

Get server SSRC for given layer.

Parameters:
layerLayer number.

Returns: Server SSRC.

inline card32  getOurSSRC ()

[const]

Get client SSRC.

Returns: Client SSRC.

card64  getPacketsLost (const cardinal layer = 0)

[const]

Get number of packets lost for given layer.

Parameters:
layerLayer number.

Returns: Number of packets lost.

double  getFractionLost (const cardinal layer = 0)

[const]

Get fraction of packets lost for given layer.

Parameters:
layerLayer number.

Returns: Fraction of packets lost.

double  getJitter (const cardinal layer = 0)

[const]

Get jitter for given layer.

Parameters:
layerLayer number.

Returns: Jitter.

const char*  getEncodingName (const cardinal index)

Get encoding name for a given index of the client's decoder repository.

Parameters:
indexRepository index.

Returns: Encoding name or NULL, if index is too high.

inline void  setPosition (const card64 position)

Set media position.

Parameters:
positionNew media position in nanoseconds.

void  setPause (const bool on)

Set pause.

Parameters:
ontrue for pause on; false for pause off.

inline void  setWantedUtilization (const double utilization)

Set wanted utilization.

Parameters:
utilizationWanted utilization.

inline void  setMinWantedBandwidth (const cardinal bandwidth)

Set minimum wanted bandwidth.

Parameters:
bandwidthMinimum wanted bandwidth.

inline void  setMaxWantedBandwidth (const cardinal bandwidth)

Set maximum wanted bandwidth.

Parameters:
bandwidthMaximum wanted bandwidth.

inline void  setMaxWantedDelay (const double delay)

Set maximum wanted delay.

Parameters:
delayMaximum wanted delay in microseconds.

inline void  setStreamPriority (const int8 priority)

Set stream priority.

Parameters:
priorityStream priority.

inline void  setSessionPriority (const int8 priority)

Set session priority.

Parameters:
prioritySession priority.

void  setEncoding (const cardinal index)

Set encoding by index in client's decoder repository.

Parameters:
indexIndex in decoder repository.