#include <MprnDTMFMsg.h>

Inheritance diagram for MprnDTMFMsg:

Collaboration diagram for MprnDTMFMsg:

Public Types
enum	KeyPressState { KEY_UP, KEY_DOWN }

enum	KeyCode { DTMF_0 = 0, DTMF_1, DTMF_2, DTMF_3, DTMF_4, DTMF_5, DTMF_6, DTMF_7, DTMF_8, DTMF_9, DTMF_STAR = 10, DTMF_POUND, DTMF_A, DTMF_B, DTMF_C, DTMF_D }

Public Types inherited from MpResNotificationMsg
enum	RNMsgType { MPRNM_MESSAGE_INVALID, MPRNM_MESSAGE_ALL = MPRNM_MESSAGE_INVALID, MPRNM_FROMFILE_STARTED, MPRNM_FROMFILE_PAUSED, MPRNM_FROMFILE_RESUMED, MPRNM_FROMFILE_STOPPED, MPRNM_FROMFILE_FINISHED, MPRNM_FROMFILE_ERROR, MPRNM_FROMFILE_PROGRESS, MPRNM_RECORDER_STARTED, MPRNM_RECORDER_PAUSED, MPRNM_RECORDER_RESUMED, MPRNM_RECORDER_STOPPED, MPRNM_RECORDER_FINISHED, MPRNM_RECORDER_ERROR, MPRNM_DTMF_RECEIVED, MPRNM_DELAY_SPEECH_STARTED, MPRNM_DELAY_NO_DELAY, MPRNM_DELAY_QUIESCENCE, MPRNM_RX_STREAM_ACTIVITY, MPRNM_ENERGY_LEVEL, MPRNM_VOICE_STARTED, MPRNM_VOICE_STOPPED, MPRNM_H264_SPS, MPRNM_H264_PPS, MPRNM_TONE_DETECT_ON, MPRNM_TONE_DETECT_OFF, MPRNM_RECORDER_CIRCULARBUFFER_WATERMARK_REACHED, MPRNM_INPUT_DEVICE_NOT_PRESENT, MPRNM_OUTPUT_DEVICE_NOT_PRESENT, MPRNM_INPUT_DEVICE_NOW_PRESENT, MPRNM_OUTPUT_DEVICE_NOW_PRESENT }
	Phone set message types. More...

Public Member Functions
Creators
	MprnDTMFMsg (const UtlString &namedResOriginator, KeyCode key, KeyPressState pressState, int32_t duration=DURATION_NOT_APPLICABLE, MpConnectionID connId=MP_INVALID_CONNECTION_ID, int streamId=-1)
	Constructor. More...

	MprnDTMFMsg (const MprnDTMFMsg &rMsg)
	Copy constructor. More...

virtual OsMsg *	createCopy (void) const
	Create a copy of this msg object (which may be of a derived type) More...

virtual	~MprnDTMFMsg ()
	Destructor. More...

Manipulators
MprnDTMFMsg &	operator= (const MprnDTMFMsg &rhs)
	Assignment operator. More...

void	setKeyCode (KeyCode key)
	Set the specific DTMF value that this event represents. More...

void	setKeyPressState (KeyPressState pressState)
	Set the key press state for this DTMF message – down or up. More...

void	setDuration (int32_t duration)
	Set the duration of this DTMF event. More...

Accessors
KeyCode	getKeyCode () const
	Get the specific DTMF value that this event represents. More...

KeyPressState	getKeyPressState () const
	Get the key press state for this DTMF message – down or up. More...

int32_t	getDuration () const
	Get the duration of this DTMF event. More...

Inquiry
UtlBoolean	isPressed () const
	Return TRUE if this notification indicates key is down/pressed. More...

Public Member Functions inherited from MpResNotificationMsg
	MpResNotificationMsg (RNMsgType msgType, const UtlString &namedResOriginator, MpConnectionID connId=MP_INVALID_CONNECTION_ID, int streamId=-1)
	Constructor. More...

	MpResNotificationMsg (const MpResNotificationMsg &rMpResNotifyMsg)
	Copy constructor. More...

virtual	~MpResNotificationMsg ()
	Destructor. More...

MpResNotificationMsg &	operator= (const MpResNotificationMsg &rhs)
	Assignment operator. More...

void	setOriginatingResourceName (const UtlString &resOriginator)
	Set the name of the resource this message applies to. More...

void	setConnectionId (MpConnectionID 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...

int	getMsg () const
	Returns the type of the media resource notification message. More...

UtlString	getOriginatingResourceName () const
	Get the name of the resource that originated this message. More...

MpConnectionID	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...

Static Public Attributes
static const int32_t	DURATION_NOT_APPLICABLE = -1

Private Attributes
KeyCode	mKey
	The DTMF key value. More...

KeyPressState	mPressState
	Whether the key is up or down. More...

int32_t	mDuration
	Duration of the DTMF event. More...

Detailed Description

Message notification object used to communicate DTMF signaling from resources outward towards the flowgraph, and up through to users above mediaLib and beyond.

If one creates a KEY_DOWN notification, duration should not be supplied, as it isn't useful until a KEY_UP event happens.

Member Enumeration Documentation

enum KeyPressState

Enumerator
KEY_UP
KEY_DOWN

enum KeyCode

Enumerator
DTMF_0
DTMF_1
DTMF_2
DTMF_3
DTMF_4
DTMF_5
DTMF_6
DTMF_7
DTMF_8
DTMF_9
DTMF_STAR
DTMF_POUND
DTMF_A
DTMF_B
DTMF_C
DTMF_D

Constructor & Destructor Documentation

MprnDTMFMsg	(	const UtlString &	namedResOriginator,
		KeyCode	key,
		KeyPressState	pressState,
		int32_t	duration = `DURATION_NOT_APPLICABLE`,
		MpConnectionID	connId = `MP_INVALID_CONNECTION_ID`,
		int	streamId = `-1`
	)

Constructor.

MprnDTMFMsg ( const MprnDTMFMsg & rMsg )

Copy constructor.

~MprnDTMFMsg ( )

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 MpResNotificationMsg.

MprnDTMFMsg & operator= ( const MprnDTMFMsg & rhs )

Assignment operator.

void setKeyCode ( KeyCode key )

Set the specific DTMF value that this event represents.

void setKeyPressState ( KeyPressState pressState )

Set the key press state for this DTMF message – down or up.

void setDuration ( int32_t duration )

Set the duration of this DTMF event.

MprnDTMFMsg::KeyCode getKeyCode ( ) const

Get the specific DTMF value that this event represents.

MprnDTMFMsg::KeyPressState getKeyPressState ( ) const

Get the key press state for this DTMF message – down or up.

int32_t getDuration ( ) const

Get the duration of this DTMF event.

UtlBoolean isPressed ( ) const

Return TRUE if this notification indicates key is down/pressed.

Member Data Documentation

const int32_t DURATION_NOT_APPLICABLE = -1

static

KeyCode mKey

private

The DTMF key value.

KeyPressState mPressState

private

Whether the key is up or down.

int32_t mDuration

private

Duration of the DTMF event.

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation