reSIProcate
SIP stack, Dialog Usage Manager and related libraries
Loading...
Searching...
No Matches
recon::MediaResourceParticipant Class Referenceabstract

This class represents a media resource participant. More...

#include <MediaResourceParticipant.hxx>

Inheritance diagram for recon::MediaResourceParticipant:
[legend]

Public Types

enum  ResourceType {
  Invalid , Tone , File , Cache ,
  Http , Https , RecordMultiChannel , Record ,
  Buffer
}
 
- Public Types inherited from recon::Participant
typedef std::map< ConversationHandle, Conversation * > ConversationMap
 

Public Member Functions

 MediaResourceParticipant (ParticipantHandle partHandle, ConversationManager &conversationManager, const resip::Uri &mediaUrl, const std::shared_ptr< resip::Data > &audioBuffer)
 
virtual ~MediaResourceParticipant ()
 
virtual void startResource ()
 
virtual bool hasInput ()
 
virtual bool hasOutput ()
 
virtual ResourceType getResourceType ()
 
virtual void destroyParticipant ()
 
virtual void resourceDone ()
 
- Public Member Functions inherited from recon::Participant
 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 void applyBridgeMixWeights ()
 
virtual void applyBridgeMixWeights (Conversation *removedConversation)
 

Protected Member Functions

virtual void startResourceImpl ()=0
 
virtual bool stopResource ()=0
 
virtual ConversationManager & getConversationManager ()
 
virtual resip::Uri & getMediaUrl ()
 
virtual bool isRepeat ()
 
virtual void setRepeat (bool repeat)
 
virtual bool isPrefetch ()
 
virtual unsigned int getDurationMs ()
 
virtual unsigned int getStartOffsetMs ()
 
virtual bool isRunning ()
 
virtual void setRunning (bool running)
 
virtual bool isDestroying ()
 
virtual void setDestroying (bool destroying)
 
virtual const std::shared_ptr< resip::Data > & getAudioBuffer ()
 

Additional Inherited Members

- Protected Attributes inherited from recon::Participant
ParticipantHandle mHandle
 
ConversationManager::ParticipantType mType
 
unsigned int mRecordChannelNum
 
ConversationManager & mConversationManager
 
ConversationMap mConversations
 

Detailed Description

This class represents a media resource participant.

A media resource participant is a representation of the a playing audio file or tone.

Author: Scott Godin (sgodin AT SipSpectrum DOT com)

Definition at line 40 of file MediaResourceParticipant.hxx.

Member Enumeration Documentation

◆ ResourceType

Enumerator
Invalid 
Tone 
File 
Cache 
Http 
Https 
RecordMultiChannel 
Record 
Buffer 

Definition at line 43 of file MediaResourceParticipant.hxx.

Constructor & Destructor Documentation

◆ MediaResourceParticipant()

MediaResourceParticipant::MediaResourceParticipant ( ParticipantHandle  partHandle,
ConversationManager &  conversationManager,
const resip::Uri &  mediaUrl,
const std::shared_ptr< resip::Data > &  audioBuffer 
)

Definition at line 36 of file MediaResourceParticipant.cxx.

◆ ~MediaResourceParticipant()

MediaResourceParticipant::~MediaResourceParticipant ( )
virtual

Definition at line 97 of file MediaResourceParticipant.cxx.

Member Function Documentation

◆ destroyParticipant()

void MediaResourceParticipant::destroyParticipant ( )
virtual

Implements recon::Participant.

Definition at line 184 of file MediaResourceParticipant.cxx.

◆ getAudioBuffer()

virtual const std::shared_ptr< resip::Data > & recon::MediaResourceParticipant::getAudioBuffer ( )
inlineprotectedvirtual

Definition at line 83 of file MediaResourceParticipant.hxx.

◆ getConversationManager()

virtual ConversationManager & recon::MediaResourceParticipant::getConversationManager ( )
inlineprotectedvirtual

Definition at line 72 of file MediaResourceParticipant.hxx.

◆ getDurationMs()

virtual unsigned int recon::MediaResourceParticipant::getDurationMs ( )
inlineprotectedvirtual

Definition at line 77 of file MediaResourceParticipant.hxx.

◆ getMediaUrl()

virtual resip::Uri & recon::MediaResourceParticipant::getMediaUrl ( )
inlineprotectedvirtual

Definition at line 73 of file MediaResourceParticipant.hxx.

◆ getResourceType()

virtual ResourceType recon::MediaResourceParticipant::getResourceType ( )
inlinevirtual

Definition at line 65 of file MediaResourceParticipant.hxx.

◆ getStartOffsetMs()

virtual unsigned int recon::MediaResourceParticipant::getStartOffsetMs ( )
inlineprotectedvirtual

Definition at line 78 of file MediaResourceParticipant.hxx.

◆ hasInput()

bool MediaResourceParticipant::hasInput ( )
virtual

Implements recon::Participant.

Definition at line 103 of file MediaResourceParticipant.cxx.

◆ hasOutput()

bool MediaResourceParticipant::hasOutput ( )
virtual

Implements recon::Participant.

Definition at line 110 of file MediaResourceParticipant.cxx.

◆ isDestroying()

virtual bool recon::MediaResourceParticipant::isDestroying ( )
inlineprotectedvirtual

Definition at line 81 of file MediaResourceParticipant.hxx.

◆ isPrefetch()

virtual bool recon::MediaResourceParticipant::isPrefetch ( )
inlineprotectedvirtual

Definition at line 76 of file MediaResourceParticipant.hxx.

◆ isRepeat()

virtual bool recon::MediaResourceParticipant::isRepeat ( )
inlineprotectedvirtual

Definition at line 74 of file MediaResourceParticipant.hxx.

◆ isRunning()

virtual bool recon::MediaResourceParticipant::isRunning ( )
inlineprotectedvirtual

Definition at line 79 of file MediaResourceParticipant.hxx.

◆ resourceDone()

void MediaResourceParticipant::resourceDone ( )
virtual

Definition at line 177 of file MediaResourceParticipant.cxx.

◆ setDestroying()

virtual void recon::MediaResourceParticipant::setDestroying ( bool  destroying)
inlineprotectedvirtual

Definition at line 82 of file MediaResourceParticipant.hxx.

◆ setRepeat()

virtual void recon::MediaResourceParticipant::setRepeat ( bool  repeat)
inlineprotectedvirtual

Definition at line 75 of file MediaResourceParticipant.hxx.

◆ setRunning()

virtual void recon::MediaResourceParticipant::setRunning ( bool  running)
inlineprotectedvirtual

Definition at line 80 of file MediaResourceParticipant.hxx.

◆ startResource()

void MediaResourceParticipant::startResource ( )
virtual

Definition at line 121 of file MediaResourceParticipant.cxx.

◆ startResourceImpl()

virtual void recon::MediaResourceParticipant::startResourceImpl ( )
protectedpure virtual

◆ stopResource()

virtual bool recon::MediaResourceParticipant::stopResource ( )
protectedpure virtual

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