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).
AggregatedStats
ApiClient
APIError
ApiKeyAuth
AudioConstraints
Options used when creating an AudioTrack.
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
Ban
BlockedUserEvent
BlockListOptions
BlockListOptionsBehaviorEnum
BlockListOptionsBehaviorEnumTypeTransformer
Transformation class that can encode an instance of BlockListOptionsBehaviorEnum to String, and decode dynamic data back to BlockListOptionsBehaviorEnum.
BlockUserRequest
BlockUserResponse
BroadcastSettingsRequest
BroadcastSettingsResponse
Call
Represents a Call in which you can connect to.
CallAcceptedEvent
CallClosedCaption
CallConnectOptions
CallCreatedData
CallCreatedEvent
CallCredentials
CallData
Represents call data with various properties related to the call.
CallDeletedEvent
CallDetails
CallEgress
CallEgressRtmp
CallEndedEvent
CallEvent
CallHLSBroadcastingFailedEvent
CallHLSBroadcastingStartedEvent
CallHLSBroadcastingStoppedEvent
CallIceServer
CallIngressResponse
CallJoinedData
CallKitEvent
Represents an event related to the CallKit.
CallLiveStartedEvent
CallMember
CallMemberAddedEvent
CallMemberRemovedEvent
CallMemberUpdatedEvent
CallMemberUpdatedPermissionEvent
CallMetadata
CallMissedEvent
CallNotificationEvent
CallParticipant
CallParticipantResponse
CallParticipantState
CallPreferences
CallReaction
CallReactionData
CallReactionEvent
CallReceivedOrCreatedData
CallRecording
CallRecordingFailedEvent
CallRecordingReadyEvent
CallRecordingStartedEvent
CallRecordingStoppedEvent
CallRejectedEvent
CallRejectReason
Reason for rejecting a call.
CallRequest
CallResponse
CallRingEvent
CallRingingData
CallRtmpBroadcastStartedEvent
CallRtmpBroadcastStoppedEvent
CallSessionData
CallSessionEndedEvent
CallSessionParticipantJoinedEvent
CallSessionParticipantLeftEvent
CallSessionResponse
CallSessionStartedEvent
CallSettings
CallSettingsRequest
CallSettingsResponse
CallSfuServer
CallState
Represents the call's state.
CallStateResponseFields
CallStats
CallStatsReportSummaryResponse
CallStatus
CallStatusActive
CallStatusConnected
CallStatusConnecting
CallStatusDisconnected
CallStatusIdle
CallStatusIncoming
CallStatusJoined
CallStatusJoining
CallStatusMigrating
CallStatusOutgoing
CallStatusReconnecting
CallTimeline
CallTranscription
CallTranscriptionFailedEvent
CallTranscriptionReadyEvent
CallTranscriptionStartedEvent
CallTranscriptionStoppedEvent
CallUpdatedEvent
CallUser
CallUserMutedEvent
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.
ChannelConfigAutomodBehaviorEnum
ChannelConfigAutomodBehaviorEnumTypeTransformer
Transformation class that can encode an instance of ChannelConfigAutomodBehaviorEnum to String, and decode dynamic data back to ChannelConfigAutomodBehaviorEnum.
ChannelConfigAutomodEnum
ChannelConfigAutomodEnumTypeTransformer
Transformation class that can encode an instance of ChannelConfigAutomodEnum to String, and decode dynamic data back to ChannelConfigAutomodEnum.
ChannelConfigBlocklistBehaviorEnum
ChannelConfigBlocklistBehaviorEnumTypeTransformer
Transformation class that can encode an instance of ChannelConfigBlocklistBehaviorEnum to String, and decode dynamic data back to ChannelConfigBlocklistBehaviorEnum.
ChannelConfigWithInfo
ChannelConfigWithInfoAutomodBehaviorEnum
ChannelConfigWithInfoAutomodBehaviorEnumTypeTransformer
Transformation class that can encode an instance of ChannelConfigWithInfoAutomodBehaviorEnum to String, and decode dynamic data back to ChannelConfigWithInfoAutomodBehaviorEnum.
ChannelConfigWithInfoAutomodEnum
ChannelConfigWithInfoAutomodEnumTypeTransformer
Transformation class that can encode an instance of ChannelConfigWithInfoAutomodEnum to String, and decode dynamic data back to ChannelConfigWithInfoAutomodEnum.
ChannelConfigWithInfoBlocklistBehaviorEnum
ChannelConfigWithInfoBlocklistBehaviorEnumTypeTransformer
Transformation class that can encode an instance of ChannelConfigWithInfoBlocklistBehaviorEnum to String, and decode dynamic data back to ChannelConfigWithInfoBlocklistBehaviorEnum.
ChannelMember
ChannelMute
ChannelResponse
ClosedCaptionEvent
CollectUserFeedbackRequest
CollectUserFeedbackResponse
Command
CompositeStreamLogger
ConnectedEvent
ConnectionErrorEvent
ConnectionStateUpdatedEvent
Model class for connection state updates.
ConnectUserDetailsRequest
ConsoleStreamLogger
Coordinates
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
CoordinatorCallMissedEvent
Sent when someone misses a call.
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
CoordinatorCallTranscriptionFailedEvent
CoordinatorCallTranscriptionStartedEvent
CoordinatorCallTranscriptionStoppedEvent
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
Count
CountrywiseAggregateStats
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
Data
DefaultCallPreferences
DeleteCallRequest
DeleteCallResponse
DeleteRecordingResponse
DeleteTranscriptionResponse
DeserializationMessage
Primarily intended for use in an isolate.
Device
DisconnectReason
DisconnectReasonCancelled
DisconnectReasonEnded
DisconnectReasonFailure
DisconnectReasonLastParticipantLeft
DisconnectReasonManuallyClosed
DisconnectReasonRejected
DisconnectReasonTimeout
DurationResponse
EdgeResponse
EgressHLSResponse
EgressResponse
EgressRTMPResponse
EndCallResponse
Failure
Represents failed result.
FileLogConfig
FileStreamLogger
GeofenceSettingsRequest
GeofenceSettingsResponse
GeolocationResult
GetCallResponse
GetCallStatsResponse
GetEdgesResponse
GetOrCreateCallRequest
GetOrCreateCallResponse
GoLiveRequest
GoLiveResponse
GuestCreatedData
HealthCheckEvent
HLSSettingsRequest
HLSSettingsResponse
HttpBasicAuth
HttpBearerAuth
ICEServer
ImageData
Images
JoinCallRequest
JoinCallResponse
LabelThresholds
LayoutSettings
LayoutSettingsNameEnum
LayoutSettingsNameEnumTypeTransformer
Transformation class that can encode an instance of LayoutSettingsNameEnum to String, and decode dynamic data back to LayoutSettingsNameEnum.
LimitsSettingsRequest
LimitsSettingsResponse
ListDevicesResponse
ListRecordingsResponse
ListTranscriptionsResponse
LocalStats
LocalTrackState
Location
MediaConstraints
MediaPubSubHint
MediaSettings
MediaStatsInfo
MemberRequest
MemberResponse
MessageTypeEnum
Contains type of the message
MessageTypeEnumTypeTransformer
Transformation class that can encode an instance of MessageTypeEnum to String, and decode dynamic data back to MessageTypeEnum.
MOSStats
MuteUsersRequest
MuteUsersResponse
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.
NullBool
NullTime
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.
OwnUser
OwnUserResponse
PeerConnectionStats
PermissionRequestEvent
PinRequest
PinResponse
PrivacySettings
PrivacySettingsResponse
ProductvideoApi
PublishedTrackInfo
PublisherAggregateStats
PushDevice
PushNotificationManager
Interface for managing push notifications related to call events.
PushNotificationSettings
PushNotificationSettingsInput
PushNotificationSettingsResponse
QueriedCall
QueriedCalls
QueriedMembers
QueryCallMembersRequest
QueryCallMembersResponse
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
RequestPermissionRequest
RequestPermissionResponse
Result<T>
A class which encapsulates a successful outcome with a value of type T or a failure with VideoError.
RingSettingsRequest
RingSettingsResponse
RTCConfiguration
RTCIceServer
RtcLocalTrack<T extends MediaConstraints>
RtcMediaDevice
RtcMediaDeviceNotifier
RtcRemoteTrack
RtcTrack
RtcVideoDimension
RtcVideoParameters
RTMPIngress
RTMPSettingsRequest
RTMPSettingsRequestQualityEnum
RTMPSettingsRequestQualityEnumTypeTransformer
Transformation class that can encode an instance of RTMPSettingsRequestQualityEnum to String, and decode dynamic data back to RTMPSettingsRequestQualityEnum.
RTMPSettingsResponse
ScreenShareConstraints
Options used when creating a video track that captures the screen.
ScreensharingSettingsRequest
ScreensharingSettingsResponse
SendCallEventRequest
SendCallEventResponse
SendReactionRequest
SendReactionResponse
SFULocationResponse
SFUResponse
SfuTrackType
SfuTrackTypeAudio
SfuTrackTypeVideo
SilentStreamLogger
SortParamRequest
StartHLSBroadcastingResponse
StartRecordingRequest
StartRecordingResponse
StartRTMPBroadcastsRequest
StartRTMPBroadcastsResponse
StartTranscriptionRequest
StartTranscriptionResponse
StatsOptions
StopAllRTMPBroadcastsResponse
StopHLSBroadcastingResponse
StopLiveResponse
StopRecordingResponse
StopRTMPBroadcastsResponse
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
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.
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
SubscriptionChange
Subscriptions
Subsession
Success<T>
Represents successful result.
TaggedLogger
TargetResolution
Thresholds
ThumbnailResponse
ThumbnailsSettingsRequest
ThumbnailsSettingsResponse
TimeStats
TokenProvider
TrackDisabled
TrackEnabled
TrackOption
TrackProvided<T extends MediaConstraints>
TrackState
TranscriptionSettingsRequest
TranscriptionSettingsRequestModeEnum
TranscriptionSettingsRequestModeEnumTypeTransformer
Transformation class that can encode an instance of TranscriptionSettingsRequestModeEnum to String, and decode dynamic data back to TranscriptionSettingsRequestModeEnum.
TranscriptionSettingsResponse
TranscriptionSettingsResponseModeEnum
TranscriptionSettingsResponseModeEnumTypeTransformer
Transformation class that can encode an instance of TranscriptionSettingsResponseModeEnum to String, and decode dynamic data back to TranscriptionSettingsResponseModeEnum.
TURNAggregatedStats
TypingIndicators
UnblockedUserEvent
UnblockUserRequest
UnblockUserResponse
UnpinRequest
UnpinResponse
UpdateCallMembersRequest
UpdateCallMembersResponse
UpdateCallRequest
UpdateCallResponse
UpdatedCallPermissionsEvent
UpdateUserPermissionsRequest
UpdateUserPermissionsResponse
User
UserBannedEvent
UserDeactivatedEvent
UserDeletedEvent
UserEventPayload
UserFlaggedEvent
UserInfo
UserInfoResponse
UserMute
UserMutedEvent
UserMuteResponse
UserObject
UserPresenceChangedEvent
UserReactivatedEvent
UserRequest
UserResponse
UserResponseData
UserSessionStats
UserStats
UserToken
Token designed to store the JWT and the user it is related to.
UserUnbannedEvent
UserUnmutedEvent
UserUpdatedEvent
VideoConstraints
Base class for options when creating a video track.
VideoQuality
VideoResolution
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.
VisibilityChange
WebhookEvent
WSAuthMessage
WSClientEvent
WSEvent

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
An ApiClient instance that uses the default values obtained from the OpenAPI specification file.
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
byName(CallParticipantState a, CallParticipantState b) int
A comparator which sorts participants by name.
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.
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.
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.
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.
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.
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

FileLogSender = Future Function(File)
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()
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?)
SetOutgoingCall = 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