RTPSenderControlMessage Class Reference

#include <RTPSenderControlMessage.h>

List of all members.

Public Member Functions
	RTPSenderControlMessage (const char *name=NULL)
	RTPSenderControlMessage (const RTPSenderControlMessage &message)
virtual	~RTPSenderControlMessage ()
RTPSenderControlMessage &	operator= (const RTPSenderControlMessage &message)
virtual cObject *	dup () const
virtual const char *	className () const
virtual const char *	command () const
virtual void	setCommand (const char *command)
virtual void	setCommand (const char *command, float commandParameter1)
virtual void	setCommand (const char *command, float commandParameter1, float commandParameter2)
virtual float	commandParameter1 ()
virtual float	commandParameter2 ()

---

Detailed Description

A message of the type RTPSenderControlMessage is created by an application to control the behavior of an rtp sender module. With this class the application can send a command string to the sender module like "PLAY" or "STOP". A message can have up to two float paramters. Following commands are evaluated in RTPPayloadSender (although correct behavior must be implemented in modules for certain payload types): PLAY start playing from current position PAUSE pause playing, stay at current position STOP stop playing, go to beginning PLAY_UNTIL_TIME start playing from current position and play until given temporal position (relative to start of file is reached) PLAY_UNTIL_BYTE start playing from current position and play until this data byte is reached SEEK_TIME go to temporal position within the file (not allowed while playing) SEEK_BYTE go to data byte (not allowed while playing)

---

Constructor & Destructor Documentation

RTPSenderControlMessage::RTPSenderControlMessage (  const char *  name = NULL  )

Default constructor.

RTPSenderControlMessage::RTPSenderControlMessage (  const RTPSenderControlMessage &  message  )

Copy constructor.

RTPSenderControlMessage::~RTPSenderControlMessage (   )  [virtual]

Destructor.

---

Member Function Documentation

const char * RTPSenderControlMessage::className (   )  const [virtual]

Returns the class name "RTPSenderControlMessage".

const char * RTPSenderControlMessage::command (   )  const [virtual]

Returns the command string in this message.

float RTPSenderControlMessage::commandParameter1 (   )  [virtual]

float RTPSenderControlMessage::commandParameter2 (   )  [virtual]

cObject * RTPSenderControlMessage::dup (   )  const [virtual]

Duplicates the object.

RTPSenderControlMessage & RTPSenderControlMessage::operator= (  const RTPSenderControlMessage &  message  )

Assignment operator.

void RTPSenderControlMessage::setCommand (  const char *  command, float  commandParameter1, float  commandParameter2 )  [virtual]

void RTPSenderControlMessage::setCommand (  const char *  command, float  commandParameter1 )  [virtual]

void RTPSenderControlMessage::setCommand (  const char *  command  )  [virtual]

Set the command string this message transports to the sender module.

---

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

• RTPSenderControlMessage.h
• RTPSenderControlMessage.cc

---