Constructor Detail

• CallState

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

Method Detail

• getCallActions

   final CallActions getCallActions()

• getConnection

   final StateFlow<RealtimeConnection> getConnection()

• getIsReconnecting

   final StateFlow<Boolean> getIsReconnecting()

• getParticipants

   final StateFlow<List<ParticipantState>> getParticipants()

• 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()

• getE2eeEnabled

   final StateFlow<Boolean> getE2eeEnabled()

  Whether media on this call is end-to-end encrypted, which is true once an io.getstream.video.android.core.e2ee.E2EEManager is attached via Call.setE2EEManager or implicitly by setting a key. Use it to show a lock indicator.

  Whether the call type permits encryption at all is a separate thing, readable from settings.value?.encryption?.mode.

• 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, in the same sort order as participants. Lazy-initialized to defer resolving _sortedParticipantsState (defined later in this class).

• 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()

• getMembers

   final StateFlow<List<MemberState>> getMembers()

• getScreenSharingSession

   final StateFlow<ScreenSharingSession> getScreenSharingSession()

• getSpeakingWhileMuted

   final StateFlow<Boolean> getSpeakingWhileMuted()

• getRecording

   final StateFlow<Boolean> getRecording()

• getIndividualRecording

   final StateFlow<Boolean> getIndividualRecording()

• getRawRecording

   final StateFlow<Boolean> getRawRecording()

• getCompositeRecording

   final StateFlow<Boolean> getCompositeRecording()

• getBlockedUsers

   final StateFlow<Set<String>> getBlockedUsers()

• getRingingState

   final StateFlow<RingingState> getRingingState()

• getSettings

   final StateFlow<CallSettingsResponse> getSettings()

• getAudioProcessingEnabled

   final StateFlow<Boolean> getAudioProcessingEnabled()

  Whether local audio processing (noise cancellation) is currently running for this call.

  The SDK changes this on its own, not only in response to the app: the call type's noise-cancellation mode and the user's enable-noise-cancellation capability can both withdraw it mid-call. Observe this instead of snapshotting Call.isAudioProcessingEnabled, or UI bound to it will go stale.

• 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 <ERROR CLASS> getLiveDurationInMs()

  How long the call has been live for, in milliseconds, or null if the call hasn't been live yet. Keeps its value when live ends and resets when live starts again.

• getLiveDuration

   final <ERROR CLASS> getLiveDuration()

  How long the call has been live for, represented as Duration, or null if the call hasn't been live yet. Keeps its value when live ends and resets when live starts again.

• 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()

• getRejectActionBundle

   final StateFlow<Bundle> getRejectActionBundle()

• 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()

• getParticipantVideoEnabledOverrides

   final <ERROR CLASS> getParticipantVideoEnabledOverrides()

• getThumbnail

   final StateFlow<String> getThumbnail()

• getModerationManager

   final ModerationManager getModerationManager()

• getIsCaptioning

   final StateFlow<Boolean> getIsCaptioning()

  Tracks whether closed captioning is currently active for the call. True if captioning is ongoing, false otherwise.

• getClosedCaptions

   final StateFlow<List<CallClosedCaption>> getClosedCaptions()

  Holds the current list of closed captions. This list is updated dynamically and contains at most ClosedCaptionsSettings.maxVisibleCaptions captions.

• getCcMode

   final StateFlow<TranscriptionSettingsResponse.ClosedCaptionMode> getCcMode()

  Holds the current closed caption mode for the video call. This object contains information about closed captioning feature availability. This state is updated dynamically based on the server's transcription setting which is io.getstream.android.video.generated.models.TranscriptionSettingsResponse.closedCaptionMode

  Possible values:

  • ClosedCaptionMode.Available: Closed captions are available and can be enabled.

  • ClosedCaptionMode.Disabled: Closed captions are explicitly disabled.

  • ClosedCaptionMode.AutoOn: Closed captions are automatically enabled as soon as user joins the call

  • ClosedCaptionMode.Unknown: Represents an unrecognized or unsupported mode.

• getNotificationIdFlow

   final StateFlow<Integer> getNotificationIdFlow()

• getScope

   final CoroutineScope getScope()

• setSortPreset

   final Unit setSortPreset(SortPreset preset)

  Switch the active sort preset.

• updateParticipantSortingOrder

   final Unit )>updateParticipantSortingOrder(<ERROR CLASS><ParticipantState> comparator)

  Plug in an ad-hoc Comparator for participant sorting. Overrides the active preset until called again with a different comparator or setSortPreset is invoked.

  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)

• cancelTimeout

   final Unit cancelTimeout()

• markSpeakingAsMuted

   final Unit markSpeakingAsMuted()

• upsertParticipants

   final Unit upsertParticipants(List<ParticipantState> participants)

• getOrCreateParticipant

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

• 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(QueryCallMembersResponse it)

• updateFromResponse

   final Unit updateFromResponse(StopLiveResponse result)

• updateFromResponse

   final Unit updateFromResponse(GoLiveResponse result)

• updateFromResponse

   final Unit updateFromResponse(StartHLSBroadcastingResponse 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.

• replaceParticipants

   final Unit replaceParticipants(List<ParticipantState> participants)

• updateRejectedBy

   final Unit updateRejectedBy(Set<String> userId)

• updateRejectActionBundle

   final Unit updateRejectActionBundle(Bundle bundle)

• updateNotification

  @Deprecated(message = Use updateNotification(Int, Notification) instead) final Unit updateNotification(Notification notification)

• updateNotification

   final Unit updateNotification(Integer notificationId, Notification notification)

• setOwnCapabilities

   final Unit setOwnCapabilities(List<OwnCapability> ownCapability)