Add description of DTX purpose (#302)

* Add description of DTX purpose Fix typos & update docs * Remove extre * from index.d.ts * Change setDTX description
millicast · Jan 15, 2024 · 32c308e · 32c308e
1 parent b39fc9a
commit 32c308e
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/packages/millicast-sdk/src/types/index.d.ts b/packages/millicast-sdk/src/types/index.d.ts
@@ -601,7 +601,7 @@ declare module '@millicast/sdk' {
      * Get the SDP modified depending the options. Optionally set the SDP information to local peer.
      * @param {Object} options
      * @param {Boolean} options.stereo - True to modify SDP for support stereo. Otherwise False.
-     * @param {Boolean} options.dtx - True to modify SDP for supporting dtx in opus. Otherwise False.*
+     * @param {Boolean} options.dtx - True to modify SDP for supporting dtx in opus. Otherwise False.
      * @param {MediaStream|Array<MediaStreamTrack>} options.mediaStream - MediaStream to offer in a stream. This object must have
      * 1 audio track and 1 video track, or at least one of them. Alternative you can provide both tracks in an array.
      * @param {VideoCodec} options.codec - Selected codec for support simulcast.

diff --git a/packages/millicast-sdk/src/utils/SdpParser.js b/packages/millicast-sdk/src/utils/SdpParser.js
@@ -103,7 +103,7 @@ export default class SdpParser {
   }
 
   /**
-   * Parse SDP for support dtx.
+   * Set DTX (Discontinuous Transmission) to the connection. Advanced configuration of the opus audio codec that allows for a large reduction in the audio traffic. For example, when a participant is silent, the audio packets won't be transmitted.
    * @param {String} sdp - Current SDP.
    * @returns {String} SDP parsed with dtx support.
    * @example SdpParser.setDTX(sdp)
@@ -122,7 +122,7 @@ export default class SdpParser {
   /**
    * Mangle SDP for adding absolute capture time header extension.
    * @param {String} sdp - Current SDP.
-   * @returns {String} SDP mungled with abs-catpure-time header extension.
+   * @returns {String} SDP mungled with abs-capture-time header extension.
    * @example SdpParser.setAbsoluteCaptureTime(sdp)
    */
   static setAbsoluteCaptureTime (sdp) {
@@ -142,7 +142,7 @@ export default class SdpParser {
   /**
    * Mangle SDP for adding dependency descriptor header extension.
    * @param {String} sdp - Current SDP.
-   * @returns {String} SDP mungled with abs-catpure-time header extension.
+   * @returns {String} SDP mungled with abs-capture-time header extension.
    * @example SdpParser.setAbsoluteCaptureTime(sdp)
    */
   static setDependencyDescriptor (sdp) {

diff --git a/packages/millicast-sdk/tests/features/SdpAbsCaptureTime.feature b/packages/millicast-sdk/tests/features/SdpAbsCaptureTime.feature
@@ -1,4 +1,4 @@
-Feature: As a user I want to mungle my SDP for adding the absolute catpure time header extension so I can offer what I need to my peer
+Feature: As a user I want to mungle my SDP for adding the absolute capture time header extension so I can offer what I need to my peer
 
   Scenario: Set abs-capture-time
     Given a local sdp without the header extension