api

Server

API Reference

Reference for the stable SPLive 2.0.0 client, services, streams, and models.

SpliveSdk constructor

dart
SpliveSdk({
  String baseUrl = SpliveEndpoints.serverUrl,
  ApiClient? apiClient,
  RoomSocketService? socketService,
  SpliveMediaClient? mediaClient,
})

Services

PropertyResponsibility
sdk.authRegister, login, current user, token lifecycle
sdk.usersBackward-compatible authentication facade
sdk.groupsGroup creation and membership
sdk.roomsRust room HTTP operations
sdk.chatRealtime chat over the room socket
sdk.socketRust WebSocket connection
sdk.mediaLiveKit media connection

Authentication

dart
sdk.auth.register(...)
sdk.auth.login(...)
sdk.auth.me()
sdk.auth.setAccessToken(token)
sdk.auth.logout()
sdk.auth.isAuthenticated
sdk.auth.accessToken

Room convenience methods

dart
sdk.createRoom(...)
sdk.loadRooms(groupId: ...)
sdk.joinRoom(roomId: ..., userId: ...)
sdk.leaveRoom(roomId: ...)

Realtime methods and streams

dart
sdk.connectRoomSocket(...)
sdk.disconnectRoomSocket()
sdk.sendRoomEvent(...)
sdk.sendRoomMessage(...)
sdk.sendRoomEmoji(...)

sdk.roomEvents
sdk.roomMessages
sdk.socketStates
sdk.isRoomSocketConnected

Media methods and streams

dart
sdk.connect(config)
sdk.disconnect()
sdk.enableMicrophone()
sdk.disableMicrophone()
sdk.toggleMicrophone()
sdk.setSpeakerOutput(enabled)
sdk.currentParticipants()

sdk.connectionStates
sdk.participants
sdk.mediaEvents
sdk.connectionState
sdk.isConnected
sdk.isMicrophoneEnabled

Cleanup

dart
await sdk.dispose();
The exact return type of room-list convenience methods should be documented from the published package source. Avoid Future<dynamic> in future releases.
Interactive

API Explorer

Build a request, inspect headers and body, then copy the generated cURL command.