37 #ifndef RTPSESSIONPARAMS_H
39 #define RTPSESSIONPARAMS_H
41 #include "rtpconfig.h"
62 int SetUsePollThread(
bool usethread);
109 #ifdef RTP_SUPPORT_PROBATION
115 #endif // RTP_SUPPORT_PROBATION
220 bool resolvehostname;
221 #ifdef RTP_SUPPORT_PROBATION
223 #endif // RTP_SUPPORT_PROBATION
225 double sessionbandwidth;
229 bool usehalfatstartup;
233 double sendermultiplier;
234 double generaltimeoutmultiplier;
235 double byetimeoutmultiplier;
236 double collisionmultiplier;
237 double notemultiplier;
239 bool usepredefinedssrc;
240 uint32_t predefinedssrc;
247 #endif // RTPSESSIONPARAMS_H
void SetCollisionTimeoutMultiplier(double m)
Sets the multiplier to be used when timing out entries in the collision table.
Definition: rtpsessionparams.h:186
void SetOwnTimestampUnit(double tsunit)
Sets the timestamp unit for our own data.
Definition: rtpsessionparams.h:93
double GetSessionBandwidth() const
Returns the session bandwidth in bytes per second (default is 10000 bytes per second).
Definition: rtpsessionparams.h:121
double GetSenderTimeoutMultiplier() const
Returns the multiplier to be used when timing out senders (default is 2).
Definition: rtpsessionparams.h:171
void SetNoteTimeoutMultiplier(double m)
Sets the multiplier to be used when timing out SDES NOTE information.
Definition: rtpsessionparams.h:192
void SetPredefinedSSRC(uint32_t ssrc)
Sets the SSRC which will be used if RTPSessionParams::GetUsePredefinedSSRC returns true...
Definition: rtpsessionparams.h:204
void SetUseHalfRTCPIntervalAtStartup(bool usehalf)
If usehalf is set to true, the session will only wait half of the calculated RTCP interval before sen...
Definition: rtpsessionparams.h:144
bool GetUseHalfRTCPIntervalAtStartup() const
Returns whether the session will only wait half of the calculated RTCP interval before sending its fi...
Definition: rtpsessionparams.h:149
uint32_t GetPredefinedSSRC() const
Returns the SSRC which will be used if RTPSessionParams::GetUsePredefinedSSRC returns true...
Definition: rtpsessionparams.h:207
ProbationType
Type of probation to use for new sources.
Definition: rtpsources.h:78
double GetNoteTimeoutMultiplier() const
Returns the multiplier to be used when timing out SDES NOTE information (default is 25)...
Definition: rtpsessionparams.h:195
bool GetSenderReportForBYE() const
Returns true if a BYE packet will be sent in an RTCP compound packet which starts with a sender repor...
Definition: rtpsessionparams.h:165
void SetCNAME(const std::string &s)
Forces this string to be used as the CNAME identifier.
Definition: rtpsessionparams.h:210
void SetBYETimeoutMultiplier(double m)
Sets the multiplier to be used when timing out a member after it has sent a BYE packet.
Definition: rtpsessionparams.h:180
void SetRequestImmediateBYE(bool v)
If v is true, the session will send a BYE packet immediately if this is allowed.
Definition: rtpsessionparams.h:152
double GetSenderControlBandwidthFraction() const
Returns the minimum fraction of the control traffic that will be used by senders (default is 25%)...
Definition: rtpsessionparams.h:133
bool GetUsePredefinedSSRC() const
Returns a flag indicating if a predefined SSRC should be used.
Definition: rtpsessionparams.h:201
void SetSenderTimeoutMultiplier(double m)
Sets the multiplier to be used when timing out senders.
Definition: rtpsessionparams.h:168
void SetSenderControlBandwidthFraction(double frac)
Sets the minimum fraction of the control traffic that will be used by senders.
Definition: rtpsessionparams.h:130
double GetControlTrafficFraction() const
Returns the fraction of the session bandwidth that will be used for control traffic (default is 5%)...
Definition: rtpsessionparams.h:127
ReceiveMode
Three kind of receive modes can be specified.
Definition: rtptransmitter.h:79
void SetReceiveMode(RTPTransmitter::ReceiveMode recvmode)
Sets the receive mode to be used by the session.
Definition: rtpsessionparams.h:82
void SetAcceptOwnPackets(bool accept)
If the argument is true, the session should accept its own packets and store them accordingly in the ...
Definition: rtpsessionparams.h:76
std::string GetCNAME() const
Returns the currently set CNAME, is blank when this will be generated automatically (the default)...
Definition: rtpsessionparams.h:213
This class is used to specify wallclock time, delay intervals etc.
Definition: rtptimeutilities.h:84
void SetSessionBandwidth(double sessbw)
Sets the session bandwidth in bytes per second.
Definition: rtpsessionparams.h:118
bool GetRequestImmediateBYE() const
Returns whether the session should send a BYE packet immediately (if allowed) or not (default is true...
Definition: rtpsessionparams.h:155
bool GetResolveLocalHostname() const
Returns whether the local hostname should be determined from the transmitter's list of local IP addre...
Definition: rtpsessionparams.h:108
size_t GetMaximumPacketSize() const
Returns the maximum allowed packet size (default is 1400 bytes).
Definition: rtpsessionparams.h:71
void SetUsePredefinedSSRC(bool f)
Sets a flag which indicates if a predefined SSRC identifier should be used.
Definition: rtpsessionparams.h:198
RTPTransmitter::ReceiveMode GetReceiveMode() const
Sets the receive mode to be used by the session (default is: accept all packets). ...
Definition: rtpsessionparams.h:85
void SetProbationType(RTPSources::ProbationType probtype)
If probation support is enabled, this function sets the probation type to be used.
Definition: rtpsessionparams.h:111
void SetMaximumPacketSize(size_t max)
Sets the maximum allowed packet size for the session.
Definition: rtpsessionparams.h:68
RTPTime GetMinimumRTCPTransmissionInterval() const
Returns the minimal time interval between sending RTCP packets (default is 5 seconds).
Definition: rtpsessionparams.h:139
double GetOwnTimestampUnit() const
Returns the currently set timestamp unit.
Definition: rtpsessionparams.h:96
double GetSourceTimeoutMultiplier() const
Returns the multiplier to be used when timing out members (default is 5).
Definition: rtpsessionparams.h:177
bool AcceptOwnPackets() const
Returns true if the session should accept its own packets (default is false).
Definition: rtpsessionparams.h:79
void SetControlTrafficFraction(double frac)
Sets the fraction of the session bandwidth to be used for control traffic.
Definition: rtpsessionparams.h:124
void SetResolveLocalHostname(bool v)
Sets a flag indicating if a DNS lookup should be done to determine our hostname (to construct a CNAME...
Definition: rtpsessionparams.h:103
void SetSourceTimeoutMultiplier(double m)
Sets the multiplier to be used when timing out members.
Definition: rtpsessionparams.h:174
void SetMinimumRTCPTransmissionInterval(const RTPTime &t)
Set the minimal time interval between sending RTCP packets.
Definition: rtpsessionparams.h:136
Describes the parameters for to be used by an RTPSession instance.
Definition: rtpsessionparams.h:54
bool IsUsingPollThread() const
Returns whether the session should use a poll thread or not (default is true).
Definition: rtpsessionparams.h:65
void SetSenderReportForBYE(bool v)
When sending a BYE packet, this indicates whether it will be part of an RTCP compound packet that beg...
Definition: rtpsessionparams.h:160
double GetCollisionTimeoutMultiplier() const
Returns the multiplier to be used when timing out entries in the collision table (default is 10)...
Definition: rtpsessionparams.h:189
double GetBYETimeoutMultiplier() const
Returns the multiplier to be used when timing out a member after it has sent a BYE packet (default is...
Definition: rtpsessionparams.h:183
RTPSources::ProbationType GetProbationType() const
Returns the probation type which will be used (default is RTPSources::ProbationStore).
Definition: rtpsessionparams.h:114