Add reason of track being added/removed in onremotetrack in janus.js

meetecho · Jan 23, 2023 · 55c5c52 · 55c5c52
1 parent 963c4b6
commit 55c5c52
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 7 deletions.
diff --git a/html/janus.js b/html/janus.js
@@ -1913,7 +1913,7 @@ function Janus(gatewayCallbacks) {
 			// Notify about the new track event
 			let mid = event.transceiver ? event.transceiver.mid : event.track.id;
 			try {
-				pluginHandle.onremotetrack(event.track, mid, true);
+				pluginHandle.onremotetrack(event.track, mid, true, { reason: 'created' });
 			} catch(e) {
 				Janus.error("Error calling onremotetrack", e);
 			}
@@ -1930,7 +1930,7 @@ function Janus(gatewayCallbacks) {
 					t => t.receiver.track === ev.target) : null;
 				let mid = transceiver ? transceiver.mid : ev.target.id;
 				try {
-					pluginHandle.onremotetrack(ev.target, mid, false);
+					pluginHandle.onremotetrack(ev.target, mid, false, { reason: 'ended' });
 				} catch(e) {
 					Janus.error("Error calling onremotetrack on removal", e);
 				}
@@ -1946,7 +1946,7 @@ function Janus(gatewayCallbacks) {
 							t => t.receiver.track === ev.target) : null;
 						let mid = transceiver ? transceiver.mid : ev.target.id;
 						try {
-							pluginHandle.onremotetrack(ev.target, mid, false);
+							pluginHandle.onremotetrack(ev.target, mid, false, { reason: 'mute' } );
 						} catch(e) {
 							Janus.error("Error calling onremotetrack on mute", e);
 						}
@@ -1968,7 +1968,7 @@ function Janus(gatewayCallbacks) {
 						let transceiver = transceivers ? transceivers.find(
 							t => t.receiver.track === ev.target) : null;
 						let mid = transceiver ? transceiver.mid : ev.target.id;
-						pluginHandle.onremotetrack(ev.target, mid, true);
+						pluginHandle.onremotetrack(ev.target, mid, true, { reason: 'unmute' });
 					} catch(e) {
 						Janus.error("Error calling onremotetrack on unmute", e);
 					}

diff --git a/src/mainpage.dox b/src/mainpage.dox
@@ -399,8 +399,11 @@ janus.attach(
         onlocaltrack: function(track, added) {
             // A local track to display has just been added (getUserMedia worked!) or removed
         },
-        onremotetrack: function(track, mid, added) {
+        onremotetrack: function(track, mid, added, metadata) {
             // A remote track (working PeerConnection!) with a specific mid has just been added or removed
+            // You can query metadata to get some more information on why track was added or removed
+            // metadata fields:
+            //   - reason: 'created' | 'ended' | 'mute' | 'unmute'
         },
         oncleanup: function() {
             // PeerConnection with the plugin closed, clean the UI
@@ -589,9 +592,12 @@ janus.attach(
             // Invoked after createOffer
             // This is info on a local track: when added, we can choose to render
         },
-        onremotetrack: function(track, mid, added) {
+        onremotetrack: function(track, mid, added, metadata) {
             // Invoked after handleRemoteJsep has got us a PeerConnection
             // This is info on a remote track: when added, we can choose to render
+            // You can query metadata to get some more information on why track was added or removed
+            // metadata fields:
+            //   - reason: 'created' | 'ended' | 'mute' | 'unmute'
         },
         [..]
   \endverbatim
@@ -639,9 +645,13 @@ janus.attach(
         onlocaltrack: function(track, added) {
             // This will NOT be invoked, we chose recvonly
         },
-        onremotetrack: function(track, mid, added) {
+        onremotetrack: function(track, mid, added, metadata) {
             // Invoked after send has got us a PeerConnection
             // This is info on a remote track: when added, we can choose to render
+            // This is info on a remote track: when added, we can choose to render
+            // You can query metadata to get some more information on why track was added or removed
+            // metadata fields:
+            //   - reason: 'created' | 'ended' | 'mute' | 'unmute'
         },
         [..]
   \endverbatim