#include <MpResNotificationMsg.h>
Public Member Functions | |
Creators | |
| 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 OsMsg * | createCopy (void) const |
| Create a copy of this msg object (which may be of a derived type) More... | |
| virtual | ~MpResNotificationMsg () |
| Destructor. More... | |
Manipulators | |
| 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... | |
Accessors | |
| 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... | |
Private Attributes | |
| UtlString | mMsgOriginatorName |
| Name of the resource that originated this message. More... | |
| MpConnectionID | mConnectionId |
| int | mStreamId |
Detailed Description
Message notification object used to communicate information from resources outward towards the flowgraph, and up through to users above mediaLib and beyond.
Member Enumeration Documentation
| enum RNMsgType |
Phone set message types.
| Enumerator | |
|---|---|
| MPRNM_MESSAGE_INVALID |
Message type is invalid (similar to NULL) |
| MPRNM_MESSAGE_ALL |
Select all message types (used in enabling/disabling) |
| MPRNM_FROMFILE_STARTED | |
| MPRNM_FROMFILE_PAUSED | |
| MPRNM_FROMFILE_RESUMED | |
| MPRNM_FROMFILE_STOPPED | |
| MPRNM_FROMFILE_FINISHED |
Audio energy level (MprnIntMsg) |
| MPRNM_FROMFILE_ERROR | |
| MPRNM_FROMFILE_PROGRESS |
Value for MprnProgressMsg notifications. |
| MPRNM_RECORDER_STARTED |
Recording started. |
| MPRNM_RECORDER_PAUSED |
Recorder paused after being started, or resumed (MprnIntMsg bears number of recorded samples). |
| MPRNM_RECORDER_RESUMED |
Recorder resumed after being paused. |
| MPRNM_RECORDER_STOPPED |
Recording stopped manually (MprnIntMsg bears number of recorded samples). |
| MPRNM_RECORDER_FINISHED |
Recording stopped automatically (MprnIntMsg bears number of recorded samples). |
| MPRNM_RECORDER_ERROR |
Recording stopped because of an error. |
| MPRNM_DTMF_RECEIVED |
Value for MprnDTMFMsg notifications. |
| MPRNM_DELAY_SPEECH_STARTED | |
| MPRNM_DELAY_NO_DELAY | |
| MPRNM_DELAY_QUIESCENCE | |
| MPRNM_RX_STREAM_ACTIVITY |
Value for MprnRtpStreamActivityMsg notifications. |
| MPRNM_ENERGY_LEVEL |
Audio energy level (MprnIntMsg) |
| 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 | |
Constructor & Destructor Documentation
| MpResNotificationMsg | ( | RNMsgType | msgType, |
| const UtlString & | namedResOriginator, | ||
| MpConnectionID | connId = MP_INVALID_CONNECTION_ID, |
||
| int | streamId = -1 |
||
| ) |
Constructor.
| MpResNotificationMsg | ( | const MpResNotificationMsg & | rMpResNotifyMsg | ) |
Copy constructor.
|
virtual |
Destructor.
Member Function Documentation
|
virtual |
Create a copy of this msg object (which may be of a derived type)
Reimplemented in MprnDTMFMsg, MprnRtpStreamActivityMsg, MprnIntMsg, MprnProgressMsg, and MprnStringMsg.
| MpResNotificationMsg & operator= | ( | const MpResNotificationMsg & | rhs | ) |
Assignment operator.
| void setOriginatingResourceName | ( | const UtlString & | resOriginator | ) |
Set the name of the resource this message applies to.
Sets the name of the intended recipient for this message.
| void setConnectionId | ( | MpConnectionID | connId | ) |
Set the connection ID that this notification is associated with.
| void setStreamId | ( | int | streamId | ) |
Set the stream number inside the connection this notification is associated with.
| int getMsg | ( | void | ) | const |
Returns the type of the media resource notification message.
| UtlString getOriginatingResourceName | ( | void | ) | const |
Get the name of the resource that originated this message.
Returns the name of the MpResource object that originated this message.
| MpConnectionID getConnectionId | ( | ) | const |
Get the connection ID that this message is associated with.
| int getStreamId | ( | ) | const |
Get the stream number inside the connection this notification is associated with.
Member Data Documentation
|
private |
Name of the resource that originated this message.
|
private |
The ID of the connection this notification is associated with.
|
private |
The ID of the stream inside connection this notification is associated with.
