From f2b5df0a418df10fa180f73443f1656505f2f42d Mon Sep 17 00:00:00 2001 From: Donat Zenichev Date: Wed, 20 Nov 2024 17:11:27 +0100 Subject: [PATCH] MT#56465 docs: add description of `sdp-media-remove` Adds a documentation for the newly introduced flag `sdp-media-remove`. Change-Id: If0ee01c77c6b1feb11d6df28965e4ce9f0790738 --- docs/ng_control_protocol.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/ng_control_protocol.md b/docs/ng_control_protocol.md index b90bd7b0a..c2bd76c8d 100644 --- a/docs/ng_control_protocol.md +++ b/docs/ng_control_protocol.md @@ -1570,6 +1570,32 @@ Example response: { "result": "ok", "sdp": "v=0\r\no=..." } +**Optionally included SDP media manipulations:** + +`sdp-media-remove` contains a list pointing, which media types are to be removed from SDP. + +This does affect an outgoing SDP offer. So it's meant to manipulate an SDP body, +which rtpengine generates during the offer processing. The removed media type will be then +not taken into consideration during further processing. + +When this flag is added, rtpengine will not show concerned media type(s), hence media section(s) +to the recipient's side. Therefore, later on the recipient side will provide only an answer +for those media section(s) shown to it. + +Upon processing such an answer coming back to the changed SDP offer, +rtpengine will just add a zeroed media towards the originator's side in order to fulfill RFC +requirements telling to use a zeroed media for those unaccepted media sections. + +Usage syntax: + + "sdp-media-remove" : ["", "", ...] + +Examples: + +* Remove all occurences of the video media type: + + "sdp-media-remove" : ["video"] + ## `answer` Message The `answer` message is identical to the `offer` message, with the additional requirement that the