Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

  • new HMSRemotePeer(params: { audioTrack?: HMSAudioTrack; auxiliaryTracks?: HMSTrack[]; customerDescription?: string; customerUserID?: string; isLocal?: boolean; metadata?: string; name: string; networkQuality?: HMSNetworkQuality; peerID: string; remoteAudioTrackData?: { id: string; isMute?: boolean; playbackAllowed?: boolean; source?: string | number; trackDescription?: string; trackId: string }; remoteVideoTrackData?: { id: string; isMute?: boolean; layer?: any; playbackAllowed?: boolean; source?: string | number; trackDescription?: string; trackId: string }; role?: HMSRole; videoTrack?: HMSVideoTrack }): HMSRemotePeer
  • Parameters

    • params: { audioTrack?: HMSAudioTrack; auxiliaryTracks?: HMSTrack[]; customerDescription?: string; customerUserID?: string; isLocal?: boolean; metadata?: string; name: string; networkQuality?: HMSNetworkQuality; peerID: string; remoteAudioTrackData?: { id: string; isMute?: boolean; playbackAllowed?: boolean; source?: string | number; trackDescription?: string; trackId: string }; remoteVideoTrackData?: { id: string; isMute?: boolean; layer?: any; playbackAllowed?: boolean; source?: string | number; trackDescription?: string; trackId: string }; role?: HMSRole; videoTrack?: HMSVideoTrack }
      • Optional audioTrack?: HMSAudioTrack
      • Optional auxiliaryTracks?: HMSTrack[]
      • Optional customerDescription?: string
      • Optional customerUserID?: string
      • Optional isLocal?: boolean
      • Optional metadata?: string
      • name: string
      • Optional networkQuality?: HMSNetworkQuality
      • peerID: string
      • Optional remoteAudioTrackData?: { id: string; isMute?: boolean; playbackAllowed?: boolean; source?: string | number; trackDescription?: string; trackId: string }
        • id: string
        • Optional isMute?: boolean
        • Optional playbackAllowed?: boolean
        • Optional source?: string | number
        • Optional trackDescription?: string
        • trackId: string
      • Optional remoteVideoTrackData?: { id: string; isMute?: boolean; layer?: any; playbackAllowed?: boolean; source?: string | number; trackDescription?: string; trackId: string }
        • id: string
        • Optional isMute?: boolean
        • Optional layer?: any
        • Optional playbackAllowed?: boolean
        • Optional source?: string | number
        • Optional trackDescription?: string
        • trackId: string
      • Optional role?: HMSRole
      • Optional videoTrack?: HMSVideoTrack

    Returns HMSRemotePeer

Properties

Optional audioTrack

audioTrack: HMSAudioTrack

Optional auxiliaryTracks

auxiliaryTracks: HMSTrack[]

Optional customerDescription

customerDescription: string

Optional customerUserID

customerUserID: string

Optional isLocal

isLocal: boolean

Optional metadata

metadata: string

name

name: string

Optional networkQuality

networkQuality: HMSNetworkQuality

peerID

peerID: string

Private Optional remoteAudio

remoteAudio: HMSRemoteAudioTrack

Private Optional remoteVideo

remoteVideo: HMSRemoteVideoTrack

Optional role

role: HMSRole

Optional videoTrack

videoTrack: HMSVideoTrack

Methods

remoteAudioTrack

remoteVideoTrack

Generated using TypeDoc