Parameters for the UDP over IPv4 transmitter. More...

#include <rtpudpv4transmitter.h>

Inheritance diagram for jrtplib::RTPUDPv4TransmissionParams:

Collaboration diagram for jrtplib::RTPUDPv4TransmissionParams:

Public Member Functions
void	SetBindIP (uint32_t ip)
	Sets the IP address which is used to bind the sockets to `ip`. More...

void	SetMulticastInterfaceIP (uint32_t ip)
	Sets the multicast interface IP address. More...

void	SetPortbase (uint16_t pbase)
	Sets the RTP portbase to `pbase`, which has to be an even number unless RTPUDPv4TransmissionParams::SetAllowOddPortbase was called; a port number of zero will cause a port to be chosen automatically. More...

void	SetMulticastTTL (uint8_t mcastTTL)
	Sets the multicast TTL to be used to `mcastTTL`. More...

void	SetLocalIPList (std::list< uint32_t > &iplist)
	Passes a list of IP addresses which will be used as the local IP addresses. More...

void	ClearLocalIPList ()
	Clears the list of local IP addresses. More...

uint32_t	GetBindIP () const
	Returns the IP address which will be used to bind the sockets. More...

uint32_t	GetMulticastInterfaceIP () const
	Returns the multicast interface IP address. More...

uint16_t	GetPortbase () const
	Returns the RTP portbase which will be used (default is 5000). More...

uint8_t	GetMulticastTTL () const
	Returns the multicast TTL which will be used (default is 1). More...

const std::list< uint32_t > &	GetLocalIPList () const
	Returns the list of local IP addresses. More...

void	SetRTPSendBuffer (int s)
	Sets the RTP socket's send buffer size. More...

void	SetRTPReceiveBuffer (int s)
	Sets the RTP socket's receive buffer size. More...

void	SetRTCPSendBuffer (int s)
	Sets the RTCP socket's send buffer size. More...

void	SetRTCPReceiveBuffer (int s)
	Sets the RTCP socket's receive buffer size. More...

void	SetRTCPMultiplexing (bool f)
	Enables or disables multiplexing RTCP traffic over the RTP channel, so that only a single port is used. More...

void	SetAllowOddPortbase (bool f)
	Can be used to allow the RTP port base to be any number, not just even numbers. More...

void	SetForcedRTCPPort (uint16_t rtcpport)
	Force the RTCP socket to use a specific port, not necessarily one more than the RTP port (set this to zero to disable). More...

void	SetUseExistingSockets (SocketType rtpsocket, SocketType rtcpsocket)
	Use sockets that have already been created, no checks on port numbers will be done, and no buffer sizes will be set; you'll need to close the sockets yourself when done, it will not be done automatically. More...

void	SetCreatedAbortDescriptors (RTPAbortDescriptors *desc)
	If non null, the specified abort descriptors will be used to cancel the function that's waiting for packets to arrive; set to null (the default to let the transmitter create its own instance. More...

int	GetRTPSendBuffer () const
	Returns the RTP socket's send buffer size. More...

int	GetRTPReceiveBuffer () const
	Returns the RTP socket's receive buffer size. More...

int	GetRTCPSendBuffer () const
	Returns the RTCP socket's send buffer size. More...

int	GetRTCPReceiveBuffer () const
	Returns the RTCP socket's receive buffer size. More...

bool	GetRTCPMultiplexing () const
	Returns a flag indicating if RTCP traffic will be multiplexed over the RTP channel. More...

bool	GetAllowOddPortbase () const
	If true, any RTP portbase will be allowed, not just even numbers. More...

uint16_t	GetForcedRTCPPort () const
	If non-zero, the specified port will be used to receive RTCP traffic. More...

bool	GetUseExistingSockets (SocketType &rtpsocket, SocketType &rtcpsocket) const
	Returns true and fills in sockets if existing sockets were set using RTPUDPv4TransmissionParams::SetUseExistingSockets. More...

RTPAbortDescriptors *	GetCreatedAbortDescriptors () const
	If non-null, this RTPAbortDescriptors instance will be used internally, which can be useful when creating your own poll thread for multiple sessions. More...

Public Member Functions inherited from jrtplib::RTPTransmissionParams
RTPTransmitter::TransmissionProtocol	GetTransmissionProtocol () const
	Returns the transmitter type for which these parameters are valid. More...

Detailed Description

Member Function Documentation

void jrtplib::RTPUDPv4TransmissionParams::ClearLocalIPList ( )

inline

Clears the list of local IP addresses. An empty list will make the transmission component itself determine the local IP addresses.

bool jrtplib::RTPUDPv4TransmissionParams::GetAllowOddPortbase ( ) const

inline

uint32_t jrtplib::RTPUDPv4TransmissionParams::GetBindIP ( ) const

inline

RTPAbortDescriptors* jrtplib::RTPUDPv4TransmissionParams::GetCreatedAbortDescriptors ( ) const

inline

References jrtplib::RTPTransmitter::IPv4UDPProto.

uint16_t jrtplib::RTPUDPv4TransmissionParams::GetForcedRTCPPort ( ) const

inline

const std::list<uint32_t>& jrtplib::RTPUDPv4TransmissionParams::GetLocalIPList ( ) const

inline

uint32_t jrtplib::RTPUDPv4TransmissionParams::GetMulticastInterfaceIP ( ) const

inline

uint8_t jrtplib::RTPUDPv4TransmissionParams::GetMulticastTTL ( ) const

inline

uint16_t jrtplib::RTPUDPv4TransmissionParams::GetPortbase ( ) const

inline

bool jrtplib::RTPUDPv4TransmissionParams::GetRTCPMultiplexing ( ) const

inline

int jrtplib::RTPUDPv4TransmissionParams::GetRTCPReceiveBuffer ( ) const

inline

int jrtplib::RTPUDPv4TransmissionParams::GetRTCPSendBuffer ( ) const

inline

int jrtplib::RTPUDPv4TransmissionParams::GetRTPReceiveBuffer ( ) const

inline

int jrtplib::RTPUDPv4TransmissionParams::GetRTPSendBuffer ( ) const

inline

bool jrtplib::RTPUDPv4TransmissionParams::GetUseExistingSockets	(	SocketType &	rtpsocket,
		SocketType &	rtcpsocket
	)		const

inline

void jrtplib::RTPUDPv4TransmissionParams::SetAllowOddPortbase ( bool f )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetBindIP ( uint32_t ip )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetCreatedAbortDescriptors ( RTPAbortDescriptors * desc )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetForcedRTCPPort ( uint16_t rtcpport )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetLocalIPList ( std::list< uint32_t > & iplist )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetMulticastInterfaceIP ( uint32_t ip )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetMulticastTTL ( uint8_t mcastTTL )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetPortbase ( uint16_t pbase )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetRTCPMultiplexing ( bool f )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetRTCPReceiveBuffer ( int s )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetRTCPSendBuffer ( int s )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetRTPReceiveBuffer ( int s )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetRTPSendBuffer ( int s )

inline

void jrtplib::RTPUDPv4TransmissionParams::SetUseExistingSockets	(	SocketType	rtpsocket,
		SocketType	rtcpsocket
	)

inline

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

src/rtpudpv4transmitter.h

Public Member Functions

Detailed Description

Member Function Documentation