From 39b2b56a1f118f41dbe2da2f9f709ef9a3a788c2 Mon Sep 17 00:00:00 2001
From: Ghamza-Jd <hamzah.jadeed@gmail.com>
Date: Sat, 12 Oct 2024 00:35:04 +0300
Subject: [PATCH] fix: added forgotten fields and docs

---
 jarust_plugins/src/audio_bridge/params.rs |  4 ++--
 jarust_plugins/src/streaming/params.rs    |  1 +
 jarust_plugins/src/video_room/params.rs   | 27 ++++++++++++++++++-----
 3 files changed, 24 insertions(+), 8 deletions(-)

diff --git a/jarust_plugins/src/audio_bridge/params.rs b/jarust_plugins/src/audio_bridge/params.rs
index d8697a7..34311f5 100644
--- a/jarust_plugins/src/audio_bridge/params.rs
+++ b/jarust_plugins/src/audio_bridge/params.rs
@@ -108,10 +108,10 @@ make_dto!(
         bitrate: u64,
         /// 0-10, Opus-related complexity to use, the higher the value, the better the quality (but more CPU); default is 4
         quality: u64,
-        /// 0-20, a percentage of the expected loss (capped at 20%), only needed in case FEC is used; optional,
+        /// 0-20, a percentage of the expected loss (capped at 20%), only needed in case FEC is used,
         /// default is 0 (FEC disabled even when negotiated) or the room default
         expected_loss: u64,
-        /// Percent value, <100 reduces volume, >100 increases volume; optional, default is 100 (no volume change)
+        /// Percent value, <100 reduces volume, >100 increases volume, default is 100 (no volume change)
         volume: u64,
         /// In case spatial audio is enabled for the room, panning of this participant (0=left, 50=center, 100=right)
         spatial_position: String,
diff --git a/jarust_plugins/src/streaming/params.rs b/jarust_plugins/src/streaming/params.rs
index 557f53a..83316a4 100644
--- a/jarust_plugins/src/streaming/params.rs
+++ b/jarust_plugins/src/streaming/params.rs
@@ -10,6 +10,7 @@ make_dto!(
         mountpoint_type: StreamingMountpointType
     },
     optional {
+        admin_key: String,
         id: JanusId,
         name: String,
         description: String,
diff --git a/jarust_plugins/src/video_room/params.rs b/jarust_plugins/src/video_room/params.rs
index 1fa49bf..5d0f09a 100644
--- a/jarust_plugins/src/video_room/params.rs
+++ b/jarust_plugins/src/video_room/params.rs
@@ -154,6 +154,9 @@ make_dto!(
         room: JanusId
     },
     optional {
+        /// unique ID to register for the publisher;
+        /// optional, will be chosen by the plugin if missing
+        id: String,
         /// display name for the publisher
         display: String,
         /// invitation token, in case the room has an ACL
@@ -272,14 +275,24 @@ make_dto!(
 );
 
 make_dto!(VideoRoomConfigurePublisherParams, optional {
+    /// bitrate cap to return via REMB;
+    /// overrides the global room value if present (unless `bitrate_cap` is set)
     bitrate: u64,
+    /// whether we should send this publisher a keyframe request
     keyframe: bool,
+    /// whether this publisher should be recorded or not
     record: bool,
+    /// if recording, the base path/file to use for the recording files
     filename: String,
+    /// new display name to use in the room
     display: String,
+    /// new `audio_active_packets` to overwrite in the room one
     audio_active_packets: u64,
+    /// new `audio_level_average` to overwrite the room one
     audio_level_average: u64,
+    /// list of streams to configure
     streams: Vec<VideoRoomConfigurePublisherStream>,
+    /// descriptions (names) for the published streams
     descriptions: Vec<VideoRoomPublishDescription>
 });
 
@@ -345,7 +358,7 @@ make_dto!(
 
 make_dto!(VideoRoomConfigureSubscriberParams,
     required {
-    /// list of streams to configure
+        /// list of streams to configure
         streams: Vec<VideoRoomConfigureSubscriberStream>
     },
     optional {
@@ -409,6 +422,8 @@ make_dto!(VideoRoomRtpForwardParams,
     optional {
         /// length of authentication tag (32 or 80)
         host_family: String,
+        /// length of authentication tag (32 or 80)
+        srtp_suite: u16,
         /// key to use as crypto (base64 encoded key as in SDES)
         srtp_crypto: String
     }
@@ -423,17 +438,17 @@ make_dto!(
         port: u16
     },
     optional {
-        /// host address to forward the packets to; optional, will use global one if missing
+        /// host address to forward the packets to, will use global one if missing
         host: String,
         host_family: String,
-        /// SSRC to use when forwarding; optional, and only for RTP streams, not data
+        /// SSRC to use when forwarding, and only for RTP streams, not data
         ssrc: String,
-        /// payload type to use when forwarding; optional, and only for RTP streams, not data
+        /// payload type to use when forwarding, and only for RTP streams, not data
         pt: String,
-        /// port to contact to receive RTCP feedback from the recipient; optional, and only for RTP streams, not data
+        /// port to contact to receive RTCP feedback from the recipient, and only for RTP streams, not data
         rtcp_port: String,
         /// set to true if the source is simulcast and you want the forwarder to act as a regular viewer
-        /// (single stream being forwarded) or false otherwise (substreams forwarded separately); optional, default=false
+        /// (single stream being forwarded) or false otherwise (substreams forwarded separately), default=false
         simulcast: bool,
         /// if video and simulcasting, port to forward the packets from the second substream/layer to
         port_2: u16,