projects/openvidu-components-angular/src/lib/services/participant/participant.service.ts
getLocalParticipant |
getLocalParticipant()
|
Returns the local participant object.
Returns :
ParticipantModel | undefined
|
getMyName |
getMyName()
|
Returns the local participant name.
Returns :
string | undefined
|
getRemoteParticipantBySid | ||||||
getRemoteParticipantBySid(sid: string)
|
||||||
Returns the remote participant with the given sid.
Parameters :
Returns :
ParticipantModel | undefined
|
getRemoteParticipants |
getRemoteParticipants()
|
Returns all remote participants in the room.
Returns :
ParticipantModel[]
|
isMyCameraEnabled |
isMyCameraEnabled()
|
Returns if the local participant camera is enabled.
Returns :
boolean
|
isMyMicrophoneEnabled |
isMyMicrophoneEnabled()
|
Returns if the local participant microphone is enabled.
Returns :
boolean
|
isMyScreenShareEnabled |
isMyScreenShareEnabled()
|
Returns if the local participant screen is enabled.
Returns :
boolean
|
Async setCameraEnabled | ||||||
setCameraEnabled(enabled: boolean)
|
||||||
Sets the local participant camera enabled or disabled.
Parameters :
Returns :
Promise<void>
|
Async setMicrophoneEnabled | ||||||
setMicrophoneEnabled(enabled: boolean)
|
||||||
Sets the local participant microphone enabled or disabled.
Parameters :
Returns :
Promise<void>
|
Async setScreenShareEnabled | ||||||||
setScreenShareEnabled(enabled: boolean)
|
||||||||
Share or unshare the local participant screen.
Parameters :
Returns :
Promise<void>
|
Async switchCamera | ||||||
switchCamera(deviceId: string)
|
||||||
Switches the active camera track used in this room to the given device id.
Parameters :
Returns :
Promise<void>
|
Async switchMicrophone | ||||||
switchMicrophone(deviceId: string)
|
||||||
Switches the active microphone track used in this room to the given device id.
Parameters :
Returns :
Promise<void>
|
Async switchScreenShare |
switchScreenShare()
|
Switches the active screen share track showing a native browser dialog to select a screen or window.
Returns :
Promise<void>
|
updateLocalParticipant |
updateLocalParticipant()
|
Forces to update the local participant object and fire a new
Returns :
void
|
updateRemoteParticipants |
updateRemoteParticipants()
|
Force to update the remote participants object and fire a new
Returns :
void
|
localParticipant$ |
Type : Observable<ParticipantModel | undefined>
|
Local participant Observable which pushes the local participant object in every update. |
remoteParticipants$ |
Type : Observable<ParticipantModel[]>
|
Remote participants Observable which pushes the remote participants array in every update. |