recon::Participant Class Reference

This is the base class for a RemoteParticipant, LocalParticipant and a MediaResourceParticipant. More...

#include <Participant.hxx>

Inheritance diagram for recon::Participant:

Public Types
typedef std::map< ConversationHandle, Conversation * >	ConversationMap

Public Member Functions
	Participant (ParticipantHandle partHandle, ConversationManager::ParticipantType participantType, ConversationManager &conversationManager)
	Participant (ConversationManager::ParticipantType participantType, ConversationManager &conversationManager)
virtual	~Participant ()
virtual ParticipantHandle	getParticipantHandle ()
virtual ConversationManager::ParticipantType	getParticipantType ()
virtual void	setRecordChannelNum (unsigned int channelNum)
virtual unsigned int	getRecordChannelNum ()
virtual void	addToConversation (Conversation *conversation, unsigned int inputGain=100, unsigned int outputGain=100)
virtual void	removeFromConversation (Conversation *conversation)
virtual void	unregisterFromAllConversations ()
virtual void	copyConversationsToParticipant (Participant *destParticipant)
virtual unsigned int	getNumConversations ()
const ConversationMap &	getConversations ()
virtual void	setHandle (ParticipantHandle partHandle)
virtual void	replaceWithParticipant (Participant *replacingParticipant)
virtual int	getConnectionPortOnBridge ()=0
virtual bool	hasInput ()=0
virtual bool	hasOutput ()=0
virtual void	applyBridgeMixWeights ()
virtual void	applyBridgeMixWeights (Conversation *removedConversation)
virtual void	destroyParticipant ()=0

Protected Attributes
ParticipantHandle	mHandle
ConversationManager::ParticipantType	mType
unsigned int	mRecordChannelNum
ConversationManager &	mConversationManager
ConversationMap	mConversations

Detailed Description

This is the base class for a RemoteParticipant, LocalParticipant and a MediaResourceParticipant.

It implements the common functionality of all participants, such as managing which Conversations that are participant belongs to.

Author: Scott Godin (sgodin AT SipSpectrum DOT com)

Definition at line 20 of file Participant.hxx.

Member Typedef Documentation

ConversationMap

typedef std::map<ConversationHandle,Conversation*> recon::Participant::ConversationMap

Definition at line 24 of file Participant.hxx.

Constructor & Destructor Documentation

Participant() [1/2]

Participant::Participant	(	ParticipantHandle	partHandle,
		ConversationManager::ParticipantType	participantType,
		ConversationManager &	conversationManager
	)

Definition at line 17 of file Participant.cxx.

Participant() [2/2]

Participant::Participant	(	ConversationManager::ParticipantType	participantType,
		ConversationManager &	conversationManager
	)

Definition at line 29 of file Participant.cxx.

~Participant()

Participant::~Participant ( )

virtual

Definition at line 40 of file Participant.cxx.

Member Function Documentation

addToConversation()

void Participant::addToConversation ( Conversation *  conversation, unsigned int  inputGain = 100, unsigned int  outputGain = 100  )

virtual

Reimplemented in recon::SipXLocalParticipant, recon::GstRemoteParticipant, recon::KurentoRemoteParticipant, recon::LibWebRTCRemoteParticipant, and recon::RemoteParticipant.

Definition at line 67 of file Participant.cxx.

applyBridgeMixWeights() [1/2]

void Participant::applyBridgeMixWeights ( )

virtual

Reimplemented in recon::GstRemoteParticipant, recon::KurentoRemoteParticipant, recon::LibWebRTCRemoteParticipant, and recon::RemoteIMPagerParticipant.

Definition at line 130 of file Participant.cxx.

applyBridgeMixWeights() [2/2]

void Participant::applyBridgeMixWeights ( Conversation *  removedConversation )

virtual

Reimplemented in recon::GstRemoteParticipant, recon::KurentoRemoteParticipant, recon::LibWebRTCRemoteParticipant, and recon::RemoteIMPagerParticipant.

Definition at line 163 of file Participant.cxx.

copyConversationsToParticipant()

void Participant::copyConversationsToParticipant ( Participant *  destParticipant )

virtual

Definition at line 100 of file Participant.cxx.

destroyParticipant()

virtual void recon::Participant::destroyParticipant ( )

pure virtual

Implemented in recon::LocalParticipant, recon::MediaResourceParticipant, recon::RemoteIMPagerParticipant, and recon::RemoteParticipant.

getConnectionPortOnBridge()

virtual int recon::Participant::getConnectionPortOnBridge ( )

pure virtual

Implemented in recon::GstRemoteParticipant, recon::KurentoRemoteParticipant, recon::LibWebRTCRemoteParticipant, recon::SipXLocalParticipant, recon::SipXMediaResourceParticipant, recon::RemoteIMPagerParticipant, recon::RemoteIMSessionParticipant, and recon::SipXRemoteParticipant.

getConversations()

const ConversationMap & recon::Participant::getConversations ( )

inline

Definition at line 46 of file Participant.hxx.

getNumConversations()

virtual unsigned int recon::Participant::getNumConversations ( )

inlinevirtual

Definition at line 45 of file Participant.hxx.

getParticipantHandle()

virtual ParticipantHandle recon::Participant::getParticipantHandle ( )

inlinevirtual

Definition at line 35 of file Participant.hxx.

getParticipantType()

virtual ConversationManager::ParticipantType recon::Participant::getParticipantType ( )

inlinevirtual

Definition at line 36 of file Participant.hxx.

getRecordChannelNum()

virtual unsigned int recon::Participant::getRecordChannelNum ( )

inlinevirtual

Definition at line 39 of file Participant.hxx.

hasInput()

virtual bool recon::Participant::hasInput ( )

pure virtual

Implemented in recon::GstRemoteParticipant, recon::KurentoRemoteParticipant, recon::LibWebRTCRemoteParticipant, recon::MediaResourceParticipant, recon::SipXLocalParticipant, recon::RemoteIMPagerParticipant, recon::RemoteIMSessionParticipant, and recon::SipXRemoteParticipant.

hasOutput()

virtual bool recon::Participant::hasOutput ( )

pure virtual

Implemented in recon::GstRemoteParticipant, recon::KurentoRemoteParticipant, recon::LibWebRTCRemoteParticipant, recon::MediaResourceParticipant, recon::SipXLocalParticipant, recon::RemoteIMPagerParticipant, recon::RemoteIMSessionParticipant, and recon::SipXRemoteParticipant.

removeFromConversation()

void Participant::removeFromConversation ( Conversation *  conversation )

virtual

Reimplemented in recon::GstRemoteParticipant, recon::KurentoRemoteParticipant, recon::LibWebRTCRemoteParticipant, and recon::RemoteParticipant.

Definition at line 79 of file Participant.cxx.

replaceWithParticipant()

void Participant::replaceWithParticipant ( Participant *  replacingParticipant )

virtual

Definition at line 110 of file Participant.cxx.

setHandle()

void Participant::setHandle ( ParticipantHandle  partHandle )

virtual

Definition at line 50 of file Participant.cxx.

setRecordChannelNum()

virtual void recon::Participant::setRecordChannelNum ( unsigned int  channelNum )

inlinevirtual

Definition at line 38 of file Participant.hxx.

unregisterFromAllConversations()

void Participant::unregisterFromAllConversations ( )

virtual

Definition at line 88 of file Participant.cxx.

Member Data Documentation

mConversationManager

ConversationManager& recon::Participant::mConversationManager

protected

Definition at line 65 of file Participant.hxx.

mConversations

ConversationMap recon::Participant::mConversations

protected

Definition at line 66 of file Participant.hxx.

mHandle

ParticipantHandle recon::Participant::mHandle

protected

Definition at line 62 of file Participant.hxx.

mRecordChannelNum

unsigned int recon::Participant::mRecordChannelNum

protected

Definition at line 64 of file Participant.hxx.

mType

ConversationManager::ParticipantType recon::Participant::mType

protected

Definition at line 63 of file Participant.hxx.

---

The documentation for this class was generated from the following files:

• resip/recon/Participant.hxx
• resip/recon/Participant.cxx