WaterbusSdk class
Main SDK class for Waterbus functionality
Constructors
- WaterbusSdk.new()
-
Factory constructor returns singleton instance
factory
Properties
- callState → CallState
-
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- onEventChangedRegister ← dynamic Function(CallbackPayload)
-
no getter
- onMessageSocketChanged ← dynamic Function(MessageSocketEvent)
-
Event listener setters
no getter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- setOnSubtitle ← dynamic Function(Subtitle)?
-
no getter
Methods
-
addMember(
{required int roomId, required int userId}) → Future< Result< Room> > - Add member to room
-
archiveConversation(
{required int roomId}) → Future< Result< Room> > - Archive a conversation
-
changeAudioInputDevice(
{required String deviceId}) → Future< void> -
changeVideoInputDevice(
{required String deviceId}) → Future< void> -
checkUsername(
{required String username}) → Future< Result< bool> > - Check if username is available
-
createRoom(
{required RoomParams params}) → Future< Result< Room> > - Create a new room
-
createToken(
AuthPayload payload, {dynamic callbackConnected()?}) → Future< Result< User> > - Create authentication token
-
deleteConversation(
{required int conversationId}) → Future< Result< bool> > - Delete a conversation
-
deleteMessage(
{required int messageId}) → Future< Result< Message> > - Delete a message
-
deleteToken(
) → Future< Result< bool> > - Delete authentication token
-
disableVirtualBackground(
) → Future< void> - Disable virtual background
-
editMessage(
{required int messageId, required String data}) → Future< Result< Message> > - Edit an existing message
-
enableVirtualBackground(
{required Uint8List backgroundImage, double thresholdConfidence = 0.7}) → Future< void> - Enable virtual background with custom image
-
getArchivedConversations(
{required int skip, int limit = 10}) → Future< Result< List< >Room> > - Get list of archived conversations with pagination
-
getConversations(
{required int skip, int limit = 10}) → Future< Result< List< >Room> > - Get list of conversations with pagination
-
getMessages(
{required int roomId, required int skip, int limit = 10}) → Future< Result< List< >Message> > - Get messages for a room with pagination
-
getPresignedUrl(
) → Future< Result< PresignedUrl> > - Get presigned URL for file upload
-
getProfile(
) → Future< Result< User> > - Get current user profile
-
getRoomInfo(
{required String code}) → Future< Result< Room> > - Get room information by code
-
getSupportedVideoCodecs(
) → Future< List< RTCVideoCodec> > - Get list of supported video codecs on current platform
-
initialize(
{required SdkConfig config}) → Future< void> - Initialize the Waterbus SDK with configuration
-
joinRoom(
{required JoinRoomParams params}) → Future< Result< Room> > - Join an existing room
-
leaveConversation(
{required int roomId}) → Future< Result< Room> > - Leave a conversation
-
leaveRoom(
) → Future< void> - Leave the current room
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
prepareMedia(
) → Future< void> - Prepare media devices for use
-
reconnect(
) → Future< void> - Reconnect to the current session
-
removeMember(
{required int roomId, required int userId}) → Future< Result< Room> > - Remove member from room
-
renewToken(
) → Future< Result< bool> > - Renew authentication token
-
sendMessage(
{required int roomId, required String data}) → Future< Result< Message?> > - Send a message to a room
-
setPictureInPictureEnabled(
{required String textureId, bool enabled = true}) → Future< void> - Enable/disable Picture-in-Picture mode
-
setSubscribeSubtitle(
{bool isEnabled = true}) → void - Enable/disable subtitle subscription
-
startScreenSharing(
{DesktopCapturerSource? source}) → Future< void> - Start screen sharing
-
stopScreenSharing(
) → Future< void> - Stop screen sharing
-
switchCamera(
) → Future< void> - Switch between front and back camera
-
toggleAudio(
) → Future< void> - Toggle audio on/off
-
toggleRaiseHand(
) → void -
toggleSpeakerPhone(
) → Future< void> - Toggle speaker phone
-
toggleVideo(
) → Future< void> - Toggle video on/off
-
toString(
) → String -
A string representation of this object.
inherited
-
updateConversation(
{required Room room, String? password}) → Future< Result< bool> > - Update conversation settings
-
updateMediaConfig(
MediaConfig setting) → Future< void> - Change call media settings
-
updateProfile(
{required User user}) → Future< Result< bool> > - Update user profile
-
updateRoom(
{required RoomParams params}) → Future< Result< bool> > - Update room settings
-
updateUsername(
{required String username}) → Future< Result< bool> > - Update username
-
uploadAvatar(
{required Uint8List image, required String presignedUrl, required String sourceUrl}) → Future< Result< String> > - Upload user avatar
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- httpVersionPref → HttpVersionPref
-
no setter
- instance → WaterbusSdk
-
Singleton instance
final
- listener → WaterbusEventListener
-
no setter
- messageEncryptionKey → String
-
no setter
- serverConfig → ServerConfig
-
no setter
- webrtcE2eeKey → String
-
no setter