|
| 1 | +RTP.io Module |
| 2 | + __________________________________________________________ |
| 3 | + |
| 4 | + Table of Contents |
| 5 | + |
| 6 | + 1. Admin Guide |
| 7 | + |
| 8 | + 1.1. Overview |
| 9 | + 1.2. Dependencies |
| 10 | + 1.3. Exported Parameters |
| 11 | + |
| 12 | + 1.3.1. rtpproxy_args(string) |
| 13 | + |
| 14 | + 1.4. Exported Functions |
| 15 | + |
| 16 | + 2. Contributors |
| 17 | + |
| 18 | + 2.1. By Commit Statistics |
| 19 | + 2.2. By Commit Activity |
| 20 | + |
| 21 | + 3. Documentation |
| 22 | + |
| 23 | + 3.1. Contributors |
| 24 | + |
| 25 | + List of Tables |
| 26 | + |
| 27 | + 2.1. Top contributors by DevScore^(1), authored commits^(2) and |
| 28 | + lines added/removed^(3) |
| 29 | + |
| 30 | + 2.2. Most recently active contributors^(1) to this module |
| 31 | + |
| 32 | + List of Examples |
| 33 | + |
| 34 | + 1.1. Set rtpproxy_args parameter |
| 35 | + |
| 36 | +Chapter 1. Admin Guide |
| 37 | + |
| 38 | +1.1. Overview |
| 39 | + |
| 40 | + The RTP.io module provides an integrated solution for handling |
| 41 | + RTP traffic within OpenSIPS, enabling RTP relaying and |
| 42 | + processing directly inside the OpenSIPS process. This |
| 43 | + eliminates the need for external processes such as RTPProxy, |
| 44 | + resulting in a more streamlined, efficient, and manageable |
| 45 | + system for certain use cases. |
| 46 | + |
| 47 | + The rtp.io module starts RTP handling threads in the main |
| 48 | + OpenSIPS process and allows the rtpproxy module to access these |
| 49 | + threads via a one-to-one socket pair. This tight integration |
| 50 | + facilitates efficient RTP traffic management within OpenSIPS |
| 51 | + without relying on external RTP handling services. |
| 52 | + |
| 53 | + The module requires RTPProxy™ version 3.1 or higher, compiled |
| 54 | + with the --enable-librtpproxy option to build. It utilizes the |
| 55 | + librtpproxy library to manage RTP traffic and interfaces with |
| 56 | + the existing rtpproxy module to generate commands, parse |
| 57 | + responses, and process SIP messages. |
| 58 | + |
| 59 | + When the rtpproxy module is loaded without arguments and the |
| 60 | + rtp.io module is also loaded, the sockets exported by rtp.io |
| 61 | + are used automatically in set 0. Alternatively, these sockets |
| 62 | + can be incorporated into other sets by using the "rtp.io:auto" |
| 63 | + moniker. |
| 64 | + |
| 65 | +1.2. Dependencies |
| 66 | + |
| 67 | +1.3. Exported Parameters |
| 68 | + |
| 69 | +1.3.1. rtpproxy_args(string) |
| 70 | + |
| 71 | + Command-line parameteres passed down to the embedded RTPProxy |
| 72 | + module upon initialization. Refer to the RTPProxy documentation |
| 73 | + for the full list. |
| 74 | + |
| 75 | + Parameter has no default value. |
| 76 | + |
| 77 | + Example 1.1. Set rtpproxy_args parameter |
| 78 | +... |
| 79 | +modparam("rtp.io", "rtpproxy_args", "-m 12000 -M 15000 -l 0.0.0.0 -6 /:: |
| 80 | +") |
| 81 | +... |
| 82 | + |
| 83 | +1.4. Exported Functions |
| 84 | + |
| 85 | +Chapter 2. Contributors |
| 86 | + |
| 87 | +2.1. By Commit Statistics |
| 88 | + |
| 89 | + Table 2.1. Top contributors by DevScore^(1), authored |
| 90 | + commits^(2) and lines added/removed^(3) |
| 91 | + Name DevScore Commits Lines ++ Lines -- |
| 92 | + 1. Maksym Sobolyev (@sobomax) 7 1 660 0 |
| 93 | + |
| 94 | + (1) DevScore = author_commits + author_lines_added / |
| 95 | + (project_lines_added / project_commits) + author_lines_deleted |
| 96 | + / (project_lines_deleted / project_commits) |
| 97 | + |
| 98 | + (2) including any documentation-related commits, excluding |
| 99 | + merge commits. Regarding imported patches/code, we do our best |
| 100 | + to count the work on behalf of the proper owner, as per the |
| 101 | + "fix_authors" and "mod_renames" arrays in |
| 102 | + opensips/doc/build-contrib.sh. If you identify any |
| 103 | + patches/commits which do not get properly attributed to you, |
| 104 | + please submit a pull request which extends "fix_authors" and/or |
| 105 | + "mod_renames". |
| 106 | + |
| 107 | + (3) ignoring whitespace edits, renamed files and auto-generated |
| 108 | + files |
| 109 | + |
| 110 | +2.2. By Commit Activity |
| 111 | + |
| 112 | + Table 2.2. Most recently active contributors^(1) to this module |
| 113 | + Name Commit Activity |
| 114 | + 1. Maksym Sobolyev (@sobomax) Jun 2024 - Jun 2024 |
| 115 | + |
| 116 | + (1) including any documentation-related commits, excluding |
| 117 | + merge commits |
| 118 | + |
| 119 | +Chapter 3. Documentation |
| 120 | + |
| 121 | +3.1. Contributors |
| 122 | + |
| 123 | + Last edited by: Maksym Sobolyev (@sobomax). |
| 124 | + |
| 125 | + Documentation Copyrights: |
| 126 | + |
| 127 | + Copyright © 2023 Sippy Software, Inc. |
0 commit comments