livekit: send UpdateTrackSettings on disable (#368)

Author: nbsp

livekit/src/room/participant/remote_participant.rs

@@ -353,6 +353,30 @@ impl RemoteParticipant {
                 }
             }
         });
+
+        publication.on_enabled_status_changed({
+            let rtc_engine = self.inner.rtc_engine.clone();
+            move |publication, enabled| {
+                let rtc_engine = rtc_engine.clone();
+                livekit_runtime::spawn(async move {
+                    let tsid: String = publication.sid().into();
+                    let TrackDimension(width, height) = publication.dimension();
+                    let update_track_settings = proto::UpdateTrackSettings {
+                        track_sids: vec![tsid.clone()],
+                        disabled: !enabled,
+                        width,
+                        height,
+                        ..Default::default()
+                    };
+
+                    rtc_engine
+                        .send_request(proto::signal_request::Message::TrackSetting(
+                            update_track_settings,
+                        ))
+                        .await
+                });
+            }
+        })
     }
 
     pub(crate) fn remove_publication(&self, sid: &TrackSid) -> Option<TrackPublication> {

livekit/src/room/publication/remote.rs

@@ -27,6 +27,7 @@ type SubscriptionStatusChangedHandler =
 type PermissionStatusChangedHandler =
     Box<dyn Fn(RemoteTrackPublication, PermissionStatus, PermissionStatus) + Send>; // old_status, new_status
 type SubscriptionUpdateNeededHandler = Box<dyn Fn(RemoteTrackPublication, bool) + Send>;
+type EnabledStatusChangedHandler = Box<dyn Fn(RemoteTrackPublication, bool) + Send>;
 
 #[derive(Default)]
 struct RemoteEvents {
@@ -35,6 +36,7 @@ struct RemoteEvents {
     subscription_status_changed: Mutex<Option<SubscriptionStatusChangedHandler>>,
     permission_status_changed: Mutex<Option<PermissionStatusChangedHandler>>,
     subscription_update_needed: Mutex<Option<SubscriptionUpdateNeededHandler>>,
+    enabled_status_changed: Mutex<Option<EnabledStatusChangedHandler>>,
 }
 
 #[derive(Debug)]
@@ -206,6 +208,13 @@ impl RemoteTrackPublication {
         *self.remote.events.subscription_update_needed.lock() = Some(Box::new(f));
     }
 
+    pub(crate) fn on_enabled_status_changed(
+        &self,
+        f: impl Fn(RemoteTrackPublication, bool) + Send + 'static,
+    ) {
+        *self.remote.events.enabled_status_changed.lock() = Some(Box::new(f));
+    }
+
     pub fn set_subscribed(&self, subscribed: bool) {
         let old_subscription_state = self.subscription_status();
         let old_permission_state = self.permission_status();
@@ -235,6 +244,24 @@ impl RemoteTrackPublication {
         self.emit_permission_update(old_permission_state);
     }
 
+    pub fn set_enabled(&self, enabled: bool) {
+        if self.is_subscribed() && enabled != self.is_enabled() {
+            let track = self.track().unwrap();
+            if self.is_enabled() {
+                track.disable();
+            } else {
+                track.enable();
+            }
+
+            // Request to send an update to the SFU
+            if let Some(enabled_status_changed) =
+                self.remote.events.enabled_status_changed.lock().as_ref()
+            {
+                enabled_status_changed(self.clone(), enabled)
+            }
+        }
+    }
+
     pub fn subscription_status(&self) -> SubscriptionStatus {
         if !self.remote.info.read().subscribed {
             return SubscriptionStatus::Unsubscribed;
@@ -267,6 +294,10 @@ impl RemoteTrackPublication {
         self.remote.info.read().allowed
     }
 
+    pub fn is_enabled(&self) -> bool {
+        self.track().is_some_and(|x| x.is_enabled())
+    }
+
     pub fn sid(&self) -> TrackSid {
         self.inner.info.read().sid.clone()
     }

livekit/src/room/track/local_audio_track.rs

@@ -84,6 +84,10 @@ impl LocalAudioTrack {
         self.inner.info.read().stream_state
     }
 
+    pub fn is_enabled(&self) -> bool {
+        self.inner.rtc_track.enabled()
+    }
+
     pub fn enable(&self) {
         self.inner.rtc_track.set_enabled(true);
     }

livekit/src/room/track/local_video_track.rs

@@ -84,6 +84,10 @@ impl LocalVideoTrack {
         self.inner.info.read().stream_state
     }
 
+    pub fn is_enabled(&self) -> bool {
+        self.inner.rtc_track.enabled()
+    }
+
     pub fn enable(&self) {
         self.inner.rtc_track.set_enabled(true);
     }

livekit/src/room/track/mod.rs

@@ -79,6 +79,7 @@ macro_rules! track_dispatch {
             pub fn kind(self: &Self) -> TrackKind;
             pub fn source(self: &Self) -> TrackSource;
             pub fn stream_state(self: &Self) -> StreamState;
+            pub fn is_enabled(self: &Self) -> bool;
             pub fn enable(self: &Self) -> ();
             pub fn disable(self: &Self) -> ();
             pub fn is_muted(self: &Self) -> bool;

livekit/src/room/track/remote_audio_track.rs

@@ -67,6 +67,10 @@ impl RemoteAudioTrack {
         self.inner.info.read().stream_state
     }
 
+    pub fn is_enabled(&self) -> bool {
+        self.inner.rtc_track.enabled()
+    }
+
     pub fn enable(&self) {
         self.inner.rtc_track.set_enabled(true);
     }

livekit/src/room/track/remote_video_track.rs

@@ -67,6 +67,10 @@ impl RemoteVideoTrack {
         self.inner.info.read().stream_state
     }
 
+    pub fn is_enabled(&self) -> bool {
+        self.inner.rtc_track.enabled()
+    }
+
     pub fn enable(&self) {
         self.inner.rtc_track.set_enabled(true);
     }