UNPKG

@videosdk.live/react-native-sdk

Version:

<h1 align="center"> <img src="https://cdn.videosdk.live/docs/images/react-native/banner.png" /><br/> </h1>

141 lines (138 loc) 4.2 kB
export class AgentParticipant { /** * @description This represents the participant's ID */ id: string; /** * @description This represents the participant's name */ displayName: string; /** * @description This represents the all the Streams that the participant is producing * */ streams: Map<string, Stream>; /** * @description This represents whether the participant is an agent. */ isAgent: boolean; /** * @description This represents the agent ID of the agentParticipant. */ agentId: string; /** * @description This represents participant's current pin state * */ pinState: { cam: boolean; share: boolean; }; /** * @description This represents participant's current webcam status */ webcamOn: boolean; /** * @description This represents participant's current mic status * */ micOn: boolean; /** * @description This represents participant's current mode * */ mode: 'SEND_AND_RECV' | 'SIGNALLING_ONLY' | 'RECV_ONLY' /** * @description This represents metaData which is passed in MeetingProvider * */ metaData: object; /** * @description This method can be used to kickout a participant from the meeting */ remove(): void; /** * @param type If `SHARE_AND_CAM` is provided, it will pin screenshare and camera of the participant. * If `CAM` is provided, it will only pin the participant's camera, If `SHARE` is provided, it will only pin the participant's screen share */ pin(type: 'SHARE_AND_CAM' | 'CAM' | 'SHARE'): void; /** * @param type If `SHARE_AND_CAM` is provided, it will unpin screenshare and camera of the participant. * If `CAM` is provided, it will only unpin the participant's camera, If `SHARE` is provided, it will only unpin the participant's screen share */ unpin(type: 'SHARE_AND_CAM' | 'CAM' | 'SHARE'): void; /** * @description This method returns the Video Statistics of the participant. * To learn more about the video statistics check these [reference](https://docs.videosdk.live/react/guide/video-and-audio-calling-api-sdk/render-media/understanding-call-quality) */ getVideoStats(): Promise< Array<{ bitrate: number; rtt: number; network: string; codec: string; jitter: number; limitation: any; totalPackets: number; packetsLost: number; concealmentEvents: number; insertedSamplesForDecelaration: number; removedSamplesForAccelaration: number; size: any; currentSpatialLayer: number; currentTemporalLayer: number; preferredSpatialLayer: number; preferredTemporalLayer: number; }> >; /** * @description This method returns the Audio Statistics of the participant. * To learn more about the video statistics check these [reference](https://docs.videosdk.live/react/guide/video-and-audio-calling-api-sdk/render-media/understanding-call-quality) */ getAudioStats(): Promise< Array<{ bitrate: number; rtt: number; network: string; codec: string; jitter: number; totalPackets: number; packetsLost: number; concealmentEvents: number; insertedSamplesForDecelaration: number; removedSamplesForAccelaration: number; size: any; }> >; /** * Add event listener * @param eventType Event name to which you want to subscribe. * @param listener Callback function which will be triggered when the event happens */ on( eventType: | "stream-enabled" | "stream-disabled" | "media-status-changed" | "agent-state-changed" | "transcription-received" | 'agent-metrics', listener: (data: any) => void ): void; /** * Remove event * @param eventType Event name to which you want to unsubscribe. * @param listener Callback function which was passed while subscribing to the event */ off( eventType: | "stream-enabled" | "stream-disabled" | "media-status-changed" | "agent-state-changed" | "transcription-received" | 'agent-metrics', listener: (data: any) => void ): void; } import { Stream } from './stream';