MiProgressNotf Class Reference

Message notification class used to communicate DTMF signaling. More...

#include <MiProgressNotf.h>

Inheritance diagram for MiProgressNotf:

Collaboration diagram for MiProgressNotf:

Public Member Functions
Creators
	MiProgressNotf (const UtlString &sourceId, unsigned posMS, unsigned totalMS)
	Constructor. More...
	MiProgressNotf (const MiProgressNotf &rNotf)
	Copy constructor. More...
virtual OsMsg *	createCopy (void) const
	Create a copy of this msg object (which may be of a derived type) More...
virtual	~MiProgressNotf ()
	Destructor. More...
Manipulators
MiProgressNotf &	operator= (const MiProgressNotf &rhs)
	Assignment operator. More...
void	setPositionMS (unsigned posMS)
	Set the position in milliseconds this message reports. More...
void	setTotalMS (unsigned totalMS)
	Set the total size of the buffer in milliseconds this message reports. More...
Accessors
unsigned	getPositionMS (void) const
	Get the current reported position of this progress update in MS. More...
unsigned	getTotalMS (void) const
	Get the total size of the buffer in milliseconds this message reports. More...
Public Member Functions inherited from MiNotification
	MiNotification (NotfType msgType, const UtlString &sourceId, int connectionId=INVALID_CONNECTION_ID, int streamId=-1)
	Constructor. More...
	MiNotification (const MiNotification &rNotf)
	Copy constructor. More...
virtual	~MiNotification ()
	Destructor. More...
MiNotification &	operator= (const MiNotification &rhs)
	Assignment operator. More...
void	setSourceId (const UtlString &sourceId)
	Set the unique source identifier. More...
void	setConnectionId (int connId)
	Set the connection ID that this notification is associated with. More...
void	setStreamId (int streamId)
	Set the stream number inside the connection this notification is associated with. More...
NotfType	getType (void) const
	Returns the type of the notification message. More...
UtlString	getSourceId (void) const
	Get the unique source identifier. More...
int	getConnectionId () const
	Get the connection ID that this message is associated with. More...
int	getStreamId () const
	Get the stream number inside the connection this notification is associated with. More...

Private Attributes
unsigned	mCurPositionMS
	current position reported, in milliseconds. More...
unsigned	mTotalMS
	Total size in milliseconds. More...

Additional Inherited Members
Public Types inherited from MiNotification
enum	NotfType {   MI_NOTF_MESSAGE_INVALID, MI_NOTF_PLAY_STARTED, MI_NOTF_PLAY_PAUSED, MI_NOTF_PLAY_RESUMED,   MI_NOTF_PLAY_STOPPED, MI_NOTF_PLAY_FINISHED, MI_NOTF_PLAY_ERROR, MI_NOTF_PROGRESS,   MI_NOTF_RECORD_STARTED, MI_NOTF_RECORD_PAUSED, MI_NOTF_RECORD_RESUMED, MI_NOTF_RECORD_STOPPED,   MI_NOTF_RECORD_FINISHED, MI_NOTF_RECORD_ERROR, MI_NOTF_DTMF_RECEIVED, MI_NOTF_DELAY_SPEECH_STARTED,   MI_NOTF_DELAY_NO_DELAY, MI_NOTF_DELAY_QUIESCENCE, MI_NOTF_RX_STREAM_ACTIVITY, MI_NOTF_ENERGY_LEVEL,   MI_NOTF_VOICE_STARTED, MI_NOTF_VOICE_STOPPED, MI_NOTF_H264_SPS, MI_NOTF_H264_PPS,   MI_NOTF_TONE_DETECT_ON, MI_NOTF_TONE_DETECT_OFF, MI_NOTF_RECORDER_CIRCULARBUFFER_WATERMARK_REACHED, MI_NOTF_INPUT_DEVICE_NOT_PRESENT,   MI_NOTF_OUTPUT_DEVICE_NOT_PRESENT, MI_NOTF_INPUT_DEVICE_NOW_PRESENT, MI_NOTF_OUTPUT_DEVICE_NOW_PRESENT }
	Media notification message types. More...
Static Public Attributes inherited from MiNotification
static const int	INVALID_CONNECTION_ID = -1
	Connection ID that indicates invalid connection or no connection. More...

Detailed Description

Message notification class used to communicate DTMF signaling.

Constructor & Destructor Documentation

MiProgressNotf	(	const UtlString &	sourceId,
		unsigned	posMS,
		unsigned	totalMS
	)

Constructor.

MiProgressNotf

(

const MiProgressNotf &

rNotf

)

Copy constructor.

~MiProgressNotf ( )

virtual

Destructor.

Member Function Documentation

OsMsg * createCopy ( void  ) const

virtual

Create a copy of this msg object (which may be of a derived type)

Reimplemented from MiNotification.

MiProgressNotf & operator=

(

const MiProgressNotf &

rhs

)

Assignment operator.

void setPositionMS

(

unsigned

posMS

)

Set the position in milliseconds this message reports.

void setTotalMS

(

unsigned

totalMS

)

Set the total size of the buffer in milliseconds this message reports.

unsigned getPositionMS

(

void

)

const

Get the current reported position of this progress update in MS.

unsigned getTotalMS

(

void

)

const

Get the total size of the buffer in milliseconds this message reports.

Member Data Documentation

unsigned mCurPositionMS

private

current position reported, in milliseconds.

unsigned mTotalMS

private

Total size in milliseconds.