Add RemoteMediaTrack.onMediaDirectionChanged() (#42)

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  MEDEA_BRANCH: edge  # for E2E tests only
+  MEDEA_BRANCH: add-media-exchange-direction  # for E2E tests only
   RUST_BACKTRACE: 1
 
 jobs:

CHANGELOG.md

@@ -44,6 +44,9 @@ All user visible changes to this project will be documented in this file. This p
                 - `InternalException`;
                 - `LocalMediaInitException`.
     - Renamed `InputDeviceInfo` object to `MediaDeviceInfo` ([#29]).
+    - `RemoteMediaTrack`:
+        - Replaced `on_enabled` and `on_disabled` callbacks with `on_media_direction_changed` callback ([#46]);
+        - Replaced `enabled` method with `media_direction` method ([#46]).
 
 ### Added
 
@@ -65,6 +68,7 @@ All user visible changes to this project will be documented in this file. This p
         - `disable_remote_video`;
         - `enable_remote_audio`;
         - `disable_remote_audio`.
+    - `MediaDirection` type ([#46]).
 
 ### Updated
 
@@ -76,6 +80,7 @@ All user visible changes to this project will be documented in this file. This p
 [#29]: /../../pull/29
 [#30]: /../../pull/30
 [#43]: /../../pull/43
+[#46]: /../../pull/46
 
 
 

e2e-demo/js/index.js

@@ -617,6 +617,9 @@ window.onload = async function() {
 
       connection.on_remote_track_added((track) => {
         let playElement = undefined;
+        track.on_media_direction_changed((direction) => {
+          console.log('New TransceiverDirection: ' + direction);
+        });
         if (track.kind() === rust.MediaKind.Video) {
           if (track.media_source_kind() === rust.MediaSourceKind.Display) {
             playElement = memberVideoDiv.getElementsByClassName('display-video')[0];

e2e/src/object/remote_track.rs

@@ -4,6 +4,23 @@ use crate::{browser::Statement, object::Object};
 
 use super::Error;
 
+/// Media exchange direction of a `RemoteMediaTrack`.
+#[derive(Clone, Copy, Debug)]
+#[repr(u8)]
+pub enum MediaDirection {
+    /// `RemoteMediaTrack` is enabled on both receiver and sender sides.
+    SendRecv = 0,
+
+    /// `RemoteMediaTrack` is enabled on sender side only.
+    SendOnly = 1,
+
+    /// `RemoteMediaTrack` is enabled on receiver side only.
+    RecvOnly = 2,
+
+    /// `RemoteMediaTrack` is disabled on both sides.
+    Inactive = 3,
+}
+
 /// Representation of a `RemoteMediaTrack` object.
 #[derive(Clone, Copy, Debug)]
 pub struct RemoteTrack;
@@ -19,7 +36,8 @@ impl Object<RemoteTrack> {
             // language=JavaScript
             r#"
             async (track) => {
-                if (!track.track.enabled()) {
+                const currentDirection = track.track.media_direction()
+                if (currentDirection != 0) {
                     let waiter = new Promise((resolve) => {
                         track.onEnabledSubs.push(resolve);
                     });
@@ -44,7 +62,8 @@ impl Object<RemoteTrack> {
             // language=JavaScript
             r#"
             async (track) => {
-                if (track.track.enabled()) {
+                const currentDirection = track.track.media_direction()
+                if (currentDirection == 0) {
                     let waiter = new Promise((resolve) => {
                         track.onDisabledSubs.push(resolve);
                     });
@@ -67,7 +86,12 @@ impl Object<RemoteTrack> {
     pub async fn disabled(&self) -> Result<bool, Error> {
         self.execute(Statement::new(
             // language=JavaScript
-            r#"async (t) => !t.track.get_track().enabled"#,
+            r#"
+            async (t) => {
+                const currentDirection = t.track.media_direction();
+                return currentDirection != 0;
+            }
+            "#,
             [],
         ))
         .await?
@@ -88,18 +112,18 @@ impl Object<RemoteTrack> {
         self.execute(Statement::new(
             // language=JavaScript
             r#"
-                async (track) => {
-                    const [count] = args;
-                    while (track.on_disabled_fire_count !== count) {
-                        await new Promise((resolve) => {
-                            if (track.on_disabled_fire_count !== count) {
-                                track.onDisabledSubs.push(resolve);
-                            } else {
-                                resolve();
-                            }
-                        });
-                    }
+            async (track) => {
+                const [count] = args;
+                while (track.on_disabled_fire_count !== count) {
+                    await new Promise((resolve) => {
+                        if (track.on_disabled_fire_count !== count) {
+                            track.onDisabledSubs.push(resolve);
+                        } else {
+                            resolve();
+                        }
+                    });
                 }
+            }
             "#,
             [count.into()],
         ))
@@ -120,18 +144,18 @@ impl Object<RemoteTrack> {
         self.execute(Statement::new(
             // language=JavaScript
             r#"
-                async (track) => {
-                    const [count] = args;
-                    while (track.on_enabled_fire_count !== count) {
-                        await new Promise((resolve) => {
-                            if (track.on_enabled_fire_count !== count) {
-                                track.onEnabledSubs.push(resolve);
-                            } else {
-                                resolve();
-                            }
-                        });
-                    }
+            async (track) => {
+                const [count] = args;
+                while (track.on_enabled_fire_count !== count) {
+                    await new Promise((resolve) => {
+                        if (track.on_enabled_fire_count !== count) {
+                            track.onEnabledSubs.push(resolve);
+                        } else {
+                            resolve();
+                        }
+                    });
                 }
+            }
             "#,
             [count.into()],
         ))
@@ -152,18 +176,18 @@ impl Object<RemoteTrack> {
         self.execute(Statement::new(
             // language=JavaScript
             r#"
-                async (track) => {
-                    const [count] = args;
-                    while (track.on_muted_fire_count !== count) {
-                        await new Promise((resolve) => {
-                            if (track.on_muted_fire_count !== count) {
-                                track.onMutedSubs.push(resolve);
-                            } else {
-                                resolve();
-                            }
-                        });
-                    }
+            async (track) => {
+                const [count] = args;
+                while (track.on_muted_fire_count !== count) {
+                    await new Promise((resolve) => {
+                        if (track.on_muted_fire_count !== count) {
+                            track.onMutedSubs.push(resolve);
+                        } else {
+                            resolve();
+                        }
+                    });
                 }
+            }
             "#,
             [count.into()],
         ))
@@ -184,22 +208,55 @@ impl Object<RemoteTrack> {
         self.execute(Statement::new(
             // language=JavaScript
             r#"
-                async (track) => {
-                    const [count] = args;
-                    while (track.on_unmuted_fire_count !== count) {
-                        await new Promise((resolve) => {
-                            if (track.on_unmuted_fire_count !== count) {
-                                track.onUnmutedSubs.push(resolve);
-                            } else {
-                                resolve();
-                            }
-                        });
-                    }
+            async (track) => {
+                const [count] = args;
+                while (track.on_unmuted_fire_count !== count) {
+                    await new Promise((resolve) => {
+                        if (track.on_unmuted_fire_count !== count) {
+                            track.onUnmutedSubs.push(resolve);
+                        } else {
+                            resolve();
+                        }
+                    });
                 }
+            }
             "#,
             [count.into()],
         ))
         .await
         .map(drop)
     }
+
+    /// Waits for the `RemoteMediaTrack.on_media_direction` with the provided
+    /// [`MediaDirection`].
+    ///
+    /// # Errors
+    ///
+    /// If failed to execute JS statement.
+    pub async fn wait_for_media_direction(
+        &self,
+        direction: MediaDirection,
+    ) -> Result<(), Error> {
+        self.execute(Statement::new(
+            // language=JavaScript
+            r#"
+            async (track) => {
+                const [direction] = args;
+                    if (track.track.media_direction() != direction) {
+                        let waiter = new Promise((resolve) => {
+                            track.onMediaDirectionChangedSubs.push((dir) => {
+                                if (dir == direction) {
+                                    resolve();
+                                }
+                            });
+                    });
+                    await waiter;
+                }
+            }
+            "#,
+            [(direction as u8).into()],
+        ))
+        .await
+        .map(drop)
+    }
 }