stream_video_flutter library

Classes

Enums

Mixins

Extensions

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}) → 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.
defaultCallControlOptions({required Call call, required 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.
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

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)
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)
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)
OnConnectionStateUpdated = void Function(ConnectionStateUpdatedEvent)
OnNotificationClick = Future<void> Function(Call)
OnSizeChanged = void Function(Size size): The action to perform when the size of child widget changes.
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.
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

stream_video_flutter library

Classes

Enums

Mixins

Extensions

Constants

Properties

Functions

Typedefs

Exceptions / Errors

stream_video_flutter package

stream_video_flutter library