Constructor Detail

• CallState

  CallState(StreamVideo client, Call call, User user, CoroutineScope scope)

Method Detail

• getConnection

   final StateFlow<RealtimeConnection> getConnection()

• isReconnecting

   final StateFlow<Boolean> isReconnecting()

• getParticipants

   final StateFlow<List<ParticipantState>> getParticipants()

  Participants returns a list of participant state object. @see ParticipantState

• getStartedAt

   final StateFlow<OffsetDateTime> getStartedAt()

  Will return always null with current SFU implementation - it may be fixed later. For now do not use it.

• getParticipantCounts

   final StateFlow<ParticipantCount> getParticipantCounts()

• getTotalParticipants

   final StateFlow<Integer> getTotalParticipants()

  a count of the total number of participants.

• getMe

   final StateFlow<ParticipantState> getMe()

  Your own participant state

• getLocalParticipant

   final StateFlow<ParticipantState> getLocalParticipant()

  Your own participant state

• getActiveSpeakers

   final StateFlow<List<ParticipantState>> getActiveSpeakers()

• getRemoteParticipants

   final StateFlow<List<ParticipantState>> getRemoteParticipants()

  participants other than yourself

• getDominantSpeaker

   final StateFlow<ParticipantState> getDominantSpeaker()

• getPinnedParticipants

   final StateFlow<Map<String, OffsetDateTime>> getPinnedParticipants()

  Pinned participants, combined value both from server and local pins.

• getStats

   final CallStats getStats()

• getLivestream

   final StateFlow<ParticipantState.Video> getLivestream()

• getSortedParticipants

   final Flow<List<ParticipantState>> getSortedParticipants()

  Sorted participants based on

  • Pinned

  • Dominant Speaker

  • Screensharing

  • Last speaking at

  • Video enabled

  • Call joined at

  Debounced 100ms to avoid rapid changes

• getMembers

   final StateFlow<List<MemberState>> getMembers()

• getScreenSharingSession

   final StateFlow<ScreenSharingSession> getScreenSharingSession()

• getSpeakingWhileMuted

   final StateFlow<Boolean> getSpeakingWhileMuted()

• getRecording

   final StateFlow<Boolean> getRecording()

• getBlockedUsers

   final StateFlow<Set<String>> getBlockedUsers()

• getRingingState

   final StateFlow<RingingState> getRingingState()

• getSettings

   final StateFlow<CallSettingsResponse> getSettings()

• getDuration

   final StateFlow<Duration> getDuration()

  how long the call has been running, rounded to seconds, null if the call didn't start yet

• getDurationInMs

   final StateFlow<Long> getDurationInMs()

  how many milliseconds the call has been running, null if the call didn't start yet

• getDurationInDateFormat

   final StateFlow<String> getDurationInDateFormat()

  how many milliseconds the call has been running in the simple date format.

• getOwnCapabilities

   final StateFlow<List<OwnCapability>> getOwnCapabilities()

• getPermissionRequests

   final StateFlow<List<PermissionRequest>> getPermissionRequests()

• getCapabilitiesByRole

   final StateFlow<Map<String, List<String>>> getCapabilitiesByRole()

• getBackstage

   final StateFlow<Boolean> getBackstage()

  if we are in backstage mode or not

• getLive

   final StateFlow<Boolean> getLive()

  the opposite of backstage, if we are live or not

• getLiveDurationInMs

   final StateFlow<Long> getLiveDurationInMs()

  how many milliseconds the call has been running, null if the call didn't start yet

• getEgress

   final StateFlow<EgressResponse> getEgress()

• getEgressPlayListUrl

   final StateFlow<String> getEgressPlayListUrl()

• getBroadcasting

   final StateFlow<Boolean> getBroadcasting()

  if the call is being broadcasted to HLS

• getTranscribing

   final StateFlow<Boolean> getTranscribing()

• getAcceptedBy

   final StateFlow<Set<String>> getAcceptedBy()

• getRejectedBy

   final StateFlow<Set<String>> getRejectedBy()

• getSession

   final StateFlow<CallSessionResponse> getSession()

• getStartsAt

   final StateFlow<OffsetDateTime> getStartsAt()

• getUpdatedAt

   final StateFlow<OffsetDateTime> getUpdatedAt()

  updatedAt

• getCreatedAt

   final StateFlow<OffsetDateTime> getCreatedAt()

• getBlockedUserIds

   final StateFlow<List<String>> getBlockedUserIds()

• getCustom

   final StateFlow<Map<String, Object>> getCustom()

• getTeam

   final StateFlow<String> getTeam()

• getCreatedBy

   final StateFlow<User> getCreatedBy()

• getIngress

   final StateFlow<Ingress> getIngress()

• getEndedAt

   final StateFlow<OffsetDateTime> getEndedAt()

• getEndedByUser

   final StateFlow<User> getEndedByUser()

• getReactions

   final StateFlow<List<ReactionResponse>> getReactions()

• getErrors

   final StateFlow<List<ErrorEvent>> getErrors()

• updateParticipantSortingOrder

   final Unit updateParticipantSortingOrder(Comparator<ParticipantState> comparator)

  Update participant sorting order

  Parameters:

  comparator - a new comparator to be used in sortedParticipants flow.

• hasPermission

   final StateFlow<Boolean> hasPermission(String permission)

  Check if you have permissions to do things like share your audio, video, screen etc

• handleEvent

   final Unit handleEvent(VideoEvent event)

• markSpeakingAsMuted

   final Unit markSpeakingAsMuted()

• upsertParticipants

   final Unit upsertParticipants(List<ParticipantState> participants)

• getOrCreateParticipant

   final ParticipantState getOrCreateParticipant(String sessionId, String userId, Boolean updateFlow)

• getParticipantBySessionId

   final ParticipantState getParticipantBySessionId(String sessionId)

• updateParticipant

   final Unit updateParticipant(ParticipantState participant)

• clearParticipants

   final Unit clearParticipants()

• updateFromResponse

   final Unit updateFromResponse(CallResponse response)

• updateFromResponse

   final Unit updateFromResponse(GetOrCreateCallResponse response)

• updateFromResponse

   final Unit updateFromResponse(UpdateCallResponse response)

• updateFromResponse

   final Unit updateFromResponse(GetCallResponse response)

• updateFromResponse

   final Unit updateFromResponse(JoinCallResponse response)

• updateFromResponse

   final Unit updateFromResponse(CallStateResponseFields callData)

• updateFromResponse

   final Unit updateFromResponse(QueryMembersResponse it)

• updateFromResponse

   final Unit updateFromResponse(StopLiveResponse result)

• updateFromResponse

   final Unit updateFromResponse(GoLiveResponse result)

• updateFromResponse

   final Unit updateFromResponse(StartBroadcastingResponse response)

• getMember

   final MemberState getMember(String userId)

• pin

   final Unit pin(String userId, String sessionId)

• unpin

   final Unit unpin(String sessionId)

• updateParticipantVisibility

   final Unit updateParticipantVisibility(String sessionId, VisibilityOnScreenState visibilityOnScreenState)

  Update participants visibility on the UI.

  Parameters:

  sessionId - the session ID of the participant.

  visibilityOnScreenState - the visibility state.

• updateParticipantVisibilityFlow

   final Unit updateParticipantVisibilityFlow(Flow<List<String>> flow)

  Set a flow to update the participants visibility. The flow should emit lists with currently visible participant session IDs.

  Note: If you pass null to the parameter it will just cancel the currently observing flow.

  E.g. Grid visible items info can be used to update the CallState

  val gridState = rememberLazyGridState()
  val updateFlow = snapshotFlow {
       gridState.layoutInfo.visibleItemsInfo.map {
           it.key // Assuming keys are sessionId
       }
  }
  
  call.state.updateParticipantVisibilityFlow(updateFlow)

  Parameters:

  flow - a flow that emits updates with list of visible participants.