vibecallsdk library
VibeCall SDK: A robust, modular video communication SDK
This package provides a complete WebRTC video communication system with additional features like virtual backgrounds, face filters, whiteboard, recording, and more.
Classes
- BackgroundOptions
- Options for configuring the virtual background effect
- BatteryOptimizer
- Optimizes battery usage by adjusting application behavior based on battery level, power mode, and usage patterns.
- CameraController
- Controller for camera operations
- CameraControllerOptions
- Camera controller configuration options
- CameraFrame
- Represents a frame of video from a camera
- CameraPreview
- Widget that displays a camera preview with optionally processed frames
- Disposable
- An interface for classes that hold resources that need to be released
- FaceDetectionService
- Service for detecting faces and facial landmarks
- FaceFilterProcessor
- Processor that applies face filters to camera frames
- FaceLandmarkPoint
- Represents a 3D point for a face landmark
- FaceLandmarks
- Represents a detected face with landmarks and attributes
- IceServer
- Configuration for an ICE server
- ImageFilterProcessor
- Processes image filters for camera frames
- Logger
- A logging utility for the VibeCall SDK
- NativeMlProcessor
- Native ML processor for performance-critical ML operations
- NetworkQuality
- Network statistics for monitoring connection quality
- Participant
- Represents a participant in a video call
- ParticipantJoinedEvent
- Event fired when a participant joins the room
- ParticipantLeftEvent
- Event fired when a participant leaves the room
- PerformanceMetrics
- Represents performance metrics collected by the PerformanceMonitor
- PerformanceMonitor
- Monitors device performance metrics like CPU usage, memory pressure, frame processing time, and battery consumption.
- PlatformUtilities
- Manager for platform-specific optimizations and utilities
- RecordingInfo
- Information about a recording
- RecordingOptions
- Configuration options for recording
- RecordingService
- Service for managing recordings of video calls
- RecoveryResult
- Represents the result of a recovery attempt for an error
-
Result<
S, E> - A class representing the result of an operation that can either succeed or fail.
- RoomConnectionStateChangedEvent
- Event fired when the room connection state changes
- RoomEvent
- Events related to room activities
- RoomOptions
- Configuration options for a video call room
- ScreenSharingOptions
- Configuration options for screen sharing
- ScreenSharingService
- Service for managing screen sharing
- SDKConfig
- Configuration for the VibeCall SDK
- SegmentationMask
- A mask representing the segmentation of a person in an image
- SegmentationService
- Service for generating person segmentation masks
- VibeCallRoom
- Main class for handling video call rooms
- VibeCallSDK
- Main entry point for the VibeCall SDK
- VirtualBackgroundProcessor
- Processor for applying virtual background effects to camera frames
- WhiteboardEvent
- An event on the whiteboard
- WhiteboardPoint
- A point in a stroke
- WhiteboardService
- Service for managing a collaborative whiteboard
- WhiteboardShape
- A shape on the whiteboard
- WhiteboardStroke
- A stroke on the whiteboard
- WhiteboardText
- A text element on the whiteboard
Enums
- BackgroundType
- Defines the type of virtual background to apply
- CameraFacing
- Direction the camera is facing
- CameraResolution
- Camera resolution options
- ErrorCode
- Error codes for the VibeCall SDK
- ErrorSeverity
- Severity levels for errors in the VibeCall SDK
- FaceDetectionAccuracy
- Model accuracy options for the face detection model
- FaceDetectionMode
- Face detection mode options
- FaceLandmarkType
- Types of facial landmarks that can be detected
- FlashMode
- Flash mode options
- NetworkQualityLevel
- Network quality level classification
- PixelFormat
- Pixel format of camera frames
- PowerMode
- Power mode for battery optimizations
- QualityLevel
- Quality levels for WebRTC and media processing
- RecordingFormat
- Format options for recording
- RecordingState
- State of the recording
- RecoveryAction
- Actions that can be taken to recover from errors
- RoomConnectionState
- Room connection states
- ScreenResolution
- Resolution options for screen sharing
- ScreenSharingState
- State of the screen sharing session
- SegmentationModelQuality
- Model quality options for the segmentation model
- SegmentationQuality
- Background segmentation quality options
- WhiteboardEventType
- The type of whiteboard event
- WhiteboardShapeType
- Shape types that can be added to the whiteboard
Extensions
-
StreamExtensions
on Stream<
T> - Extension to get the current value from a stream
Typedefs
-
FrameProcessor
= Future<
CameraFrame> Function(CameraFrame frame) - Type definition for frame processor functions
- PerformanceMetricsCallback = void Function(PerformanceMetrics metrics)
- Function signature for performance metrics updates
- PowerModeCallback = void Function(PowerMode mode)
- Function signature for power mode change callbacks
- RecordingStateCallback = void Function(RecordingState state)
- Callback for recording state changes
- ScreenSharingStateCallback = void Function(ScreenSharingState state)
- Callback for screen sharing state changes
- WhiteboardDataChannelStateCallback = void Function(RTCDataChannelState state)
- Callback for whiteboard data channel state changes
- WhiteboardEventCallback = void Function(WhiteboardEvent event)
- Callback for whiteboard events
Exceptions / Errors
- VibecallError
- Base error class for the VibeCall SDK