
public class Participant

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`Participant.Identity`
`public final class`	`Participant.Sid`
`public enum`	`Participant.Kind`
`public enum`	`Participant.State`

Field Summary

Fields
Modifier and Type	Field	Description
`private final EventListenable<ParticipantEvent>`	`events`
`private LivekitModels.ParticipantInfo`	`participantInfo`
`private Participant.Identity`	`identity`
`private Participant.State`	`state`
`private Float`	`audioLevel`
`private Boolean`	`isSpeaking`
`private String`	`name`
`private String`	`metadata`
`private Map<String, String>`	`attributes`
`private AgentAttributes`	`agentAttributes`
`private ParticipantPermission`	`permissions`
`private ConnectionQuality`	`connectionQuality`
`private final Long`	`joinedAt`
`private Long`	`lastSpokeAt`
`private Participant.Kind`	`kind`
`private final Boolean`	`hasInfo`
`private <ERROR CLASS>`	`trackPublications`
`private final <ERROR CLASS>`	`audioTrackPublications`
`private final <ERROR CLASS>`	`videoTrackPublications`
`private final <ERROR CLASS>`	`isMicrophoneEnabled`
`private final <ERROR CLASS>`	`isCameraEnabled`
`private final <ERROR CLASS>`	`isScreenShareEnabled`
`private Participant.Sid`	`sid`

Constructor Summary

Constructors
Constructor	Description
`Participant(Participant.Sid sid, Participant.Identity identity, CoroutineDispatcher coroutineDispatcher)`

Method Summary

Modifier and Type	Method	Description
`final EventListenable<ParticipantEvent>`	`getEvents()`
`final LivekitModels.ParticipantInfo`	`getParticipantInfo()`	Changes can be observed by using io.livekit.android.util.flow
`final Unit`	`setParticipantInfo(@FlowObservable() LivekitModels.ParticipantInfo participantInfo)`
`final Participant.Identity`	`getIdentity()`	The participant's identity on the server.
`final Unit`	`setIdentity(@FlowObservable() Participant.Identity identity)`
`final Participant.State`	`getState()`	The participant state.
`final Unit`	`setState(@FlowObservable() Participant.State state)`
`final Float`	`getAudioLevel()`	Changes can be observed by using io.livekit.android.util.flow
`final Unit`	`setAudioLevel(@FlowObservable() Float audioLevel)`
`final Boolean`	`getIsSpeaking()`	Changes can be observed by using io.livekit.android.util.flowA ParticipantEvent.SpeakingChanged event is emitted from events whenever this changes.
`final Unit`	`setIsSpeaking(@FlowObservable() Boolean isSpeaking)`
`final String`	`getName()`	The participant's name.
`final Unit`	`setName(@FlowObservable() String name)`
`final String`	`getMetadata()`	The metadata for this participant.
`final Unit`	`setMetadata(@FlowObservable() String metadata)`
`final Map<String, String>`	`getAttributes()`	The attributes set on this participant.
`final Unit`	`setAttributes(@FlowObservable() Map<String, String> attributes)`
`final AgentAttributes`	`getAgentAttributes()`	The agent attributes for this participant.
`final Unit`	`setAgentAttributes(@FlowObservable() AgentAttributes agentAttributes)`	The agent attributes for this participant.
`final ParticipantPermission`	`getPermissions()`	The permissions for this participant.
`final Unit`	`setPermissions(@FlowObservable() ParticipantPermission permissions)`
`final ConnectionQuality`	`getConnectionQuality()`	Changes can be observed by using io.livekit.android.util.flow
`final Unit`	`setConnectionQuality(@FlowObservable() ConnectionQuality connectionQuality)`
`final Long`	`getJoinedAt()`
`final Long`	`getLastSpokeAt()`	Timestamp when the participant last started speaking, in milliseconds
`final Unit`	`setLastSpokeAt(@FlowObservable() Long lastSpokeAt)`
`final Participant.Kind`	`getKind()`	The kind of participant (i.e.
`final Unit`	`setKind(@FlowObservable() Participant.Kind kind)`
`final Boolean`	`getHasInfo()`
`final <ERROR CLASS>`	`getTrackPublications()`	Maps track sids to their track publications.
`final Unit`	`)>setTrackPublications(@FlowObservable() <ERROR CLASS> trackPublications)`
`final <ERROR CLASS>`	`getAudioTrackPublications()`	Changes can be observed by using io.livekit.android.util.flow
`final <ERROR CLASS>`	`getVideoTrackPublications()`	Changes can be observed by using io.livekit.android.util.flow
`final <ERROR CLASS>`	`getIsMicrophoneEnabled()`
`final <ERROR CLASS>`	`getIsCameraEnabled()`
`final <ERROR CLASS>`	`getIsScreenShareEnabled()`
`final Participant.Sid`	`getSid()`
`final Unit`	`setSid(Participant.Sid sid)`
`TrackPublication`	`getTrackPublication(Track.Source source)`	Retrieves the first track that matches the source, or null
`TrackPublication`	`getTrackPublicationByName(String name)`	Retrieves the first track that matches name, or null
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Participant

Participant(Participant.Sid sid, Participant.Identity identity, CoroutineDispatcher coroutineDispatcher)

Method Detail
- getEvents
```
 final EventListenable<ParticipantEvent> getEvents()
```
- getParticipantInfo
```
@FlowObservable() final LivekitModels.ParticipantInfo getParticipantInfo()
```
  Changes can be observed by using io.livekit.android.util.flow
- setParticipantInfo
```
 final Unit setParticipantInfo(@FlowObservable() LivekitModels.ParticipantInfo participantInfo)
```
- getIdentity
```
@FlowObservable() final Participant.Identity getIdentity()
```
  The participant's identity on the server. name should be preferred for UI usecases.
  Changes can be observed by using io.livekit.android.util.flow
- setIdentity
```
@VisibleForTesting() final Unit setIdentity(@FlowObservable() Participant.Identity identity)
```
- getState
```
@FlowObservable() final Participant.State getState()
```
  The participant state.
  Changes can be observed by using io.livekit.android.util.flow
- setState
```
@VisibleForTesting() final Unit setState(@FlowObservable() Participant.State state)
```
- getAudioLevel
```
@FlowObservable() final Float getAudioLevel()
```
  Changes can be observed by using io.livekit.android.util.flow
- setAudioLevel
```
@VisibleForTesting() final Unit setAudioLevel(@FlowObservable() Float audioLevel)
```
- getIsSpeaking
```
@FlowObservable() final Boolean getIsSpeaking()
```
  Changes can be observed by using io.livekit.android.util.flow
  A ParticipantEvent.SpeakingChanged event is emitted from events whenever this changes.
- setIsSpeaking
```
@VisibleForTesting() final Unit setIsSpeaking(@FlowObservable() Boolean isSpeaking)
```
- getName
```
@FlowObservable() final String getName()
```
  The participant's name. To be used for user-facing purposes (i.e. when displayed in the UI).
  Changes can be observed by using io.livekit.android.util.flow
  A ParticipantEvent.NameChanged event is emitted from events whenever this changes.
- setName
```
@VisibleForTesting() final Unit setName(@FlowObservable() String name)
```
- getMetadata
```
@FlowObservable() final String getMetadata()
```
  The metadata for this participant.
  Changes can be observed by using io.livekit.android.util.flow
  A ParticipantEvent.MetadataChanged event is emitted from events whenever this changes.
- setMetadata
```
@VisibleForTesting() final Unit setMetadata(@FlowObservable() String metadata)
```
- getAttributes
```
@FlowObservable() final Map<String, String> getAttributes()
```
  The attributes set on this participant.
  Changes can be observed by using io.livekit.android.util.flow
  A ParticipantEvent.AttributesChanged event is emitted from events whenever this changes.
- setAttributes
```
@VisibleForTesting() final Unit setAttributes(@FlowObservable() Map<String, String> attributes)
```
- getAgentAttributes
```
@FlowObservable() final AgentAttributes getAgentAttributes()
```
  The agent attributes for this participant.
  Changes can be observed by using io.livekit.android.util.flow
  A ParticipantEvent.AttributesChanged event is emitted from events whenever this changes.
- setAgentAttributes
```
 final Unit setAgentAttributes(@FlowObservable() AgentAttributes agentAttributes)
```
  The agent attributes for this participant.
  Changes can be observed by using io.livekit.android.util.flow
  A ParticipantEvent.AttributesChanged event is emitted from events whenever this changes.
- getPermissions
```
@FlowObservable() final ParticipantPermission getPermissions()
```
  The permissions for this participant.
  Changes can be observed by using io.livekit.android.util.flow
  A ParticipantEvent.ParticipantPermissionsChanged event is emitted from events whenever this changes.
- setPermissions
```
 final Unit setPermissions(@FlowObservable() ParticipantPermission permissions)
```
- getConnectionQuality
```
@FlowObservable() final ConnectionQuality getConnectionQuality()
```
  Changes can be observed by using io.livekit.android.util.flow
- setConnectionQuality
```
 final Unit setConnectionQuality(@FlowObservable() ConnectionQuality connectionQuality)
```
- getJoinedAt
```
 final Long getJoinedAt()
```
- getLastSpokeAt
```
@FlowObservable() final Long getLastSpokeAt()
```
  Timestamp when the participant last started speaking, in milliseconds
- setLastSpokeAt
```
 final Unit setLastSpokeAt(@FlowObservable() Long lastSpokeAt)
```
- getKind
```
@FlowObservable() final Participant.Kind getKind()
```
  The kind of participant (i.e. a standard client participant, AI agent, etc.)
- setKind
```
 final Unit setKind(@FlowObservable() Participant.Kind kind)
```
- getHasInfo
```
 final Boolean getHasInfo()
```
- getTrackPublications
```
@FlowObservable() final <ERROR CLASS> getTrackPublications()
```
  Maps track sids to their track publications.
  Changes can be observed by using io.livekit.android.util.flow
- setTrackPublications
```
 final Unit )>setTrackPublications(@FlowObservable() <ERROR CLASS> trackPublications)
```
- getAudioTrackPublications
```
@FlowObservable() final <ERROR CLASS> getAudioTrackPublications()
```
  Changes can be observed by using io.livekit.android.util.flow
- getVideoTrackPublications
```
@FlowObservable() final <ERROR CLASS> getVideoTrackPublications()
```
  Changes can be observed by using io.livekit.android.util.flow
- getIsMicrophoneEnabled
```
@FlowObservable() final <ERROR CLASS> getIsMicrophoneEnabled()
```
- getIsCameraEnabled
```
@FlowObservable() final <ERROR CLASS> getIsCameraEnabled()
```
- getIsScreenShareEnabled
```
@FlowObservable() final <ERROR CLASS> getIsScreenShareEnabled()
```
- getSid
```
 final Participant.Sid getSid()
```
- setSid
```
 final Unit setSid(Participant.Sid sid)
```
- getTrackPublication
```
 TrackPublication getTrackPublication(Track.Source source)
```
  Retrieves the first track that matches the source, or null
- getTrackPublicationByName
```
 TrackPublication getTrackPublicationByName(String name)
```
  Retrieves the first track that matches name, or null
- equals
```
 Boolean equals(Object other)
```
- hashCode
```
 Integer hashCode()
```

Class Participant

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Participant

Method Detail

getEvents

getParticipantInfo

setParticipantInfo

getIdentity

setIdentity

getState

setState

getAudioLevel

setAudioLevel

getIsSpeaking

setIsSpeaking

getName

setName

getMetadata

setMetadata

getAttributes

setAttributes

getAgentAttributes

setAgentAttributes

getPermissions

setPermissions

getConnectionQuality

setConnectionQuality

getJoinedAt

getLastSpokeAt

setLastSpokeAt

getKind

setKind

getHasInfo

getTrackPublications

setTrackPublications

getAudioTrackPublications

getVideoTrackPublications

getIsMicrophoneEnabled

getIsCameraEnabled

getIsScreenShareEnabled

getSid

setSid

getTrackPublication

getTrackPublicationByName

equals

hashCode