sipxmedialib  Version 3.3
Public Types | Private Attributes | List of all members
MpStreamMsg Class Reference

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

#include <MpStreamMsg.h>

Inheritance diagram for MpStreamMsg:
Inheritance graph
[legend]
Collaboration diagram for MpStreamMsg:
Collaboration graph
[legend]

Public Types

enum  MpStreamMsgType {
  STREAM_REALIZE_URL, STREAM_REALIZE_BUFFER, STREAM_PREFETCH, STREAM_PLAY,
  STREAM_REWIND, STREAM_PAUSE, STREAM_STOP, STREAM_DESTROY
}
 Phone set message types. More...
 

Public Member Functions

Creators
 MpStreamMsg (int msg, UtlString &target, StreamHandle handle, void *pPtr1=NULL, void *pPtr2=NULL, intptr_t int1=-1, intptr_t int2=-1)
 Constructor. More...
 
 MpStreamMsg (const MpStreamMsg &rMpStreamMsg)
 Copy constructor. More...
 
virtual OsMsg * createCopy () const
 Create a copy of this msg object (which may be of a derived type) More...
 
virtual ~MpStreamMsg ()
 Destructor. More...
 
Manipulators
MpStreamMsgoperator= (const MpStreamMsg &rhs)
 Assignment operator. More...
 
void setTarget (UtlString &target)
 Sets the target id of the stream message. More...
 
void setHandle (StreamHandle handle)
 Sets the stream handle of the stream message. More...
 
void setPtr1 (void *p)
 Sets pointer 1 (void*) of the stream message. More...
 
void setPtr2 (void *p)
 Sets pointer 2 (void*) of the stream message. More...
 
void setInt1 (intptr_t i)
 Sets integer 1 of the stream message. More...
 
void setInt2 (intptr_t i)
 Sets integer 2 of the stream message. More...
 
Accessors
int getMsg () const
 Returns the type of the stream message. More...
 
UtlString getTarget () const
 Return the target id of the stream message. More...
 
StreamHandle getHandle () const
 Return stream handle of stream msg. More...
 
void * getPtr1 () const
 Return pointer 1 (void*) of the stream message. More...
 
void * getPtr2 () const
 Return pointer 2 (void*) of the stream message. More...
 
intptr_t getInt1 () const
 Return integer 1 of the media stream message. More...
 
intptr_t getInt2 () const
 Return integer 2 of the media stream message. More...
 

Private Attributes

UtlString mTarget
 Target ID. More...
 
StreamHandle mHandle
 Stream Handle. More...
 
void * mpPtr1
 Message pointer 1. More...
 
void * mpPtr2
 Message pointer 2. More...
 
intptr_t mInt1
 Message integer 1. More...
 
intptr_t mInt2
 Message integer 2. More...
 

Detailed Description

Message object used to communicate with the media processing task.

Member Enumeration Documentation

Phone set message types.

Enumerator
STREAM_REALIZE_URL 
STREAM_REALIZE_BUFFER 
STREAM_PREFETCH 
STREAM_PLAY 
STREAM_REWIND 
STREAM_PAUSE 
STREAM_STOP 
STREAM_DESTROY 

Constructor & Destructor Documentation

MpStreamMsg ( int  msg,
UtlString &  target,
StreamHandle  handle,
void *  pPtr1 = NULL,
void *  pPtr2 = NULL,
intptr_t  int1 = -1,
intptr_t  int2 = -1 
)

Constructor.

MpStreamMsg ( const MpStreamMsg rMpStreamMsg)

Copy constructor.

~MpStreamMsg ( )
virtual

Destructor.

Member Function Documentation

OsMsg * createCopy ( void  ) const
virtual

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

MpStreamMsg & operator= ( const MpStreamMsg rhs)

Assignment operator.

void setTarget ( UtlString &  target)

Sets the target id of the stream message.

void setHandle ( StreamHandle  handle)

Sets the stream handle of the stream message.

void setPtr1 ( void *  p)

Sets pointer 1 (void*) of the stream message.

void setPtr2 ( void *  p)

Sets pointer 2 (void*) of the stream message.

void setInt1 ( intptr_t  i)

Sets integer 1 of the stream message.

void setInt2 ( intptr_t  i)

Sets integer 2 of the stream message.

int getMsg ( void  ) const

Returns the type of the stream message.

UtlString getTarget ( ) const

Return the target id of the stream message.

StreamHandle getHandle ( ) const

Return stream handle of stream msg.

void * getPtr1 ( void  ) const

Return pointer 1 (void*) of the stream message.

void * getPtr2 ( void  ) const

Return pointer 2 (void*) of the stream message.

intptr_t getInt1 ( void  ) const

Return integer 1 of the media stream message.

intptr_t getInt2 ( void  ) const

Return integer 2 of the media stream message.

Member Data Documentation

UtlString mTarget
private

Target ID.

StreamHandle mHandle
private

Stream Handle.

void* mpPtr1
private

Message pointer 1.

void* mpPtr2
private

Message pointer 2.

intptr_t mInt1
private

Message integer 1.

intptr_t mInt2
private

Message integer 2.