10 | * Just production ready applications are listed.
11 | * We, mediasoup authors, are aware of many other companies and products using mediasoup. However they prefer not to disclosure it so we cannot list them below.
12 |
13 |
14 |
15 | ### Around / [around.co](https://around.co)
16 |
17 | ❝ _Quick, high-impact video calls for a new era of work._ ❞
18 |
19 | ### Daily.co / [daily.co](https://daily.co)
20 |
21 | ❝ _Ship 1-click video chat faster and smarter._ ❞
22 |
23 |
28 |
29 | ### PornHub / [pornhub.com](https://pornhub.com)
30 |
31 | Not within public domain, but figured out [here](https://mediasoup.discourse.group/t/pornhub-uses-mediasoup/685).
32 |
--------------------------------------------------------------------------------
/_art/favicon-dark-theme.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/versatica/mediasoup-website/462064b0011f50a9b668f48f680270e2aa48ee7d/_art/favicon-dark-theme.png
--------------------------------------------------------------------------------
/_art/favicon-dark-theme.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
88 |
--------------------------------------------------------------------------------
/_art/favicon-light-theme.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/versatica/mediasoup-website/462064b0011f50a9b668f48f680270e2aa48ee7d/_art/favicon-light-theme.png
--------------------------------------------------------------------------------
/_art/favicon-light-theme.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
86 |
--------------------------------------------------------------------------------
/_art/logo-light-theme.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/versatica/mediasoup-website/462064b0011f50a9b668f48f680270e2aa48ee7d/_art/logo-light-theme.png
--------------------------------------------------------------------------------
/_art/mediasoup-dark-theme.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/versatica/mediasoup-website/462064b0011f50a9b668f48f680270e2aa48ee7d/_art/mediasoup-dark-theme.png
--------------------------------------------------------------------------------
/_art/mediasoup-light-theme.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/versatica/mediasoup-website/462064b0011f50a9b668f48f680270e2aa48ee7d/_art/mediasoup-light-theme.png
--------------------------------------------------------------------------------
/_compass/_anchor.scss:
--------------------------------------------------------------------------------
1 | .anchorjs-link {
2 | opacity: 0;
3 | text-decoration: none !important;
4 | font-size: 120%;
5 | }
6 | *:hover > .anchorjs-link,
7 | .anchorjs-link:focus {
8 | /* To fade links as they appear, change transition-property from 'color' to 'all' */
9 | opacity: 1;
10 | @include transition(color .16s linear);
11 | }
12 |
13 | .anchorjs-link:link { color: $color-text; }
14 | .anchorjs-link:visited { color: $color-text; }
15 | .anchorjs-link:hover { color: $color-highlight-2; }
16 | .anchorjs-link:active { color: $color-highlight-2; }
17 |
--------------------------------------------------------------------------------
/_compass/_api_toc.scss:
--------------------------------------------------------------------------------
1 | .api-toc-button {
2 | position: fixed;
3 | z-index: 50;
4 | background: center url(/images/toc.svg) no-repeat;
5 | background-size: 50%;
6 | background-color: lighten($color-white-2, 15%);
7 | border-right: none;
8 | @include box-shadow(0px 0px 3px 0px rgba(#111, 0.35));
9 | cursor: pointer;
10 | overscroll-behavior: contain;
11 | -webkit-tap-highlight-color: transparent;
12 |
13 | @include breakpoint($computer) {
14 | $height: 110px;
15 | $width: 56px;
16 |
17 | right: 0;
18 | top: 50%;
19 | margin-top: -$height / 2;
20 | height: $height;
21 | width: $width;
22 | }
23 |
24 | @include breakpoint($mobile) {
25 | $height: 50px;
26 | $width: 30px;
27 |
28 | right: 0;
29 | top: 50%;
30 | margin-top: -$height / 2;
31 | height: $height;
32 | width: $width;
33 | }
34 | }
35 |
36 | .api-toc-wrapper {
37 | position: fixed;
38 | z-index: 10;
39 | bottom: 0;
40 | top: 0;
41 | background-color: lighten($color-white-2, 15%);
42 | @include box-shadow(-3px 0px 8px 0px rgba(#fff, 0.25));
43 | border-color: transparent;
44 | border-style: solid;
45 | border-width: 8px 0;
46 | font-size: 0.95rem;
47 | @include transition-duration(0.2s);
48 | overflow-y: auto;
49 | overscroll-behavior: contain;
50 |
51 | @include breakpoint($computer) {
52 | right: -500px;
53 | width: 480px;
54 | padding: 2rem 1rem;
55 | }
56 |
57 | @include breakpoint($mobile) {
58 | right: -290px;
59 | width: 260px;
60 | padding: 1rem 0.25rem;
61 | }
62 |
63 | &.visible {
64 | right: 0px;
65 | }
66 |
67 | ul {
68 | margin: 0;
69 | padding: 0;
70 | list-style: none;
71 | }
72 |
73 | a {
74 | display: inline-block;
75 | text-decoration: none;
76 | color: inherit;
77 | font-weight: inherit;
78 | text-overflow: ellipsis;
79 | white-space: nowrap;
80 | overflow: hidden;
81 | max-width: 100%;
82 |
83 | &:hover {
84 | text-decoration: underline;
85 | }
86 | }
87 |
88 | > ul {
89 | // First level.
90 | > li {
91 | display: block;
92 | margin: 1.5em 0.75em 0.25em 0.75em;
93 | font-weight: 400;
94 | color: $color-dark-2;
95 |
96 | &:first-child {
97 | margin-top: 0.75em;
98 | }
99 |
100 | // Second level.
101 | > ul {
102 | margin-left: 0.5em;
103 |
104 | > li {
105 | margin: 0 0 0.5em 0;
106 | font-size: 0.95em;
107 | font-weight: 400;
108 | color: darken($color-highlight-2, 10%);
109 |
110 | // Third level (API).
111 | > ul {
112 | > li {
113 | font-family: 'Monaco', 'Consolas', 'Andale Mono', monospace;
114 | letter-spacing: -0.04em;
115 | font-size: 0.9em;
116 | line-height: 1.3em;
117 | color: darken($color-text, 25%);
118 | }
119 | }
120 | }
121 | }
122 | }
123 | }
124 | }
125 |
--------------------------------------------------------------------------------
/_compass/_breadcrumbs.scss:
--------------------------------------------------------------------------------
1 | [data-content='breadcrumbs'] {
2 | position: absolute;
3 |
4 | @include breakpoint($computer) {
5 | top: 20px;
6 | font-size: 0.9rem;
7 | }
8 |
9 | @include breakpoint($mobile) {
10 | top: 40px;
11 | font-size: 0.65rem;
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/_compass/_fonts.scss:
--------------------------------------------------------------------------------
1 | @font-face {
2 | font-family: 'Monaco';
3 | font-style: normal;
4 | src: url('/fonts/Monaco.ttf') format('truetype');
5 | }
6 |
7 | @font-face {
8 | font-family: 'Poiret One';
9 | font-style: normal;
10 | font-weight: 400;
11 | src:
12 | url('/fonts/PoiretOne.ttf') format('truetype'),
13 | url('/fonts/PoiretOne.woff') format('woff');
14 | }
15 |
16 | @font-face {
17 | font-family: 'Roboto';
18 | font-style: normal;
19 | font-weight: 300;
20 | src:
21 | local('Roboto Light'),
22 | local('Roboto-Light'),
23 | url('/fonts/Roboto-Light.ttf') format('truetype');
24 | }
25 | @font-face {
26 | font-family: 'Roboto';
27 | font-style: normal;
28 | font-weight: 400;
29 | src:
30 | local('Roboto'),
31 | local('Roboto-Regular'),
32 | url('/fonts/Roboto-Regular.ttf') format('truetype');
33 | }
34 | @font-face {
35 | font-family: 'Roboto';
36 | font-style: normal;
37 | font-weight: 500;
38 | src:
39 | local('Roboto Medium'),
40 | local('Roboto-Medium'),
41 | url('/fonts/Roboto-Medium.ttf') format('truetype');
42 | }
43 | @font-face {
44 | font-family: 'Roboto';
45 | font-style: normal;
46 | font-weight: 500;
47 | src:
48 | local('Roboto Bold'),
49 | local('Roboto-Bold'),
50 | url('/fonts/Roboto-Bold.ttf') format('truetype');
51 | }
52 |
--------------------------------------------------------------------------------
/_compass/_menu.scss:
--------------------------------------------------------------------------------
1 | > .menu {
2 | $width: 250px;
3 |
4 | position: fixed;
5 | z-index: 100;
6 | top: 0;
7 | // Hide the lateral shadow.
8 | right: -$width - 5px;
9 | width: $width;
10 | // Trick to avoid menu flash effect in mobile.
11 | height: 110%;
12 | padding-bottom: 10%;
13 | overflow: auto;
14 | overscroll-behavior: contain;
15 | background-color: lighten($color-white-2, 15%);
16 | @include box-shadow(-3px 0px 8px 0px rgba(#fff, 0.25));
17 | @include transition-property(right);
18 | @include transition-duration(0.15s);
19 |
20 | &.visible {
21 | right: 0;
22 |
23 | > .container > .close {
24 | @include transition-delay(0.25s);
25 | @include transform(scale(1));
26 | }
27 | }
28 |
29 | > .container {
30 | @include breakpoint($computer) {
31 | padding: 64px 8px 8px 8px;
32 | }
33 |
34 | @include breakpoint($mobile) {
35 | padding: 48px 6px 6px 6px;
36 | }
37 |
38 | > .close {
39 | position: absolute;
40 | top: 12px;
41 | right: 16px;
42 | height: 32px;
43 | width: 32px;
44 | background-size: 24px;
45 | background-image: url('/images/close.svg');
46 | background-position: center;
47 | background-repeat: no-repeat;
48 | cursor: pointer;
49 | opacity: 0.9;
50 | @include transform(scale(0));
51 | @include transition-property(opacity, transform);
52 | @include transition-duration(0.25s);
53 | -webkit-tap-highlight-color: transparent;
54 |
55 | &:hover {
56 | @include transition-delay(0s);
57 | opacity: 1;
58 | }
59 | }
60 |
61 | > a {
62 | display: block;
63 | padding: 0.7em 1em;
64 | color: rgba($color-dark-2, 0.75);
65 | text-align: left;
66 | text-decoration: none;
67 | border-radius: 4px;
68 | @include transition-property(color, background-color);
69 | @include transition-duration(0.05s);
70 |
71 | @include breakpoint($computer) {
72 | font-size: 1.1rem;
73 | font-weight: 400;
74 | }
75 |
76 | @include breakpoint($mobile) {
77 | font-size: 1rem;
78 | font-weight: 400;
79 | }
80 |
81 | &:hover {
82 | color: $color-dark-2;
83 | background-color: rgba(#fff, 1);
84 | }
85 | }
86 | }
87 | }
88 |
--------------------------------------------------------------------------------
/_compass/_mixins.scss:
--------------------------------------------------------------------------------
1 | @mixin mediasoup-gradient() {
2 | @include background-image(linear-gradient(
3 | 0deg, $color-highlight-2 10%,
4 | $color-highlight-1 100%));
5 | background-clip: text;
6 | -webkit-background-clip: text;
7 | text-fill-color: transparent;
8 | -webkit-text-fill-color: transparent;
9 | }
10 |
11 | @mixin mediasoup-logo($light: true) {
12 | font-family: 'Poiret One';
13 | letter-spacing: -0.04em;
14 | @if ($light) {
15 | color: $color-white-2;
16 | } @else {
17 | color: $color-dark;
18 | }
19 | -webkit-tap-highlight-color: transparent;
20 |
21 | span.small {
22 | font-size: 0.85em;
23 | }
24 |
25 | span.merge {
26 | letter-spacing: -0.1em;
27 | }
28 |
29 | span.highlight {
30 | @include mediasoup-gradient();
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/_compass/_rouge_theme.scss:
--------------------------------------------------------------------------------
1 | pre.highlight {
2 | overflow: auto;
3 | width: 100%;
4 | margin: 0 auto;
5 | padding: 1.2em;
6 | border-radius: 4px;
7 | background: $color-dark;
8 | border: 1px solid rgba($color-white-2, 0.15);
9 | font-size: 0.85em;
10 | font-family: 'Monaco', 'Andale Mono', monospace;
11 | text-align: left;
12 | white-space: pre;
13 | word-spacing: normal;
14 | word-break: normal;
15 | word-wrap: normal;
16 | line-height: 1.5;
17 | -moz-tab-size: 4;
18 | -o-tab-size: 4;
19 | tab-size: 4;
20 | @include hyphens(none);
21 | // Default color.
22 | color: #d7d7d7;
23 | opacity: 0.75;
24 |
25 | .hll { background-color: #49483e }
26 | .c { color: #908d7f; } /* comment */
27 | .err { color: #960050; background-color: #1e0010; } /* error */
28 | .k { color: #f9ee9a; } /* keyword */
29 | .l { color: #ffe081; } /* literal */
30 | .n { color: #f8f8f2; } /* name */
31 | .o { color: #a1e075; } /* operator */
32 | .p { color: rgba(#fff, 0.55); } /* punctuation */
33 | .cm { color: #908d7f; } /* comment.multiline */
34 | .cp { color: #908d7f; } /* comment.preproc */
35 | .c1 { color: #908d7f; } /* comment.single */
36 | .cs { color: #908d7f; } /* comment.special */
37 | .ge { font-style: italic; } /* generic.emph */
38 | .gs { font-weight: bold; } /* generic.strong */
39 | .kc { color: #ff8d26; } /* keyword.constant */
40 | .kd { color: #f9ee9a; } /* keyword.declaration */
41 | .kn { color: #a1e075; } /* keyword.namespace */
42 | .kp { color: #f9ee9a; } /* keyword.pseudo */
43 | .kr { color: #ff8d26; } /* keyword.reserved */
44 | .kt { color: #f9ee9a; } /* keyword.type */
45 | .ld { color: #63d3f2; } /* literal.date */
46 | .m { color: #ffe081; } /* literal.number */
47 | .s { color: #63d3f2; } /* literal.string */
48 | .na { color: #cccccc; } /* name.attribute */
49 | .nb { color: #f8f8f2; } /* name.builtin */
50 | .nc { color: #e5e5e5; } /* name.class */
51 | .no { color: #f9ee9a; } /* name.constant */
52 | .nd { color: #e5e5e5; } /* name.decorator */
53 | .ni { color: #f8f8f2; } /* name.entity */
54 | .ne { color: #e5e5e5; } /* name.exception */
55 | .nf { color: #e5e5e5; } /* name.function */
56 | .nl { color: #f8f8f2; } /* name.label */
57 | .nn { color: #f8f8f2; } /* name.namespace */
58 | .nx { color: #e5e5e5; } /* name.other */
59 | .py { color: #f8f8f2; } /* name.property */
60 | .nt { color: #a1e075; } /* name.tag */
61 | .nv { color: #f8f8f2; } /* name.variable */
62 | .ow { color: #a1e075; } /* operator.word */
63 | .w { color: #f8f8f2; } /* text.whitespace */
64 | .mf { color: #ffe081; } /* literal.number.float */
65 | .mh { color: #ffe081; } /* literal.number.hex */
66 | .mi { color: #ffe081; } /* literal.number.integer */
67 | .mo { color: #ffe081; } /* literal.number.oct */
68 | .sb { color: #63d3f2; } /* literal.string.backtick */
69 | .sc { color: #63d3f2; } /* literal.string.char */
70 | .sd { color: #63d3f2; } /* literal.string.doc */
71 | .s2 { color: #63d3f2; } /* literal.string.double */
72 | .se { color: #ffe081; } /* literal.string.escape */
73 | .sh { color: #63d3f2; } /* literal.string.heredoc */
74 | .si { color: #63d3f2; } /* literal.string.interpol */
75 | .sx { color: #63d3f2; } /* literal.string.other */
76 | .sr { color: #63d3f2; } /* literal.string.regex */
77 | .s1 { color: #63d3f2; } /* literal.string.single */
78 | .ss { color: #63d3f2; } /* literal.string.symbol */
79 | .bp { color: #f8f8f2; } /* name.builtin.pseudo */
80 | .vc { color: #f8f8f2; } /* name.variable.class */
81 | .vg { color: #f8f8f2; } /* name.variable.global */
82 | .vi { color: #f8f8f2; } /* name.variable.instance */
83 | .il { color: #ffe081; } /* literal.number.integer.long */
84 |
85 | .gh { } /* generic heading & diff header */
86 | .gu { color: #908d7f; } /* generic.subheading & diff unified/comment? */
87 | .gd { color: #a1e075; } /* generic.deleted & diff deleted */
88 | .gi { color: #e5e5e5; } /* generic.inserted & diff inserted */
89 | }
90 |
--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | # source: .
2 |
3 | exclude:
4 | - NO_GIT
5 | - Gemfile
6 | - Gemfile.lock
7 | - package.json
8 | - node_modules
9 | - lib
10 | - gulpfile.js
11 | - LICENSE
12 |
13 | markdown: kramdown
14 |
15 | kramdown:
16 | input: GFM
17 | auto_ids: false
18 | toc_levels: 2..4
19 | # Remove typographic single quotes (but allow typographic double quotes).
20 | smart_quotes: [ 'apos', 'apos', 'ldquo', 'rdquo' ]
21 | syntax_highlighter: rouge
22 |
23 | plugins:
24 | - jekyll-compass
25 | - breakpoint
26 | - rouge
27 |
28 | permalink: pretty
29 |
30 | defaults:
31 | -
32 | scope:
33 | path: ''
34 | values:
35 | layout: layout
36 |
37 | custom:
38 | canonicalUrl: 'https://mediasoup.org'
39 |
--------------------------------------------------------------------------------
/_data/compass.yml:
--------------------------------------------------------------------------------
1 | ---
2 | require:
3 | - jekyll-compass
4 | project_path: './'
5 | http_path: '/'
6 | css_dir: css
7 | sass_dir: _compass
8 | images_dir: images
9 | javascripts_dir: js
10 | output_style: compressed
11 | ---
12 |
--------------------------------------------------------------------------------
/_includes/breadcrumbs.html:
--------------------------------------------------------------------------------
1 |
2 | {% for crumb in breadcrumbs %}
3 | /
4 | {% if crumb.url == '/' %}
5 | home
6 | {% else %}
7 | {% if page.url != crumb.url %}
8 | {{ crumb.title }}
9 | {% else %}
10 | {{ crumb.title }}
11 | {% endif %}
12 | {% endif %}
13 | {% endfor %}
14 |
15 |
--------------------------------------------------------------------------------
/_includes/documentation/v2/mediasoup-client/api/Peer.md:
--------------------------------------------------------------------------------
1 | ## Peer
2 | {: #Peer}
3 |
4 | A `peer` is the local representation of a remote `peer`.
5 |
6 | For more information, check the [Glossary](/documentation/v2/glossary/#Glossary-Peer) section.
7 |
8 |
9 | ### Properties
10 | {: #Peer-properties}
11 |
12 |
56 |
57 | Argument | Type | Description | Required | Default
58 | ---------- | ------- | ----------- | -------- | ----------
59 | `id` | Number | Consumer id. | Yes |
60 |
61 |
62 |
63 |
84 |
85 | Argument | Type | Description
86 | -------- | ------- | ----------------
87 | `consumer` | [Consumer](#Consumer) | New `consumer`.
88 |
89 |
90 |
91 |
26 |
27 | Field | Type | Description
28 | ----------- | ------- | -------------
29 | `flag` | String | Browser/device identifier.
30 | `name` | String | Browser/device descriptive name (taken from `User-Agent`.
31 | `version` | String | Browser/device version.
32 | `bowser` | Object | Object produced by the `_detect()` method of the [bowser](https://www.npmjs.com/package/bowser) library.
33 |
34 |
35 |
36 |
37 | Current `flag` values can be:
38 |
39 | * "chrome"
40 | * "firefox"
41 | * "safari"
42 | * "msedge"
43 | * "opera"
44 | * `custom` (see [setDeviceHandler](#mediasoupClient-setDeviceHandler))
45 |
46 |
47 |
74 |
75 | Argument | Type | Description | Required | Default
76 | ---------- | ------- | ----------- | -------- | ----------
77 | `handler` | [DeviceHandler](https://github.com/versatica/mediasoup-client/blob/v2/lib/handlers) | Custom device handler. | Yes |
78 | `metadata` | [DeviceInfo](#mediasoupClient-DeviceInfo) | Custom device info. | Yes |
79 |
80 |
81 |
82 | #### mediasoupClient.isDeviceSupported()
83 | {: #mediasoupClient-isDeviceSupported .code}
84 |
85 | Returns a Boolean indicating if the current browser/device is supported by mediasoup-client.
86 |
87 | #### mediasoupClient.getDeviceInfo()
88 | {: #mediasoupClient-getDeviceInfo .code}
89 |
90 | Returns a [DeviceInfo](#mediasoupClient-DeviceInfo) Object with the browser/device information.
91 |
92 | #### mediasoupClient.checkCapabilitiesForRoom(roomRtpCapabilities)
93 | {: #mediasoupClient-checkCapabilitiesForRoom .code}
94 |
95 | Checks the audio/video capabilities of the current device/browser for the remote `room` given its RTP capabilities.
96 |
97 | It returns a Promise that resolves to an Object with `audio` and `video` Booleans, indicating whether sending and receiving audio/video is possible once joined in that `room`.
98 |
99 |
100 |
101 | Argument | Type | Description | Required | Default
102 | ---------- | ------- | ----------- | -------- | ----------
103 | `roomRtpCapabilities` | [RTCRtpCapabilities](https://draft.ortc.org/#rtcrtpcapabilities*) | Room RTP capabilities. | Yes |
104 |
105 |
106 |
107 |
108 | This method is useful in the scenario in which the application wishes to request the user with mic/webcam permissions before joining the room. By running this method before, the application could avoid requesting webcam permission to the user if his browser does not support the video codec of the room.
109 |
110 |
111 |
7 | The `ActiveSpeakerDetector` mechanism is based on the [`audiolevels`](#room-on-audiolevels) event of the `room`.
8 |
9 |
10 |
11 | ### Methods
12 | {: #ActiveSpeakerDetector-methods}
13 |
14 |
42 |
43 | Argument | Type | Description
44 | --------- | ------- | ----------------
45 | `peer` | [Peer](#Peer) | Associated `peer`.
46 | `producer`| [Producer](#Producer) | Associated audio `producer`.
47 |
48 |
49 |
50 |
51 | Both `peer` and `producer` can be `undefined` when no active speaker is detected.
52 |
53 |
54 |
16 |
17 | Field | Type | Description | Required | Default
18 | ------------ | ------- | ------------- | -------- | ---------
19 | `ip` | String | Destination IP. | Yes |
20 | `port` | Number | Destination port. | Yes |
21 |
22 |
23 |
24 |
86 |
87 | Argument | Type | Description | Required | Default
88 | ---------- | ------- | ----------- | -------- | ----------
89 | `parameters` | [PlainRtpRemoteParameters](#PlainRtpTransport-RemoteParameters) | Remote parameters. | Yes |
90 |
91 |
92 |
93 |
18 |
19 | Field | Type | Description | Required | Default
20 | ------------ | ------- | ------------- | -------- | ---------
21 | `remoteIP` | String | Destination IP. | Yes |
22 | `remotePort` | Number | Destination port. | Yes |
23 | `localIP` | String | Local IP. | No | `rtcIPv4` or `rtcIPv6` given in [ServerSettings](#Server-ServerSettings)
24 |
25 |
26 |
27 |
28 | If `localIP` is given, the RTP port range given in [ServerSettings](#Server-ServerSettings) (`rtcMinPort` - `rtcMaxPort`) is not honored and, instead, any available random port will be used.
29 |
30 |
31 |
32 |
35 |
36 | Argument | Type | Description | Required | Default
37 | ---------- | ------- | ----------- | -------- | ----------
38 | `settings` | [ServerSettings](#Server-ServerSettings) | Server settings. | No |
39 |
40 |
41 |
42 | Usage example:
43 |
44 | ```javascript
45 | const server = mediasoup.Server(
46 | {
47 | logLevel : "warn",
48 | rtcIPv4 : "1.2.3.4",
49 | rtcIPv6 : false,
50 | dtlsCertificateFile : "/home/foo/dtls-cert.pem",
51 | dtlsPrivateKeyFile : "/home/foo/dtls-key.pem"
52 | });
53 | ```
54 |
55 |
45 | Check the [Communication Between Client and Server](/documentation/v3/communication-between-client-and-server/) section for more details.
46 |
47 |
48 | #### consumer.GetTrack()
49 | {: #Consumer-GetTrack .code}
50 |
51 | The remote audio or video track.
52 |
53 | > `@returns` webrtc::MediaStreamTrackInterface\*
54 |
55 | #### consumer.GetStats()
56 | {: #Consumer-GetStats .code}
57 |
58 | Gets the local RTP receiver statistics by calling `getStats()` in the underlying `RTCRtpReceiver` instance.
59 |
60 | > `@async` blocks current thread
61 | >
62 | > `@returns` nlohmann::json [RTCStatsReport](https://w3c.github.io/webrtc-pc/#dom-rtcstatsreport)
63 |
64 | #### consumer.GetAppData()
65 | {: #Consumer-GetAppData .code}
66 |
67 | Custom data Object provided by the application in the consumer factory method. The app can modify its content at any time.
68 |
69 | > `@returns` const nlohmann::json&
70 |
71 | #### consumer.IsClosed()
72 | {: #Consumer-IsClosed .code}
73 |
74 | Whether the consumer is closed.
75 |
76 | > `@returns` bool
77 |
78 | #### consumer.IsPaused()
79 | {: #Consumer-IsPaused .code}
80 |
81 | Whether the consumer is paused.
82 |
83 | > `@returns` bool
84 |
85 | #### consumer.Close()
86 | {: #Consumer-Close .code}
87 |
88 | Closes the consumer.
89 |
90 |
91 | This method should be called when the server side consumer has been closed (and vice-versa).
92 |
93 |
94 | #### consumer.Pause()
95 | {: #Consumer-Pause .code}
96 |
97 | Pauses the consumer. Internally the library executes `track->set_enabled(false)` in the remote track.
98 |
99 |
100 | This method should be called when the server side consumer has been paused (and vice-versa).
101 |
102 |
103 | #### consumer.Resume()
104 | {: #Consumer-Resume .code}
105 |
106 | Resumes the consumer Internally the library executes `track->set_enabled(true)` in the remote track.
107 |
108 |
109 | This method should be called when the server side consumer has been resumed (and vice-versa).
110 |
111 |
112 |
25 |
26 | Argument | Type | Description | Required | Default
27 | --------------- | ------- | ----------- | -------- | ----------
28 | `consumer` | [Consumer\*](#Consumer) | The consumer instance executing this method. | Yes |
29 |
30 |
31 |
32 | ```c++
33 | void MyConsumerListener::OnTransportClose(mediasoupclient::Consumer* consumer)
34 | {
35 | std::cout << "transport closed" << std::endl;
36 | }
37 | ```
38 |
39 |
78 | This method should be called when the server side consumer has been closed (and vice-versa).
79 |
80 |
81 |
25 |
26 | Argument | Type | Description | Required | Default
27 | --------------- | ------- | ----------- | -------- | ----------
28 | `producer` | [DataConsumer\*](#DataConsumer) | The producer instance executing this method. | Yes |
29 |
30 |
31 |
32 | #### DataConsumerListener::OnOpen(producer)
33 | {: #DataConsumerListener-OnOpen .code}
34 |
35 | Executed when the underlying DataChannel is open.
36 |
37 |
38 |
39 | Argument | Type | Description | Required | Default
40 | --------------- | ------- | ----------- | -------- | ----------
41 | `producer` | [DataConsumer\*](#DataConsumer) | The producer instance executing this method. | Yes |
42 |
43 |
44 |
45 | #### DataConsumerListener::OnClosing(consumer)
46 | {: #DataConsumerListener-OnClosing .code}
47 |
48 | Executed when the underlying DataChannel is closing.
49 |
50 |
51 |
52 | Argument | Type | Description | Required | Default
53 | --------------- | ------- | ----------- | -------- | ----------
54 | `producer` | [DataConsumer\*](#DataConsumer) | The producer instance executing this method. | Yes |
55 |
56 |
57 |
58 | #### DataConsumerListener::OnClose(producer)
59 | {: #DataConsumerListener-OnClose .code}
60 |
61 | Executed when the underlying DataChannel is closed for unknown reasons.
62 |
63 |
64 |
65 | Argument | Type | Description | Required | Default
66 | --------------- | ------- | ----------- | -------- | ----------
67 | `producer` | [DataConsumer\*](#DataConsumer) | The producer instance executing this method. | Yes |
68 |
69 |
70 |
71 | #### DataConsumerListener::OnTransportClose(consumer)
72 | {: #DataConsumerListener-OnTransportClose .code}
73 |
74 | Executed when the transport this consumer belongs to is closed for whatever reason. The consumer itself is also closed.
75 |
76 |
77 |
78 | Argument | Type | Description | Required | Default
79 | --------------- | ------- | ----------- | -------- | ----------
80 | `consumer` | [DataConsumer\*](#DataConsumer) | The consumer instance executing this method. | Yes |
81 |
82 |
83 |
84 | ```c++
85 | void MyConsumerListener::OnTransportClose(mediasoupclient::DataConsumer* consumer)
86 | {
87 | std::cout << "transport closed" << std::endl;
88 | }
89 | ```
90 |
91 | #### DataConsumerListener::OnMessage(dataConsumer, buffer)
92 | {: #DataConsumerListener-OnMessage .code}
93 |
94 | Executed when a DataChannel message is received.
95 |
96 |
97 |
98 | Argument | Type | Description | Required | Default
99 | --------------- | ------- | ----------- | -------- | ----------
100 | `consumer` | [DataConsumer\*](#DataConsumer) | The consumer instance executing this method. | Yes |
101 | `buffer` | webrtc::DataBuffer& | Data message received. | No |
102 |
103 |
104 |
105 | ```c++
106 | void MyConsumerListener::OnMessage(DataConsumer* dataConsumer, const webrtc::DataBuffer& buffer)
107 | {
108 | if (dataConsumer->GetLabel() == "chat")
109 | {
110 | std::string message = std::string(buffer.data.data
78 | This method should be called when the server side producer has been closed (and vice-versa).
79 |
80 |
81 | #### dataProducer.Send(buffer)
82 | {: #DataProducer-Send .code}
83 |
84 | Sends the given data over the corresponding DataChannel. If the data can't be sent at the SCTP level (due to congestion control), it's buffered at the data channel level, up to a maximum of 16MB. If Send is called while this buffer is full, the data channel will be closed abruptly.
85 |
86 | So, it's important to use [GetBufferedAmount](#DataProducer-GetBufferedAmount) and [OnBufferedAmountChange](#DataProducerListener-OnBufferAmountChange) to ensure the data channel is used efficiently but without filling this buffer.
87 |
88 |
89 |
90 | Argument | Type | Description | Required | Default
91 | --------------- | ------- | ----------- | -------- | ----------
92 | `buffer` | webrtc::DataBuffer& | Data message to be sent. | No |
93 |
94 |
95 |
96 |
25 |
26 | Argument | Type | Description | Required | Default
27 | --------------- | ------- | ----------- | -------- | ----------
28 | `producer` | [DataProducer\*](#DataProducer) | The producer instance executing this method. | Yes |
29 |
30 |
31 |
32 | #### DataProducerListener::OnClose(producer)
33 | {: #DataProducerListener-OnClose .code}
34 |
35 | Executed when the underlying DataChannel is closed for unknown reasons.
36 |
37 |
38 |
39 | Argument | Type | Description | Required | Default
40 | --------------- | ------- | ----------- | -------- | ----------
41 | `producer` | [DataProducer\*](#DataProducer) | The producer instance executing this method. | Yes |
42 |
43 |
44 |
45 | #### DataProducerListener::OnBufferAmountChange(producer, sentDataSize)
46 | {: #DataProducerListener-OnBufferAmountChange .code}
47 |
48 | Executed when the DataChannel buffered amount of bytes changes.
49 |
50 |
51 |
52 | Argument | Type | Description | Required | Default
53 | --------------- | ------- | ----------- | -------- | ----------
54 | `producer` | [DataProducer\*](#DataProducer) | The producer instance executing this method. | Yes |
55 | `sentDataSize` | uint64_t | The amount of data sent. | Yes |
56 |
57 |
58 |
59 | #### DataProducerListener::OnTransportClose(producer)
60 | {: #DataProducerListener-OnTransportClose .code}
61 |
62 | Executed when the transport this producer belongs to is closed for whatever reason. The producer itself is also closed.
63 |
64 |
65 |
66 | Argument | Type | Description | Required | Default
67 | --------------- | ------- | ----------- | -------- | ----------
68 | `producer` | [DataProducer\*](#DataProducer) | The producer instance executing this method. | Yes |
69 |
70 |
71 |
72 | ```c++
73 | void MyProducerListener::OnTransportClose(mediasoupclient::Producer* producer)
74 | {
75 | std::cout << "transport closed" << std::endl;
76 | }
77 | ```
78 |
79 |
20 |
21 | Value | Description
22 | -------------- | -------------
23 | "LOG_DEBUG" | Logs debug level and above.
24 | "LOG_WARN" | Logs warning level and above.
25 | "LOG_ERROR" | Logs error level.
26 | "LOG_NONE" | Logs nothing.
27 |
28 |
29 |
30 |
31 | * "LOG_DEBUG" only applies if libmediasoupclient [MEDIASOUPCLIENT_LOG_DEV](/documentation/v3/libmediasoupclient/installation/#Building-Flags) building flag is set.
32 | * Log trace only applies if libmediasoupclient [MEDIASOUPCLIENT_LOG_TRACE](/documentation/v3/libmediasoupclient/installation/#Building-Flags) building flag is set and `LogLevel` is "LOG_DEBUG".
33 |
34 |
35 |
62 |
63 | Argument | Type | Description | Required | Default
64 | ----------- | ------- | ----------- | -------- | ----------
65 | `level` | [LogLevel](#LoggerLogLevel)| The log level to be used for logging. | Yes |
66 |
67 |
68 |
69 | #### Logger::SetHandler(handler)
70 | {: #Logger-SetHandler .code}
71 |
72 | Sets log handler.
73 |
74 |
75 |
76 | Argument | Type | Description | Required | Default
77 | -------- | ------- | ----------- | -------- | ----------
78 | `level` | [LogHandlerInterface\*](#LoggerLogHandlerInterface) | The log handler to be used. | Yes |
79 |
80 |
81 |
82 | #### Logger::SetDefaultHandler()
83 | {: #Logger-SetDefaultHandler .code}
84 |
85 | Sets the default log handler, which prints all log messages to `stdout`.
86 |
87 |
24 |
25 | Argument | Type | Description | Required | Default
26 | ----------- | ------- | ----------- | -------- | ----------
27 | `level` | [LogLevel](#LoggerLogLevel) | The level this log message belongs to. | Yes |
28 | `payload` | char\* | The log message. | Yes |
29 | `len` | size_t | The log message length. | Yes |
30 |
31 |
32 |
33 | ```c++
34 | void MyLogHandler::OnLog(LogLevel level, char* payload, size_t len)
35 | {
36 | std::cout << payload << std::endl;
37 | }
38 | ```
39 |
40 |
25 |
26 | Argument | Type | Description | Required | Default
27 | --------------- | ------- | ----------- | -------- | ----------
28 | `producer` | [Producer\*](#Producer) | The producer instance executing this method. | Yes |
29 |
30 |
31 |
32 | ```c++
33 | void MyProducerListener::OnTransportClose(mediasoupclient::Producer* producer)
34 | {
35 | std::cout << "transport closed" << std::endl;
36 | }
37 | ```
38 |
39 |
26 |
27 | Argument | Type | Description | Required | Default
28 | ----------- | ------- | ----------- | -------- | ----------
29 | `listener` | [Consumer::Listener](#ConsumerListener) | Consumer listener. | Yes |
30 | `id` | const std::string& | The identifier of the server side consumer. | Yes |
31 | `producerId` | const std::string& | The identifier of the server side producer being consumed. | Yes |
32 | `kind` | const std::string& | Media kind ("audio" or "video"). | Yes |
33 | `rtpParameters` | const nlohmann::json\* [RtpReceiveParameters](/documentation/v3/mediasoup/rtp-parameters-and-capabilities/#RtpReceiveParameters) | Receive RTP parameters. | Yes |
34 | `appData` | nlohmann::json | Custom application data. | No | `{ }`
35 |
36 |
37 |
38 | > `@async` blocks current thread
39 | >
40 | > `@returns` [Consumer](#Consumer)
41 |
42 | ```c++
43 | auto* consumerListener = new MyConsumerListener();
44 |
45 | // This will block the current thread until completion.
46 | auto* consumer = recvTransport->Consume(
47 | consumerListener,
48 | id,
49 | producerId,
50 | kind,
51 | rtpParameters);
52 | ```
53 |
54 | #### recvTransport.ConsumeData(listener, id, producerId, label, protocol, appData)
55 | {: #transport-ConsumeData .code}
56 |
57 | Instructs the transport to receive data via [DataChannel](https://www.w3.org/TR/webrtc/#rtcdatachannel) from the mediasoup router.
58 |
59 |
60 |
61 | Argument | Type | Description | Required | Default
62 | ----------- | ------- | ----------- | -------- | ----------
63 | `listener` | [DataConsumer::Listener](#DataConsumerListener) | Consumer listener. | Yes |
64 | `id` | const std::string& | The identifier of the server side consumer. | Yes |
65 | `producerId` | const std::string& | The identifier of the server side producer being consumed. | Yes |
66 | `label` | const std::string& | A label which can be used to distinguish this DataChannel from others. | Yes |
67 | `protocol` | const std::string& | Name of the sub-protocol used by this DataChannel. | No |
68 | `appData` | nlohmann::json | Custom application data. | No | `{ }`
69 |
70 |
71 |
72 | > `@async` blocks current thread
73 | >
74 | > `@returns` [DataConsumer](#DataConsumer)
75 |
76 | ```c++
77 | auto* consumerListener = new MyConsumerListener();
78 |
79 | // This will block the current thread until completion.
80 | auto* consumer = recvTransport->Consume(
81 | consumerListener,
82 | id,
83 | "dataChannelLabel",
84 | "dataChannelProtocol");
85 | ```
86 |
87 |
61 | This method should be called when the server side transport has been closed (and vice-versa).
62 |
63 |
64 | #### transport.RestartIce(iceParameters)
65 | {: #Transport-RestartIce .code}
66 |
67 | Instructs the underlying peerconnection to restart ICE by providing it with new remote ICE parameters.
68 |
69 |
70 |
71 | Argument | Type | Description | Required | Default
72 | --------------- | ------- | ----------- | -------- | ----------
73 | `iceParameters` | const nlohmann::json& [IceParameters](/documentation/v3/mediasoup/api/#WebRtcTransportIceParameters) | New ICE parameters of the server side transport. | Yes |
74 |
75 |
76 |
77 | > `@async` blocks current thread
78 |
79 |
80 | This method must be called after restarting ICE in server side via [webRtcTransport.restartIce()](/documentation/v3/mediasoup/api/#webRtcTransport-restartIce).
81 |
82 |
83 | ```c++
84 | transport.RestartIce(iceParameters);
85 | ```
86 |
87 | #### transport.UpdateIceServers(iceServers)
88 | {: #Transport-UpdateIceServers .code}
89 |
90 | Provides the underlying peerconnection with a new list of TURN servers.
91 |
92 |
93 |
94 | Argument | Type | Description | Required | Default
95 | --------------- | ------- | ----------- | -------- | ----------
96 | `iceServers` | const nlohmann::json& Array<[RTCIceServer](https://w3c.github.io/webrtc-pc/#rtciceserver-dictionary)> | List of TURN servers to provide the local peerconnection with. | No | `[ ]`
97 |
98 |
99 |
100 |
101 | This method is specially useful if the TURN server credentials have changed.
102 |
103 |
104 | ```javascript
105 | transport.updateIceServers(iceServers);
106 | ```
107 |
108 |
24 |
25 | Argument | Type | Description
26 | ----------- | ------- | ----------------
27 | `transport` | [Transport\*](#Transport) | Transport instance.
28 | `dtlsParameters` | const nlohmann::json& [DtlsParameters](/documentation/v3/mediasoup/api/#WebRtcTransportDtlsParameters) | Local DTLS parameters.
29 |
30 |
31 |
32 | > `@returns` std::future\
35 | In server side, the application should call [webRtcTransport.connect()](/documentation/v3/mediasoup/api/#webRtcTransport-connect).
36 |
37 |
38 | ```c++
39 | std::future
71 |
72 | Argument | Type | Description
73 | ----------- | ------- | ----------------
74 | `transport` | [Transport\*](#Transport) | Transport instance.
75 | `connectionState` | const std::string& [RTCPeerConnectionState](https://w3c.github.io/webrtc-pc/#rtcpeerconnectionstate-enum) | Transport connection state.
76 |
77 |
78 |
79 |
75 |
76 | Argument | Type | Description | Required | Default
77 | ---------- | ------- | ----------- | -------- | ----------
78 | `scalabilityMode` | const std::string& | Scalability mode. | Yes |
79 |
80 |
81 |
82 | > `@returns` nlohmann::json:
83 | >
84 | > * `spatialLayers` {`@type` uint16_t} Number of spatial layers (by default 1).
85 | >
86 | > * `temporalLayers` {`@type` uint16_t} Number of temporal layers (by default 1).
87 |
88 | ```javascript
89 | mediasoupclient::parseScalabilityMode("L2T3");
90 | // => { spatialLayers: 2, temporalLayers: 3 }
91 |
92 | mediasoupclient::parseScalabilityMode("L4T7_KEY_SHIFT");
93 | // => { spatialLayers: 4, temporalLayers: 7 }
94 | ```
95 |
96 |
9 | The application must use it to construct JSON objects and pass them to the libmediasoupclient API when required.
10 |
11 |
12 | ```c++
13 | #include "nlohmann/json.hpp"
14 | ```
15 |
16 |
24 |
25 | Field | Type | Description | Required | Default
26 | -------------- | ------- | ------------ | -------- | ----------
27 | `interval` | Number | Interval in ms for checking audio volumes. | No | 300
28 | `appData` | [AppData](#AppData) | Custom application data. | No | `{ }`
29 |
30 |
31 |
32 |
33 | #### ActiveSpeakerObserverDominantSpeaker
34 | {: #ActiveSpeakerObserverDominantSpeaker .code}
35 |
36 |
37 |
38 | Field | Type | Description | Required | Default
39 | -------------- | ------- | ------------ | -------- | ----------
40 | `producer` | [Producer](#Producer) | The dominant audio producer instance. | Yes |
41 |
42 |
43 |
44 |
80 |
81 | Argument | Type | Description
82 | --------- | ------- | ----------------
83 | `dominantSpeaker` | [ActiveSpeakerObserverDominantSpeaker](#ActiveSpeakerObserverDominantSpeaker) | Speaker with most dominant audio in the last interval.
84 |
85 |
86 |
87 |
24 |
25 | Field | Type | Description | Required | Default
26 | -------------- | ------- | ------------ | -------- | ----------
27 | `maxEntries` | Number | Maximum number of entries in the "volumes" event. | No | 1
28 | `threshold` | Number | Minimum average volume (in dBvo from -127 to 0) for entries in the "volumes" event. | No | -80
29 | `interval` | Number | Interval in ms for checking audio volumes. | No | 1000
30 | `appData` | [AppData](#AppData) | Custom application data. | No | `{ }`
31 |
32 |
33 |
34 |
35 | #### AudioLevelObserverVolume
36 | {: #AudioLevelObserverVolume .code}
37 |
38 |
39 |
40 | Field | Type | Description | Required | Default
41 | -------------- | ------- | ------------ | -------- | ----------
42 | `producer` | [Producer](#Producer) | The audio producer instance. | Yes |
43 | `volume` | Number | The average volume (in dBvo from -127 to 0) of the audio producer in the last interval. | Yes |
44 |
45 |
46 |
47 |
83 |
84 | Argument | Type | Description
85 | --------- | ------- | ----------------
86 | `volumes` | Array<[AudioLevelObserverVolume](#AudioLevelObserverVolume)> | Audio volumes entries ordered by `volume` (louder ones go first).
87 |
88 |
89 |
90 | #### audioLevelObserver.on("silence")
91 | {: #audioLevelObserver-on-silence .code}
92 |
93 | Emitted when no one of the producers in this RTP observer is generating audio with a volume beyond the given threshold.
94 |
95 |
2 |
6 |
--------------------------------------------------------------------------------
/_includes/menu.html:
--------------------------------------------------------------------------------
1 |
18 |
--------------------------------------------------------------------------------
/_layouts/layout.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | {% if page.home %}
6 | mediasoup
3 | 4 | 5 |
37 |
38 | {% unless page.home %}
39 | {% include header.html %}
40 | {% endunless %}
41 |
42 | {% include menu.html %}
43 |
44 |
45 | {% if page.home %}
46 |
56 |
57 |
65 |
66 |
67 |
68 |
80 |
81 |
82 |
83 |
84 |
85 |
--------------------------------------------------------------------------------
/_plugins/breadcrumbs.rb:
--------------------------------------------------------------------------------
1 | require_relative 'drops/breadcrumb_item.rb'
2 |
3 | Jekyll::Hooks.register [:pages, :documents], :pre_render do |side, payload| # documents are collections, and collections include also posts
4 | drop = Drops::BreadcrumbItem
5 |
6 | if side.url == "/"
7 | then payload["breadcrumbs"] = [
8 | drop.new(side, payload)
9 | ]
10 | else
11 | payload["breadcrumbs"] = []
12 | path = side.url.split("/")
13 |
14 | 0.upto(path.size - 1) do |int|
15 | joined_path = path[0..int].join("/")
16 | sides = [].concat(side.site.pages).concat(side.site.documents)
17 | item = sides.find { |side_| joined_path == "" && side_.url == "/" || side_.url.chomp("/") == joined_path }
18 | payload["breadcrumbs"] << drop.new(item, payload) if item
19 | end
20 | end
21 | end
22 |
--------------------------------------------------------------------------------
/_plugins/drops/breadcrumb_item.rb:
--------------------------------------------------------------------------------
1 | module Drops
2 | class BreadcrumbItem < Liquid::Drop
3 | extend Forwardable
4 |
5 | def_delegator :@page, :data
6 | def_delegator :@page, :url
7 |
8 | def initialize(page, payload)
9 | @payload = payload
10 | @page = page
11 | end
12 |
13 | def title
14 | @page.data["breadcrumb"] != nil ? @page.data["breadcrumb"] : @page.data["title"]
15 | end
16 |
17 | def namespace
18 | @page.data["namespace"]
19 | end
20 |
21 | end
22 | end
23 |
--------------------------------------------------------------------------------
/documentation/examples.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Examples
3 | anchors : true
4 | ---
5 |
6 |
7 | # Examples
8 |
9 |
10 | ### versatica/mediasoup-demo
11 |
12 | **Project:** [https://github.com/versatica/mediasoup-demo](https://github.com/versatica/mediasoup-demo)
13 |
14 | This is the "official" mediasoup demo made by mediasoup authors. Said that, we (the authors) don't want this demo to become the "mediasoup reference" and encourage developers to read the API documentation instead.
15 |
16 | The **mediasoup-demo** has a client side web application and a server side Node.js application:
17 |
18 | * The client side is a [React](https://reactjs.org) application that uses [mediasoup-client](https://github.com/versatica/mediasoup-client) and [protoo-client](https://www.npmjs.com/package/protoo-client) among other libraries.
19 | * The server side is a Node.js application that uses [mediasoup](https://github.com/versatica/mediasoup) and [protoo-server](https://www.npmjs.com/package/protoo-server).
20 | * [protoo](https://protoo.versatica.com) is a JavaScript library for both, client and server sides, that provides an easy way for clients to connect via WebSocket to a shared room. The API offers request/response transactions and notifications in both directions.
21 | - As an alternative (there are many) readers may be more used to [socket.io](https://socket.io).
22 |
23 |
24 | ### versatica/mediasoup-broadcaster-demo
25 |
26 | **Project:** [https://github.com/versatica/mediasoup-broadcaster-demo](https://github.com/versatica/mediasoup-broadcaster-demo)
27 |
28 | Made by [mediasoup authors](https://github.com/versatica), this project is a
29 | [libmediasoupclient](https://github.com/versatica/libmediasoupclient/) based application that takes the system microphone and webcam and produces the media to the specified room in [mediasoup-demo](https://github.com/versatica/mediasoup-demo/) application.
30 |
31 |
32 | ### Kurento/mediasoup-demos
33 |
34 | **Project:** [https://github.com/Kurento/mediasoup-demos](https://github.com/Kurento/mediasoup-demos)
35 |
36 | Contains mediasoup + Kurento integration projects.
37 |
38 |
39 | ### vpalmisano/mediasoupbin
40 |
41 | **Project:** [https://github.com/vpalmisano/mediasoupbin](https://github.com/vpalmisano/mediasoupbin)
42 |
43 | GStreamer plugin for mediasoup-demo.
44 |
45 |
46 | ### havfo/multiparty-meeting
47 |
48 | **Project:** [https://github.com/havfo/multiparty-meeting](https://github.com/havfo/multiparty-meeting)
49 |
50 | **Web:** [https://letsmeet.no](https://letsmeet.no)
51 |
52 | Multiparty web-meetings using mediasoup and WebRTC. It started as a fork of mediasoup-demo but has evolved quite a bit.
53 |
54 |
55 | ### ethand91/mediasoup3-record-demo
56 |
57 | **Project:** [https://github.com/ethand91/mediasoup3-record-demo](https://github.com/ethand91/mediasoup3-record-demo)
58 |
59 | Simple audio/video record application using mediasoup and GStreamer or FFmpeg.
60 |
61 |
62 | ### mkhahani/mediasoup-sample-app
63 |
64 | **Project:** [https://github.com/mkhahani/mediasoup-sample-app](https://github.com/mkhahani/mediasoup-sample-app)
65 |
66 | A minimal client/server app based on Mediasoup and Socket.io made by [@mkhahani](https://github.com/mkhahani).
67 |
68 |
69 | ### daily-co/mediasoup-sandbox
70 |
71 | **Project:** [https://github.com/daily-co/mediasoup-sandbox/tree/master/single-page](https://github.com/daily-co/mediasoup-sandbox/tree/master/single-page)
72 |
73 | Sample code with the the simplest possible signaling, and fewest possible dependencies, for cross-browser testing of:
74 |
75 | * Sending/receiving audio and video tracks
76 | * Switching to a different input device and replacing a track
77 | * Screen sharing
78 | * Subscribing to and unsubscribing from tracks
79 | * Pausing tracks for sender and receiver independently
80 | * Simulcast
81 | * Setting maximum simulcast layer when sending
82 | * Setting maximum simulcast layer when receiving
83 | * Display of stats
84 | * Display of "active speaker"
85 |
86 |
87 | ### Dirvann/mediasoup-sfu-webrtc-video-rooms
88 |
89 | **Project:** [https://github.com/Dirvann/mediasoup-sfu-webrtc-video-rooms](https://github.com/Dirvann/mediasoup-sfu-webrtc-video-rooms)
90 |
91 | Example website for multi-party video/audio/screen conferencing using mediasoup. This project is intended to better understand how mediasoup works with a simple example.
92 |
93 |
94 | ### Others
95 |
96 | Other public projects using mediasoup can be found in [GitHub](https://github.com/versatica/mediasoup/network/dependents).
97 |
98 |
--------------------------------------------------------------------------------
/documentation/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Documentation
3 | ---
4 |
5 |
6 | # Documentation
7 |
8 | ##### [Overview](/documentation/overview/)
9 |
10 | A brief introduction to mediasoup and its ecosystem.
11 |
12 | ##### [v3 Documentation](/documentation/v3/)
13 |
14 | mediasoup, mediasoup-rust, mediasoup-client and libmediasoupclient v3.
15 |
16 | ##### [v2 Documentation](/documentation/v2/)
17 |
18 | mediasoup and mediasoup-client v2.
19 |
20 | ##### [v1 Documentation](/documentation/v1/)
21 |
22 | mediasoup v1.
23 |
24 | ##### [Examples](/documentation/examples/)
25 |
26 | mediasoup usage samples.
27 |
28 | ##### [Publications](/documentation/publications/)
29 |
30 | Publications and studies about mediasoup.
31 |
--------------------------------------------------------------------------------
/documentation/overview.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Overview
3 | anchors : true
4 | ---
5 |
6 |
7 | # Overview
8 |
9 | An [SFU](https://webrtcglossary.com/sfu/) (Selective Forwarding Unit) receives audio and video streams from endpoints and relays them to everyone else (endpoints send one and receive many). Each receiver endpoint can select which streams and spatial/temporal layers it receives. Compared to a mixer or [MCU](https://webrtcglossary.com/mcu/) (Multipoint Conferencing Unit) this design leads to a better performance, higher throughput and less latency. It's highly scalable and requires much less resources given that it does not transcode or mix media.
10 |
11 | Since endpoints get the other endpoints' media separately, they can have a personalized layout and choose which streams to render and how to display them.
12 |
13 |
47 | {{ content }}
48 |
49 | {% else %}
50 |
51 | {% include breadcrumbs.html %}
52 | {{ content }}
53 |
54 | {% endif %}
55 |
14 | Detailed information regarding the architecture of an SFU can be found at RFC 7667 "RTP Topologies" [section 3.7](https://tools.ietf.org/html/rfc7667#section-3.7).
15 |
16 |
17 |
18 | ## Design Goals
19 |
20 | mediasoup and its client side libraries are designed to accomplish with the following goals:
21 |
22 | * Be a [SFU](https://webrtcglossary.com/sfu/) (Selective Forwarding Unit).
23 | * Support both WebRTC and plain RTP input and output.
24 | * Be a Node.js module in server side.
25 | * Be a tiny JavaScript and C++ libraries in client side.
26 | * Be minimalist: just handle the media layer.
27 | * Be signaling agnostic: do not mandate any signaling protocol.
28 | * Be super low level API.
29 | * Support all existing WebRTC endpoints.
30 | * Enable integration with well known multimedia libraries/tools.
31 |
32 |
33 | ## Use Cases
34 |
35 | mediasoup and its client side libraries provide a super low level API. They are intended to enable different use cases and scenarios, without any constraint or assumption. Some of these use cases are:
36 |
37 | * Group video chat applications.
38 | * One-to-many (or few-to-many) broadcasting applications in real-time.
39 | * RTP streaming.
40 |
--------------------------------------------------------------------------------
/documentation/publications.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Publications
3 | anchors : true
4 | ---
5 |
6 |
7 | # Publications
8 |
9 |
10 | ### Comparative Study of WebRTC Open Source SFUs for Video Conferencing
11 |
12 | "Comparative Study of WebRTC Open Source SFUs for Video Conferencing", by Emmanuel André, Nicolas Le Breton, Augustin Lemesle, Ludovic Roux and Alexandre Gouaillard ([CoSMo Software](https://www.cosmosoftware.io)), in "Proceedings of Principles, Systems and Applications of IP Telecommunications".
13 |
14 | * Illinois Institute of Technology, Chicago, USA
15 | * October 2018
16 | * [Download PDF](/resources/CoSMo_ComparativeStudyOfWebrtcOpenSourceSfusForVideoConferencing.pdf)
17 |
18 | This study used mediasoup v2.
19 |
20 |
21 | ### Performance Testing with mediasoup: 1:many video broadcasting
22 |
23 | Topic in the [mediasoup Discourse Group](https://mediasoup.discourse.group/) about performance of mediasoup v3 for 1:many video broadcasting using various mediasoup `workers` and `pipeToRouter()`. It includes performance testing numbers:
24 |
25 | * [Link to the topic](https://mediasoup.discourse.group/t/experience-with-mediasoup/1578)
26 |
--------------------------------------------------------------------------------
/documentation/v1/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : v1
3 | ---
4 |
5 |
6 | # v1 Documentation
7 |
8 |
9 | mediasoup v1 is no longer documented. Sorry. Anyway it's no longer maintained so please move to the latest version.
10 |
11 |
--------------------------------------------------------------------------------
/documentation/v2/glossary.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Glossary
3 | anchors : true
4 | ---
5 |
6 |
7 | # Glossary
8 |
9 | Both mediasoup and mediasoup-client refer to the same common entities that are represented in both client and server sides. Those entities are described below:
10 |
11 |
12 | ### Room
13 | {: #Glossary-Room}
14 |
15 | A **Room** represents a multi-party conference with N participants (**Peers**). Within a **Room**, audio and video tracks generated by a client/browser are relayed to all the participants.
16 |
17 |
18 | ### Peer
19 | {: #Glossary-Peer}
20 |
21 | A **Peer** represents a participant in the conference, thus it has a local (client side) representation and a remote (server side) representation. When a client joins a **Room** it also gets information about existing and new **Peers** in the conference.
22 |
23 | A **Peer** holds a set of associated **Transport**, **Producer** and **Consumer** instances.
24 |
25 |
26 | ### Transport
27 | {: #Glossary-Transport}
28 |
29 | A **Transport** represents a path for sending or receiving audio/video RTP and RTCP. In the context of WebRTC this means a network path negotiated by both, the client and the server, via ICE and DTLS. A **Transport** has an associated entity in both client and server sides.
30 |
31 |
32 | ### Producer
33 | {: #Glossary-Producer}
34 |
35 | A **Producer** represents and handles a media track (audio or video) sent by a client to the server. A **Producer** has an associated entity in both client and server sides, meaning that both sides (the client app and the server app) can run API methods on it (such as pausing or resuming it).
36 |
37 | In order to send the media track to the server, the **Producer** needs to be provided with a **Transport** instance.
38 |
39 | In mediasoup (server side) a **Producer** is connected with many **Consumers** associated to it.
40 |
41 |
42 | ### Consumer
43 | {: #Glossary-Consumer}
44 |
45 | A **Consumer** represents and handles a media track (audio or video) sent by the server to the client. A **Consumer** has an associated entity in both client and server sides, meaning that both sides (the client app and the server app) can run API methods on it (such as pausing or resuming it).
46 |
47 | Typically, a **Consumer** has a remote **Producer** as a source. In fact, an audio **Producer** created by Alice's **Peer** will trigger the creation of an audio **Consumer** in Bob's **Peer** and all the other **Peers**.
48 |
49 | It's up to the client side application whether to enable/activate a **Consumer** (by providing a **Transport**) or not. Once enabled, the corresponding RTP is relayed to the client.
50 |
51 |
52 | ### Profile
53 | {: #Glossary-Profile}
54 |
55 | A **Profile** represents a RTP quality layer and, hence, just makes sense for [simulcast](https://tools.ietf.org/html/draft-westerlund-avtcore-rtp-simulcast) streams.
56 |
57 | mediasoup defines the following profiles:
58 |
59 | * **default**: If no simulcast, it just points to the single audio or video RTP stream. When there is simulcast, this profile means the highest available stream.
60 | * **low**: The lowest profile. In simulcast this means the stream with lowest video resolution.
61 | * **medium**: The medium profile. In simulcast this means the stream with medium video resolution.
62 | * **high**: The highest profile. In simulcast this means the stream with highest video resolution.
63 | * **none**: Special case when there is no available stream (this may happen at **Consumer** level when no profile can be sent to the remote client).
64 |
--------------------------------------------------------------------------------
/documentation/v2/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : v2
3 | ---
4 |
5 |
6 | # v2 Documentation
7 |
8 | ### General
9 |
10 | * [Glossary](/documentation/v2/glossary/)
11 | * [mediasoup protocol](/documentation/v2/mediasoup-protocol/)
12 | * [RTC stats](/documentation/v2/rtc-stats/)
13 |
14 | ### mediasoup
15 |
16 | {% include documentation/v2/mediasoup/index.md %}
17 |
18 | ### mediasoup-client
19 |
20 | {% include documentation/v2/mediasoup-client/index.md %}
21 |
--------------------------------------------------------------------------------
/documentation/v2/mediasoup-client/api.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : API
3 | anchors : true
4 | apiToc : true
5 | class : h3color
6 | ---
7 |
8 |
9 |
10 | * Will be replaced with the ToC
11 | {: toc}
12 |
13 |
14 |
16 |
17 |
18 | # mediasoup-client v2 API
19 |
20 | {% include documentation/v2/mediasoup-client/api/mediasoupClient.md %}
21 |
22 | {% include documentation/v2/mediasoup-client/api/Room.md %}
23 |
24 | {% include documentation/v2/mediasoup-client/api/Transport.md %}
25 |
26 | {% include documentation/v2/mediasoup-client/api/Producer.md %}
27 |
28 | {% include documentation/v2/mediasoup-client/api/Peer.md %}
29 |
30 | {% include documentation/v2/mediasoup-client/api/Consumer.md %}
31 |
--------------------------------------------------------------------------------
/documentation/v2/mediasoup-client/debugging.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Debugging
3 | anchors : true
4 | ---
5 |
6 |
7 | # Debugging
8 |
9 |
10 | ## Log Levels
11 |
12 | mediasoup-client uses the [debug](https://www.npmjs.com/package/debug) module to log to the browser console.
13 |
14 | There are three log severities:
15 |
16 | * **debug**: verbose information logged to `console.info`
17 | * **warn**: warning messages logged to `console.warn`
18 | * **error**: error messages logged to `console.error`
19 |
20 | All the logs generated by mediasoup-client have a namespace starting with "mediasoup-client" plus colon, followed by the log severity in upper case plus colon (just if "warn" or "error"), and followed by the internal component name (if any) and the log message.
21 |
22 |
23 | ## Enable Logging
24 |
25 | By default logging is turned off. In order to enable it, the `debug` key in the browser's `localStorage` must be set.
26 |
27 |
28 | Check the [debug](https://www.npmjs.com/package/debug) module documentation for further information regarding how to filter specific log messages based on namespace matching rules.
29 |
30 |
31 |
32 | ### Example
33 |
34 | Within the `` section of your HTML app:
35 |
36 | ```html
37 |
40 |
41 |
42 | ```
43 |
--------------------------------------------------------------------------------
/documentation/v2/mediasoup-client/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : mediasoup-client
3 | ---
4 |
5 |
6 | # Documentation
7 |
8 | Client side JavaScript library.
9 |
10 | * [Installation](/documentation/v2/mediasoup-client/installation/)
11 | * [API](/documentation/v2/mediasoup-client/api/)
12 | * [Debugging](/documentation/v2/mediasoup-client/debugging/)
13 |
--------------------------------------------------------------------------------
/documentation/v2/mediasoup-client/installation.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Installation
3 | anchors : true
4 | ---
5 |
6 |
7 | # Installation
8 |
9 | Install mediasoup-client within you client application:
10 |
11 | ```bash
12 | $ npm install mediasoup-client@2
13 | ```
14 |
15 |
16 | ## Usage
17 |
18 | Depending on how your web application loads libraries (for example, by using a JavaScript module loader) your may need to use one of the following ways to load mediasoup-client:
19 |
20 | * Using `import`:
21 |
22 | ```javascript
23 | import * as mediasoupClient from "mediasoup-client";
24 | ```
25 |
26 | * Using CommonJS with [browserify](http://browserify.org) or [webpack](https://webpack.github.io):
27 |
28 | ```javascript
29 | const mediasoupClient = require("mediasoup-client");
30 | ```
31 |
--------------------------------------------------------------------------------
/documentation/v2/mediasoup-protocol.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : mediasoup protocol
3 | ---
4 |
5 |
6 | # mediasoup protocol
7 |
8 | Although mediasoup does not implement a signaling protocol, both the client (mediasoup-client) and the server (mediasoup) must exchange messages. Those messages can be **request**/**response** pairs or **notifications**, and can be sent in both directions.
9 |
10 | Those messages can be serialized to JSON bodies for network transmission, but may be converted into JavaScripts Objects (`JSON.parse()`) before they are given to the corresponding API methods in both mediasoup and mediasoup-client.
11 |
12 | The exact definition of the message payloads that must be exchanged is documented in the [MEDIASOUP_PROTOCOL.md](https://github.com/versatica/mediasoup-client/blob/v2/MEDIASOUP_PROTOCOL.md) file included in the mediasoup-client source code.
13 |
14 |
15 | The application developer does not need to know in depth about these messages, but can intercept them for advanced usages.
16 |
17 |
18 |
19 | ## Request/response pairs and notifications
20 |
21 | mediasoup-client can generate both **requests** and **notifications** to be sent to mediasoup, while mediasoup just generates **notifications** and **responses** for mediasoup-client.
22 |
23 | * A mediasoup protocol **request** is an Object that requires a **response** from the other side.
24 | * A mediasoup protocol **notification** is also an Object that includes a `notification: true` key/value and does **NOT** require a **response**.
25 |
26 |
27 | It's up to the application how to correlate those **requests** and their associated **responses**, for example by enveloping the **request** and its **response** into a signaling transaction that uses a `id` field to match them.
28 |
29 |
30 |
31 | ## Message target
32 |
33 | Both **requests** and **notifications** sent by mediasoup-client have a `target` key whose value can be "room" or "peer":
34 |
35 | * `target: "room"` means that the **request** or **notification** must be delivered to the corresponding server side [Room](/documentation/v2/mediasoup/api/#Room).
36 | * The `Room` just accepts **requests** by calling to its [room.receiveRequest()](/documentation/v2/mediasoup/api/#room-receiveRequest) method.
37 | * `target: "peer"` means that the **request** or **notification** must be delivered to the corresponding server side [Peer](/documentation/v2/mediasoup/api/#Peer).
38 | * The `Peer` accepts **requests** by calling to its [peer.receiveRequest()](/documentation/v2/mediasoup/api/#peer-receiveRequest) method.
39 | * The `Peer` accepts **notifications** by calling to its [peer.receiveNotification()](/documentation/v2/mediasoup/api/#peer-receiveNotification) method.
40 |
41 |
42 | It's up to the application how to correlate those **requests** and their associated **responses**, for example by enveloping the **request** and its **response** into a signaling transaction that uses a `id` field to match them.
43 |
44 |
45 |
46 | ## Message examples
47 |
48 | Those real messages are directly taken from the [MEDIASOUP_PROTOCOL.md](https://github.com/versatica/mediasoup-client/blob/v2/MEDIASOUP_PROTOCOL.md) file included in the mediasoup-client source code. Here they are represented in JSON format.
49 |
50 |
51 | ### mediasoup-client request sent to the mediasoup Room
52 |
53 | * **request**:
54 |
55 | ```json
56 | {
57 | "method": "queryRoom",
58 | "target": "room"
59 | }
60 | ```
61 |
62 | * **response**:
63 |
64 | ```json
65 | {
66 | "rtpCapabilities": {},
67 | "mandatoryCodecPayloadTypes": []
68 | }
69 | ```
70 |
71 | ### mediasoup-client request sent to the mediasoup Peer
72 |
73 | * **request**:
74 |
75 | ```json
76 | {
77 | "method": "createTransport",
78 | "target": "peer",
79 | "id": 1111,
80 | "options": {},
81 | "dtlsParameters": {},
82 | "appData": "foo"
83 | }
84 | ```
85 |
86 | * **response**:
87 |
88 | ```json
89 | {
90 | "iceParameters": {},
91 | "iceCandidates": [],
92 | "dtlsParameters": {}
93 | }
94 | ```
95 |
96 | ### mediasoup-client notification sent to the mediasoup Peer
97 |
98 | * **notification**:
99 |
100 | ```json
101 | {
102 | "method": "leave",
103 | "target": "peer",
104 | "notification": true,
105 | "appData": 1234
106 | }
107 | ```
108 |
109 | ### mediasoup notification sent to the mediasoup-client Peer
110 |
111 | * **notification**:
112 |
113 | ```json
114 | {
115 | "method": "transportStats",
116 | "target": "peer",
117 | "notification": true,
118 | "id": 3333,
119 | "stats": []
120 | }
121 | ```
122 |
--------------------------------------------------------------------------------
/documentation/v2/mediasoup/api.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : API
3 | anchors : true
4 | apiToc : true
5 | class : h3color
6 | ---
7 |
8 |
9 |
10 | * Will be replaced with the ToC
11 | {: toc}
12 |
13 |
14 |
16 |
17 |
18 | # mediasoup v2 API
19 |
20 | {% include documentation/v2/mediasoup/api/mediasoup.md %}
21 |
22 | {% include documentation/v2/mediasoup/api/Server.md %}
23 |
24 | {% include documentation/v2/mediasoup/api/Room.md %}
25 |
26 | {% include documentation/v2/mediasoup/api/Peer.md %}
27 |
28 | {% include documentation/v2/mediasoup/api/Transport.md %}
29 |
30 | {% include documentation/v2/mediasoup/api/WebRtcTransport.md %}
31 |
32 | {% include documentation/v2/mediasoup/api/PlainRtpTransport.md %}
33 |
34 | {% include documentation/v2/mediasoup/api/Producer.md %}
35 |
36 | {% include documentation/v2/mediasoup/api/Consumer.md %}
37 |
38 | {% include documentation/v2/mediasoup/api/ActiveSpeakerDetector.md %}
39 |
40 | {% include documentation/v2/mediasoup/api/RtpStreamer.md %}
41 |
42 | {% include documentation/v2/mediasoup/api/errors.md %}
43 |
--------------------------------------------------------------------------------
/documentation/v2/mediasoup/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : mediasoup
3 | ---
4 |
5 |
6 | # Documentation
7 |
8 | C++ SFU and server side Node.js module.
9 |
10 | * [Installation](/documentation/v2/mediasoup/installation/)
11 | * [API](/documentation/v2/mediasoup/api/)
12 | * [Debugging](/documentation/v2/mediasoup/debugging/)
13 |
--------------------------------------------------------------------------------
/documentation/v2/mediasoup/installation.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Installation
3 | anchors : true
4 | ---
5 |
6 |
7 | # Installation
8 |
9 | Install the mediasoup Node.js module via NPM within your Node.js application:
10 |
11 | ```bash
12 | $ npm install mediasoup@2
13 | ```
14 |
15 |
16 | ## Requirements
17 |
18 | In order to build the C/C++ component the following packages and libraries must be available in the target host:
19 |
20 | * Node.js >= `v6.4.0`
21 | * POSIX based operating system (Windows not supported)
22 | * Python 2 (`python2` or `python` command must point to the Python 2 executable)
23 | * `make`
24 | * `gcc` and `g++` or `clang` (with C++11 support)
25 | * `cc` command pointing to `gcc` or `clang`
26 |
27 |
28 | * In Debian and Ubuntu install the `build-essential` DEB package. It includes both `make` and `gcc`/`g++`.
29 | * In YUM based Linux (Red Hat, CentOS) use `yum groupinstall "Development Tools"`.
30 | * The installation path MUST NOT contain whitespaces.
31 |
32 |
--------------------------------------------------------------------------------
/documentation/v2/rtc-stats.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : RTC stats
3 | anchors : true
4 | ---
5 |
6 |
7 | # RTC stats
8 |
9 | Similar to [WebRTC](https://w3c.github.io/webrtc-stats/) and [ORTC](https://draft.ortc.org/#rtcstats-dictionary), mediasoup provides stats in server side. If enabled, they are also delivered to mediasoup-client.
10 |
11 | Currently stats are generated for the following entities:
12 |
13 | * [WebRtcTransport](/documentation/v2/mediasoup/api/#WebRtcTransport)
14 | * [Producer](/documentation/v2/mediasoup/api/#Producer)
15 | * [Consumer](/documentation/v2/mediasoup/api/#Consumer)
16 |
17 | Stats are an Array of Objects.
18 |
19 |
20 | ## Examples
21 |
22 | ### Video consumer stats
23 |
24 | When enabling stats for a `consumer`, received stats look as follows:
25 |
26 | ```js
27 | [
28 | {
29 | bitrate: 126032
30 | byteCount: 3813723
31 | firCount: 0
32 | fractionLost: 0
33 | id: '8nvfesjqo5ntjm3k'
34 | jitter: 17
35 | kind: 'video'
36 | mediaType: 'video'
37 | mimeType: 'video/VP8'
38 | nackCount: 16
39 | packetCount: 4566
40 | packetsDiscarded: 0
41 | packetsLost: 10
42 | packetsRepaired: 8
43 | pliCount: 29
44 | sliCount: 0
45 | ssrc: 3514166852
46 | timestamp: 139426926
47 | type: 'inbound-rtp'
48 | },
49 | {
50 | bitrate: 126032
51 | byteCount: 6025653
52 | firCount: 0
53 | fractionLost: 0
54 | id: 'x2dtpsmtsmnp7dwp'
55 | inboundRtpId: '8nvfesjqo5ntjm3k'
56 | kind: 'video'
57 | mediaType: 'video'
58 | mimeType: 'video/VP8'
59 | nackCount: 17
60 | packetCount: 6431
61 | packetsDiscarded: 0
62 | packetsLost: 38
63 | packetsRepaired: 14
64 | pliCount: 0
65 | roundTripTime: 25
66 | sliCount: 0
67 | ssrc: 93410199
68 | timestamp: 139426926
69 | transportId: 20102291
70 | type: 'outbound-rtp'
71 | }
72 | ]
73 | ```
74 |
75 | Here there is an Array with two Objects, one for the stream being consumed by the `consumer` (with `type: 'outbound-rtp'`) and another with the stats of the associated `producer` (`type: 'inbound-rtp'`). Note that the second one includes a `inboundRtpId: '8nvfesjqo5ntjm3k'` field referencing the associated `producer`'s stats Object within the array.
76 |
77 |
78 | When the `producer` uses simulcast (so it sends N streams with different SSRC values) the stats Object with `type: 'inbound-rtp'` references the stats of the specific inbound stream with same profile ("low", "medium" or "high") that the `consumer` is receiving in that moment.
79 |
80 |
81 |
--------------------------------------------------------------------------------
/documentation/v3/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : v3
3 | ---
4 |
5 |
6 | # v3 Documentation
7 |
8 | ### General
9 |
10 | * [Communication Between Client and Server](/documentation/v3/communication-between-client-and-server/)
11 | * [Scalability](/documentation/v3/scalability/)
12 | * [Tricks](/documentation/v3/tricks/)
13 |
14 | ### mediasoup
15 |
16 | {% include documentation/v3/mediasoup/index.md %}
17 |
18 | ### mediasoup-rust
19 |
20 | Brings the same powerful C++ SFU to the Rust ecosystem, shares design philosophy with Node.js module.
21 |
22 | * [Documentation on docs.rs](https://docs.rs/mediasoup)
23 | * [Crate on crates.io](https://crates.io/crates/mediasoup)
24 |
25 | ### mediasoup-client
26 |
27 | {% include documentation/v3/mediasoup-client/index.md %}
28 |
29 | ### libmediasoupclient
30 |
31 | {% include documentation/v3/libmediasoupclient/index.md %}
32 |
33 | ### mediasoup-client-aiortc
34 |
35 | mediasoup-client handler for [aiortc](https://github.com/aiortc/aiortc/) Python library. Suitable for building Node.js applications that connect to a mediasoup server using WebRTC and exchange real audio, video and DataChannel messages with it in both directions.
36 |
37 | Documentation is exposed in the project [README](https://github.com/versatica/mediasoup-client-aiortc/blob/v3/README.md) file.
38 |
--------------------------------------------------------------------------------
/documentation/v3/libmediasoupclient/api.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : API
3 | anchors : true
4 | apiToc : true
5 | class : h3color
6 | ---
7 |
8 |
9 |
10 | * Will be replaced with the ToC
11 | {: toc}
12 |
13 |
14 |
16 |
17 |
18 | # libmediasoupclient v3 API
19 |
20 | {% include documentation/v3/libmediasoupclient/api/mediasoupclient.md %}
21 |
22 | {% include documentation/v3/libmediasoupclient/api/Device.md %}
23 |
24 | {% include documentation/v3/libmediasoupclient/api/Transport.md %}
25 |
26 | {% include documentation/v3/libmediasoupclient/api/TransportListener.md %}
27 |
28 | {% include documentation/v3/libmediasoupclient/api/SendTransport.md %}
29 |
30 | {% include documentation/v3/libmediasoupclient/api/SendTransportListener.md %}
31 |
32 | {% include documentation/v3/libmediasoupclient/api/RecvTransport.md %}
33 |
34 | {% include documentation/v3/libmediasoupclient/api/RecvTransportListener.md %}
35 |
36 | {% include documentation/v3/libmediasoupclient/api/Producer.md %}
37 |
38 | {% include documentation/v3/libmediasoupclient/api/ProducerListener.md %}
39 |
40 | {% include documentation/v3/libmediasoupclient/api/Consumer.md %}
41 |
42 | {% include documentation/v3/libmediasoupclient/api/ConsumerListener.md %}
43 |
44 | {% include documentation/v3/libmediasoupclient/api/DataProducer.md %}
45 |
46 | {% include documentation/v3/libmediasoupclient/api/DataProducerListener.md %}
47 |
48 | {% include documentation/v3/libmediasoupclient/api/DataConsumer.md %}
49 |
50 | {% include documentation/v3/libmediasoupclient/api/DataConsumerListener.md %}
51 |
52 | {% include documentation/v3/libmediasoupclient/api/Logger.md %}
53 |
54 | {% include documentation/v3/libmediasoupclient/api/LoggerLogHandlerInterface.md %}
55 |
56 | {% include documentation/v3/libmediasoupclient/api/nlohmann-json.md %}
57 |
--------------------------------------------------------------------------------
/documentation/v3/libmediasoupclient/debugging.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Debugging
3 | anchors : true
4 | ---
5 |
6 |
7 | # libmediasoupclient v3 Debugging
8 |
9 |
10 | Take a look to the [Logger](/documentation/v3/libmediasoupclient/api/#Logger) API.
11 |
12 |
--------------------------------------------------------------------------------
/documentation/v3/libmediasoupclient/design.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Design
3 | anchors : true
4 | ---
5 |
6 |
7 | # libmediasoupclient v3 Design
8 |
9 | libmediasoupclient is a C++ library based on [libwebrtc](https://webrtc.org/) for building mediasoup based C++ client side applications.
10 |
11 |
12 | ## Features
13 |
14 | * C++11 low level API.
15 | * Uses [libwebrtc](https://webrtc.org/) as native WebRTC engine.
16 |
17 |
18 | ## libwebrtc API
19 |
20 | The application is responsible of using the API exposed by libwebrtc to create instances of `webrtc::MediaStreamTrackInterface` (audio and video tracks) and use them to feed the API methods of libmediasoupclient.
21 |
22 |
23 | This is: libmediasoupclient does not expose any "track factory" API. The application must use libwebrtc for that.
24 |
25 |
26 |
27 | ## Multi Threading
28 |
29 | libmediasoup client does not implement multi-threading. All API methods marked as `@async` block the current thread until the underlaying operation is terminated. Such underlaying operation can be an operation executed by the libwebrtc stack or an operation executed by the user.
30 |
31 | Examples:
32 |
33 | * [device.GetRtpCapabilities()](/documentation/v3/libmediasoupclient/api/#device-GetRtpCapabilities) blocks the current thread until capabilities are internally retrieved and returns them.
34 | * [sendTransport.Produce()](/documentation/v3/libmediasoupclient/api/#SendTransport-Produce) internally performs SDP offer/answer in the underlaying `RTCPeerConnection` instance and blocks the thread until done.
35 | * The [SendTransport::Listener::OnProduce](/documentation/v3/libmediasoupclient/api/#SendTransportListener-OnProduce) event returns a `std::future` and waits for the application to fulfil it (once it communicates to the server).
36 |
--------------------------------------------------------------------------------
/documentation/v3/libmediasoupclient/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : libmediasoupclient
3 | ---
4 |
5 |
6 | # libmediasoupclient v3 Documentation
7 |
8 | {% include documentation/v3/libmediasoupclient/index.md %}
9 |
--------------------------------------------------------------------------------
/documentation/v3/mediasoup-client/api.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : API
3 | anchors : true
4 | apiToc : true
5 | class : h3color
6 | ---
7 |
8 |
9 |
10 | * Will be replaced with the ToC
11 | {: toc}
12 |
13 |
14 |
16 |
17 |
18 | # mediasoup-client v3 API
19 |
20 | {% include documentation/v3/mediasoup-client/api/mediasoupClient.md %}
21 |
22 | {% include documentation/v3/mediasoup-client/api/Device.md %}
23 |
24 | {% include documentation/v3/mediasoup-client/api/Transport.md %}
25 |
26 | {% include documentation/v3/mediasoup-client/api/Producer.md %}
27 |
28 | {% include documentation/v3/mediasoup-client/api/Consumer.md %}
29 |
30 | {% include documentation/v3/mediasoup-client/api/DataProducer.md %}
31 |
32 | {% include documentation/v3/mediasoup-client/api/DataConsumer.md %}
33 |
34 | {% include documentation/v3/mediasoup-client/api/observer-api.md %}
35 |
--------------------------------------------------------------------------------
/documentation/v3/mediasoup-client/debugging.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Debugging
3 | anchors : true
4 | ---
5 |
6 |
7 | # mediasoup-client v3 Debugging
8 |
9 | * Will be replaced with the ToC
10 | {: toc}
11 |
12 |
13 | ## Log Levels
14 | {: #Log-Level}
15 |
16 | mediasoup-client uses the [debug](https://www.npmjs.com/package/debug) module to log to the browser console.
17 |
18 | There are three log severities:
19 |
20 | * **debug**: verbose information logged to `console.info`
21 | * **warn**: warning messages logged to `console.warn`
22 | * **error**: error messages logged to `console.error`
23 |
24 | All the logs generated by mediasoup-client have a namespace starting with "mediasoup-client" plus colon, followed by the log severity in upper case plus colon (just if "warn" or "error"), and followed by the internal component name (if any) and the log message.
25 |
26 |
27 | ## Enable Logging
28 | {: #Enable-Logging}
29 |
30 | By default logging is turned off. In order to enable it, the `debug` key in the browser's `localStorage` must be set.
31 |
32 |
33 | Check the [debug](https://www.npmjs.com/package/debug) module documentation for further information regarding how to filter specific log messages based on namespace matching rules.
34 |
35 |
36 |
37 | ### Example
38 | {: #Enable-Logging-Example}
39 |
40 | Within the `` section of your HTML app:
41 |
42 | ```html
43 |
46 |
47 |
48 | ```
49 |
--------------------------------------------------------------------------------
/documentation/v3/mediasoup-client/design.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Design
3 | anchors : true
4 | ---
5 |
6 |
7 | # mediasoup-client v3 Design
8 |
9 | mediasoup-client is a JavaScript library for building mediasoup based client side applications (such as web applications). It's a tiny library exposing a powerful cross-browser API and supports all current WebRTC browsers via different [handlers](https://github.com/versatica/mediasoup-client/tree/v3/src/handlers) for each model/version.
10 |
11 |
12 | ## Features
13 |
14 | * ECMAScript low level API.
15 | * Works in the browser and Node.js.
16 |
17 |
18 | There is no native WebRTC or RTP engine in Node.js. When running in Node.js the application must provide mediasoup-client with a custom [handler](/documentation/v3/mediasoup-client/api/#DeviceOptions) to control a 3rd party media/RTP library.
19 |
20 |
--------------------------------------------------------------------------------
/documentation/v3/mediasoup-client/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : mediasoup-client
3 | ---
4 |
5 |
6 | # mediasoup-client v3 Documentation
7 |
8 | {% include documentation/v3/mediasoup-client/index.md %}
9 |
--------------------------------------------------------------------------------
/documentation/v3/mediasoup-client/installation.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Installation
3 | anchors : true
4 | ---
5 |
6 |
7 | # mediasoup-client v3 Installation
8 |
9 | Install mediasoup-client within you client application:
10 |
11 | ```bash
12 | $ npm install mediasoup-client@3
13 | ```
14 |
15 |
16 | ## Usage
17 |
18 | mediasoup-client is written in TypeScript and transpiled to JavaScript plus CommonJS. This is: it uses `require()` internally.
19 |
20 | This makes it work in the browser by properly using [browserify](http://browserify.org), [webpack](https://webpack.js.org) or similar tools, and also in Node.js (which does not yet implement `import`/`export`) . It's up to the application developer to decide how to integrate mediasoup-client into his client side application.
21 |
22 |
23 | mediasoup-client does not provide any bundled, minified and/or ES5 transpiled single file. There are tools out there to do that if your application needs it.
24 |
25 |
26 | Depending on how your web application loads libraries (for example, by using a JavaScript module loader) your may need to use one of the following ways to load mediasoup-client:
27 |
28 | * Using `import`:
29 |
30 | ```javascript
31 | import * as mediasoupClient from "mediasoup-client";
32 | ```
33 |
34 | * Using CommonJS with [browserify](http://browserify.org) or [webpack](https://webpack.github.io):
35 |
36 | ```javascript
37 | const mediasoupClient = require("mediasoup-client");
38 | ```
39 |
--------------------------------------------------------------------------------
/documentation/v3/mediasoup-client/react-native.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : React Native
3 | anchors : true
4 | ---
5 |
6 |
7 | # React Native
8 |
9 | In order to use mediasoup-client in React Native (for building Android and iOS apps):
10 |
11 | - Include [react-native-webrtc](https://www.npmjs.com/package/react-native-webrtc) dependency into your React Native project.
12 | - Call mediasoup-client exposed [registerGlobals()](https://github.com/react-native-webrtc/react-native-webrtc#registerglobals) function **before** creating a mediasoup-client [Device](/documentation/v3/mediasoup-client/api/#Device-constructor) instance.
13 |
14 |
15 | * By calling `registerGlobals()`, classes such as `RTCPeerConnection` and `MediaStream` (among others) will be exposed in the global scope.
16 | * Those classes are required for the `ReactNative` handler (or the new `ReactNativeUnifiedPlan` handler) of mediasoup-client to work.
17 |
18 |
--------------------------------------------------------------------------------
/documentation/v3/mediasoup/api.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : API
3 | anchors : true
4 | apiToc : true
5 | class : h3color
6 | ---
7 |
8 |
9 |
10 | * Will be replaced with the ToC
11 | {: toc}
12 |
13 |
14 |
16 |
17 |
18 | # mediasoup v3 API
19 |
20 | {% include documentation/v3/mediasoup/api/mediasoup.md %}
21 |
22 | {% include documentation/v3/mediasoup/api/Worker.md %}
23 |
24 | {% include documentation/v3/mediasoup/api/Router.md %}
25 |
26 | {% include documentation/v3/mediasoup/api/WebRtcServer.md %}
27 |
28 | {% include documentation/v3/mediasoup/api/Transport.md %}
29 |
30 | {% include documentation/v3/mediasoup/api/WebRtcTransport.md %}
31 |
32 | {% include documentation/v3/mediasoup/api/PlainTransport.md %}
33 |
34 | {% include documentation/v3/mediasoup/api/PipeTransport.md %}
35 |
36 | {% include documentation/v3/mediasoup/api/DirectTransport.md %}
37 |
38 | {% include documentation/v3/mediasoup/api/Producer.md %}
39 |
40 | {% include documentation/v3/mediasoup/api/Consumer.md %}
41 |
42 | {% include documentation/v3/mediasoup/api/DataProducer.md %}
43 |
44 | {% include documentation/v3/mediasoup/api/DataConsumer.md %}
45 |
46 | {% include documentation/v3/mediasoup/api/RtpObserver.md %}
47 |
48 | {% include documentation/v3/mediasoup/api/ActiveSpeakerObserver.md %}
49 |
50 | {% include documentation/v3/mediasoup/api/AudioLevelObserver.md %}
51 |
52 | {% include documentation/v3/mediasoup/api/observer-api.md %}
53 |
--------------------------------------------------------------------------------
/documentation/v3/mediasoup/design.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Design
3 | anchors : true
4 | ---
5 |
6 |
7 | # mediasoup v3 Design
8 |
9 | Unlike other existing SFU implementations, mediasoup is not a standalone server but an unopinionated [Node.js](https://nodejs.org) module which can be integrated into a larger application:
10 |
11 | ```javascript
12 | const mediasoup = require("mediasoup");
13 | ```
14 |
15 | Thus internally, mediasoup can be splitted into two separate components:
16 |
17 | * a JavaScript layer exposing a modern ECMAScript API for Node.js, and
18 | * a set of C/C++ subprocesses that handle the media layer (ICE, DTLS, RTP and so on).
19 |
20 | Both components communicate to each other by means of inter-process communication. However, from the point of view of the developer, the application should just care about the JavaScript API integration.
21 |
22 |
23 | ## Features
24 |
25 | * ECMAScript low level API.
26 | * Multi-stream: multiple audio/video streams over a single ICE + DTLS transport.
27 | * IPv6 ready.
28 | * ICE / DTLS / RTP / RTCP over UDP and TCP.
29 | * Simulcast and SVC support.
30 | * Congestion control.
31 | * Sender and receiver bandwidth estimation with spatial/temporal layers distribution algorithm.
32 | * Extremely powerful (media worker subprocess coded in C++ on top of [libuv](https://libuv.org)).
33 |
34 |
35 | ## Architecture
36 |
37 | {: .full-width }
38 |
--------------------------------------------------------------------------------
/documentation/v3/mediasoup/garbage-collection.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Garbage Collection
3 | anchors : true
4 | ---
5 |
6 |
7 | # Garbage Collection
8 |
9 | Due to its design, the Node.js application is responsible of creating and managing mediasoup objects such as workers, routers, transports, producers and consumers. In summary this means that the application must keep references to those objects, call methods on them, listen for events on them and remove those references when the corresponding object has been closed.
10 |
11 |
12 | ## Closure Actions and Events
13 | {: #closure-actions-and-events}
14 |
15 | The mediasoup [API](/documentation/v3/mediasoup/api/) describes all those actions and events. Here just a summary of them.
16 |
17 | A [Worker](/documentation/v3/mediasoup/api/#Worker) is closed when:
18 |
19 | * `worker.close()` is called, or
20 | * `worker.on("died")` event is fired (emitted when the worker process unexpectedly).
21 |
22 | A [Router](/documentation/v3/mediasoup/api/#Router) is closed when:
23 |
24 | * `router.close()` is called, or
25 | * `router.on("workerclose")` event is fired (emitted when the worker this router belongs to is closed for whatever reason).
26 |
27 | A [Transport](/documentation/v3/mediasoup/api/#Transport) is closed when:
28 |
29 | * `transport.close()` is called, or
30 | * `transport.on("routerclose")` event is fired (emitted when the router this transport belongs to is closed for whatever reason).
31 |
32 | A [Producer](/documentation/v3/mediasoup/api/#Producer) is closed when:
33 |
34 | * `producer.close()` is called, or
35 | * `producer.on("transportclose")` event is fired (emitted when the transport this producer belongs to is closed for whatever reason).
36 |
37 | A [Consumer](/documentation/v3/mediasoup/api/#Consumer) is closed when:
38 |
39 | * `consumer.close()` is called, or
40 | * `consumer.on("transportclose")` event is fired (emitted when the transport this consumer belongs to is closed for whatever reason), or
41 | * `consumer.on("producerclose")` event is fired (emitted when the associated producer is closed for whatever reason).
42 |
43 | A [DataProducer](/documentation/v3/mediasoup/api/#DataProducer) is closed when:
44 |
45 | * `dataProducer.close()` is called, or
46 | * `dataProducer.on("transportclose")` event is fired (emitted when the transport this data producer belongs to is closed for whatever reason).
47 |
48 | A [DataConsumer](/documentation/v3/mediasoup/api/#DataConsumer) is closed when:
49 |
50 | * `dataConsumer.close()` is called, or
51 | * `dataConsumer.on("transportclose")` event is fired (emitted when the transport this data consumer belongs to is closed for whatever reason), or
52 | * `consumer.on("dataproducerclose")` event is fired (emitted when the associated data producer is closed for whatever reason).
53 |
54 | A [RtpObserver](/documentation/v3/mediasoup/api/#RtpObserver) is closed when:
55 |
56 | * `rtpObserver.close()` is called, or
57 | * `rtpObserver.on("routerclose")` event is fired (emitted when the router this RTP observer belongs to is closed for whatever reason).
58 |
59 | When any of these `close()` methods is called or "xxxxxclose" event is emitted, the corresponding mediasoup object becomes "closed" (its `closed` property is `true` from now on) and the application should clean the reference to that object.
60 |
--------------------------------------------------------------------------------
/documentation/v3/mediasoup/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : mediasoup
3 | ---
4 |
5 |
6 | # mediasoup v3 Documentation
7 |
8 | {% include documentation/v3/mediasoup/index.md %}
9 |
--------------------------------------------------------------------------------
/documentation/v3/mediasoup/installation.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Installation
3 | anchors : true
4 | ---
5 |
6 |
7 | # mediasoup v3 Installation
8 |
9 | Install mediasoup via NPM within your Node.js application:
10 |
11 | ```bash
12 | $ npm install mediasoup@3
13 | ```
14 |
15 | During the installation process, the mediasoup NPM package will try to fetch a prebuilt mediasoup-worker binary appropriate for current platform and architecture. If not found, it will locally build the mediasoup-worker binary.
16 |
17 |
18 | * If "MEDIASOUP_SKIP_WORKER_PREBUILT_DOWNLOAD" or "MEDIASOUP_LOCAL_DEV" environment variables are set, or if mediasoup package is being installed via `git+ssh` (instead of via `npm`), and if "MEDIASOUP_FORCE_WORKER_PREBUILT_DOWNLOAD" environment variable is not set, the installation process won't attempt to fetch any prebuilt mediasoup-worker binary and it will build it locally instead.
19 |
20 | ```bash
21 | MEDIASOUP_SKIP_WORKER_PREBUILT_DOWNLOAD="true" npm install mediasoup@3
22 | ```
23 |
24 | * If "MEDIASOUP_WORKER_BIN" environment variable is set during mediasoup package installation, mediasoup will use the the value of such an environment variable as mediasoup-worker binary and **won't** compile it locally. And if same environment variable is set when running your Node.js app, mediasoup will use it as mediasoup-worker binary (instead of looking for it in the `mediasoup/worker/out/Release` path).
25 |
26 | ```bash
27 | MEDIASOUP_WORKER_BIN="/home/xxx/src/foo/mediasoup-worker" npm install mediasoup@3
28 | MEDIASOUP_WORKER_BIN="/home/xxx/src/foo/mediasoup-worker" node myapp.js
29 | ```
30 |
31 |
32 |
33 | ## Requirements
34 |
35 | In order to build the mediasoup C/C++ components the following packages and libraries must be available in the target host:
36 |
37 | ### All Platforms
38 |
39 | * Node.js version >= v20.0.0
40 | * Python version >= 3.7 with PIP
41 |
42 |
43 | Python is only required if no prebuilt mediasoup-worker binary was fetched.
44 |
45 |
46 |
47 | ### Linux, OSX and *NIX Systems
48 |
49 | * `gcc` and `g++` >= 8 or `clang` (with C++17 support)
50 | * `cc` and `c++` commands (symlinks) pointing to the corresponding `gcc`/`g++` or `clang`/`clang++` executables
51 |
52 |
53 | * On Debian and Ubuntu install the `python3-pip` DEB package, otherwise PIP package manager might be unavailable.
54 | * On Debian and Ubuntu install the `build-essential` DEB package. It includes `gcc`/`g++`.
55 | * On YUM based Linux (Red Hat, CentOS) use `yum groupinstall "Development Tools"`.
56 | * On musl based systems (such as Alpine Linux) `linux-headers` package must be installed, otherwise abseil-cpp C++ subproject fails to build due to "linux/futex.h: No such file or directory".
57 |
58 |
59 |
60 | If there is neither `python3` nor `python` command pointing to Python 3 executable, set the `PYTHON` environment variable during mediasoup installation:
61 |
62 | ```bash
63 | $ PYTHON=python3.9 npm install mediasoup@3
64 | ```
65 |
66 |
67 |
68 | If the `MEDIASOUP_MAX_CORES` environment variable is set, the build process will use that number of CPU cores. Otherwise, it will auto-detect the number of cores in the machine.
69 |
70 |
71 |
72 | ### Windows
73 |
74 | * Microsoft Visual Studio environment with MSVC compiler (with C++17 support).
75 |
76 |
77 | * Make sure to have **ISRG Root X1** certificate installed, or you will get errors while downloading OpenSSL (whose website is secured with Let's Encrypt), you can import it from (install to Local computer).
78 | * If you have Python-related errors, search for "App execution aliases" in system settings and disable everything Python-related from there.
79 |
80 |
--------------------------------------------------------------------------------
/documentation/v3/mediasoup/sctp-parameters.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : SCTP Parameters
3 | anchors : true
4 | ---
5 |
6 |
7 | # SCTP Parameters
8 |
9 | * Will be replaced with the ToC
10 | {: toc}
11 |
12 |
13 | ## Dictionaries
14 | {: #Dictionaries}
15 |
16 |
24 |
25 | Field | Type | Description | Required | Default
26 | ---------------- | ------ | ------------- | --------- |
27 | `port` | Number | Must always equal 5000. | Yes |
28 | `OS` | Number | Initially requested number of outgoing SCTP streams. | Yes |
29 | `MIS` | Number | Maximum number of incoming SCTP streams. | Yes |
30 | `maxMessageSize` | Number | Maximum allowed size for SCTP messages. | Yes |
31 |
32 |
33 |
34 | #### NumSctpStreams
35 | {: #NumSctpStreams .code}
36 |
37 |
38 |
39 | Field | Type | Description | Required | Default
40 | ------ | ------ | ------------- | --------- |
41 | `OS` | Number | Initially requested number of outgoing SCTP streams (from 1 to 65535). | No | 1024
42 | `MIS` | Number | Maximum number of incoming SCTP streams (from 1 to 65535). | No | 1024
43 |
44 |
45 |
46 |
47 | Both `OS` and `MIS` are part of the SCTP INIT+ACK handshake. `OS` refers to the initial number of outgoing SCTP streams that the server side transport creates (to be used by [DataConsumers](#DataConsumer)), while `MIS` refers to the maximum number of incoming SCTP streams that the server side transport can receive (to be used by [DataProducers](#DataProducer)). So, if the server side transport will just be used to create data producers (but no data consumers), `OS` can be low (~1). However, if data consumers are desired on the server side transport, `OS` must have a proper value and such a proper value depends on whether the remote endpoint supports `SCTP_ADD_STREAMS` extension or not.
48 |
49 | * libwebrtc (Chrome, Safari, etc) does not enable `SCTP_ADD_STREAMS` so, if data consumers are required, `OS` should be 1024 (the maximum number of DataChannels that libwebrtc enables).
50 | * Firefox does enable `SCTP_ADD_STREAMS` so, if data consumers are required, `OS` can be lower (16 for instance). The mediasoup transport will allocate and announce more outgoing SCTP streams when needed.
51 | * mediasoup-client provides specific per browser/version `OS` and `MIS` values via the [device.sctpCapabilities](/documentation/v3/mediasoup-client/api/#device-sctpCapabilities) getter.
52 |
53 |
54 | #### SctpStreamParameters
55 | {: #SctpStreamParameters .code}
56 |
57 | SCTP stream parameters describe the reliability of a certain SCTP stream.
58 |
59 |
60 |
61 | Field | Type | Description | Required | Default
62 | ------------------ | ------- | ------------- | -------- | ---------
63 | `streamId` | Number | SCTP stream id | true |
64 | `ordered` | Boolean | Whether data messages must be received in order. if true the messages will be sent reliably. | No | true
65 | `maxPacketLifeTime`| Number | When `ordered` is false indicates the time (in milliseconds) after which a SCTP packet will stop being retransmitted. | No |
66 | `maxRetransmits`| Number | When `ordered` is false indicates the maximum number of times a packet will be retransmitted. | No |
67 |
68 |
69 |
70 |
71 | * If `ordered` is true then `maxPacketLifeTime` and `maxRetransmits` must be false.
72 |
73 | * If `ordered` if false, only one of `maxPacketLifeTime` or `maxRetransmits` can be true.
74 |
75 |
76 |
26 |
27 | Field | Type | Description | Required | Default
28 | --------------| ------ | ------------- | --------- |
29 | `cryptoSuite` | [SrtpCryptoSuite](#SrtpCryptoSuite) | Encryption and authentication transforms to be used. | Yes |
30 | `keyBase64` | String | SRTP keying material (master key and salt) in Base64. | Yes |
31 |
32 |
33 |
34 |
46 |
47 | Value | Description
48 | ------------------------- | -------------
49 | "AEAD_AES_256_GCM" | It requires SRTP keying material of 44 bytes (60 bytes in Base64).
50 | "AEAD_AES_128_GCM" | It requires SRTP keying material of 28 bytes (40 bytes in Base64).
51 | "AES_CM_128_HMAC_SHA1_80" | It requires SRTP keying material of 30 bytes (40 bytes in Base64).
52 | "AES_CM_128_HMAC_SHA1_32" | It requires SRTP keying material of 30 bytes (40 bytes in Base64).
53 |
54 |
55 |
56 |
49 | Those are just some of the libraries/SDKs that exist. Not all them are covered here.
50 |
51 |
52 | ##### [ethand91/mediasoup-ios-client](https://github.com/ethand91/mediasoup-ios-client)
53 |
54 | Objective-C wrapper library for libmediasoupclient for building mediasoup based **native** iOS based applications.
55 |
56 | ##### [VLprojects/mediasoup-ios-client](https://github.com/VLprojects/mediasoup-ios-client)
57 |
58 | Objective-C wrapper library for libmediasoupclient for building mediasoup iOS based applications.
59 |
60 | A more updated fock of ethand91/mediasoup-ios-client.
61 |
62 | ##### [VLprojects/mediasoup-client-swift](https://github.com/VLprojects/mediasoup-client-swift)
63 |
64 | Swift wrapper for libmediasoupclient with iOS support.
65 |
66 | ##### [haiyangwu/mediasoup-client-android](https://github.com/haiyangwu/mediasoup-client-android)
67 |
68 | Java wrapper library for libmediasoupclient for building mediasoup based **native** Android based applications.
69 |
70 | ##### [haiyangwu/mediasoup-demo-android](https://github.com/haiyangwu/mediasoup-demo-android)
71 |
72 | mediasoup-client-android based Android app to connect to the [mediasoup demo](https://demo.mediasoup.org).
73 |
74 |
75 | ## Examples
76 |
77 | Check out some projects and examples using mediasoup, mediasoup-client and libmediasoup client in the [Examples](/documentation/examples/) section.
78 |
--------------------------------------------------------------------------------
/images/arrow-up.svg:
--------------------------------------------------------------------------------
1 |
2 |
45 |
--------------------------------------------------------------------------------
/images/checkbox-off-white.svg:
--------------------------------------------------------------------------------
1 |
2 |
56 |
--------------------------------------------------------------------------------
/images/checkbox-on.svg:
--------------------------------------------------------------------------------
1 |
2 |
61 |
--------------------------------------------------------------------------------
/images/close.svg:
--------------------------------------------------------------------------------
1 |
2 |
45 |
--------------------------------------------------------------------------------
/images/ibc.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/versatica/mediasoup-website/462064b0011f50a9b668f48f680270e2aa48ee7d/images/ibc.jpg
--------------------------------------------------------------------------------
/images/icon-bug.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/images/icon-github.svg:
--------------------------------------------------------------------------------
1 |
2 |
40 |
--------------------------------------------------------------------------------
/images/icon-help.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/images/icon-linkedin.svg:
--------------------------------------------------------------------------------
1 |
2 |
40 |
--------------------------------------------------------------------------------
/images/icon-twitter.svg:
--------------------------------------------------------------------------------
1 |
2 |
40 |
--------------------------------------------------------------------------------
/images/icon-upwork.svg:
--------------------------------------------------------------------------------
1 |
2 |
36 |
--------------------------------------------------------------------------------
/images/icon-website.svg:
--------------------------------------------------------------------------------
1 |
2 |
45 |
--------------------------------------------------------------------------------
/images/jmillan.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/versatica/mediasoup-website/462064b0011f50a9b668f48f680270e2aa48ee7d/images/jmillan.jpg
--------------------------------------------------------------------------------
/images/mediasoup-banner.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/versatica/mediasoup-website/462064b0011f50a9b668f48f680270e2aa48ee7d/images/mediasoup-banner.png
--------------------------------------------------------------------------------
/images/menu-white.svg:
--------------------------------------------------------------------------------
1 |
2 |
55 |
--------------------------------------------------------------------------------
/images/menu.svg:
--------------------------------------------------------------------------------
1 |
2 |
55 |
--------------------------------------------------------------------------------
/images/nazar.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/versatica/mediasoup-website/462064b0011f50a9b668f48f680270e2aa48ee7d/images/nazar.jpg
--------------------------------------------------------------------------------
/images/toc.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/lib/anchors.js:
--------------------------------------------------------------------------------
1 | const AnchorJS = require('anchor-js');
2 |
3 | const anchorjs = new AnchorJS();
4 |
5 | module.exports = () =>
6 | {
7 | anchorjs.add('.content h2, .content h3, .content h4');
8 | };
9 |
--------------------------------------------------------------------------------
/lib/apiToc.js:
--------------------------------------------------------------------------------
1 | const hammerjs = require('hammerjs');
2 | const dontscrollthebody = require('dontscrollthebody');
3 |
4 | module.exports = () =>
5 | {
6 | const tocButton = document.querySelector('.api-toc-button');
7 | const toc = document.querySelector('.api-toc-wrapper');
8 | const tocUl = toc.children[0];
9 | const transitionDuration = 200;
10 | let isTocVisible = false;
11 | const tocButtonHammer = new hammerjs.Manager(tocButton);
12 | const tocHammer = new hammerjs.Manager(toc);
13 |
14 | tocButtonHammer.add(new hammerjs.Pan(
15 | {
16 | threshold : 30,
17 | direction : hammerjs.DIRECTION_LEFT
18 | }));
19 |
20 | tocHammer.add(new hammerjs.Pan(
21 | {
22 | threshold : 30,
23 | direction : hammerjs.DIRECTION_RIGHT
24 | }));
25 |
26 | if (!CSS.supports || !CSS.supports('overscroll-behavior', 'contain'))
27 | dontscrollthebody(toc);
28 |
29 | document.addEventListener('click', (event) =>
30 | {
31 | if (tocButton.contains(event.target))
32 | {
33 | if (!isTocVisible)
34 | showToc();
35 | else
36 | hideToc();
37 | }
38 | else if (!toc.contains(event.target))
39 | {
40 | hideToc();
41 | }
42 | });
43 |
44 | // ESC key hides the TOC panel.
45 | document.addEventListener('keydown', (event) =>
46 | {
47 | if (event.keyCode === 27)
48 | hideToc();
49 | });
50 |
51 | tocButtonHammer.on('panleft', () => showToc());
52 |
53 | tocHammer.on('panright', () => hideToc());
54 |
55 | function showToc()
56 | {
57 | if (isTocVisible)
58 | return;
59 |
60 | isTocVisible = true;
61 | toc.classList.add('visible');
62 | }
63 |
64 | function hideToc()
65 | {
66 | if (!isTocVisible)
67 | return;
68 |
69 | isTocVisible = false;
70 | toc.classList.remove('visible');
71 | }
72 | };
73 |
--------------------------------------------------------------------------------
/lib/arrowUp.js:
--------------------------------------------------------------------------------
1 | module.exports = () =>
2 | {
3 | const arrow = document.querySelector('.arrow-up');
4 | let isVisible = false;
5 | let elem;
6 | let startTime = new Date();
7 | const interval = 1000;
8 | let timer;
9 |
10 | if (!arrow)
11 | return;
12 |
13 | function checkScroll()
14 | {
15 | const scrollHeight = elem.scrollHeight;
16 | const visibleHeight = elem.offsetHeight;
17 | const scrollTop = elem.scrollTop;
18 |
19 | // Reset timer.
20 | clearTimeout(timer);
21 | timer = null;
22 |
23 | if (
24 | scrollTop > visibleHeight &&
25 | (scrollTop + visibleHeight < scrollHeight - 100)
26 | )
27 | {
28 | if (!isVisible)
29 | {
30 | isVisible = true;
31 | arrow.classList.add('visible');
32 | }
33 | }
34 | else
35 | {
36 | if (isVisible)
37 | {
38 | isVisible = false;
39 | arrow.classList.remove('visible');
40 | }
41 | }
42 | }
43 |
44 | document.addEventListener('scroll', () =>
45 | {
46 | if (!elem)
47 | {
48 | // Hack: https://miketaylr.com/posts/2014/11/document-body-scrolltop.html
49 | if (document.documentElement && document.documentElement.scrollTop)
50 | elem = document.documentElement;
51 | else if (document.body.parentNode && document.body.parentNode.scrollTop)
52 | elem = document.body.parentNode;
53 | else if (document.body.scrollTop)
54 | elem = document.body;
55 |
56 | if (!elem)
57 | return;
58 | }
59 |
60 | // Check interval.
61 | const now = new Date();
62 |
63 | if (now - startTime >= interval)
64 | {
65 | startTime = now;
66 | checkScroll();
67 | }
68 | else
69 | {
70 | if (!timer)
71 | {
72 | timer = setTimeout(() =>
73 | {
74 | if (!timer)
75 | return;
76 |
77 | checkScroll();
78 | }, interval * 1.5);
79 | }
80 |
81 | return;
82 | }
83 | }, { passive: true });
84 |
85 | arrow.addEventListener('click', () =>
86 | {
87 | // Hack: https://miketaylr.com/posts/2014/11/document-body-scrolltop.html
88 | const d = document;
89 |
90 | if (d.documentElement && d.documentElement.scrollTop)
91 | d.documentElement.scrollTop = 0;
92 | else if (d.body.parentNode && d.body.parentNode.scrollTop)
93 | d.body.parentNode.scrollTop = 0;
94 | else if (d.body && d.body.scrollTop)
95 | d.body.scrollTop = 0;
96 | });
97 | };
98 |
--------------------------------------------------------------------------------
/lib/index.js:
--------------------------------------------------------------------------------
1 | const domready = require('domready');
2 | const loading = require('./loading');
3 | const shields = require('./shields');
4 | const menu = require('./menu');
5 | const arrowUp = require('./arrowUp');
6 | const anchors = require('./anchors');
7 | const apiToc = require('./apiToc');
8 | // const piwik = require('./piwik');
9 |
10 | domready(() =>
11 | {
12 | loading();
13 | shields();
14 | menu();
15 | arrowUp();
16 |
17 | // Set anchors if requested.
18 | if (window.siteSettings.anchors)
19 | anchors();
20 |
21 | // Set API TOC if requested.
22 | if (window.siteSettings.apiToc)
23 | apiToc();
24 |
25 | // Set Piwik.
26 | // piwik();
27 | });
28 |
--------------------------------------------------------------------------------
/lib/loading.js:
--------------------------------------------------------------------------------
1 | module.exports = () =>
2 | {
3 | // Hack for iOS devices.
4 | const iOS = /iPad|iPhone|iPod/.test(navigator.userAgent) && !window.MSStream;
5 |
6 | if (iOS)
7 | {
8 | document.body.classList.add('ios');
9 |
10 | const header = document.querySelector('body > .header')
11 |
12 | if (header)
13 | header.classList.add('ios');
14 | }
15 |
16 | // Transition for 'loading' elements.
17 | const elems = document.querySelectorAll('.loading');
18 |
19 | for (let i = 0, len = elems.length; i < len; ++i)
20 | {
21 | const element = elems[i];
22 |
23 | (function(elem)
24 | {
25 | elem.classList.remove('loading');
26 | elem.addEventListener('transitionend', loaded);
27 |
28 | function loaded()
29 | {
30 | elem.removeEventListener('transitionend', loaded);
31 | elem.classList.add('loaded');
32 | }
33 | })(element);
34 | }
35 | };
36 |
--------------------------------------------------------------------------------
/lib/menu.js:
--------------------------------------------------------------------------------
1 | const hammerjs = require('hammerjs');
2 | const dontscrollthebody = require('dontscrollthebody');
3 |
4 | module.exports = () =>
5 | {
6 | const menuButton = document.querySelector('.menu-button');
7 | const footerMore = document.querySelector('.footer-more');
8 | const menu = document.querySelector('.menu');
9 | const menuClose = menu.querySelector('.close');
10 | let isVisible = false;
11 | const hammer = new hammerjs.Manager(menu);
12 |
13 | hammer.add(new hammerjs.Pan({ threshold: 15 }));
14 |
15 | if (!CSS.supports || !CSS.supports('overscroll-behavior', 'contain'))
16 | dontscrollthebody(menu);
17 |
18 | document.addEventListener('click', (event) =>
19 | {
20 | if (menuButton.contains(event.target))
21 | {
22 | showMenu();
23 | }
24 | else if (footerMore.contains(event.target))
25 | {
26 | event.preventDefault();
27 |
28 | if (!isVisible)
29 | showMenu();
30 | else
31 | hideMenu();
32 | }
33 | else if (!menu.contains(event.target))
34 | {
35 | hideMenu();
36 | }
37 | });
38 |
39 | menuClose.addEventListener('click', hideMenu);
40 |
41 | // ESC key hides the menu.
42 | document.addEventListener('keydown', (event) =>
43 | {
44 | if (event.keyCode === 27)
45 | hideMenu();
46 | });
47 |
48 | hammer.on('panright', () => hideMenu());
49 |
50 | function showMenu()
51 | {
52 | if (isVisible)
53 | return;
54 |
55 | isVisible = true;
56 | menu.classList.add('visible');
57 | menuButton.classList.add('hidden');
58 | }
59 |
60 | function hideMenu()
61 | {
62 | if (!isVisible)
63 | return;
64 |
65 | isVisible = false;
66 | menu.classList.remove('visible');
67 | menuButton.classList.remove('hidden');
68 | }
69 | };
70 |
--------------------------------------------------------------------------------
/lib/piwik.js:
--------------------------------------------------------------------------------
1 | module.exports = () =>
2 | {
3 | const _paq = _paq || [];
4 |
5 | _paq.push(['trackPageView']);
6 | _paq.push(['enableLinkTracking']);
7 |
8 | const u = (('https:' == document.location.protocol) ? 'https' : 'http') + '://private.versatica.com/piwik/';
9 |
10 | _paq.push(['setTrackerUrl', u+'piwik.php']);
11 | _paq.push(['setSiteId', 8]);
12 |
13 | const d = document;
14 | const g = d.createElement('script');
15 | const s = d.getElementsByTagName('script')[0];
16 |
17 | g.type = 'text/javascript';
18 | g.defer = true;
19 | g.async = true;
20 | g.src = u+'piwik.js';
21 | s.parentNode.insertBefore(g, s);
22 | };
23 |
--------------------------------------------------------------------------------
/lib/shields.js:
--------------------------------------------------------------------------------
1 | module.exports = () =>
2 | {
3 | const shields = document.querySelectorAll('.shield img');
4 |
5 | shields.forEach((shield) =>
6 | {
7 | shield.src = shield.dataset.canonicalSrc;
8 | });
9 | };
10 |
11 |
12 |
--------------------------------------------------------------------------------
/license.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : License
3 | ---
4 |
5 |
6 | # ISC License
7 |
8 | Copyright © 2015, Iñaki Baz Castillo <ibc@aliax.net>
9 |
10 | Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
11 |
12 | THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
13 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "mediasoup-website",
3 | "version": "3.0.0",
4 | "private": true,
5 | "description": "mediasoup website",
6 | "main": "lib/index.js",
7 | "homepage": "https://mediasoup.org",
8 | "repository": {
9 | "type": "git",
10 | "url": "https://github.com/versatica/mediasoup-website.git"
11 | },
12 | "author": "Iñaki Baz Castillo
39 | This is a donation. No goods or services are expected in return. Any requests for refunds for those purposes will be rejected.
40 |
41 |
42 |
43 | ## Sponsors
44 |
45 | Check the list of individuals and organizations already contributing to mediasoup in Open Collective:
46 |
47 | * [opencollective.com/mediasoup](https://opencollective.com/mediasoup#section-contributors)
48 |
--------------------------------------------------------------------------------
/support.md:
--------------------------------------------------------------------------------
1 | ---
2 | title : Support
3 | anchors : true
4 | ---
5 |
6 |
7 | # Support
8 |
9 | mediasoup is an Open Source project supported on a best effort basis. Before asking any questions, please check the [documentation](/documentation/) and the [F.A.Q.](/faq/) (the response may be there).
10 |
11 |
12 | ### Questions and Doubts
13 |
14 |
28 |
29 |
30 | ### Bug Reports and Feature Requests
31 |
32 |
48 |
49 |
50 | Please do **NOT** open an issue in GitHub for questions or doubts. Use the **[mediasoup Discourse Group][mediasoup-discourse-group]** instead.
51 |
52 |
53 | #### Crashes in mediasoup (get a core dump)
54 |
55 | If you get a crash in mediasoup server, this is, if you get an error log as follows:
56 |
57 | ```
58 | 2020-01-06T16:02:57.965Z mediasoup:ERROR:Worker worker process died unexpectedly [pid:22, code:null, signal:SIGABRT]
59 | ```
60 |
61 | or if the [worker.on("died")](/documentation/v3/mediasoup/api/#worker-on-died) event fires, this is a bug in mediasoup that should not happen.
62 |
63 | If so, please report the issue in [GitHub][mediasoup-github-issues] and also enable core dumps in your host.
64 |
65 | ##### Enabling core dumps in Linux
66 |
67 | If you run mediasoup in Linux, do the following **before** running your mediasoup application again:
68 |
69 | ```bash
70 | $ mkdir /tmp/cores
71 | $ chmod 777 /tmp/cores
72 | $ echo "/tmp/cores/core.%e.sig%s.%p" > /proc/sys/kernel/core_pattern
73 | $ ulimit -c unlimited
74 | ```
75 |
76 | Then run your mediasoup application. If the crash happens again you should get a core dump in the `/tmp/cores` folder. Open it with `gdb` and attach it into the issue reported in GitHub:
77 |
78 | ```bash
79 | $ gdb PATH_TO_YOUR_NODE_APP/node_modules/mediasoup/worker/out/Release/mediasoup-worker PATH_TO_COREFILE
80 | ```
81 |
82 | Then, within the `gdb` terminal:
83 |
84 | ```bash
85 | gdb> bt full
86 | ```
87 |
88 | ##### Enabling core dumps in OSX
89 |
90 | Crashing processes in OSX automatically got a crash report in `/Users/USER/Library/Logs/DiagnosticReports` folder.
91 |
92 | ##### Forcing a core dump or crash report
93 |
94 | You can check whether your setup works by manually generating one as follows:
95 |
96 | ```bash
97 | $ pidof mediasoup-worker
98 | 46717 46718 46719 46720
99 |
100 | $ kill -s SIGSEGV 46717
101 | ```
102 |
103 | Then check the generated core dump or crash report file in the corresponding folder.
104 |
105 |
106 |
107 |
108 | [mediasoup-discourse-group]:https://mediasoup.discourse.group
109 | [mediasoup-google-group]: https://groups.google.com/forum/#!forum/mediasoup
110 | [mediasoup-github-issues]: https://github.com/versatica/mediasoup/issues
111 | [mediasoup-client-github-issues]: https://github.com/versatica/mediasoup-client/issues
112 | [libmediasoupclient-github-issues]: https://github.com/versatica/libmediasoupclient/issues
113 |
--------------------------------------------------------------------------------