feat: notify user via toast when the action was triggered

feat: only show the participant action in transcoded calls
refactor: explain the usage of the generic senRequest API call in README.md

Author: timwilking

README.md

@@ -14,6 +14,12 @@ participant in the paricipant list. This allows the host user to set:
 - **Deny receive presentation**: Stop participant receiving presentation from the meeting
 - **Allow receive presentation**: Allow participant to receive presentation from the meeting (default)
 
+The plugin relies on the generic API request: `plugin.conference.sendRequest`. This function is not typed published plugin-api package.
+
+## Limitations
+
+The plugin only works for transcoded meetings, it will not show up in direct media calls.
+
 ## Run for development
 
 - To be able to build the plugin, you need to comply with the following versions

package-lock.json

@@ -1,61 +1,92 @@
-import { registerPlugin, type RPCCallPayload } from '@pexip/plugin-api'
+import {
+  Button,
+  InfinityParticipant,
+  registerPlugin,
+  type RPCCallPayload,
+} from "@pexip/plugin-api";
 
 const plugin = await registerPlugin({
-  id: 'rx-presentation',
-  version: 0
-})
+  id: "rx-presentation",
+  version: 0,
+});
 
-const denyRxButtonPayload: RPCCallPayload<'ui:button:add'> = {
-  position: 'participantActions',
-  label: 'Deny receive presentation'
-}
+const denyRxButtonPayload: RPCCallPayload<"ui:button:add"> = {
+  position: "participantActions",
+  label: "Deny receive presentation",
+};
 
-const allowRxButtonPayload: RPCCallPayload<'ui:button:add'> = {
-  position: 'participantActions',
-  label: 'Allow receive presentation'
-}
+const allowRxButtonPayload: RPCCallPayload<"ui:button:add"> = {
+  position: "participantActions",
+  label: "Allow receive presentation",
+};
 
-const denyRxButton = await plugin.ui.addButton(denyRxButtonPayload)
-const allowRxButton = await plugin.ui.addButton(allowRxButtonPayload)
+let isDirectMedia: boolean | undefined = undefined;
+
+let participantList: Map<string, InfinityParticipant> = new Map();
+
+const denyRxButton = await plugin.ui.addButton(denyRxButtonPayload);
+const allowRxButton = await plugin.ui.addButton(allowRxButtonPayload);
 
 denyRxButton.onClick.add(async ({ participantUuid }) => {
   const payload = {
     path: "participants/" + participantUuid + "/denyrxpresentation",
     method: "POST",
-    payload: {}
+    payload: {},
   };
   await plugin.conference.sendRequest(payload);
-})
+  plugin.ui.showToast({
+    message:
+      "Denying receive presentation for " +
+      participantList.get(participantUuid)?.displayName,
+  });
+});
 
 allowRxButton.onClick.add(async ({ participantUuid }) => {
   const payload = {
     path: "participants/" + participantUuid + "/allowrxpresentation",
     method: "POST",
-    payload: {}
+    payload: {},
   };
   await plugin.conference.sendRequest(payload);
-})
+  plugin.ui.showToast({
+    message:
+      "Allowing receive presentation for " +
+      participantList.get(participantUuid)?.displayName,
+  });
+});
 
-plugin.events.participants.add(({ participants }) => {
+plugin.events.conferenceStatus.add(async ({ status }) => {
+  isDirectMedia = status.directMedia;
+});
+
+const updateParticipantButtons = (participants: InfinityParticipant[]) => {
   const allowedRxParticipants = participants
-    .filter((participant) => participant.rxPresentation)
-    .map((participant) => participant.uuid)
+    .filter((participant) => participant.rxPresentation && !isDirectMedia)
+    .map((participant) => participant.uuid);
 
   const deniedRxParticipants = participants
-    .filter((participant) => !participant.rxPresentation)
-    .map((participant) => participant.uuid)
+    .filter((participant) => !participant.rxPresentation && !isDirectMedia)
+    .map((participant) => participant.uuid);
 
   denyRxButton
     .update({
       ...denyRxButtonPayload,
-      participantIDs: allowedRxParticipants
+      participantIDs: allowedRxParticipants,
     })
-    .catch(console.error)
+    .catch(console.error);
 
   allowRxButton
     .update({
       ...allowRxButtonPayload,
-      participantIDs: deniedRxParticipants
+      participantIDs: deniedRxParticipants,
     })
-    .catch(console.error)
-})
+    .catch(console.error);
+};
+
+plugin.events.participants.add(({ participants }) => {
+  participantList = new Map();
+  participants.forEach((participant) =>
+    participantList.set(participant.uuid, participant)
+  );
+    updateParticipantButtons(participants);
+});

src/index.ts

@@ -1,12 +1,12 @@
 {
   "compilerOptions": {
-    "target": "ESNext",                                  
-    "module": "ESNext",                               
-    "moduleResolution": "node",                       
-    "esModuleInterop": true,                          
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true,         
-    "strict": true,                                   
+    "resolveJsonModule": true,
+    "strict": true,
     "skipLibCheck": true                              
   }
-}
+}