SDRAngel
4.11.5
Developer docs for <a href="https://github.com/f4exb/sdrangel">SDRangel<\a>, an Open Source Qt5 / OpenGL 3.0+ SDR and signal analyzer frontend to various hardware.
|
#include <rtpsessionparams.h>
Private Attributes | |
bool | acceptown |
bool | usepollthread |
std::size_t | maxpacksize |
double | owntsunit |
RTPTransmitter::ReceiveMode | receivemode |
bool | resolvehostname |
double | sessionbandwidth |
double | controlfrac |
double | senderfrac |
RTPTime | mininterval |
bool | usehalfatstartup |
bool | immediatebye |
bool | SR_BYE |
double | sendermultiplier |
double | generaltimeoutmultiplier |
double | byetimeoutmultiplier |
double | collisionmultiplier |
double | notemultiplier |
bool | usepredefinedssrc |
uint32_t | predefinedssrc |
std::string | cname |
bool | m_needThreadSafety |
Describes the parameters for to be used by an RTPSession instance. Describes the parameters for to be used by an RTPSession instance. Note that the own timestamp unit must be set to a valid number, otherwise the session can't be created.
Definition at line 56 of file rtpsessionparams.h.
qrtplib::RTPSessionParams::RTPSessionParams | ( | ) |
Definition at line 41 of file rtpsessionparams.cpp.
References qrtplib::RTPTransmitter::AcceptAll, acceptown, byetimeoutmultiplier, collisionmultiplier, controlfrac, generaltimeoutmultiplier, immediatebye, m_needThreadSafety, maxpacksize, mininterval, notemultiplier, owntsunit, predefinedssrc, receivemode, resolvehostname, RTCP_DEFAULTBANDWIDTHFRACTION, RTCP_DEFAULTHALFATSTARTUP, RTCP_DEFAULTIMMEDIATEBYE, RTCP_DEFAULTMININTERVAL, RTCP_DEFAULTSENDERFRACTION, RTCP_DEFAULTSRBYE, RTP_BYETIMEOUTMULTIPLIER, RTP_COLLISIONTIMEOUTMULTIPLIER, RTP_DEFAULTPACKETSIZE, RTP_DEFAULTSESSIONBANDWIDTH, RTP_MEMBERTIMEOUTMULTIPLIER, RTP_NOTETTIMEOUTMULTIPLIER, RTP_SENDERTIMEOUTMULTIPLIER, senderfrac, sendermultiplier, sessionbandwidth, SR_BYE, usehalfatstartup, usepollthread, and usepredefinedssrc.
|
inline |
Returns true
if the session should accept its own packets (default is false
).
Definition at line 97 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns the multiplier to be used when timing out a member after it has sent a BYE packet (default is 1).
Definition at line 272 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns the currently set CNAME, is blank when this will be generated automatically (the default).
Definition at line 332 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns the multiplier to be used when timing out entries in the collision table (default is 10).
Definition at line 284 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns the fraction of the session bandwidth that will be used for control traffic (default is 5%).
Definition at line 168 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns the maximum allowed packet size (default is 1400 bytes).
Definition at line 83 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::Create(), and RTPSink::RTPSink().
|
inline |
Returns the minimal time interval between sending RTCP packets (default is 5 seconds).
Definition at line 192 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns the multiplier to be used when timing out SDES NOTE information (default is 25).
Definition at line 296 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns the currently set timestamp unit.
Definition at line 126 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns the SSRC which will be used if RTPSessionParams::GetUsePredefinedSSRC returns true.
Definition at line 320 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Sets the receive mode to be used by the session (default is: accept all packets).
Definition at line 109 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns whether the session should send a BYE packet immediately (if allowed) or not (default is true
).
Definition at line 220 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns whether the local hostname should be determined from the transmitter's list of local IP addresses or not (default is false
).
Definition at line 144 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns the minimum fraction of the control traffic that will be used by senders (default is 25%).
Definition at line 180 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns true
if a BYE packet will be sent in an RTCP compound packet which starts with a sender report; if a receiver report will be used, the function returns false
(default is true
).
Definition at line 236 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::Create().
|
inline |
Returns the multiplier to be used when timing out senders (default is 2).
Definition at line 248 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns the session bandwidth in bytes per second (default is 10000 bytes per second).
Definition at line 156 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns the multiplier to be used when timing out members (default is 5).
Definition at line 260 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns whether the session will only wait half of the calculated RTCP interval before sending its first RTCP packet or not (default is true
).
Definition at line 208 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns a flag indicating if a predefined SSRC should be used.
Definition at line 308 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::InternalCreate().
|
inline |
Returns whether the session should use a poll thread or not (default is true
).
Definition at line 71 of file rtpsessionparams.h.
Referenced by qrtplib::RTPSession::Create().
|
inline |
Returns true
if thread safety was requested using RTPSessionParams::SetNeedThreadSafety.
Definition at line 338 of file rtpsessionparams.h.
|
inline |
If the argument is true
, the session should accept its own packets and store them accordingly in the source table.
Definition at line 91 of file rtpsessionparams.h.
|
inline |
Sets the multiplier to be used when timing out a member after it has sent a BYE packet.
Definition at line 266 of file rtpsessionparams.h.
|
inline |
Forces this string to be used as the CNAME identifier.
Definition at line 326 of file rtpsessionparams.h.
|
inline |
Sets the multiplier to be used when timing out entries in the collision table.
Definition at line 278 of file rtpsessionparams.h.
|
inline |
Sets the fraction of the session bandwidth to be used for control traffic.
Definition at line 162 of file rtpsessionparams.h.
|
inline |
Sets the maximum allowed packet size for the session.
Definition at line 77 of file rtpsessionparams.h.
References leansdr::max().
|
inline |
Set the minimal time interval between sending RTCP packets.
Definition at line 186 of file rtpsessionparams.h.
int qrtplib::RTPSessionParams::SetNeedThreadSafety | ( | bool | s | ) |
if s
is true
, the session will use mutexes in case multiple threads are at work.
Definition at line 76 of file rtpsessionparams.cpp.
References ERR_RTP_NOTHREADSUPPORT.
|
inline |
Sets the multiplier to be used when timing out SDES NOTE information.
Definition at line 290 of file rtpsessionparams.h.
|
inline |
Sets the timestamp unit for our own data. Sets the timestamp unit for our own data. The timestamp unit is defined as a time interval in seconds divided by the corresponding timestamp interval. For example, for 8000 Hz audio, the timestamp unit would typically be 1/8000. Since this value is initially set to an illegal value, the user must set this to an allowed value to be able to create a session.
Definition at line 120 of file rtpsessionparams.h.
Referenced by RTPSink::RTPSink().
|
inline |
Sets the SSRC which will be used if RTPSessionParams::GetUsePredefinedSSRC returns true.
Definition at line 314 of file rtpsessionparams.h.
|
inline |
Sets the receive mode to be used by the session.
Definition at line 103 of file rtpsessionparams.h.
|
inline |
If v
is true
, the session will send a BYE packet immediately if this is allowed.
Definition at line 214 of file rtpsessionparams.h.
|
inline |
Sets a flag indicating if a DNS lookup should be done to determine our hostname (to construct a CNAME item). If v
is set to true
, the session will ask the transmitter to find a host name based upon the IP addresses in its list of local IP addresses. If set to false
, a call to gethostname
or something similar will be used to find the local hostname. Note that the first method might take some time.
Definition at line 136 of file rtpsessionparams.h.
|
inline |
Sets the minimum fraction of the control traffic that will be used by senders.
Definition at line 174 of file rtpsessionparams.h.
|
inline |
When sending a BYE packet, this indicates whether it will be part of an RTCP compound packet that begins with a sender report (if allowed) or a receiver report.
Definition at line 228 of file rtpsessionparams.h.
|
inline |
Sets the multiplier to be used when timing out senders.
Definition at line 242 of file rtpsessionparams.h.
|
inline |
Sets the session bandwidth in bytes per second.
Definition at line 150 of file rtpsessionparams.h.
|
inline |
Sets the multiplier to be used when timing out members.
Definition at line 254 of file rtpsessionparams.h.
|
inline |
If usehalf
is set to true
, the session will only wait half of the calculated RTCP interval before sending its first RTCP packet.
Definition at line 200 of file rtpsessionparams.h.
int qrtplib::RTPSessionParams::SetUsePollThread | ( | bool | usethread | ) |
If usethread
is true
, the session will use a poll thread to automatically process incoming data and to send RTCP packets when necessary.
Definition at line 70 of file rtpsessionparams.cpp.
References ERR_RTP_NOTHREADSUPPORT.
|
inline |
Sets a flag which indicates if a predefined SSRC identifier should be used.
Definition at line 302 of file rtpsessionparams.h.
|
private |
Definition at line 343 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 360 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 367 of file rtpsessionparams.h.
|
private |
Definition at line 361 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 351 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 359 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 355 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 368 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 345 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 353 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 362 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 346 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 365 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 347 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 348 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 352 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 358 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 350 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 356 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 354 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 344 of file rtpsessionparams.h.
Referenced by RTPSessionParams().
|
private |
Definition at line 364 of file rtpsessionparams.h.
Referenced by RTPSessionParams().