Class LocalParticipant

Hierarchy

Participant
- LocalParticipant

Implements

LocalParticipantMethods

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new LocalParticipant(props: ParticipantProperties, binder: default, internalEvents: InternalEvents<RoomListener>, roomId: string): LocalParticipant

Overrides Participant.constructor
- Defined in src/libs/Participant.ts:74
Parameters
- props: ParticipantProperties
- binder: default
- internalEvents: InternalEvents<RoomListener>
- roomId: string
Returns LocalParticipant

Accessors

duration

get duration(): number

Inherited from Participant.duration
- Defined in src/libs/Participant.ts:47
Returns number

enteredAt

get enteredAt(): number

Inherited from Participant.enteredAt
- Defined in src/libs/Participant.ts:41
Returns number

exitedAt

get exitedAt(): number

Inherited from Participant.exitedAt
- Defined in src/libs/Participant.ts:44
Returns number

isAudioEnabled

get isAudioEnabled(): boolean

Inherited from Participant.isAudioEnabled
- Defined in src/libs/Participant.ts:50
Returns boolean

isVideoEnabled

get isVideoEnabled(): boolean

Inherited from Participant.isVideoEnabled
- Defined in src/libs/Participant.ts:53
Returns boolean

participantId

get participantId(): string

Inherited from Participant.participantId
- Defined in src/libs/Participant.ts:32
Returns string

state

get state(): ParticipantState

Inherited from Participant.state
- Defined in src/libs/Participant.ts:38
Returns ParticipantState

updatedAt

get updatedAt(): number

Inherited from Participant.updatedAt
- Defined in src/libs/Participant.ts:56
Returns number

user

get user(): User

Inherited from Participant.user
- Defined in src/libs/Participant.ts:35
Returns User

Methods

muteMicrophone

muteMicrophone(): void

Implementation of LocalParticipantMethods.muteMicrophone
- Defined in src/libs/Participant.ts:97
Mutes the audio of the local user. Will trigger RoomListener.onRemoteAudioSettingsChanged method of remote participants. If the remote user changes their audio settings, the local user will be notified via the same method.

since
1.0.0

Returns void

startVideo

startVideo(): void

Implementation of LocalParticipantMethods.startVideo
- Defined in src/libs/Participant.ts:142
Unmutes the audio of the local user. Will trigger RoomListener.onRemoteVideoSettingsChanged method of remote participants. If the remote user changes their video settings, the local user will be notified via the same method.

since
1.0.0

Returns void

stopVideo

stopVideo(): void

Implementation of LocalParticipantMethods.stopVideo
- Defined in src/libs/Participant.ts:127
Unmutes the audio of the local user. Will trigger RoomListener.onRemoteVideoSettingsChanged method of remote participants. If the remote user changes their video settings, the local user will be notified via the same method.

since
1.0.0

Returns void

switchCamera

switchCamera(): Promise<void>

Implementation of LocalParticipantMethods.switchCamera
- Defined in src/libs/Participant.ts:158
Toggles the selection between the front and the back camera.

on Android, In case of more than two cameras, the next camera will be selected. If the last camera is already selected, the first one will be selected again.

since
1.0.0

Returns Promise<void>

unmuteMicrophone

unmuteMicrophone(): void

Implementation of LocalParticipantMethods.unmuteMicrophone
- Defined in src/libs/Participant.ts:112
Unmutes the audio of the local user. Will trigger RoomListener.onRemoteAudioSettingsChanged method of remote participants. If the remote user changes their audio settings, the local user will be notified via the same method.

since
1.0.0

Returns void

Generated using TypeDoc