codecs.conf.sample: update codec opus docs
[asterisk/asterisk.git] / configs / samples / rtp.conf.sample
1 ;
2 ; RTP Configuration
3 ;
4 [general]
5 ;
6 ; RTP start and RTP end configure start and end addresses
7 ;
8 ; Defaults are rtpstart=5000 and rtpend=31000
9 ;
10 rtpstart=10000
11 rtpend=20000
12 ;
13 ; Whether to enable or disable UDP checksums on RTP traffic
14 ;
15 ;rtpchecksums=no
16 ;
17 ; The amount of time a DTMF digit with no 'end' marker should be
18 ; allowed to continue (in 'samples', 1/8000 of a second)
19 ;
20 ;dtmftimeout=3000
21 ; rtcpinterval = 5000   ; Milliseconds between rtcp reports
22                         ;(min 500, max 60000, default 5000)
23 ;
24 ; Enable strict RTP protection.  This will drop RTP packets that do not come
25 ; from the recoginized source of the RTP stream.  Strict RTP qualifies RTP
26 ; packet stream sources before accepting them upon initial connection and
27 ; when the connection is renegotiated (e.g., transfers and direct media).
28 ; Initial connection and renegotiation starts a learning mode to qualify
29 ; stream source addresses.  Once Asterisk has recognized a stream it will
30 ; allow other streams to qualify and replace the current stream for 5
31 ; seconds after starting learning mode.  Once learning mode completes the
32 ; current stream is locked in and cannot change until the next
33 ; renegotiation.
34 ; Valid options are "no" to disable strictrtp, "yes" to enable strictrtp,
35 ; and "seqno", which does the same thing as strictrtp=yes, but only checks
36 ; to make sure the sequence number is correct rather than checking the time
37 ; interval as well.
38 ; This option is enabled by default.
39 ; strictrtp=yes
40 ;
41 ; Number of packets containing consecutive sequence values needed
42 ; to change the RTP source socket address. This option only comes
43 ; into play while using strictrtp=yes. Consider changing this value
44 ; if rtp packets are dropped from one or both ends after a call is
45 ; connected. This option is set to 4 by default.
46 ; probation=8
47 ;
48 ; Whether to enable or disable ICE support. This option is enabled by default.
49 ; icesupport=false
50 ;
51 ; Hostname or address for the STUN server used when determining the external
52 ; IP address and port an RTP session can be reached at. The port number is
53 ; optional. If omitted the default value of 3478 will be used. This option is
54 ; disabled by default.
55 ;
56 ; e.g. stundaddr=mystun.server.com:3478
57 ;
58 ; stunaddr=
59 ;
60 ; Some multihomed servers have IP interfaces that cannot reach the STUN
61 ; server specified by stunaddr.  Blacklist those interface subnets from
62 ; trying to send a STUN packet to find the external IP address.
63 ; Attempting to send the STUN packet needlessly delays processing incoming
64 ; and outgoing SIP INVITEs because we will wait for a response that can
65 ; never come until we give up on the response.
66 ; * Multiple subnets may be listed.
67 ; * Blacklisting applies to IPv4 only.  STUN isn't needed for IPv6.
68 ; * Blacklisting applies when binding RTP to specific IP addresses and not
69 ; the wildcard 0.0.0.0 address.  e.g., A PJSIP endpoint binding RTP to a
70 ; specific address using the bind_rtp_to_media_address and media_address
71 ; options.  Or the PJSIP endpoint specifies an explicit transport that binds
72 ; to a specific IP address.
73 ;
74 ; e.g. stun_blacklist = 192.168.1.0/255.255.255.0
75 ;      stun_blacklist = 10.32.77.0/255.255.255.0
76 ;
77 ; stun_blacklist =
78 ;
79 ; Hostname or address for the TURN server to be used as a relay. The port
80 ; number is optional. If omitted the default value of 3478 will be used.
81 ; This option is disabled by default.
82 ;
83 ; e.g. turnaddr=myturn.server.com:34780
84 ;
85 ; turnaddr=
86 ;
87 ; Username used to authenticate with TURN relay server.
88 ; turnusername=
89 ;
90 ; Password used to authenticate with TURN relay server.
91 ; turnpassword=
92 ;
93 ; Subnets to exclude from ICE host, srflx and relay discovery. This is useful
94 ; to optimize the ICE process where a system has multiple host address ranges
95 ; and/or physical interfaces and certain of them are not expected to be used
96 ; for RTP. For example, VPNs and local interconnections may not be suitable or
97 ; necessary for ICE. Multiple subnets may be listed. If left unconfigured,
98 ; all discovered host addresses are used.
99 ;
100 ; e.g. ice_blacklist = 192.168.1.0/255.255.255.0
101 ;      ice_blacklist = 10.32.77.0/255.255.255.0
102 ;
103 ; ice_blacklist =
104 ;
105 [ice_host_candidates]
106 ;
107 ; When Asterisk is behind a static one-to-one NAT and ICE is in use, ICE will
108 ; expose the server's internal IP address as one of the host candidates.
109 ; Although using STUN (see the 'stunaddr' configuration option) will provide a
110 ; publicly accessible IP, the internal IP will still be sent to the remote
111 ; peer. To help hide the topology of your internal network, you can override
112 ; the host candidates that Asterisk will send to the remote peer.
113 ;
114 ; IMPORTANT: Only use this functionality when your Asterisk server is behind a
115 ; one-to-one NAT and you know what you're doing. If you do define anything
116 ; here, you almost certainly will NOT want to specify 'stunaddr' or 'turnaddr'
117 ; above.
118 ;
119 ; The format for these overrides is:
120 ;
121 ;    <local address> => <advertised address>
122 ;
123 ; The following will replace 192.168.1.10 with 1.2.3.4 during ICE
124 ; negotiation:
125 ;
126 ;192.168.1.10 => 1.2.3.4
127 ;
128 ; You can define an override for more than 1 interface if you have a multihomed
129 ; server. Any local interface that is not matched will be passed through
130 ; unaltered. Both IPv4 and IPv6 addresses are supported.