[STREAM-1351] - Removed v2.conversations.{id}.media sub, cleaned up… (#988)

Author: zservies

changelog.md

@@ -4,6 +4,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 # [Unreleased](https://github.com/MyPureCloud/genesys-cloud-webrtc-sdk/compare/v12.0.0...HEAD)
+### Breaking Changes
+* [STREAM-1351](https://inindca.atlassian.net/browse/STREAM-1351) - Removed `v2.conversations.{id}.media` notification subscription. Removed the `activeVideoParticipantsUpdate` session event and `IOnScreenParticipantsUpdate` interface. Speaker and on-screen participant updates are now entirely handled via the data channel.
+
 ### Added
 * Added documentation for live screen monitoring functionality
 

doc/video.md

@@ -6,8 +6,8 @@ are done using the public API, but are abstracted being api's in this sdk.
 > *Note: video conferencing does not support guest users.*
 
 ## WebRTC SDK Video Index
-This documentation expands upon the [GenesysCloudWebrtcSdk] documention but is specific to 
-video conferencing. See the full list of the [APIs], [methods], and [events]. 
+This documentation expands upon the [GenesysCloudWebrtcSdk] documention but is specific to
+video conferencing. See the full list of the [APIs], [methods], and [events].
 
 * See [sdk.startVideoConference()] for usage
 * [Example usage](#example-usage)
@@ -71,55 +71,8 @@ interface IParticipantUpdate {
   audioMuted: boolean
 }
 ```
-Value of event: 
-* `update: IParticipantsUpdate` – list of updated participants
-
-#### `activeVideoParticipantsUpdate`
-
-This event will happen when the server switches who is visible on the screen. 
-
-> *Note: this user may not be providing video or that video could be muted. It is up to the
-> implementing party to show something else such as an avatar or profile picture in such instances.*
-
-Declaration:
-``` ts
-session.on('activeVideoParticipantsUpdate', (update: IOnScreenParticipantsUpdate) => {});
-
-/* interface declaration */
-interface IOnScreenParticipantsUpdate {
-  participantsOnScreen: [
-    {
-      userId: string,
-    }
-  ]
-}
-```
 Value of event:
-* `update: IOnScreenParticipantsUpdate` – the new participant on the screen
-
-
-#### `speakersUpdate`
-
-This event tells who is making noise in the conference.
-
-> Caveat: currently, we can only emit on this event when the on-screen user changes, 
-this will often appear to be out of sync. This will be fixed in the future.
-
-Declaration:
-``` ts
-session.on('speakersUpdate', (update: ISpeakersUpdate) => {})):
-
-/* interface declaration */
-interface ISpeakersUpdate {
-  speakers: [
-    {
-      userId: string;
-    }
-  ]
-}
-```
-Value of event:
-* `update: ISpeakersUpdate` – userIds of the participants speaking
+* `update: IParticipantsUpdate` – list of updated participants
 
 ## Video Session Methods
 
@@ -134,7 +87,7 @@ be cleaned up and replaced with a track presenting your screen. When ending scre
 a camera track was cleaned up during `startScreenShare` a new one will be created to replace the screen share track.
 
 
-Declaration: 
+Declaration:
 ``` ts
 session.startScreenShare(): Promise<void>;
 ```
@@ -145,13 +98,13 @@ Returns: a promise that completes after the screen share started.
 
 
 #### `stopScreenShare()`
-Ends the active outgoing screen share. If video media was on before the screen share 
-started, the media we be required and added to the session. 
+Ends the active outgoing screen share. If video media was on before the screen share
+started, the media we be required and added to the session.
 
-If there was no active screen share for this session, an error is logged 
-and returns (no error is thrown). 
+If there was no active screen share for this session, an error is logged
+and returns (no error is thrown).
 
-Declaration: 
+Declaration:
 ``` ts
 session.stopScreenShare(): Promise<void>;
 ```
@@ -164,19 +117,19 @@ Returns: a promise that completes after the screen share end and the new video
 
 #### `pinParticipantVideo()`
 Locks video to the provided video conference participant. If `participantId` is `null`
-or `undefined`, any currently pinned participants will be removed and will switch automatically 
-when speaking. 
+or `undefined`, any currently pinned participants will be removed and will switch automatically
+when speaking.
 
 When a participant's video is pinned it will disable the video switching when other participants talk.
 
 > Note: participantIds can be found in the [participantsUpdate](#participantsupdate) event.
 
-Declaration: 
+Declaration:
 ``` ts
 session.pinParticipantVideo(participantId?: string): Promise<void>;
 ```
 
-Params: 
+Params:
 * `participantId: string` – Optional: if provided, it will pin that participant's video. If
   the id is not provided, it will clear any old pin and reset back to the active user on screen.
 
@@ -188,4 +141,4 @@ Returns: a promise that completes after the Public API call finishes pinning the
 [methods]: index.md#methods
 [events]: index.md#events
 
-[session level events]: index.md#session-level-events
+[session level events]: index.md#session-level-events

src/sessions/video-session-handler.ts

@@ -1,4 +1,4 @@
-import { differenceBy, intersection } from 'lodash';
+import { differenceBy } from 'lodash';
 import { Constants } from 'stanza';
 
 import {
@@ -8,8 +8,6 @@ import {
   IExtendedMediaSession,
   IParticipantUpdate,
   IParticipantsUpdate,
-  IOnScreenParticipantsUpdate,
-  ISpeakersUpdate,
   IConversationParticipant,
   IMediaRequestOptions,
   IStartVideoSessionParams,
@@ -26,35 +24,6 @@ import { ConversationUpdate } from '../conversations/conversation-update';
 import { JsonRpcMessage } from 'genesys-cloud-streaming-client';
 import { jwtDecode } from "jwt-decode";
 
-/**
- * speakers is an array of audio track ids sending audio
- */
-export interface IMediaChangeEvent {
-  eventBody: {
-    id: string,
-    participants: IMediaChangeEventParticipant[],
-    speakers: string[]
-  };
-  metadata: {
-    CorrelationId: string
-  };
-}
-
-/**
- * sinks represents outgoing paths for this track. For example, if we have a track that looks like { id: "1", mediaType: "audio", sinks: ["a", "b"] }
- * then we know that the audio of track "1" can be heard on tracks "a" and "b". Another way to say this is whichever participants are receiving
- * tracks "a" or "b" are hearing this participant
- */
-export interface IMediaChangeEventParticipant {
-  communicationId: string;
-  userId: string;
-  tracks: {
-    id: string,
-    mediaType: 'audio' | 'video',
-    sinks?: string[]
-  }[];
-}
-
 export class VideoSessionHandler extends BaseSessionHandler {
   requestedSessions: { [roomJid: string]: boolean } = {};
   requestedMeetingSessions: { [meetingId: string]: boolean } = {};
@@ -165,91 +134,6 @@ export class VideoSessionHandler extends BaseSessionHandler {
     session.emit('participantsUpdate', update);
   }
 
-  updateParticipantsOnScreen (session: VideoMediaSession, mediaUpdateEvent: IMediaChangeEvent) {
-    const incomingVideoTrackIds = session.pc.getReceivers()
-      .filter((receiver) => receiver.track && receiver.track.kind === 'video')
-      .map((receiver) => receiver.track.id);
-
-    /**
-     * Firefox messes the trackIds up from what is actually in the sdp offer.
-     * Need to pull it from the offer to accurately match the track.sinks
-     */
-    const incomingVideoMsidTrackId = this.getTrackIdFromSdp(session.pc.remoteDescription.sdp, 'video');
-
-    if (incomingVideoMsidTrackId) {
-      incomingVideoTrackIds.push(incomingVideoMsidTrackId);
-    }
-
-    const onScreenParticipants: Array<{ userId: string }> = [];
-    mediaUpdateEvent.eventBody.participants.forEach((updateParticipant: IMediaChangeEventParticipant) => {
-      const matchingVideoTracks = updateParticipant.tracks
-        .filter((track) => track.mediaType === 'video')
-        .filter((track) => {
-          const intersectingTracks = intersection(track.sinks, incomingVideoTrackIds);
-          return intersectingTracks.length;
-        });
-
-      if (matchingVideoTracks.length) {
-        onScreenParticipants.push({ userId: updateParticipant.userId });
-      }
-    });
-
-    const lastUpdate: IOnScreenParticipantsUpdate = session._lastOnScreenUpdate || { participants: [] } as any;
-
-    // send out an update if the onScreenParticipants count or items changed
-    if (lastUpdate.participants.length === onScreenParticipants.length) {
-      const changed = differenceBy(lastUpdate.participants, onScreenParticipants, 'userId').length ||
-        differenceBy(lastUpdate.participants, onScreenParticipants, 'userId').length;
-
-      if (!changed) {
-        return;
-      }
-    }
-
-    const update: IOnScreenParticipantsUpdate = {
-      participants: onScreenParticipants
-    };
-
-    session._lastOnScreenUpdate = update;
-    session.emit('activeVideoParticipantsUpdate', update);
-  }
-
-  updateSpeakers (session: IExtendedMediaSession, mediaUpdateEvent: IMediaChangeEvent) {
-    const incomingAudioTrackIds = session.pc.getReceivers()
-      .filter((receiver) => receiver.track && receiver.track.kind === 'audio')
-      .map((receiver) => receiver.track.id);
-
-    /**
-     * Firefox messes the trackIds up from what is actually in the sdp offer.
-     * Need to pull it from the offer to accurately match the track.sinks
-     */
-    const incomingAudioMsidTrackId = this.getTrackIdFromSdp(session.pc.remoteDescription.sdp, 'audio');
-
-    if (incomingAudioMsidTrackId) {
-      incomingAudioTrackIds.push(incomingAudioMsidTrackId);
-    }
-
-    const speakingParticipants: Array<{ userId: string }> = [];
-    mediaUpdateEvent.eventBody.participants.forEach((updateParticipant: IMediaChangeEventParticipant) => {
-      const matchingAudioTracks = updateParticipant.tracks
-        .filter((track) => track.mediaType === 'audio')
-        .filter((track) => {
-          const intersectingTracks = intersection(track.sinks, incomingAudioTrackIds);
-          return intersectingTracks.length;
-        });
-
-      if (matchingAudioTracks.length) {
-        speakingParticipants.push({ userId: updateParticipant.userId });
-      }
-    });
-
-    const update: ISpeakersUpdate = {
-      speakers: speakingParticipants
-    };
-
-    session.emit('speakersUpdate', update);
-  }
-
   // triggers a propose from the backend
   async startSession(startParams: IStartVideoSessionParams | IStartVideoMeetingSessionParams): Promise<{ conversationId: string }> {
     if ("jid" in startParams) {
@@ -414,10 +298,6 @@ export class VideoSessionHandler extends BaseSessionHandler {
     }
 
     session._outboundStream = stream;
-    // If using a JWT, we can't subscribe to the media change events.
-    if (!this.sdk._config.jwt) {
-    await this.sdk._streamingConnection.notifications.subscribe(`v2.conversations.${session.conversationId}.media`, this.handleMediaChangeEvent.bind(this, session));
-    }
 
     await this.addMediaToSession(session, stream);
 
@@ -699,11 +579,6 @@ export class VideoSessionHandler extends BaseSessionHandler {
     }
   }
 
-  handleMediaChangeEvent (session: VideoMediaSession, event: IMediaChangeEvent): void {
-    this.updateParticipantsOnScreen(session, event);
-    this.updateSpeakers(session, event);
-  }
-
   async startScreenShare (session: VideoMediaSession): Promise<void> {
     session._resurrectVideoOnScreenShareEnd = !session.videoMuted;
     try {

src/types/interfaces.ts

@@ -13,7 +13,6 @@ export { ISessionInfo, IPendingSession };
 declare module 'genesys-cloud-streaming-client' {
   export interface SessionEvents {
     participantsUpdate: IParticipantsUpdate;
-    activeVideoParticipantsUpdate: IOnScreenParticipantsUpdate;
     speakersUpdate: ISpeakersUpdate;
     incomingMedia: void;
     pinnedParticipant: { participantId: string | null };
@@ -928,7 +927,6 @@ export interface VideoMediaSession extends IExtendedMediaSession {
   pinParticipantVideo?: (participantId: string) => Promise<void>;
   _resurrectVideoOnScreenShareEnd?: boolean;
   _lastParticipantsUpdate?: IParticipantsUpdate;
-  _lastOnScreenUpdate?: IOnScreenParticipantsUpdate;
 }
 
 export interface ScreenRecordingMediaSession extends IExtendedMediaSession {
@@ -1002,15 +1000,6 @@ export interface IParticipantUpdate {
   videoMuted: boolean;
   audioMuted: boolean;
 }
-
-export interface IOnScreenParticipantsUpdate {
-  participants: Array<
-    {
-      userId: string;
-    }
-  >;
-}
-
 export interface ISpeakersUpdate {
   speakers: Array<
     {