File

projects/openvidu-components-angular/src/lib/models/participant.model.ts

Description

Class that represents a participant in the room.

Index

Properties
Methods
Accessors

Constructor

constructor(props: ParticipantProperties)
Parameters :
Name Type Optional
props ParticipantProperties No

Properties

colorProfile
Type : string

The color profile associated with the participant. It specifies the visual representation of the participant in the user interface.

Methods

publishTrack
publishTrack(track: LocalTrack, options?: TrackPublishOptions)

Publishes a track to the room

Parameters :
Name Type Optional
track LocalTrack No
options TrackPublishOptions Yes
Returns : Promise<LocalTrackPublication>

Accessors

sid
getsid()

Returns the server assigned unique identifier for the participant.

Returns : string
name
getname()

Returns the participant name.

Returns : string | undefined
isCameraEnabled
getisCameraEnabled()

Returns if the participant has enabled its camera.

Returns : boolean
isMicrophoneEnabled
getisMicrophoneEnabled()

Returns if the participant has enabled its microphone.

Returns : boolean
isScreenShareEnabled
getisScreenShareEnabled()

Returns if the participant has enabled its screen share.

Returns : boolean
isSpeaking
getisSpeaking()

Returns if the participant is speaking.

Returns : boolean
tracks
gettracks()

Returns all the participant tracks.

videoTracks
getvideoTracks()

Returns all the participant video tracks.

audioTracks
getaudioTracks()

Returns all the participant audio tracks.

cameraTracks
getcameraTracks()

Returns all the participant camera tracks.

isLocal
getisLocal()

Returns if the participant is local.

Returns : boolean
onlyHasAudioTracks
getonlyHasAudioTracks()

Returns if the participant has only audio tracks.

Returns : boolean
onlyHasScreenTracks
getonlyHasScreenTracks()

Returns if the participant has only screen tracks.

Returns : boolean

results matching ""

    No results matching ""