fix(srt): review deprecated API for SRT

ThibaultBee · Dec 26, 2023 · 28fc611 · 28fc611
1 parent 96f777e
commit 28fc611
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 26 deletions.
diff --git a/.../src/main/java/io/github/thibaultbee/streampack/ext/srt/internal/endpoints/SrtProducer.kt b/.../src/main/java/io/github/thibaultbee/streampack/ext/srt/internal/endpoints/SrtProducer.kt
@@ -47,33 +47,33 @@ class SrtProducer(
     /**
      * Get/set SRT stream ID
      */
-    @Deprecated("Use SrtConnectionDescriptor.streamId instead")
     var streamId: String
         get() = socket.getSockFlag(SockOpt.STREAMID) as String
+        @Deprecated("Use SrtConnectionDescriptor.streamId instead")
         set(value) = socket.setSockFlag(SockOpt.STREAMID, value)
 
     /**
      * Get/set SRT stream passPhrase
      * It is a set only parameter, so getting the value throws an exception.
      */
-    @Deprecated("Use SrtConnectionDescriptor.passPhrase instead")
     var passPhrase: String
         get() = socket.getSockFlag(SockOpt.PASSPHRASE) as String
+        @Deprecated("Use SrtConnectionDescriptor.passPhrase instead")
         set(value) = socket.setSockFlag(SockOpt.PASSPHRASE, value)
 
     /**
      * Get/set bidirectional latency in milliseconds
      */
     var latency: Int
         get() = socket.getSockFlag(SockOpt.LATENCY) as Int
-        internal set(value) = socket.setSockFlag(SockOpt.LATENCY, value)
+        private set(value) = socket.setSockFlag(SockOpt.LATENCY, value)
 
     /**
      * Get/set connection timeout in milliseconds
      */
     var connectionTimeout: Int
         get() = socket.getSockFlag(SockOpt.CONNTIMEO) as Int
-        internal set(value) = socket.setSockFlag(SockOpt.CONNTIMEO, value)
+        private set(value) = socket.setSockFlag(SockOpt.CONNTIMEO, value)
 
     /**
      * Get SRT stats

diff --git a/.../main/java/io/github/thibaultbee/streampack/ext/srt/streamers/AudioOnlySrtLiveStreamer.kt b/.../main/java/io/github/thibaultbee/streampack/ext/srt/streamers/AudioOnlySrtLiveStreamer.kt
@@ -63,6 +63,10 @@ class AudioOnlySrtLiveStreamer(
         /**
          * @param value stream ID
          */
+        @Deprecated(
+            "Use the new connect(SrtConnectionDescriptor) method",
+            replaceWith = ReplaceWith("connect(SrtConnectionDescriptor)")
+        )
         set(value) {
             srtProducer.streamId = value
         }
@@ -80,6 +84,10 @@ class AudioOnlySrtLiveStreamer(
         /**
          * @param value passphrase
          */
+        @Deprecated(
+            "Use the new connect(SrtConnectionDescriptor) method",
+            replaceWith = ReplaceWith("connect(SrtConnectionDescriptor)")
+        )
         set(value) {
             srtProducer.passPhrase = value
         }
@@ -88,18 +96,12 @@ class AudioOnlySrtLiveStreamer(
      * Get/set bidirectional latency in milliseconds.
      * **See:** [SRT Socket Options](https://github.com/Haivision/srt/blob/master/docs/API/API-socket-options.md#SRTO_LATENCY)
      */
-    override var latency: Int
+    override val latency: Int
         /**
          * Get latency in milliseconds
          * @return latency
          */
         get() = srtProducer.latency
-        /**
-         * @param value latency in milliseconds
-         */
-        set(value) {
-            srtProducer.latency = value
-        }
 
     /**
      * Connect to an SRT server with correct Live streaming parameters.

diff --git a/...src/main/java/io/github/thibaultbee/streampack/ext/srt/streamers/CameraSrtLiveStreamer.kt b/...src/main/java/io/github/thibaultbee/streampack/ext/srt/streamers/CameraSrtLiveStreamer.kt
@@ -95,6 +95,10 @@ class CameraSrtLiveStreamer(
         /**
          * @param value stream ID
          */
+        @Deprecated(
+            "Use the new connect(SrtConnectionDescriptor) method",
+            replaceWith = ReplaceWith("connect(SrtConnectionDescriptor)")
+        )
         set(value) {
             srtProducer.streamId = value
         }
@@ -112,6 +116,10 @@ class CameraSrtLiveStreamer(
         /**
          * @param value passphrase
          */
+        @Deprecated(
+            "Use the new connect(SrtConnectionDescriptor) method",
+            replaceWith = ReplaceWith("connect(SrtConnectionDescriptor)")
+        )
         set(value) {
             srtProducer.passPhrase = value
         }
@@ -120,18 +128,12 @@ class CameraSrtLiveStreamer(
      * Get/set bidirectional latency in milliseconds.
      * **See:** [SRT Socket Options](https://github.com/Haivision/srt/blob/master/docs/API/API-socket-options.md#SRTO_LATENCY)
      */
-    override var latency: Int
+    override val latency: Int
         /**
          * Get latency in milliseconds
          * @return latency
          */
         get() = srtProducer.latency
-        /**
-         * @param value latency in milliseconds
-         */
-        set(value) {
-            srtProducer.latency = value
-        }
 
     /**
      * Connect to an SRT server with correct Live streaming parameters.

diff --git a/.../java/io/github/thibaultbee/streampack/ext/srt/streamers/ScreenRecorderSrtLiveStreamer.kt b/.../java/io/github/thibaultbee/streampack/ext/srt/streamers/ScreenRecorderSrtLiveStreamer.kt
@@ -101,6 +101,10 @@ class ScreenRecorderSrtLiveStreamer(
         /**
          * @param value stream ID
          */
+        @Deprecated(
+            "Use the new connect(SrtConnectionDescriptor) method",
+            replaceWith = ReplaceWith("connect(SrtConnectionDescriptor)")
+        )
         set(value) {
             srtProducer.streamId = value
         }
@@ -118,6 +122,10 @@ class ScreenRecorderSrtLiveStreamer(
         /**
          * @param value passphrase
          */
+        @Deprecated(
+            "Use the new connect(SrtConnectionDescriptor) method",
+            replaceWith = ReplaceWith("connect(SrtConnectionDescriptor)")
+        )
         set(value) {
             srtProducer.passPhrase = value
         }
@@ -126,18 +134,12 @@ class ScreenRecorderSrtLiveStreamer(
      * Get/set bidirectional latency in milliseconds.
      * **See:** [SRT Socket Options](https://github.com/Haivision/srt/blob/master/docs/API/API-socket-options.md#SRTO_LATENCY)
      */
-    override var latency: Int
+    override val latency: Int
         /**
          * Get latency in milliseconds
          * @return latency
          */
         get() = srtProducer.latency
-        /**
-         * @param value latency in milliseconds
-         */
-        set(value) {
-            srtProducer.latency = value
-        }
 
     /**
      * Connect to an SRT server with correct Live streaming parameters.

diff --git a/...in/java/io/github/thibaultbee/streampack/ext/srt/streamers/interfaces/ISrtLiveStreamer.kt b/...in/java/io/github/thibaultbee/streampack/ext/srt/streamers/interfaces/ISrtLiveStreamer.kt
@@ -32,7 +32,7 @@ interface ISrtLiveStreamer : ILiveStreamer {
     /**
      * Get/set bidirectional latency in milliseconds.
      */
-    var latency: Int
+    val latency: Int
 
     /**
      * Connect to a remote server.