core: initialize RtcManagerDispatcher with remoteMediaOptions

Author: kevinwhereby

.changeset/common-clubs-fly.md

@@ -0,0 +1,6 @@
+---
+"@whereby.com/media": minor
+"@whereby.com/core": minor
+---
+
+Add neverReceiveAudio p2p flag

packages/core/src/client/RoomConnection/index.ts

@@ -318,6 +318,7 @@ export class RoomConnectionClient extends BaseClient<RoomConnectionState, RoomCo
             assistantKey: this.options.assistantKey || null,
             isNodeSdk: this.options.isNodeSdk || false,
             isAudioRecorder: this.options.isAudioRecorder ?? false,
+            remoteMediaOptions: this.options.remoteMediaOptions ?? { receiveAudio: true, receiveVideo: true },
         };
 
         this.store.dispatch(doAppStart(roomConfig));

packages/core/src/redux/slices/__tests__/app.unit.ts

@@ -12,6 +12,7 @@ describe("appSlice", () => {
                     isAudioRecorder: false,
                     isDialIn: true,
                     isNodeSdk: true,
+                    remoteMediaOptions: { receiveAudio: true, receiveVideo: false },
                     roomKey: "roomKey",
                     roomUrl: "https://some.url/roomName",
                     userAgent: "userAgent",
@@ -29,6 +30,7 @@ describe("appSlice", () => {
                     isAudioRecorder: false,
                     isDialIn: true,
                     isNodeSdk: true,
+                    remoteMediaOptions: { receiveAudio: true, receiveVideo: false },
                     roomKey: "roomKey",
                     roomName: "/roomName",
                     roomUrl: "https://some.url/roomName",
@@ -57,6 +59,7 @@ describe("appSlice", () => {
                     isAudioRecorder: false,
                     isDialIn: false,
                     isNodeSdk: true,
+                    remoteMediaOptions: { receiveAudio: true, receiveVideo: true },
                     roomKey: "roomKey",
                     roomName: "/roomName",
                     roomUrl: "https://some.url/roomName",

packages/core/src/redux/slices/app.ts

@@ -7,6 +7,7 @@ import { coreVersion } from "../../version";
  * Reducer
  */
 
+type RemoteMediaOptions = { receiveVideo: boolean; receiveAudio: boolean };
 export interface AppConfig {
     assistantKey?: string | null;
     displayName: string;
@@ -16,6 +17,7 @@ export interface AppConfig {
     isDialIn?: boolean;
     isNodeSdk?: boolean;
     localMediaOptions?: LocalMediaOptions;
+    remoteMediaOptions?: RemoteMediaOptions;
     roomKey: string | null;
     roomUrl: string;
     userAgent?: string;
@@ -31,6 +33,7 @@ export interface AppState {
     isAudioRecorder: boolean;
     isDialIn: boolean;
     isNodeSdk: boolean;
+    remoteMediaOptions: RemoteMediaOptions;
     roomName: string | null;
     roomUrl: string | null;
     userAgent: string | null;
@@ -45,6 +48,7 @@ export const initialState: AppState = {
     isAudioRecorder: false,
     isDialIn: false,
     isNodeSdk: false,
+    remoteMediaOptions: { receiveAudio: true, receiveVideo: true },
     roomName: null,
     roomUrl: null,
     userAgent: `core:${coreVersion}`,
@@ -95,3 +99,4 @@ export const selectAppExternalId = (state: RootState) => state.app.externalId;
 export const selectAppIsNodeSdk = (state: RootState) => state.app.isNodeSdk;
 export const selectAppInitialConfig = (state: RootState) => state.app.initialConfig;
 export const selectAppIgnoreBreakoutGroups = (state: RootState) => state.app.ignoreBreakoutGroups;
+export const selectAppRemoteMediaOptions = (state: RootState) => state.app.remoteMediaOptions;

packages/core/src/redux/slices/rtcConnection/index.ts

@@ -14,7 +14,13 @@ import { selectSignalConnectionRaw, selectSignalConnectionSocket, socketReconnec
 import { createReactor, startAppListening } from "../../listenerMiddleware";
 import { selectRemoteClients, selectRemoteParticipants, streamStatusUpdated } from "../remoteParticipants";
 import { RemoteParticipant, StreamState } from "../../../RoomParticipant";
-import { selectAppIsNodeSdk, selectAppIsActive, doAppStop, selectAppIgnoreBreakoutGroups } from "../app";
+import {
+    selectAppIsNodeSdk,
+    selectAppIsActive,
+    doAppStop,
+    selectAppIgnoreBreakoutGroups,
+    selectAppRemoteMediaOptions,
+} from "../app";
 
 import {
     selectIsCameraEnabled,
@@ -208,6 +214,7 @@ export const doConnectRtc = createAppThunk(() => (dispatch, getState) => {
     const isCameraEnabled = selectIsCameraEnabled(state);
     const isMicrophoneEnabled = selectIsMicrophoneEnabled(state);
     const isNodeSdk = selectAppIsNodeSdk(state);
+    const { receiveAudio, receiveVideo } = selectAppRemoteMediaOptions(state);
 
     if (dispatcher || !socket) {
         return;
@@ -239,6 +246,7 @@ export const doConnectRtc = createAppThunk(() => (dispatch, getState) => {
             sfuVp9On: false,
             h264On: false,
             simulcastScreenshareOn: false,
+            shouldReceiveMedia: { audio: receiveAudio, video: receiveVideo },
         },
     });
 

packages/core/src/redux/tests/store/rtcConnection.spec.ts

@@ -88,6 +88,7 @@ describe("actions", () => {
                             roomName: null,
                             roomUrl: null,
                             userAgent: `core:${coreVersion}`,
+                            remoteMediaOptions: { receiveAudio: true, receiveVideo: true },
                         },
                     },
                 });
@@ -109,6 +110,46 @@ describe("actions", () => {
                 });
             });
         });
+
+        describe("when remoteMediaOptions is set", () => {
+            it("initializes the RtcManagerDispatcher with that feature", () => {
+                const store = createStore({
+                    withSignalConnection: true,
+                    initialState: {
+                        app: {
+                            displayName: null,
+                            externalId: null,
+                            ignoreBreakoutGroups: false,
+                            isActive: false,
+                            isAssistant: false,
+                            isAudioRecorder: false,
+                            isDialIn: false,
+                            isNodeSdk: false,
+                            roomName: null,
+                            roomUrl: null,
+                            userAgent: `core:${coreVersion}`,
+                            remoteMediaOptions: { receiveAudio: true, receiveVideo: false },
+                        },
+                    },
+                });
+                const before = store.getState().rtcConnection;
+
+                store.dispatch(doConnectRtc());
+
+                const after = store.getState().rtcConnection;
+
+                expect(RtcManagerDispatcher).toHaveBeenCalledTimes(1);
+                expect(RtcManagerDispatcher).toHaveBeenCalledWith(
+                    expect.objectContaining({
+                        features: expect.objectContaining({ shouldReceiveMedia: { audio: true, video: false } }),
+                    }),
+                );
+                expect(diff(before, after)).toEqual({
+                    dispatcherCreated: true,
+                    rtcManagerDispatcher: expect.any(RtcManagerDispatcher),
+                });
+            });
+        });
     });
 
     it("doDisconnectRtc", () => {
@@ -164,7 +205,12 @@ describe("actions", () => {
         store.dispatch(doRtcManagerInitialize());
 
         expect(mockRtcManager.addNewStream).toHaveBeenCalledTimes(1);
-        expect(mockRtcManager.addNewStream).toHaveBeenCalledWith(CAMERA_STREAM_ID, store.getState().localMedia.stream, true, true);
+        expect(mockRtcManager.addNewStream).toHaveBeenCalledWith(
+            CAMERA_STREAM_ID,
+            store.getState().localMedia.stream,
+            true,
+            true,
+        );
         expect(store.getState().rtcConnection.rtcManagerInitialized).toBe(true);
     });
 });