MpFlowGraphMsg Class Reference

Message object used to communicate with the media processing task. More...

#include <MpFlowGraphMsg.h>

Inheritance diagram for MpFlowGraphMsg:

Collaboration diagram for MpFlowGraphMsg:

Public Types
enum	MpFlowGraphMsgType {   FLOWGRAPH_ADD_LINK = 0, FLOWGRAPH_ADD_RESOURCE, FLOWGRAPH_DESTROY_RESOURCES, FLOWGRAPH_DISABLE,   FLOWGRAPH_ENABLE, FLOWGRAPH_PROCESS_FRAME, FLOWGRAPH_REMOVE_CONNECTION, FLOWGRAPH_REMOVE_LINK,   FLOWGRAPH_REMOVE_RESOURCE, FLOWGRAPH_DESTROY_RESOURCE, FLOWGRAPH_START, FLOWGRAPH_STOP,   RESOURCE_DISABLE, RESOURCE_ENABLE, FLOWGRAPH_START_PLAY, FLOWGRAPH_START_TONE,   FLOWGRAPH_STOP_PLAY, FLOWGRAPH_STOP_TONE, FLOWGRAPH_STOP_RECORD, FLOWGRAPH_SYNCHRONIZE,   FLOWGRAPH_GET_LATENCY_FOR_PATH, RESOURCE_SPECIFIC_START = 100 }
	Phone set message types. More...

Public Member Functions
Creators
	MpFlowGraphMsg (int msg, MpResource *pMsgDest=NULL, void *pPtr1=NULL, void *pPtr2=NULL, intptr_t int1=-1, intptr_t int2=-1)
	Constructor. More...
	MpFlowGraphMsg (const MpFlowGraphMsg &rMpFlowGraphMsg)
	Copy constructor. More...
virtual OsMsg *	createCopy (void) const
	Create a copy of this msg object (which may be of a derived type) More...
virtual	~MpFlowGraphMsg ()
	Destructor. More...
Manipulators
MpFlowGraphMsg &	operator= (const MpFlowGraphMsg &rhs)
	Assignment operator. More...
void	setMsgDest (MpResource *pMsgDest)
	Set destination object of the message. More...
void	setPtr1 (void *p)
	Sets pointer 1 (void*) of the media flow graph message. More...
void	setPtr2 (void *p)
	Sets pointer 2 (void*) of the media flow graph message. More...
void	setInt1 (intptr_t i)
	Sets integer 1 of the media flow graph message. More...
void	setInt2 (intptr_t i)
	Sets integer 2 of the media flow graph message. More...
Accessors
int	getMsg (void) const
	Returns the type of the media flow graph message. More...
MpResource *	getMsgDest (void) const
	Get destination object of the message. More...
void *	getPtr1 (void) const
	Return pointer 1 (void*) of the media flow graph message. More...
void *	getPtr2 (void) const
	Return pointer 2 (void*) of the media flow graph message. More...
intptr_t	getInt1 (void) const
	Return integer 1 of the media flow graph message. More...
intptr_t	getInt2 (void) const
	Return integer 2 of the media flow graph message. More...

Private Attributes
MpResource *	mpMsgDest
	Intended recipient for this message. More...
void *	mpPtr1
	Pointer to data 1. More...
void *	mpPtr2
	Pointer to data 2. More...
intptr_t	mInt1
	Integer data 1. More...
intptr_t	mInt2
	Integer data 2. More...

Detailed Description

Message object used to communicate with the media processing task.

Member Enumeration Documentation

enum MpFlowGraphMsgType

Phone set message types.

Enumerator
FLOWGRAPH_ADD_LINK
FLOWGRAPH_ADD_RESOURCE
FLOWGRAPH_DESTROY_RESOURCES
FLOWGRAPH_DISABLE
FLOWGRAPH_ENABLE
FLOWGRAPH_PROCESS_FRAME
FLOWGRAPH_REMOVE_CONNECTION
FLOWGRAPH_REMOVE_LINK
FLOWGRAPH_REMOVE_RESOURCE
FLOWGRAPH_DESTROY_RESOURCE
FLOWGRAPH_START
FLOWGRAPH_STOP
RESOURCE_DISABLE
RESOURCE_ENABLE
FLOWGRAPH_START_PLAY
FLOWGRAPH_START_TONE
FLOWGRAPH_STOP_PLAY
FLOWGRAPH_STOP_TONE
FLOWGRAPH_STOP_RECORD
FLOWGRAPH_SYNCHRONIZE
FLOWGRAPH_GET_LATENCY_FOR_PATH
RESOURCE_SPECIFIC_START	start of resource-specific messages

Constructor & Destructor Documentation

MpFlowGraphMsg	(	int	msg,
		MpResource *	pMsgDest = NULL,
		void *	pPtr1 = NULL,
		void *	pPtr2 = NULL,
		intptr_t	int1 = -1,
		intptr_t	int2 = -1
	)

Constructor.

MpFlowGraphMsg

(

const MpFlowGraphMsg &

rMpFlowGraphMsg

)

Copy constructor.

~MpFlowGraphMsg ( )

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 in MpSyncFlowgraphMsg.

MpFlowGraphMsg & operator=

(

const MpFlowGraphMsg &

rhs

)

Assignment operator.

void setMsgDest

(

MpResource *

pMsgDest

)

Set destination object of the message.

Sets the intended recipient for this message. Setting the message destination to NULL indicates that the message is intended for the flow graph itself.

void setPtr1

(

void *

p

)

Sets pointer 1 (void*) of the media flow graph message.

void setPtr2

(

void *

p

)

Sets pointer 2 (void*) of the media flow graph message.

void setInt1

(

intptr_t

i

)

Sets integer 1 of the media flow graph message.

void setInt2

(

intptr_t

i

)

Sets integer 2 of the media flow graph message.

int getMsg

(

void

)

const

Returns the type of the media flow graph message.

MpResource * getMsgDest

(

void

)

const

Get destination object of the message.

Returns the MpResource object that is the intended recipient for this message. A NULL return indicates that the message is intended for the flow graph itself.

void * getPtr1

(

void

)

const

Return pointer 1 (void*) of the media flow graph message.

void * getPtr2

(

void

)

const

Return pointer 2 (void*) of the media flow graph message.

intptr_t getInt1

(

void

)

const

Return integer 1 of the media flow graph message.

intptr_t getInt2

(

void

)

const

Return integer 2 of the media flow graph message.

Member Data Documentation

MpResource* mpMsgDest

private

Intended recipient for this message.

void* mpPtr1

private

Pointer to data 1.

void* mpPtr2

private

Pointer to data 2.

intptr_t mInt1

private

Integer data 1.

intptr_t mInt2

private

Integer data 2.