Documentation based on repostory git version commit 1.0.12-487-g7669680

Module MediaRelay

The MediaRelay module masquerades SDP message so that all RTP and RTCP streams go through the proxy. The RTP and RTCP streams are then routed so that each client receives the stream of the other. MediaRelay makes sure that RTP is ALWAYS established, even with uncooperative firewalls.

Configuration options:

NameDescriptionDefault ValueType
enabledIndicate whether the module is activated. trueBoolean
filterA request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains '', from.uri.domain in '', (to.uri.domain in '') && (user-agent == 'Linphone v2') BooleanExpr
nortpproxySDP attribute set by the first proxy to forbid subsequent proxies to provide relay. Use 'disable' to disable. nortpproxyString
sdp-port-range-minThe minimal value of SDP port range 1024Integer
sdp-port-range-maxThe maximal value of SDP port range 65535Integer
bye-orphan-dialogsSends a ACK and BYE to 200Ok for INVITEs not belonging to any established call. falseBoolean
max-callsMaximum concurrent calls processed by the media-relay. Calls arriving when the limit is exceed will be rejected. A value of 0 means no limit. 0Integer
force-relay-for-non-ice-targetsWhen true, the 'c=' line and port number are set to the relay ip/port even if ICE candidates are present in the request. This is allow non-ice clients to have their streams relayed. trueBoolean
prevent-loopsPrevent media-relay ports to loop between them, which can cause 100% cpu on the media relay thread.You need to set this property to false if you are running test calls from clients running on the same IP address as the flexisip server trueBoolean
early-media-relay-singleIn case multiples 183 Early media responses are received for a call, only the first one will have RTP streams forwarded back to caller. This feature prevents the caller to receive 'mixed' streams, but it breaks scenarios where multiple servers play early media announcement in sequence. trueBoolean
max-early-media-per-callMaximum number of relayed early media streams per call. This is useful to limit the cpu usage due to early media relaying on embedded systems. A value of 0 stands for unlimited. 0Integer
inactivity-periodPeriod of time in seconds, after which a relayed call without any activity is considered as no longer running. Activity counts RTP/RTCP packets exchanged through the relay and SIP messages. 3600Integer
Created by Buildbot on 2017/01/16 10:02