stream_video library

Classes

AbstractSettings
AcceptCallResponse
ActionCallAccept
Represents a call accept event.
ActionCallCallback
Represents a call callback event.
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).
ApiClient
APIError
ApiKeyAuth
APNS
APNSRequest
AudioConstraints
Options used when creating an AudioTrack.
AudioSettings
AudioSettingsDefaultDeviceEnum
AudioSettingsDefaultDeviceEnumTypeTransformer
Transformation class that can encode an instance of AudioSettingsDefaultDeviceEnum to String, and decode dynamic data back to AudioSettingsDefaultDeviceEnum.
AudioSettingsRequest
AudioSettingsRequestDefaultDeviceEnum
AudioSettingsRequestDefaultDeviceEnumTypeTransformer
Transformation class that can encode an instance of AudioSettingsRequestDefaultDeviceEnum to String, and decode dynamic data back to AudioSettingsRequestDefaultDeviceEnum.
Authentication
BackstageSettings
BackstageSettingsRequest
BlockedUserEvent
BlockUserRequest
BlockUserResponse
BroadcastSettings
BroadcastSettingsRequest
Call
Represents a Call in which you can connect to.
CallAcceptedEvent
CallBroadcastingStartedEvent
CallBroadcastingStoppedEvent
CallConnectOptions
CallCreatedData
CallCreatedEvent
CallCredentials
CallData
Represents call data with various properties related to the call.
CallDetails
CallEgress
CallEgressRtmp
CallEndedEvent
CallIceServer
CallIngressResponse
CallJoinedData
CallKitEvent
Represents an event related to the CallKit.
CallLiveStartedEvent
CallMember
CallMemberAddedEvent
CallMemberRemovedEvent
CallMemberUpdatedEvent
CallMemberUpdatedPermissionEvent
CallMetadata
CallNotificationEvent
CallParticipant
CallParticipantResponse
CallParticipantState
CallPreferences
CallReaction
CallReactionData
CallReactionEvent
CallReceivedOrCreatedData
CallRecording
CallRecordingFailedEvent
CallRecordingReadyEvent
CallRecordingStartedEvent
CallRecordingStoppedEvent
CallRejectedEvent
CallRequest
CallResponse
CallRingEvent
CallRingingData
CallSessionData
CallSessionEndedEvent
CallSessionParticipantJoinedEvent
CallSessionParticipantLeftEvent
CallSessionResponse
CallSessionStartedEvent
CallSettings
CallSettingsRequest
CallSettingsResponse
CallSfuServer
CallState
Represents the call's state.
CallStateResponseFields
CallStats
CallStatus
CallStatusActive
CallStatusConnected
CallStatusConnecting
CallStatusDisconnected
CallStatusIdle
CallStatusIncoming
CallStatusJoined
CallStatusJoining
CallStatusMigrating
CallStatusOutgoing
CallStatusReconnecting
CallTypeResponse
CallUpdatedEvent
CallUser
CallUserMuted
CameraConstraints
Options used when creating a video track that captures the camera. mirror: Whether the video should be mirrored. If set to null, the default is true when facingMode is user and false when facingMode is environment.
CompositeStreamLogger
ConnectedEvent
ConnectionErrorEvent
ConnectionStateUpdatedEvent
Model class for connection state updates.
ConnectUserDetailsRequest
ConsoleStreamLogger
CoordinatorCallAcceptedEvent
Sent when a user accepts the call.
CoordinatorCallBroadcastingStartedEvent
CoordinatorCallBroadcastingStoppedEvent
CoordinatorCallCreatedEvent
Sent when someone creates a call and invites another person to participate.
CoordinatorCallCustomEvent
CoordinatorCallEndedEvent
Sent when a calls gets ended.
CoordinatorCallEvent
CoordinatorCallPermissionRequestEvent
CoordinatorCallPermissionsUpdatedEvent
CoordinatorCallReactionEvent
CoordinatorCallRecordingStartedEvent
CoordinatorCallRecordingStoppedEvent
CoordinatorCallRejectedEvent
Sent when a user rejects the call.
CoordinatorCallRingingEvent
Sent when someone creates a call and invites another person to participate.
CoordinatorCallSessionEndedEvent
CoordinatorCallSessionParticipantJoinedEvent
CoordinatorCallSessionParticipantLeftEvent
CoordinatorCallSessionStartedEvent
CoordinatorCallUpdatedEvent
Sent when a call gets updated.
CoordinatorCallUserBlockedEvent
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.
CoordinatorUnknownEvent
CoordinatorUnsupportedEvent
CreateCallTypeRequest
CreateCallTypeResponse
CreateDeviceRequest
CreateDeviceRequestPushProviderEnum
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
DefaultApi
DefaultCallPreferences
DeserializationMessage
Primarily intended for use in an isolate.
Device
DisconnectReason
DisconnectReasonCancelled
DisconnectReasonEnded
DisconnectReasonFailure
DisconnectReasonLastParticipantLeft
DisconnectReasonManuallyClosed
DisconnectReasonRejected
DisconnectReasonTimeout
DurationResponse
EdgeResponse
EgressHLSResponse
EgressResponse
EgressRTMPResponse
EndCallResponse
EventNotificationSettings
EventNotificationSettingsRequest
Failure
Represents failed result.
FileLogConfig
FileStreamLogger
FlipCamera
GeofenceSettings
GeofenceSettingsRequest
GetCallResponse
GetCallTypeResponse
GetEdgesResponse
GetOrCreateCallRequest
GetOrCreateCallResponse
GoLiveRequest
GoLiveResponse
GuestCreatedData
HealthCheckEvent
HLSSettings
HLSSettingsRequest
HttpBasicAuth
HttpBearerAuth
ICEServer
JoinCallRequest
JoinCallResponse
ListCallTypeResponse
ListDevicesResponse
ListRecordingsResponse
LocalParticipantAction
LocalStats
LocalTrackState
MediaConstraints
MediaSettings
MediaStatsInfo
MemberRequest
MemberResponse
MuteUsersRequest
MuteUsersResponse
None
Used instead of void as a return statement for a function when no value is expected to be returned.
NotificationSettings
NotificationSettingsRequest
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
ParticipantAction
PeerConnectionStats
PermissionRequestEvent
PinRequest
PinResponse
PushDevice
PushNotificationManager
Interface for managing push notifications related to call events.
QueriedCall
QueriedCalls
QueriedMembers
QueryCallsRequest
QueryCallsResponse
QueryMembersRequest
QueryMembersResponse
QueryParam
ReactionResponse
RecordSettings
RecordSettingsModeEnum
RecordSettingsModeEnumTypeTransformer
Transformation class that can encode an instance of RecordSettingsModeEnum to String, and decode dynamic data back to RecordSettingsModeEnum.
RecordSettingsQualityEnum
RecordSettingsQualityEnumTypeTransformer
Transformation class that can encode an instance of RecordSettingsQualityEnum to String, and decode dynamic data back to RecordSettingsQualityEnum.
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.
RejectCallResponse
RemoteParticipantAction
RemoteTrackState
RemoveSubscription
RequestPermissionRequest
RequestPermissionResponse
Result<T>
A class which encapsulates a successful outcome with a value of type T or a failure with VideoError.
RingSettings
RingSettingsRequest
RTCConfiguration
RTCIceServer
RtcLocalTrack<T extends MediaConstraints>
RtcMediaDevice
RtcMediaDeviceNotifier
RtcRemoteTrack
RtcTrack
RtcVideoDimension
RTMPIngress
ScreenShareConstraints
Options used when creating a video track that captures the screen.
ScreensharingSettings
ScreensharingSettingsRequest
SendEventRequest
SendEventResponse
SendReactionRequest
SendReactionResponse
ServerSideApi
SetAudioInputDevice
SetAudioOutputDevice
SetCameraEnabled
SetCameraPosition
SetMicrophoneEnabled
SetParticipantPinned
SetScreenShareEnabled
SetSubscription
SetSubscriptions
SetVideoInputDevice
SFUResponse
SfuTrackType
SfuTrackTypeAudio
SfuTrackTypeVideo
SilentStreamLogger
SortParamRequest
StartBroadcastingResponse
StartRecordingResponse
StartTranscriptionResponse
StatsOptions
StopBroadcastingResponse
StopLiveResponse
StopRecordingResponse
StopTranscriptionResponse
StreamAudioSettings
StreamBackstageSettings
StreamBroadcastingSettings
StreamCallAcceptedEvent
Event that is triggered when the call is accepted.
StreamCallAudioLevelChangedEvent
Event that is triggered when the audio levels change for participants
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
StreamCallConnectedEvent
Event that is triggered when the call is connected
StreamCallConnectionQualityChangedEvent
Event that is triggered when the connection quality changes for participants
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
StreamCallGrantsUpdated
StreamCallJoinedEvent
Event that is triggered when the call is joined.
StreamCallParticipantJoinedEvent
Event that is triggered when a participant joins the call
StreamCallParticipantLeftEvent
Event that is triggered when a participant leaves the call
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
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
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
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.
StreamCallUserUnblockedEvent
Event that is triggered when the user is unblocked in a call.
StreamGeofencingSettings
StreamHlsSettings
StreamLog
StreamLogger
StreamRecordingSettings
StreamRingSettings
StreamScreenShareSettings
StreamSfuCallEvent
StreamTranscriptionSettings
StreamVideo
The client responsible for handling config and maintaining calls
StreamVideoOptions
StreamVideoSettings
SubscriptionAction
Subscriptions
Success<T>
Represents successful result.
TaggedLogger
TargetResolution
TargetResolutionRequest
TokenProvider
TrackDisabled
TrackEnabled
TrackOption
TrackProvided<T extends MediaConstraints>
TrackState
TranscriptionSettings
TranscriptionSettingsModeEnum
TranscriptionSettingsModeEnumTypeTransformer
Transformation class that can encode an instance of TranscriptionSettingsModeEnum to String, and decode dynamic data back to TranscriptionSettingsModeEnum.
TranscriptionSettingsRequest
TranscriptionSettingsRequestModeEnum
TranscriptionSettingsRequestModeEnumTypeTransformer
Transformation class that can encode an instance of TranscriptionSettingsRequestModeEnum to String, and decode dynamic data back to TranscriptionSettingsRequestModeEnum.
UnblockedUserEvent
UnblockUserRequest
UnblockUserResponse
UnpinRequest
UnpinResponse
UpdateCallMembersRequest
UpdateCallMembersResponse
UpdateCallRequest
UpdateCallResponse
UpdateCallTypeRequest
UpdateCallTypeResponse
UpdatedCallPermissionsEvent
UpdateSubscription
UpdateSubscriptions
UpdateUserPermissionsRequest
UpdateUserPermissionsResponse
UpdateViewportVisibilities
UpdateViewportVisibility
User
UserInfo
UserRequest
UserResponse
UserResponseData
UserToken
Token designed to store the JWT and the user it is related to.
VideoConstraints
Base class for options when creating a video track.
VideoEvent
VideoSettings
VideoSettingsCameraFacingEnum
VideoSettingsCameraFacingEnumTypeTransformer
Transformation class that can encode an instance of VideoSettingsCameraFacingEnum to String, and decode dynamic data back to VideoSettingsCameraFacingEnum.
VideoSettingsRequest
VideoSettingsRequestCameraFacingEnum
VideoSettingsRequestCameraFacingEnumTypeTransformer
Transformation class that can encode an instance of VideoSettingsRequestCameraFacingEnum to String, and decode dynamic data back to VideoSettingsRequestCameraFacingEnum.
WSAuthMessageRequest
WSCallEvent
WSClientEvent

Mixins

CallParticipantSortingPresets
CallStatusConnectable
ConnectionStateMixin
Connection state mixin used throughout the SDK.

Constants

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
getter/setter pair
streamLog → StreamLog
no setter

Functions

buildCoordinatorClient({required String rpcUrl, required String wsUrl, required String apiKey, required TokenManager tokenManager, required RetryPolicy retryPolicy, required LatencySettings latencySettings}) → CoordinatorClient
deserializeAsync(DeserializationMessage message) → Future
Primarily intended for use in an isolate.
generateAlphanumericString(int length) → String
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.
serializeAsync(Object? value) → Future<String>
Primarily intended for use in an isolate.
taggedLogger({required Tag tag}) → TaggedLogger

Typedefs

FileLogSender = Future Function(File)
Finder = T? Function<T extends StreamLogger>([dynamic criteria])
GetActiveCallCid = StreamCallCid? Function()
GetCurrentUserId = String? 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()
IsLoggableValidator = bool Function(Priority, Tag)
LogHandlerFunction = void Function(Priority priority, String tag, MessageBuilder message, [Object? error, StackTrace? stk])
Handler function used for logging.
MessageBuilder = String Function()
OnCallPermissionRequest = void Function(CoordinatorCallPermissionRequestEvent)
OnConnectionStateUpdated = void Function(ConnectionStateUpdatedEvent)
OnTokenUpdated = Future<void> Function(UserToken token)
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>
SetActiveCall = Future<void> Function(Call?)
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

Exceptions / Errors

ApiException
FileLoggerException