Hierarchy

Constructors

  • Parameters

    • params: {
          localAudioTrackData?: {
              id: string;
              isMute?: boolean;
              settings?: HMSAudioTrackSettings;
              source?: string | number;
              trackDescription?: string;
              trackId: string;
              type: HMSTrackType;
          };
          localVideoTrackData?: {
              id: string;
              isMute?: boolean;
              settings?: HMSVideoTrackSettings;
              source?: string | number;
              trackDescription?: string;
              trackId: string;
              type: HMSTrackType;
          };
          peerID: string;
      }
      • Optional localAudioTrackData?: {
            id: string;
            isMute?: boolean;
            settings?: HMSAudioTrackSettings;
            source?: string | number;
            trackDescription?: string;
            trackId: string;
            type: HMSTrackType;
        }
        • id: string
        • Optional isMute?: boolean
        • Optional settings?: HMSAudioTrackSettings
        • Optional source?: string | number
        • Optional trackDescription?: string
        • trackId: string
        • type: HMSTrackType
      • Optional localVideoTrackData?: {
            id: string;
            isMute?: boolean;
            settings?: HMSVideoTrackSettings;
            source?: string | number;
            trackDescription?: string;
            trackId: string;
            type: HMSTrackType;
        }
        • id: string
        • Optional isMute?: boolean
        • Optional settings?: HMSVideoTrackSettings
        • Optional source?: string | number
        • Optional trackDescription?: string
        • trackId: string
        • type: HMSTrackType
      • peerID: string

    Returns HMSLocalPeer

Properties

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