stream_video_flutter library

Stream Video Flutter UI toolkit and widgets.

High-level Flutter components, themes, and utilities for building call experiences with the Stream Video SDK. Import this library to access call screens, participants views, controls, livestream UI, screen sharing, and related helpers built on top of package:stream_video/stream_video.dart.

Classes

AbstractSettings
AcceptCallResponse
ActionCallAccept
Represents a call accept event.
ActionCallCallback
Represents a call callback event.
ActionCallConnected
ActionCallCustom
Represents a custom call event.
ActionCallDecline
Represents a call decline event.
ActionCallEnded
Represents a call end event.
ActionCallIncoming
Represents an incoming call event.
ActionCallStart
Represents a call start event.
ActionCallTimeout
Represents a call timeout event.
ActionCallToggleAudioSession
Represents a call toggle audio session event.
ActionCallToggleDmtf
Represents a call toggle DMTF event.
ActionCallToggleGroup
Represents a call toggle group event.
ActionCallToggleHold
Represents a call toggle hold event.
ActionCallToggleMute
Represents a call toggle mute event.
ActionDidUpdateDevicePushTokenVoip
Event for updating the VoIP push token on the device (iOS specific).
AddReactionOption
A widget that allows a user to add a reaction
AndroidPictureInPictureConfiguration
AndroidPipOverlay
A dedicated overlay widget for Android Picture-in-Picture mode. This widget creates a floating overlay that shows only the video content optimized for PiP viewing.
ApiClient
APIError
ApiKeyAuth
AppEventResponse
AppUpdatedEvent
AudioConstraints
Options used when creating an AudioTrack.
AudioProcessor
AudioRecognition
AudioSettingsRequest
AudioSettingsRequestDefaultDeviceEnum
AudioSettingsRequestDefaultDeviceEnumTypeTransformer
Transformation class that can encode an instance of AudioSettingsRequestDefaultDeviceEnum to String, and decode dynamic data back to AudioSettingsRequestDefaultDeviceEnum.
AudioSettingsResponse
AudioSettingsResponseDefaultDeviceEnum
AudioSettingsResponseDefaultDeviceEnumTypeTransformer
Transformation class that can encode an instance of AudioSettingsResponseDefaultDeviceEnum to String, and decode dynamic data back to AudioSettingsResponseDefaultDeviceEnum.
Authentication
BackstageSettingsRequest
BackstageSettingsResponse
BlockedUserEvent
BlockUserRequest
BlockUserResponse
Bound
BroadcastSettingsRequest
BroadcastSettingsResponse
Call
Represents a Call in which you can connect to.
CallAcceptedEvent
CallAppBar
Widget that represents the default app bar that's shown in calls.
CallbackData
Data that can be used to build a part of the call screen.
CallClosedCaption
CallClosedCaptionsFailedEvent
CallClosedCaptionsStartedEvent
CallClosedCaptionsStoppedEvent
CallConnectOptions
CallControlOption
Widget that represents a call control option.
CallCreatedData
CallCreatedEvent
CallCredentials
CallData
Represents call data with various properties related to the call.
CallDeletedEvent
CallDetails
CallDisconnectedProperties
CallDurationReport
CallDurationReportResponse
CallEgress
CallEgressRtmp
CallEndedEvent
CallFrameRecordingFailedEvent
CallFrameRecordingFrameReadyEvent
CallFrameRecordingStartedEvent
CallFrameRecordingStoppedEvent
CallHLSBroadcastingFailedEvent
CallHLSBroadcastingStartedEvent
CallHLSBroadcastingStoppedEvent
CallIceServer
CallIngressResponse
CallJoinedData
CallKitEvent
Represents an event related to the CallKit.
CallLiveStartedEvent
CallMember
CallMemberAddedEvent
CallMemberRemovedEvent
CallMemberUpdatedEvent
CallMemberUpdatedPermissionEvent
CallMetadata
CallMetrics
CallMissedEvent
CallNotificationEvent
CallParticipant
CallParticipantCountReport
CallParticipantCountReportResponse
CallParticipantResponse
CallParticipantState
CallPreferences
CallReaction
CallReactionData
CallReactionEvent
CallReceivedOrCreatedData
CallRecording
CallRecordingFailedEvent
CallRecordingReadyEvent
CallRecordingStartedEvent
CallRecordingStoppedEvent
CallRejectedEvent
CallRejectReason
Reason for rejecting a call.
CallReportResponse
CallRequest
CallResponse
CallRingEvent
CallRingingData
CallRtmpBroadcastFailedEvent
CallRtmpBroadcastStartedEvent
CallRtmpBroadcastStoppedEvent
CallSessionData
CallSessionEndedEvent
CallSessionParticipantCountsUpdatedEvent
CallSessionParticipantJoinedEvent
CallSessionParticipantLeftEvent
CallSessionResponse
CallSessionStartedEvent
CallSettings
CallSettingsRequest
CallSettingsResponse
CallSfuServer
CallsPerDayReport
CallsPerDayReportResponse
CallState
Represents the call's state.
CallStateResponseFields
CallStatsReportReadyEvent
CallStatsReportSummaryResponse
CallStatus
CallStatusActive
CallStatusConnected
CallStatusConnecting
CallStatusDisconnected
CallStatusIdle
CallStatusIncoming
CallStatusJoined
CallStatusJoining
CallStatusMigrating
CallStatusOutgoing
CallStatusReconnecting
CallStatusReconnectionFailed
CallTranscription
CallTranscriptionFailedEvent
CallTranscriptionReadyEvent
CallTranscriptionStartedEvent
CallTranscriptionStoppedEvent
CallUpdatedEvent
CallUser
CallUserMutedEvent
CameraConstraints
Options used when creating a video track that captures the camera.
ChatActivityStatsResponse
ClientEnvironment
ClientPublishOptions
ClosedCaptionEvent
CollectUserFeedbackRequest
CollectUserFeedbackResponse
CompositeStreamLogger
ConnectedEvent
ConnectionErrorEvent
ConnectUserDetailsRequest
ConsoleStreamLogger
CoordinatorCallAcceptedEvent
Sent when a user accepts the call.
CoordinatorCallBroadcastingFailedEvent
CoordinatorCallBroadcastingStartedEvent
CoordinatorCallBroadcastingStoppedEvent
CoordinatorCallClosedCaptionEvent
CoordinatorCallClosedCaptionFailedEvent
CoordinatorCallClosedCaptionStartedEvent
CoordinatorCallClosedCaptionStoppedEvent
CoordinatorCallCreatedEvent
Sent when someone creates a call and invites another person to participate.
CoordinatorCallCustomEvent
CoordinatorCallEndedEvent
Sent when a calls gets ended.
CoordinatorCallEvent
CoordinatorCallFrameRecordingFailedEvent
CoordinatorCallFrameRecordingReadyEvent
CoordinatorCallFrameRecordingStartedEvent
CoordinatorCallFrameRecordingStoppedEvent
CoordinatorCallLiveStartedEvent
CoordinatorCallMemberAddedEvent
CoordinatorCallMemberRemovedEvent
CoordinatorCallMemberUpdatedEvent
CoordinatorCallMemberUpdatedPermissionEvent
CoordinatorCallMissedEvent
Sent when someone misses a call.
CoordinatorCallNotificationEvent
CoordinatorCallPermissionRequestEvent
CoordinatorCallPermissionsUpdatedEvent
CoordinatorCallReactionEvent
CoordinatorCallRecordingFailedEvent
CoordinatorCallRecordingReadyEvent
CoordinatorCallRecordingStartedEvent
CoordinatorCallRecordingStoppedEvent
CoordinatorCallRejectedEvent
Sent when a user rejects the call.
CoordinatorCallRingingEvent
Sent when someone creates a call and invites another person to participate.
CoordinatorCallSessionEndedEvent
CoordinatorCallSessionParticipantCountUpdatedEvent
CoordinatorCallSessionParticipantJoinedEvent
CoordinatorCallSessionParticipantLeftEvent
CoordinatorCallSessionStartedEvent
CoordinatorCallTranscriptionFailedEvent
CoordinatorCallTranscriptionStartedEvent
CoordinatorCallTranscriptionStoppedEvent
CoordinatorCallUpdatedEvent
Sent when a call gets updated.
CoordinatorCallUserBlockedEvent
CoordinatorCallUserKickedEvent
CoordinatorCallUserMutedEvent
CoordinatorCallUserUnblockedEvent
CoordinatorClient
CoordinatorConnectedEvent
Sent one time after successful connection.
CoordinatorDisconnectedEvent
Fired when web socket is closed.
CoordinatorEvent
Represents the events coming in from the socket.
CoordinatorHealthCheckEvent
Sent periodically by the server to keep the connection alive.
CoordinatorReconnectedEvent
Fired when web socket reconnected.
CoordinatorUnknownEvent
CoordinatorUnsupportedEvent
CountByMinuteResponse
CreateDeviceRequest
CreateDeviceRequestPushProviderEnum
Push provider
CreateDeviceRequestPushProviderEnumTypeTransformer
Transformation class that can encode an instance of CreateDeviceRequestPushProviderEnum to String, and decode dynamic data back to CreateDeviceRequestPushProviderEnum.
CreateGuestRequest
CreateGuestResponse
Credentials
CurrentPlatform
Utility class that provides information on the current platform
CustomVideoEvent
DailyAggregateCallDurationReportResponse
DailyAggregateCallParticipantCountReportResponse
DailyAggregateCallsPerDayReportResponse
DailyAggregateQualityScoreReportResponse
DailyAggregateSDKUsageReportResponse
DailyAggregateUserFeedbackReportResponse
DefaultCallPreferences
DeleteCallRequest
DeleteCallResponse
DeleteRecordingResponse
DeleteTranscriptionResponse
DeserializationMessage
Primarily intended for use in an isolate.
DesktopCapturerSource
DeviceResponse
DisconnectReason
DisconnectReasonBlocked
DisconnectReasonCancelled
DisconnectReasonEnded
DisconnectReasonFailure
DisconnectReasonLastParticipantLeft
DisconnectReasonManuallyClosed
DisconnectReasonReconnectionFailed
DisconnectReasonRejected
DisconnectReasonReplaced
DisconnectReasonSfuError
DisconnectReasonTimeout
DurationResponse
DynascaleManager
EdgeResponse
Effect
Effect store
EgressHLSResponse
EgressResponse
EgressRTMPResponse
EndCallResponse
Failure
Represents failed result.
FileLogConfig
FileStreamLogger
FileUploadConfig
FlipCameraOption
A widget that represents a call control option to flip the active camera.
FloatingViewContainer
A widget that uses either SimpleFloatingView or SnappingFloatingView depending on the enableSnappingBehavior.
FrameRecordingResponse
FrameRecordingSettingsRequest
FrameRecordingSettingsRequestModeEnum
FrameRecordingSettingsRequestModeEnumTypeTransformer
Transformation class that can encode an instance of FrameRecordingSettingsRequestModeEnum to String, and decode dynamic data back to FrameRecordingSettingsRequestModeEnum.
FrameRecordingSettingsRequestQualityEnum
FrameRecordingSettingsRequestQualityEnumTypeTransformer
Transformation class that can encode an instance of FrameRecordingSettingsRequestQualityEnum to String, and decode dynamic data back to FrameRecordingSettingsRequestQualityEnum.
FrameRecordingSettingsResponse
FrameRecordingSettingsResponseModeEnum
FrameRecordingSettingsResponseModeEnumTypeTransformer
Transformation class that can encode an instance of FrameRecordingSettingsResponseModeEnum to String, and decode dynamic data back to FrameRecordingSettingsResponseModeEnum.
GeofenceSettingsRequest
GeofenceSettingsResponse
GetCallReportResponse
GetCallResponse
GetEdgesResponse
GetOrCreateCallRequest
GetOrCreateCallResponse
GoLiveRequest
GoLiveResponse
GroupedStatsResponse
GuestCreatedData
HealthCheckEvent
HLSSettingsRequest
HLSSettingsResponse
HttpBasicAuth
HttpBearerAuth
ICEServer
IncomingVideoSettings
IngressAudioEncodingOptionsRequest
IngressAudioEncodingOptionsRequestChannelsEnum
IngressAudioEncodingOptionsRequestChannelsEnumTypeTransformer
Transformation class that can encode an instance of IngressAudioEncodingOptionsRequestChannelsEnum to int, and decode dynamic data back to IngressAudioEncodingOptionsRequestChannelsEnum.
IngressAudioEncodingResponse
IngressSettingsRequest
IngressSettingsResponse
IngressVideoEncodingOptionsRequest
IngressVideoEncodingResponse
IngressVideoLayerRequest
IngressVideoLayerRequestCodecEnum
IngressVideoLayerRequestCodecEnumTypeTransformer
Transformation class that can encode an instance of IngressVideoLayerRequestCodecEnum to String, and decode dynamic data back to IngressVideoLayerRequestCodecEnum.
IngressVideoLayerResponse
InterruptionBeginEvent
InterruptionEndEvent
InterruptionEvent
IOSPictureInPictureConfiguration
Configuration options for enabling Picture-in-Picture (PiP) mode on iOS.
JoinCallRequest
JoinCallResponse
KickedUserEvent
KickUserRequest
KickUserResponse
LandscapeCallControls
A widget that represents call controls on mobile devices in landscape mode.
LayoutSettingsRequest
LayoutSettingsRequestNameEnum
LayoutSettingsRequestNameEnumTypeTransformer
Transformation class that can encode an instance of LayoutSettingsRequestNameEnum to String, and decode dynamic data back to LayoutSettingsRequestNameEnum.
LeaveCallOption
A widget that represents a call control option to leave a call.
LimitsSettingsRequest
LimitsSettingsResponse
ListDevicesResponse
ListRecordingsResponse
ListTranscriptionsResponse
LivestreamBackstageContent
LivestreamContent
The video renderer widget associated with LivestreamPlayer.
LivestreamEndedContent
LivestreamHostsUnavailableProperties
LivestreamInfo
A control bar style widget meant for displaying livestream controls and actions.
LivestreamNotConnectedProperties
LivestreamPlayer
Creates a widget that allows a user to view a livestream.
LivestreamSpeakerphoneOption
A widget that represents a call control option to toggle if the speakerphone is on or off.
LocalTrackState
MediaConstraints
MediaSettings
MediaStatsInfo
MemberRequest
MemberResponse
MessageStatsResponse
MutableStateEmitter<T>
MuteToggleTitles
Contains titles for muted and unmuted states.
MuteUsersRequest
MuteUsersResponse
NativeWebRtcEvent
NetworkMetricsReportResponse
NetworkMonitorEndpoint
NetworkMonitorSettings
NoiseCancellationSettings
NoiseCancellationSettingsModeEnum
NoiseCancellationSettingsModeEnumTypeTransformer
Transformation class that can encode an instance of NoiseCancellationSettingsModeEnum to String, and decode dynamic data back to NoiseCancellationSettingsModeEnum.
None
Used instead of void as a return statement for a function when no value is expected to be returned.
NotificationAvatar
NotificationContent
NotificationOptions
NotificationPayload
OAuth
OwnCapability
All possibility of string to use
OwnCapabilityTypeTransformer
Transformation class that can encode an instance of OwnCapability to String, and decode dynamic data back to OwnCapability.
OwnUserResponse
PartialCallStateBuilder<T>
Convenience widget to build a part of the call screen based on a partial call state.
PartialStateDeprecationMessage
ParticipantCountByMinuteResponse
ParticipantCountOverTimeResponse
ParticipantReportResponse
ParticipantsData
Data about participants in a call. Used by incoming and outgoing call content.
PeerConnectionStats
PeerConnectionStatsBundle
PermissionRequestEvent
PerSDKUsageReport
PictureInPictureConfiguration
Configuration for picture-in-picture mode.
PinRequest
PinResponse
PortraitCallControls
A widget that represents call controls on desktop devices and on mobile devices in portrait mode.
PrivacySettings
ProductvideoApi
PublisherStatsResponse
PushDevice
PushNotificationManager
Interface for managing push notifications related to call events.
PushPreferences
QualityScoreReport
QualityScoreReportResponse
QueriedCall
QueriedCalls
QueriedMembers
QueryAggregateCallStatsRequest
QueryAggregateCallStatsResponse
QueryCallMembersRequest
QueryCallMembersResponse
QueryCallParticipantsRequest
QueryCallParticipantsResponse
QueryCallsRequest
QueryCallsResponse
QueryCallStatsRequest
QueryCallStatsResponse
QueryParam
ReactionResponse
ReadReceipts
RecordSettingsRequest
RecordSettingsRequestModeEnum
RecordSettingsRequestModeEnumTypeTransformer
Transformation class that can encode an instance of RecordSettingsRequestModeEnum to String, and decode dynamic data back to RecordSettingsRequestModeEnum.
RecordSettingsRequestQualityEnum
RecordSettingsRequestQualityEnumTypeTransformer
Transformation class that can encode an instance of RecordSettingsRequestQualityEnum to String, and decode dynamic data back to RecordSettingsRequestQualityEnum.
RecordSettingsResponse
RejectCallRequest
RejectCallResponse
RemoteTrackState
ReportByHistogramBucket
ReportResponse
RequestPermissionRequest
RequestPermissionResponse
Result<T>
A class which encapsulates a successful outcome with a value of type T or a failure with VideoError.
RetryConfig
RetryPolicy
RingSettingsRequest
RingSettingsResponse
RTCConfiguration
RTCIceServer
RtcLocalTrack<T extends MediaConstraints>
RtcMediaDevice
RtcMediaDeviceNotifier
RtcRemoteTrack
RtcTrack
RtcVideoDimension
RtcVideoParameters
RTMPBroadcastRequest
RTMPBroadcastRequestQualityEnum
If provided, will override the call's RTMP settings quality
RTMPBroadcastRequestQualityEnumTypeTransformer
Transformation class that can encode an instance of RTMPBroadcastRequestQualityEnum to String, and decode dynamic data back to RTMPBroadcastRequestQualityEnum.
RTMPIngress
RTMPSettingsRequest
RTMPSettingsRequestQualityEnum
Resolution to set for the RTMP stream
RTMPSettingsRequestQualityEnumTypeTransformer
Transformation class that can encode an instance of RTMPSettingsRequestQualityEnum to String, and decode dynamic data back to RTMPSettingsRequestQualityEnum.
RTMPSettingsResponse
ScreenSelectorState
ScreenSelectorStateNotifier
The ScreenSelectorStateNotifier is used to keep track of the available screens and windows to share. This is used by showDefaultScreenSelectionDialog, but can be used directly if you want to build a custom widget. Can be used in combination with a ValueListenableBuilder to get stateful updates.
ScreenShareConstraints
Options used when creating a video track that captures the screen.
ScreenShareThumbnailWidget
ScreensharingSettingsRequest
ScreensharingSettingsResponse
ScreenSharingStartedEvent
ScreenSharingStoppedEvent
SDKUsageReport
SDKUsageReportResponse
SendCallEventRequest
SendCallEventResponse
SendReactionRequest
SendReactionResponse
SessionConnectionFailure
SessionSettingsRequest
SessionSettingsResponse
SfuError
SFUResponse
SfuTrackType
SfuTrackTypeAudio
SfuTrackTypeVideo
SilentStreamLogger
SizeChangeListener
A widget that calls the callback when the layout dimensions of its child change.
SortParamRequest
SoundState
SpeakingWhileMutedRecognition
The SpeakingWhileMutedRecognition.stream emits state changes when an increase in audio volume is detected while the user is muted.
SpeakingWhileMutedState
StartClosedCaptionsRequest
StartClosedCaptionsRequestLanguageEnum
The spoken language in the call, if not provided the language defined in the transcription settings will be used
StartClosedCaptionsRequestLanguageEnumTypeTransformer
Transformation class that can encode an instance of StartClosedCaptionsRequestLanguageEnum to String, and decode dynamic data back to StartClosedCaptionsRequestLanguageEnum.
StartClosedCaptionsResponse
StartFrameRecordingRequest
StartFrameRecordingResponse
StartHLSBroadcastingResponse
StartRecordingRequest
StartRecordingResponse
StartRTMPBroadcastsRequest
StartRTMPBroadcastsResponse
StartTranscriptionRequest
StartTranscriptionRequestLanguageEnum
The spoken language in the call, if not provided the language defined in the transcription settings will be used
StartTranscriptionRequestLanguageEnumTypeTransformer
Transformation class that can encode an instance of StartTranscriptionRequestLanguageEnum to String, and decode dynamic data back to StartTranscriptionRequestLanguageEnum.
StartTranscriptionResponse
StateEmitter<T>
StatsOptions
StopAllRTMPBroadcastsResponse
StopClosedCaptionsRequest
StopClosedCaptionsResponse
StopFrameRecordingResponse
StopHLSBroadcastingResponse
StopLiveRequest
StopLiveResponse
StopRecordingResponse
StopRTMPBroadcastsResponse
StopTranscriptionRequest
StopTranscriptionResponse
StreamAudioSettings
StreamBackgroundService
StreamBackstageSettings
StreamBroadcastingSettings
StreamCallAcceptedEvent
Event that is triggered when the call is accepted.
StreamCallAudioLevelChangedEvent
Event that is triggered when the audio levels change for participants
StreamCallBroadcastingFailedEvent
Event that is triggered when the broadcasting fails for a call.
StreamCallBroadcastingStartedEvent
Event that is triggered when the broadcasting is started for a call.
StreamCallBroadcastingStoppedEvent
Event that is triggered when the broadcasting is stopped for a call.
StreamCallCid
StreamCallClosedCaptionsEvent
Event that is triggered when the closed caption is received
StreamCallClosedCaptionsFailedEvent
Event that is triggered when the closed captioning failed for a call.
StreamCallClosedCaptionsStartedEvent
Event that is triggered when the closed captioning is started for a call.
StreamCallClosedCaptionsStoppedEvent
Event that is triggered when the closed captioning is stopped for a call.
StreamCallConnectedEvent
Event that is triggered when the call is connected
StreamCallConnectionQualityChangedEvent
Event that is triggered when the connection quality changes for participants
StreamCallContainer
Represents different call content based on the call state.
StreamCallContent
Represents the UI in an active call that shows participants and their video, as well as some extra UI features to control the call settings, browse participants and more.
StreamCallContentTheme
Applies a theme to descendant StreamCallContent
StreamCallContentThemeData
Defines default property values for StreamCallContent widgets.
StreamCallControls
Represents the set of controls the user can use to change their audio and video device state, or browse other types of settings, leave the call, or implement something custom.
StreamCallControlsTheme
Applies a call controls theme to descendant StreamCallControls widgets.
StreamCallControlsThemeData
Defines default property values for StreamCallControls widgets.
StreamCallCreatedEvent
Event that is triggered when the call is created and another person is invited to participate.
StreamCallCustomEvent
StreamCallDisconnectedEvent
Event that is triggered when the call is disconnected
StreamCallDominantSpeakerChangedEvent
Event that is triggered when the dominant speaker changes
StreamCallEndedEvent
Event that is triggered when the call is ended.
StreamCallEvent
StreamCallFrameRecordingFailedEvent
Event that is triggered when frame recording fails.
StreamCallFrameRecordingReadyEvent
Event that is triggered when a frame recording is ready.
StreamCallFrameRecordingStartedEvent
Event that is triggered when frame recording starts.
StreamCallFrameRecordingStoppedEvent
Event that is triggered when frame recording stops.
StreamCallGrantsUpdated
StreamCallJoinedEvent
Event that is triggered when the call is joined.
StreamCallLiveStartedEvent
Event that is triggered when a call goes live.
StreamCallMemberAddedEvent
Event that is triggered when members are added to a call.
StreamCallMemberRemovedEvent
Event that is triggered when members are removed from a call.
StreamCallMemberUpdatedEvent
Event that is triggered when members are updated in a call.
StreamCallMemberUpdatedPermissionEvent
Event that is triggered when member permissions are updated in a call.
StreamCallMissedEvent
Event that is triggered when the call is created and another person is invited to participate.
StreamCallNotificationEvent
Event that is triggered for call notifications.
StreamCallParticipant
A widget that represents a single participant in a call.
StreamCallParticipantJoinedEvent
Event that is triggered when a participant joins the call
StreamCallParticipantLeftEvent
Event that is triggered when a participant leaves the call
StreamCallParticipants
Widget that renders all the StreamCallParticipant, based on the number of people in a call.
StreamCallParticipantTheme
Applies a call participant theme to descendant StreamCallParticipant widgets.
StreamCallParticipantThemeData
Defines default property values for StreamCallParticipant widgets.
StreamCallPermissionRequestEvent
Event that is triggered when there is a permission request for a call.
StreamCallPermissionsUpdatedEvent
Event that is triggered when the permissions are updated for a call.
StreamCallReactionEvent
Event that is triggered when someone sends a reaction during a call
StreamCallRecordingFailedEvent
Event that is triggered when the recording failed for a call.
StreamCallRecordingReadyEvent
Event that is triggered when a recording is ready.
StreamCallRecordingStartedEvent
Event that is triggered when the recording is started for a call.
StreamCallRecordingStoppedEvent
Event that is triggered when the recording is stopped for a call.
StreamCallRejectedEvent
Event that is triggered when the call is rejected.
StreamCallRingingEvent
Event that is triggered when the call is ringing.
StreamCallSessionEndedEvent
Event that is triggered when the session is ended for a call
StreamCallSessionParticipantCountUpdatedEvent
StreamCallSessionParticipantJoinedEvent
Event that is triggered when participant joins the call session
StreamCallSessionParticipantLeftEvent
Event that is triggered when participant leaves the call session
StreamCallSessionStartedEvent
Event that is triggered when the new session is started for a call
StreamCallSfuTrackPublishedEvent
StreamCallSfuTrackUnpublishedEvent
StreamCallTranscriptionFailedEvent
Event that is triggered when the transcription failed for a call.
StreamCallTranscriptionStartedEvent
Event that is triggered when the transcription is started for a call.
StreamCallTranscriptionStoppedEvent
Event that is triggered when the transcription is stopped for a call.
StreamCallType
The type of call to be made.
StreamCallUpdatedEvent
Event that is triggered when the call is updated.
StreamCallUserBlockedEvent
Event that is triggered when the user is blocked in a call.
StreamCallUserKickedEvent
Event that is triggered when the user is kicked from a call.
StreamCallUserMutedEvent
Event that is triggered when users are muted.
StreamCallUserUnblockedEvent
Event that is triggered when the user is unblocked in a call.
StreamClosedCaption
StreamColorTheme
Theme that holds colors
StreamFrameRecordingSettings
StreamGeofencingSettings
StreamHlsSettings
StreamIconToggle
Contains icons for active and inactive states accordingly.
StreamIncomingCallContent
Represents the Incoming Call state and UI, when the user is called by other people.
StreamIncomingOutgoingCallTheme
Applies a incoming/outgoing call theme to descendant StreamIncomingCallContent and StreamOutgoingCallContent widgets.
StreamIncomingOutgoingCallThemeData
Defines default property values for StreamIncomingCallContent and StreamOutgoingCallContent widgets.
StreamIngressAudioEncodingOptions
StreamIngressSettings
StreamIngressVideoEncodingOptions
StreamIngressVideoLayer
StreamLimitsSettings
StreamLivestreamTheme
Applies a call controls theme to descendant StreamLivestreamThemeData widgets.
StreamLivestreamThemeData
Defines default property values for StreamLivestreamThemeData widgets.
StreamLobbyVideo
A widget that can be shown before joining a call. Measures latencies and selects the best SFU. This speeds up the process of joining when the user decides to enter the call.
StreamLobbyView
A widget that can be shown before joining a call. Measures latencies and selects the best SFU. This speeds up the process of joining when the user decides to enter the call.
StreamLobbyViewTheme
Applies a lobby view theme to descendant StreamLobbyView widgets.
StreamLobbyViewThemeData
Defines default property values for StreamLobbyView widgets.
StreamLocalVideo
Represents a floating item used to feature a participant video.
StreamLocalVideoTheme
Applies a local video theme to descendant StreamLocalVideo widgets.
StreamLocalVideoThemeData
Defines default property values for StreamLocalVideo widgets.
StreamLog
StreamLogger
StreamNoiceCancellingSettings
StreamOutgoingCallContent
Represents the Outgoing Call state and UI, when the user is calling other people.
StreamPictureInPictureAndroidView
Android implementation of Picture-in-Picture functionality. This widget handles all PiP logic internally and provides a clean interface similar to the iOS StreamPictureInPictureUiKitView.
StreamPictureInPictureUiKitView
A widget that handles the picture-in-picture mode on iOS. If you are implementing custom call content widget and want to include PiP support add this widget to your widget tree.
StreamPinsUpdatedEvent
Event that is triggered when pinned participants are updated
StreamRecordingSettings
StreamRingSettings
StreamRtmpSettings
StreamScreenShareSettings
StreamSessionSettings
StreamSfuCallEvent
StreamTargetResolution
StreamTextTheme
Contains definitions for the various text styles.
StreamTranscriptionSettings
StreamUserAvatar
Displays a user's avatar.
StreamUserAvatarTheme
Applies a user avatar theme to descendant StreamUserAvatar widgets.
StreamUserAvatarThemeData
Defines default property values for StreamUserAvatar widgets.
StreamVideo
The client responsible for handling config and maintaining calls
StreamVideoEffectsManager
StreamVideoOptions
StreamVideoRenderer
Widget that renders a single video track for a call participant.
StreamVideoSettings
StreamVideoTheme
Theme data for Stream Video
SubscriberStatsResponse
SubscriptionChange
Subscriptions
Success<T>
Represents successful result.
TabbedScreenSelectWidget
TaggedLogger
TargetResolution
ThumbnailGrid
ThumbnailResponse
ThumbnailsSettingsRequest
ThumbnailsSettingsResponse
ToggleCameraOption
A widget that represents a call control option to toggle if the camera is on or off.
ToggleClosedCaptionsOption
A widget that represents a call control option to toggle if closed captions is on or off.
ToggleLayoutOption
A widget that allows to change the layout of the call.
ToggleMicrophoneOption
A widget that represents a call control option to toggle if the microphone is on or off.
ToggleRecordingOption
A widget that represents a call control option to toggle if recording is on or off.
ToggleScreenShareOption
A widget that represents a call control option to start/stop screen sharing
ToggleSpeakerphoneOption
A widget that represents a call control option to toggle if the speakerphone is on or off.
TokenProvider
TrackDisabled
TrackEnabled
TrackOption
TrackProvided<T extends MediaConstraints>
TrackState
TrackStatsResponse
TranscriptionSettingsRequest
TranscriptionSettingsRequestClosedCaptionModeEnum
TranscriptionSettingsRequestClosedCaptionModeEnumTypeTransformer
Transformation class that can encode an instance of TranscriptionSettingsRequestClosedCaptionModeEnum to String, and decode dynamic data back to TranscriptionSettingsRequestClosedCaptionModeEnum.
TranscriptionSettingsRequestLanguageEnum
TranscriptionSettingsRequestLanguageEnumTypeTransformer
Transformation class that can encode an instance of TranscriptionSettingsRequestLanguageEnum to String, and decode dynamic data back to TranscriptionSettingsRequestLanguageEnum.
TranscriptionSettingsRequestModeEnum
TranscriptionSettingsRequestModeEnumTypeTransformer
Transformation class that can encode an instance of TranscriptionSettingsRequestModeEnum to String, and decode dynamic data back to TranscriptionSettingsRequestModeEnum.
TranscriptionSettingsResponse
TranscriptionSettingsResponseClosedCaptionModeEnum
TranscriptionSettingsResponseClosedCaptionModeEnumTypeTransformer
Transformation class that can encode an instance of TranscriptionSettingsResponseClosedCaptionModeEnum to String, and decode dynamic data back to TranscriptionSettingsResponseClosedCaptionModeEnum.
TranscriptionSettingsResponseLanguageEnum
TranscriptionSettingsResponseLanguageEnumTypeTransformer
Transformation class that can encode an instance of TranscriptionSettingsResponseLanguageEnum to String, and decode dynamic data back to TranscriptionSettingsResponseLanguageEnum.
TranscriptionSettingsResponseModeEnum
TranscriptionSettingsResponseModeEnumTypeTransformer
Transformation class that can encode an instance of TranscriptionSettingsResponseModeEnum to String, and decode dynamic data back to TranscriptionSettingsResponseModeEnum.
TypingIndicators
UnblockedUserEvent
UnblockUserRequest
UnblockUserResponse
UnpinRequest
UnpinResponse
UpdateCallMembersRequest
UpdateCallMembersResponse
UpdateCallRequest
UpdateCallResponse
UpdatedCallPermissionsEvent
UpdateUserPermissionsRequest
UpdateUserPermissionsResponse
User
UserBannedEvent
UserDeactivatedEvent
UserFeedbackReport
UserFeedbackReportResponse
UserInfo
UserMutedEvent
UserRatingReportResponse
UserReactivatedEvent
UserRequest
UserResponse
UserResponseData
UserResponsePrivacyFields
UserToken
Token designed to store the JWT and the user it is related to.
UserUpdatedEvent
VideoConstraints
Base class for options when creating a video track.
VideoDimension
VideoEvent
VideoReactionOverTimeResponse
VideoReactionsResponse
VideoSettingsRequest
VideoSettingsRequestCameraFacingEnum
VideoSettingsRequestCameraFacingEnumTypeTransformer
Transformation class that can encode an instance of VideoSettingsRequestCameraFacingEnum to String, and decode dynamic data back to VideoSettingsRequestCameraFacingEnum.
VideoSettingsResponse
VideoSettingsResponseCameraFacingEnum
VideoSettingsResponseCameraFacingEnumTypeTransformer
Transformation class that can encode an instance of VideoSettingsResponseCameraFacingEnum to String, and decode dynamic data back to VideoSettingsResponseCameraFacingEnum.
VideoTrackRenderer
A widget that renders a single video track.
VideoTrackSubscriptionOverride
VisibilityChange
WSAuthMessage

Constants

deviceIdEarpiece → const String
deviceIdSpeaker → const String
kLocalTrackIdPrefix → const String
none → const None
Used instead of void as a return statement for a function when no value is expected to be returned.

Properties

defaultApiClient ↔ ApiClient
An ApiClient instance that uses the default values obtained from the OpenAPI specification file.
getter/setter pair
isDesktopDevice → bool
Returns true if the app is running in a desktop device.
no setter
isMobileDevice → bool
Returns true if the app is running in a mobile device.
no setter
streamLog → StreamLog
no setter

Functions

buildCoordinatorClient({required User user, required String rpcUrl, required String wsUrl, required String apiKey, required TokenManager tokenManager, required RetryPolicy retryPolicy, required LatencySettings latencySettings, required InternetConnection networkMonitor}) → CoordinatorClient
byName(CallParticipantState a, CallParticipantState b) → int
A comparator which sorts participants by name.
byParticipantSource(List<SfuParticipantSource> sources) → Comparator<CallParticipantState>
A comparator factory which creates a comparator which prioritizes participants who are from a specific sources (e.g., WebRTC, RTMP, WHIP...).
byReactionType(String type) → Comparator<CallParticipantState>
A comparator creator which will set up a comparator which prioritizes participants who have a specific reaction.
byRole(List<String> roles) → Comparator<CallParticipantState>
A comparator creator which will set up a comparator which prioritizes participants who have a specific role.
byVideoIngressSource() → Comparator<CallParticipantState>
combineComparators<T>(List<Comparator<T>> comparators) → Comparator<T>
Creates a new combined Comparator which sorts items by the given comparators.
decodeAsync(DeserializationMessage message) → Future
Primarily intended for use in an isolate.
defaultCallControlOptions({required Call call, CallParticipantState? localParticipant}) → List<Widget>
Builds the default set of call control options.
deserializeAsync(DeserializationMessage message) → Future
Primarily intended for use in an isolate.
dominantSpeaker(CallParticipantState a, CallParticipantState b) → int
A comparator which sorts participants by the fact that they are the dominant speaker or not.
generateAlphanumericString(int length) → String
ifInvisibleBy(Comparator<CallParticipantState> comparator) → Comparator<CallParticipantState>
A comparator decorator which applies the decorated comparator only if the participant viewport visibility is hidden or net yet determined.
isMobileLandscape(BuildContext context) → bool
Returns true if the app is running on a mobile device in landscape mode.
isMobilePortrait(BuildContext context) → bool
Returns true if the app is running on a mobile device in portrait mode.
mapCastOfType<K, V>(dynamic map, String key) → Map<K, V>?
Returns a valid Map<K, V> found at the specified Map key, null otherwise.
mapDateTime(dynamic map, String key, [String? pattern]) → DateTime?
Returns a valid DateTime found at the specified Map key, null otherwise.
mapValueOfType<T>(dynamic map, String key) → T?
Returns a valid T value found at the specified Map key, null otherwise.
parameterToString(dynamic value) → String
Format the given parameter object into a String.
pinned(CallParticipantState a, CallParticipantState b) → int
A comparator which prioritizes participants who are pinned.
publishingAudio(CallParticipantState a, CallParticipantState b) → int
A comparator which sorts participants by audio status.
publishingVideo(CallParticipantState a, CallParticipantState b) → int
A comparator which sorts participants by video status.
runCatchingResult<T>(FutureOr<Result<T>> fn()) → Future<Result<T>>
screenSharing(CallParticipantState a, CallParticipantState b) → int
A comparator which sorts participants by screen sharing status.
serializeAsync(Object? value) → Future<String>
Primarily intended for use in an isolate.
showDefaultScreenSelectionDialog(BuildContext context) → Future<DesktopCapturerSource?>
Default screen selection dialog. This shows a dialog with 2 tabs for screens and windows. Can be styled using overlay from StreamColorTheme; body, bodyBold and tabBar from StreamTextTheme.
speaking(CallParticipantState a, CallParticipantState b) → int
A comparator which sorts participants by the fact that they are speaking or not.
taggedLogger({required Tag tag}) → TaggedLogger

Typedefs

Backoff = Duration Function(RetryConfig config, int retryAttempt)
CallAppBarBuilder = PreferredSizeWidget? Function(BuildContext context, Call call, CallState callState)
Builder used to create a custom call app bar.
CallContentBuilder = Widget Function(BuildContext context, Call call, CallState callState)
Builder used to create a custom call content widget.
CallControlsBuilder = Widget Function(BuildContext context, Call call, CallState callState)
Builder used to create a custom call controls widget.
CallParticipantBuilder = Widget Function(BuildContext context, Call call, CallParticipantState participant)
Builder function used to build a participant item.
CallParticipantsBuilder = Widget Function(BuildContext context, Call call, CallState callState)
Builder used to create a custom call participants widget.
CallPictureInPictureBuilder = Widget Function(BuildContext context, Call call, CallState callState)
CallPreferredSizeWidgetBuilder = PreferredSizeWidget? Function(BuildContext context, Call call)
Builder for parts of the call screen that need a PreferredSizeWidget. For example used to create a custom app bar.
CallStateSelector<T> = T Function(CallState state)
CallWidgetBuilder = Widget Function(BuildContext context, Call call)
Builder for parts of the call screen that need a regular Widget.
CallWidgetBuilderWithData<T extends CallbackData> = Widget Function(BuildContext context, Call call, T data)
Builder for parts of the call screen that need a regular Widget. The function also contains a data object that can be used to build the widget.
CallWidgetChildBuilder = Widget Function(BuildContext context, Call call, Widget child)
Builder for parts of the call screen that need a regular Widget and has a prebuild child widget.
DesktopScreenSelectorBuilder = Future<DesktopCapturerSource?> Function(BuildContext context)
ErrorWidgetBuilder = Widget Function(BuildContext context, UserInfo user, Object error)
Builder function used to build an error widget.
FallbackWidgetBuilder = Widget Function(BuildContext context, UserInfo user)
Builder function used to build a widget with the user initials.
FileLogSender = Future Function(File)
Filter<T> = bool Function(T element)
A function used to sort the participants.
Finder = T? Function<T extends StreamLogger>([dynamic criteria])
GetActiveCall = Call? Function()
GetCurrentUserId = String? Function()
GetOutgoingCall = Call? Function()
GuestTokenLoader = Future<String> Function(UserInfo user)
A function which can be used to request a Stream Video API token from your own backend server
HttpBearerAuthProvider = String Function()
ImageWidgetBuilder = Widget Function(BuildContext context, UserInfo user, ImageProvider<Object> imageProvider)
Builder function used to build an image widget for the user avatar.
IncomingCallBuilder = Widget Function(BuildContext context, Call call, CallState callState)
Builder used to create a custom incoming call widget.
IsLoggableValidator = bool Function(Priority, Tag)
LivestreamBackstageBuilder = Widget Function(BuildContext context, Call call, CallState callState)
LivestreamControlsBuilder = Widget Function(BuildContext context, Call call, CallState callState)
LivestreamEndedBuilder = Widget Function(BuildContext context, Call call, CallState callState)
LivestreamHostsUnavailableBuilder = Widget Function(BuildContext context, LivestreamHostsUnavailableProperties properties)
LivestreamNotConnectedBuilder = Widget Function(BuildContext context, LivestreamNotConnectedProperties properties)
LogHandlerFunction = void Function(Priority priority, String tag, MessageBuilder message, [Object? error, StackTrace? stk])
Handler function used for logging.
MessageBuilder = String Function()
NotificationOptionsBuilder = NotificationOptions Function(Call)
OnButtonClick = Future<void> Function(Call, ButtonType, ServiceType)
OnCallPermissionRequest = void Function(StreamCallPermissionRequestEvent)
OnNotificationClick = Future<void> Function(Call)
OnSizeChanged = void Function(Size size)
The action to perform when the size of child widget changes.
OnThumbnailTapped = void Function(DesktopCapturerSource)
OnTokenUpdated = Future<void> Function(UserToken token)
OnUiLayerDestroyed = Future<void> Function(Call)
OnUserAvatarLongPress = void Function(UserInfo)
The action to perform when the user avatar is long-pressed.
OnUserAvatarTap = void Function(UserInfo)
The action to perform when the user avatar is tapped.
OutgoingCallBackground = Widget Function(Call call, CallState callState, List<UserInfo> participants, Widget child)
OutgoingCallBuilder = Widget Function(BuildContext context, Call call, CallState callState)
Builder used to create a custom outgoing call widget.
ParticipantsAvatarBuilder = Widget Function(BuildContext context, Call call, CallState callState, List<UserInfo> participants)
Builder used to create a custom widget for participants avatars.
ParticipantsDisplayNameBuilder = Widget Function(BuildContext context, Call call, CallState callState, List<UserInfo> participants)
Builder used to create a custom widget for participants display names.
PlaceholderWidgetBuilder = Widget Function(BuildContext context, UserInfo user)
Builder function used to build a placeholder widget.
PNManagerProvider = PushNotificationManager Function(CoordinatorClient client, StreamVideo streamVideo)
Signature for a function which provides a new instance of PushNotificationManager.
Role = String
RtcLocalAudioTrack = RtcLocalTrack<AudioConstraints>
RtcLocalCameraTrack = RtcLocalTrack<CameraConstraints>
RtcLocalScreenShareTrack = RtcLocalTrack<ScreenShareConstraints>
RtcLocalVideoTrack = RtcLocalTrack<VideoConstraints>
ScreenShareContentBuilder = Widget Function(BuildContext context, Call call, CallParticipantState participant)
Builder function used to build a screen sharing content.
ScreenShareParticipantBuilder = Widget Function(BuildContext context, Call call, CallParticipantState participant)
Builder function used to build participant item in screen sharing mode.
SetActiveCall = Future<void> Function(Call?)
SetOutgoingCall = Future<void> Function(Call?)
Sort<T> = Comparator<T>
Comparator used to sort the participants.
SoundStateChangedCallback = void Function(SoundState state)
Tag = String
TokenLoader = Future<String> Function(String userId)
A function which can be used to request a Stream Video API token from your own backend server. Function requires a single userId.
UserSessionId = String
VideoPlaceholderBuilder = Widget Function(BuildContext context, Call call, CallParticipantState participant)
Builder function used to build a video placeholder.
VideoRendererBuilder = Widget Function(BuildContext context, Call call, CallParticipantState participant)
Builder function used to build a video renderer.

Exceptions / Errors

ApiException
FileLoggerException