LiveSeatStore

abstract class LiveSeatStore

Live seat management related interfaces, managing seat operations such as taking seat, leaving seat, locking seat, and releasing seat.

Overview

LiveSeatStore Live seat management class for managing seat operations such as taking seat, leaving seat, locking seat, and releasing seat. LiveSeatStore provides a complete set of seat management APIs, including taking seat, leaving seat, locking seat, unlocking seat, kicking user off seat, remote device control, etc. Through this class, seat management functionality can be implemented in the live room.

Core Features

  • Seat Management: Take seat, leave seat, lock seat, unlock seat operations

  • User Management: Kick user off seat, move user to specified seat

  • Device Control: Remote control of user's camera and microphone

  • Event Listening: Listen to seat-related events

Important: Use the LiveSeatStore.create factory method to create a LiveSeatStore instance, passing a valid live room ID. Seat state updates are delivered through the liveSeatState publisher. Subscribe to it to receive real-time updates of seat data in the room.

Seat Management Operations Overview

OperationMethodDescription
Take SeattakeSeatUser takes seat
Leave SeatleaveSeatUser leaves seat
Lock SeatlockSeatLock seat
UnlockunlockSeatUnlock seat
KickkickUserOutOfSeatKick user off seat
MovemoveUserToSeatMove user to specified seat

Remote Device Control

OperationMethodDescription
Open CameraopenRemoteCameraRemotely open user's camera
Close CameracloseRemoteCameraRemotely close user's camera
Open MicrophoneopenRemoteMicrophoneRemotely open user's microphone
Close MicrophonecloseRemoteMicrophoneRemotely close user's microphone

Topics

Creating Instance

Observing State and Events

Seat Operations

User Management

Remote Device Control

See Also

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Seat state data provided by LiveSeatStore.

Functions

Link copied to clipboard

Add seat event listener

Link copied to clipboard
abstract fun closeRemoteCamera(userID: String?, completion: CompletionHandler?)

Close remote camera

Link copied to clipboard
abstract fun closeRemoteMicrophone(userID: String?, completion: CompletionHandler?)

Close remote microphone

Link copied to clipboard
abstract fun kickUserOutOfSeat(userID: String?, completion: CompletionHandler?)

Kick user off seat

Link copied to clipboard
abstract fun leaveSeat(completion: CompletionHandler?)

Leave seat

Link copied to clipboard
abstract fun lockSeat(seatIndex: Int, completion: CompletionHandler?)

Lock seat

Link copied to clipboard
abstract fun moveUserToSeat(userID: String?, targetIndex: Int, policy: MoveSeatPolicy? = MoveSeatPolicy.ABORT_WHEN_OCCUPIED, completion: CompletionHandler?)

Move user to seat

Link copied to clipboard
abstract fun muteMicrophone()

Mute microphone

Link copied to clipboard
abstract fun openRemoteCamera(userID: String?, policy: DeviceControlPolicy, completion: CompletionHandler?)

Open remote camera

Link copied to clipboard
abstract fun openRemoteMicrophone(userID: String?, policy: DeviceControlPolicy, completion: CompletionHandler?)

Open remote microphone

Link copied to clipboard

Remove seat event listener

Link copied to clipboard
abstract fun takeSeat(seatIndex: Int, completion: CompletionHandler?)

Take seat

Link copied to clipboard
abstract fun unlockSeat(seatIndex: Int, completion: CompletionHandler?)

Unlock seat

Link copied to clipboard
abstract fun unmuteMicrophone(completion: CompletionHandler?)

Unmute microphone