#include "rtcp/RtcpConfig.h"#include "IBaseClass.h"#include "INetworkRender.h"#include "IRTCPConnection.h"
Go to the source code of this file.
Enumerations | |
| enum | MIXER_MODE_ET { MIXER_DISABLED = 0, MIXER_ENABLED = 1 } |
Functions | |
| virtual bool | TerminateRTCPConnection (IRTCPConnection *piRTCPConnection)=0 |
| virtual void | TerminateAllConnections (void)=0 |
| virtual unsigned long | GetSessionID (void)=0 |
| virtual void | ReassignSSRC (unsigned long ulSSRC, unsigned char *puchReason=NULL)=0 |
| virtual void | ForwardSDESReport (IGetSrcDescription *piGetSrcDescription, IRTCPConnection *piRTCPConnection)=0 |
| virtual void | ForwardByeReport (IGetByeInfo *piGetByeInfo, IRTCPConnection *piRTCPConnection)=0 |
| virtual void | CheckLocalSSRCCollisions (void)=0 |
| virtual void | CheckRemoteSSRCCollisions (IRTCPConnection *piRTCPConnection)=0 |
| virtual void | SetMixerMode (MIXER_MODE_ET etMixerMode)=0 |
| virtual MIXER_MODE_ET | GetMixerMode (void)=0 |
| virtual ssrc_t | GetSSRC (int, int, int)=0 |
| virtual IRTCPConnection * | CheckConnection (IRTCPConnection *)=0 |
Enumeration Type Documentation
| enum MIXER_MODE_ET |
Function Documentation
|
pure virtual |
Method Name: TerminateRTCPConnection
Inputs: IRTCPConnection *piRTCPConnection The Connection Interface pointer returned on creation
Outputs: None
Returns: bool
Description: The TerminateRTCPConnection() method shall manage the termination of and RTCP session. This shall include the graceful release of all associated objects as well as the deallocation of all resources associated with each contained RTCP connection.
Usage Notes:
|
pure virtual |
Method Name: TerminateAllConnections
Inputs: None
Outputs: None
Returns: bool
Description: The TerminateAllConnections() method shall manage the termination of all RTCP connections. This shall include the transmission of a Bye report over each RTCP connection in addition to the graceful release of all associated objects and the deallocation of all resources associated with each contained RTCP connection.
Usage Notes:
|
pure virtual |
Method Name: GetSessionID()
Inputs: None
Outputs: None
Returns: unsigned long - The ID for this Sesson
Description: Retrieves the Session ID associated with a session.
Usage Notes:
|
pure virtual |
Method Name: ReassignSSRC
Inputs: unsigned long ulSSRC - Source ID unsigned char *puchReason - Optional Reason for Reassignment
Outputs: None
Returns: void
Description: Reassigns the Source Identifier associated with an RTP session due to collision detection and resolution. Calling of this method shall result in the resetting of the SSRC IDs of associated Sender, Receiver, and SDES Reports.
Usage Notes:
|
pure virtual |
Method Name: ForwardSDESReport
Inputs: IGetSrcDescription *piGetSrcDescription Interface for getting SDES Report Statistics IRTCPConnection *piRTCPConnection Interface to RTCP Connection originating SDES
Outputs: None
Returns: None
Description: The ForwardSDESReport() method shall enable the RTC Manager to pass interfaces to SDES Reports received from participating site while acting in the mode of a conference Mixer. The Mixer's role in this situation is to transmit these reports unchanged to others participating within a conference. The handoff of an SDES Report to the CRTCPRender will cause the report to be transmitted to a participating site using the associated Network Render object.
Usage Notes: The interface for the local site's Source Description Report generator is passed as an argument at construction time.
|
pure virtual |
Method Name: ForwardByeReport
Inputs: IGetByeInfo *piGetByeInfo Interface used to retrieve Bye Report information IRTCPConnection *piRTCPConnection Interface to RTCP Connection originating Bye
Outputs: None
Returns: None
Description: The ForwardByeReport() method shall enable the RTC Manager to pass interfaces to Bye Reports received from participating site while acting in the mode of a conference Mixer. The Mixer's role in this situation is to transmit these reports unchanged to others participating within a conference. The handoff of a Bye Report to the CRTCPRender will cause the report to be transmitted to a participating site using the associated Network Render object.
Usage Notes:
|
pure virtual |
Method Name: CheckLocalSSRCCollisions
Inputs: None
Outputs: None
Returns: void
Description: Check that our local SSRC is not colliding with one fo the SSRCs of a participating site.
Usage Notes:
|
pure virtual |
Method Name: CheckRemoteSSRCCollisions
Inputs: IRTCPConnection *piRTCPConnection - Connection Interface
Outputs: None
Returns: void
Description: Check that other remote SSRCs aren't colliding with each other.
Usage Notes:
|
pure virtual |
Method Name: SetMixerMode()
Inputs: MIXER_MODE_ET etMixerMode Identifies whether the audio mixer is enabled or disabled
Outputs: None
Returns: None
Description: Sets the audio mixer mode for a session.
Usage Notes:
|
pure virtual |
Method Name: GetMixerMode()
Inputs: None
Outputs: None
Returns: MIXER_MODE_ET - The audio mixer mode supported by the session
Description: Retrieves the audio mixer mode supported by the session.
Usage Notes:
|
pure virtual |
Method Name: GetSSRC()
Inputs: None
Outputs: None
Returns: unsigned long - Local SSRC associated with the session
Description: Retrieves the SSRC associated with a session.
Usage Notes:
|
pure virtual |
Method Name: CheckConnection
Inputs: None
Outputs: None
Returns: IRTCPConnection * Returns an interface for use in controlling an RTCP Connection
Description: The CheckConnection shall check an instance of an RTCP Connection interface on the RTCP Session's collection list.
Usage Notes:
