Hierarchy

Constructors

  • Parameters

    • params: {
          name: string;
          peerID: string;
          remoteAudioTrackData?: {
              id: string;
              isMute?: boolean;
              playbackAllowed?: boolean;
              source?: HMSTrackSource;
              trackDescription?: string;
              trackId: string;
          };
          remoteVideoTrackData?: {
              id: string;
              isMute?: boolean;
              playbackAllowed?: boolean;
              source?: HMSTrackSource;
              trackDescription?: string;
              trackId: string;
          };
      }
      • name: string
      • peerID: string
      • Optional remoteAudioTrackData?: {
            id: string;
            isMute?: boolean;
            playbackAllowed?: boolean;
            source?: HMSTrackSource;
            trackDescription?: string;
            trackId: string;
        }
        • id: string
        • Optional isMute?: boolean
        • Optional playbackAllowed?: boolean
        • Optional source?: HMSTrackSource
        • Optional trackDescription?: string
        • trackId: string
      • Optional remoteVideoTrackData?: {
            id: string;
            isMute?: boolean;
            playbackAllowed?: boolean;
            source?: HMSTrackSource;
            trackDescription?: string;
            trackId: string;
        }
        • id: string
        • Optional isMute?: boolean
        • Optional playbackAllowed?: boolean
        • Optional source?: HMSTrackSource
        • Optional trackDescription?: string
        • trackId: string

    Returns HMSRemotePeer

Properties

name: string
peerID: string

Accessors

  • get customerUserID(): undefined | string
  • Returns undefined | string

  • get isLocal(): undefined | boolean
  • Returns undefined | boolean

  • get metadata(): undefined | string
  • Returns undefined | string

Methods

Generated using TypeDoc