@100mslive/hms-video-store/src/interfaces/peer/hms-peer.ts

@100mslive Core SDK which abstracts the complexities of webRTC while providing a reactive store for data management with a unidirectional data flow

import { HMSAudioTrack, HMSTrack, HMSVideoTrack } from '../../media/tracks';
import { HMSRole } from '../role';

export enum HMSPeerType {
  SIP = 'sip',
  REGULAR = 'regular',
}

export interface HMSPeer {
  peerId: string;
  name: string;
  isLocal: boolean;
  joinedAt?: Date;
  customerUserId?: string;
  metadata?: string;
  audioTrack?: HMSAudioTrack;
  videoTrack?: HMSVideoTrack;
  auxiliaryTracks: HMSTrack[];
  role?: HMSRole;
  networkQuality?: number;
  groups?: string[];
  realtime?: boolean;
  isHandRaised: boolean;
  type: HMSPeerType;

  updateRole(newRole: HMSRole): void;
  updateName(newName: string): void;
  updateMetadata(data: string): void;
  updateNetworkQuality(value: number): void;
  updateGroups(groups: string[]): void;
}