返回开发者中心

< Flutter UIKit />

UTD Live Room Kit

视频直播房间，内置房主摄像头、嘉宾画面与上麦管理。

版本 1.4.0在 pub.dev 上
开始使用在 pub.dev 上查看
iOSAndroid
live_room_kit.dart
import 'package:utd_live_room_kit/utd_live_room_kit.dart';

UTDLiveRoom(
  appId: '<utd-app-id>',
  appKey: '<utd-app-key>', // publishable; no backend needed
  userId: 'user123',
  userName: 'Jane',
  roomId: 'room456',
  roomOwnerId: 'owner789',
  adminIds: const {'mod1', 'mod2'},
  config: const UTDLiveRoomConfig(maxGuestTiles: 3),
);

3

嘉宾画面

4

角色

Drop-in

完整 UI

PiP

+ 最小化

< utd_live_room_kit />

核心功能

一个可投入生产的 Flutter 套件，用于打造由 LiveKit 与 UTD Stream Engine 驱动的互动视频直播房间。全屏房主摄像头，最多支持三个悬浮嘉宾画面，服务端权威的角色（房主、嘉宾、管理员、观众），用于邀请共同发布者的动态上麦操作，实时聊天，带音频路由的媒体控制，以及最小化/PiP。

开箱即用的直播房间 UI，含房主 + 嘉宾画面

不限数量的直播上麦（无座位网格）

上麦流程：申请发言、房主邀请、移除

服务端权威的角色：房主、嘉宾、管理员（审核员）、观众

房主媒体控制：强制静音/解除静音、关闭摄像头、移出上麦

通过数据通道的实时聊天，支持去重

分级重连（轻量 <15s，完整 <60s，退出 >60s）

最小化为悬浮窗，可选 Android OS PiP

通过 TrackProcessor 实现视频特效（与 Video Effects Kit 搭配使用）

无后端凭据：基于 appKey 的令牌签发，配合按用户的 bearer 鉴权

< utd_live_room_kit />

开始使用

1

安装

Terminal
flutter pub add utd_live_room_kit
2

在 pub.dev 上查看

视频直播房间，内置房主摄像头、嘉宾画面与上麦管理。

在 pub.dev 上查看

< utd_live_room_kit />

API 参考

Main widget

The drop-in LiveKit live-streaming room widget.

UTDLiveRoomwidget
const UTDLiveRoom({required String appId, required String appKey, required String userId, required String userName, required String roomId, required String roomOwnerId, Set<String> adminIds, ..., UTDLiveRoomConfig config, void Function(UTDRoomController)? onControllerReady, ...})

A LiveKit-based video live room. The host's camera fills the screen as the background; up to maxGuestTiles invited guests appear as floating video tiles. Audience watch + chat and may request to go live.

参数

  • appIdString必填

    App ID for the UTD Stream Engine (X-App-Id).

  • appKeyString必填

    Publishable app key (no backend). The kit mints tokens directly with X-App-Key; the server secret never ships.

  • userIdString必填

    Local user's identity.

  • userNameString必填

    Local user's display name.

  • roomIdString必填

    Room / LiveKit room name to join.

  • roomOwnerIdString必填

    Identity of the room owner (becomes host); everyone else joins as audience.

  • adminIdsSet<String>默认值 = const {}

    Identities the owner will promote to admin (moderators) once present in the room.

  • adminIdsResolverFuture<Set<String>> Function()?默认值 = null

    Async source for adminIds resolved after join; the owner self-promotes them via the role endpoint.

  • adminIdsNowSet<String> Function()?默认值 = null

    Optional sync probe for the admin list at token time (no waiting).

  • configUTDLiveRoomConfig默认值 = const UTDLiveRoomConfig()

    Behaviour, theming, and section/tile override configuration.

  • onControllerReadyvoid Function(UTDRoomController)?默认值 = null

    Called once the room controller is created (use it to drive the room imperatively).

  • onConnectionChangedvoid Function(bool)?默认值 = null

    Called when the connection succeeds (true) or fails (false).

  • onConnectErrorvoid Function(Object, StackTrace)?默认值 = null

    Called on connect failure; if null the kit shows its built-in connect-error view.

  • controllerUTDRoomController?默认值 = null

    Reuse an existing already-connected controller, e.g. restoring from a minimized overlay.

Room controller

Imperative facade over the room: connection lifecycle, participants, roles, stage, moderation, and sub-controllers.

UTDRoomControllerconstructor
UTDRoomController()

Creates a room controller that wires up the seat/stage, media, chat, minimize, and PiP sub-controllers.

initApimethod
void initApi({String baseUrl, String engineBaseUrl, String? appId, String? appKey})

Initializes the engine REST clients (token host + in-room ops host). Must be called before connect to use the backend APIs.

参数

  • baseUrlString默认值 = UTDApiClient.defaultBaseUrl

    Token/auth host (POST /api/v1/token).

  • engineBaseUrlString默认值 = UTDApiClient.defaultEngineBaseUrl

    In-room ops host (stage, roles, bans, participants).

  • appIdString?默认值 = null

    App ID sent as the X-App-Id header.

  • appKeyString?默认值 = null

    Publishable app key (no-backend mint credential, sent as X-App-Key).

connectmethodasync
Future<void> connect({required String url, required String token, int seatCount = 9, bool enableMicOnJoin = false, bool useSpeaker = true, Map<String, String> userAttributes = const {}, String? roomName, String? hostIdentity})

Connects to the LiveKit room, initializes seats/stage, starts chat + media listeners, and begins participant/speaking tracking.

参数

  • urlString必填

    LiveKit server URL from the token response.

  • tokenString必填

    LiveKit access token from generateToken.

  • seatCountint默认值 = 9

    Tile-layout capacity (host slot + guest tiles); the engine stage is uncapped.

  • enableMicOnJoinbool默认值 = false

    Enable the local mic immediately after connecting.

  • useSpeakerbool默认值 = true

    Route audio to the speaker (preferring Bluetooth) on join.

  • userAttributesMap<String, String>默认值 = const {}

    Participant attributes (avatar, name, VIP frame, etc.) published after connect.

  • roomNameString?默认值 = null

    Room name used for in-room REST calls; falls back to the LiveKit room name.

  • hostIdentityString?默认值 = null

    Owner identity, used to detect when the host leaves and end the live for others.

generateTokenmethodasync
Future<UTDTokenResponse> generateToken({required String identity, required String roomName, required String roomOwnerId, String type = 'live_stream', String? name, String role = 'audience', ..., Map<String, dynamic>? metadata})

Mints a LiveKit token via the engine and, in app-key mode, applies the returned per-user bearer to the in-room clients. Throws UTDBannedException on a 403 ban.

参数

  • identityString必填

    User identity to mint the token for.

  • roomNameString必填

    Target room name.

  • roomOwnerIdString必填

    Identity of the room owner.

  • typeString默认值 = 'live_stream'

    Engine product type; live_stream is the unbounded seatless stage.

  • nameString?默认值 = null

    Display name.

  • roleString默认值 = 'audience'

    Requested role; the engine clamps non-owners to audience.

  • deviceIdString?默认值 = null

    Stable per-install id for single-active-session enforcement; auto-resolved when omitted.

  • metadataMap<String, dynamic>?默认值 = null

    Extra metadata to embed in the token.

leavemethodasync
Future<void> leave()

Leaves the room: a host broadcasts _live_ended first, then all listeners/timers are cancelled and LiveKit is disconnected.

disposemethod
void dispose()

Releases all controller resources (timers, subscriptions, notifiers, sub-controllers, and REST clients). Idempotent.

requestToSpeakmethodasync
Future<Map<String, dynamic>?> requestToSpeak()

Local audience member asks to go on stage (transient host-side signal). Returns a result map on success, null on failure.

inviteToSpeakmethodasync
Future<Map<String, dynamic>?> inviteToSpeak(String targetIdentity)

Host/admin invites a user onto the stage (grants publish immediately, no accept/decline). Returns null when guest tiles are full.

参数

  • targetIdentityString必填

    Identity of the user to invite on stage.

approveSpeakerRequestmethodasync
Future<Map<String, dynamic>?> approveSpeakerRequest(String identity)

Host/admin approves a pending stage request by adding the user to the stage. Returns null when guest tiles are full.

参数

  • identityString必填

    Identity of the requester to approve.

changeRolemethodasync
Future<UTDRoleChangeResult> changeRole({required String targetIdentity, required String role})

Owner-only: changes a participant's role via the engine. Throws on REST error (403/404/409/422) so callers can surface a message.

参数

  • targetIdentityString必填

    Identity of the participant whose role changes.

  • roleString必填

    New role (e.g. 'admin', 'audience').

banUsermethodasync
Future<bool> banUser(String identity, {String? reason, int? durationSeconds, bool global = false})

Bans a user. Room-scoped by default; pass global true for a project-wide ban. Returns true on success.

参数

  • identityString必填

    Identity to ban.

  • reasonString?默认值 = null

    Optional ban reason.

  • durationSecondsint?默认值 = null

    Ban duration; null = permanent.

  • globalbool默认值 = false

    When true, bans across the whole project rather than this room.

kickParticipantmethodasync
Future<bool> kickParticipant(String targetIdentity)

Host/admin: removes a user from the broadcast entirely (engine-side disconnect). Returns true on success.

参数

  • targetIdentityString必填

    Identity to remove from the room.

setRemoteMicEnabledmethodasync
Future<bool> setRemoteMicEnabled(String targetIdentity, bool enabled)

Host/admin: server-side force-mute or unmute another participant's microphone. Returns true on success.

参数

  • targetIdentityString必填

    Identity whose mic is controlled.

  • enabledbool必填

    True to enable, false to mute.

sendChatMessagemethodasync
Future<void> sendChatMessage(String text)

Sends a chat message to the room (delegates to the chat controller).

参数

  • textString必填

    Message body to send.

participantsStreamgetterasync
Stream<List<UTDParticipant>> get participantsStream

Stream of all room participants; emits on join/leave/attribute/metadata changes.

返回值: Stream<List<UTDParticipant>> — Live participant list.

roleChangeStreamgetterasync
Stream<UTDRoleChangeEvent> get roleChangeStream

Stream of role changes (_role_change) for all participants — owner promotions/demotions and engine auto-corrections.

返回值: Stream<UTDRoleChangeEvent> — Role-change events.

isConnectedgetter
bool get isConnected

Whether the room is currently in the connected state.

返回值: bool — True when connected.

isLocalHostgetter
bool get isLocalHost

Whether this device is the room owner (host).

返回值: bool — True if the local user is the host.

activeSpeakersproperty
final ValueNotifier<Set<String>> activeSpeakers

Set of user IDs currently speaking, driven by LiveKit active-speaker events plus a 300ms backstop poll.

返回值: ValueNotifier<Set<String>> — Speaking identities.

onBannedcallback
void Function(UTDBanNotice notice)? onBanned

Fired once when the local user is banned (data message, removal, or token 403). The widget wires this to show the banned dialog and leave.

返回值: void Function(UTDBanNotice)? — Ban callback.

Media controller

Mic, camera, speaker, and host preview/Go-Live control (UTDRoomController.mediaController).

startPreviewmethodasync
Future<LocalVideoTrack?> startPreview({CameraPosition position = CameraPosition.front})

Creates a local, unpublished camera preview for the host 'Go Live' screen (no remote sees it). Idempotent.

参数

  • positionCameraPosition默认值 = CameraPosition.front

    Front/back camera to open the preview with.

goLivemethodasync
Future<void> goLive({bool withMic = true})

Host 'Go Live': publishes the camera (reusing the preview track for no flicker) and, by default, enables the mic.

参数

  • withMicbool默认值 = true

    Also enable the microphone when going live.

setMicrophoneEnabledmethodasync
Future<void> setMicrophoneEnabled(bool enabled)

Sets the local microphone to a specific enabled state and updates isMicEnabled.

参数

  • enabledbool必填

    True to enable, false to mute.

setCameraEnabledmethodasync
Future<void> setCameraEnabled(bool enabled)

Sets the local camera to a specific state (requests camera permission first) and updates isCameraEnabled.

参数

  • enabledbool必填

    True to enable, false to disable.

switchCameramethodasync
Future<void> switchCamera()

Flips between front and back camera for the active (published or preview) camera track, re-attaching any video-effects processor.

setSpeakerOnmethodasync
Future<void> setSpeakerOn(bool on)

Turns the speaker on/off. Off truly silences the room (disables remote audio tracks), not just reroutes to the earpiece.

参数

  • onbool必填

    True for loudspeaker, false to silence the room.

setVideoProcessormethodasync
Future<void> setVideoProcessor(TrackProcessor<VideoProcessorOptions>? processor)

Attaches (or detaches with null) a beauty/filter processor to the active local camera track at runtime, without re-capturing.

参数

  • processorTrackProcessor<VideoProcessorOptions>?必填

    Effects processor to attach; null detaches.

isMicEnabledproperty
final ValueNotifier<bool> isMicEnabled

Reactive local microphone enabled state, kept in sync with server/host-initiated mutes.

返回值: ValueNotifier<bool> — Mic state.

canPublishproperty
final ValueNotifier<bool> canPublish

Whether the local participant may publish mic/camera; driven by LiveKit permission events. Gate publish UI on this.

返回值: ValueNotifier<bool> — Publish permission.

isPreviewingproperty
final ValueNotifier<bool> isPreviewing

Whether a local, unpublished camera preview (host 'Go Live' screen) is active.

返回值: ValueNotifier<bool> — Preview-active state.

Stage REST API

Direct REST client for the live_stream stage endpoints (UTDStageApi). The stage is the unbounded publisher set: host plus host-invited co-publishers.

getStagemethodasync
Future<Map<String, dynamic>> getStage({required String roomName})

Returns the current stage publishers as { members: [{ identity, name, role }] }. GET /api/v1/rooms/:name/stage.

参数

  • roomNameString必填

    Room name.

addToStagemethodasync
Future<Map<String, dynamic>> addToStage({required String roomName, required String targetIdentity, required String actorIdentity})

Host/admin invites a user onto the stage (grants A/V publish). POST /api/v1/rooms/:name/stage/add.

参数

  • roomNameString必填

    Room name.

  • targetIdentityString必填

    User being added to the stage.

  • actorIdentityString必填

    Host/admin performing the action (dual-mode fallback).

removeFromStagemethodasync
Future<Map<String, dynamic>> removeFromStage({required String roomName, required String targetIdentity, required String actorIdentity})

Host/admin removes a user from the stage (revokes publish). POST /api/v1/rooms/:name/stage/remove.

参数

  • roomNameString必填

    Room name.

  • targetIdentityString必填

    User being removed from the stage.

  • actorIdentityString必填

    Host/admin performing the action.

leaveStagemethodasync
Future<Map<String, dynamic>> leaveStage({required String roomName, required String identity})

A co-publisher steps down from the stage on their own. POST /api/v1/rooms/:name/stage/leave.

参数

  • roomNameString必填

    Room name.

  • identityString必填

    The co-publisher leaving the stage.

requestStagemethodasync
Future<Map<String, dynamic>> requestStage({required String roomName, required String identity})

A viewer asks to go on stage; the engine notifies host/admins via a _stage_request message (no persisted queue). POST /api/v1/rooms/:name/stage/request.

参数

  • roomNameString必填

    Room name.

  • identityString必填

    The requesting viewer's identity.

Chat controller

Room chat: send, receive, and retain messages (UTDRoomController.chatController).

sendMessagemethodasync
Future<void> sendMessage(String text, {Map<String, dynamic>? userData})

Sends a chat message (trims and skips empty text), appends it locally, and broadcasts it over the data channel.

参数

  • textString必填

    Message body.

  • userDataMap<String, dynamic>?默认值 = null

    Optional sender metadata (e.g. avatar, VIP frame) attached to the message.

addDisplayMessagemethod
void addDisplayMessage(UTDChatMessage message)

Appends a message to the list for display only (e.g. local system notices), without sending it.

参数

  • messageUTDChatMessage必填

    Message to append locally.

clearMessagesmethod
void clearMessages()

Clears the retained chat message list.

messagesproperty
final ValueNotifier<List<UTDChatMessage>> messages

Reactive list of retained chat messages (capped at the most recent 300).

返回值: ValueNotifier<List<UTDChatMessage>> — Chat history.

Configuration & theming

Room behaviour, layout overrides, video effects, and color tokens.

UTDLiveRoomConfigconstructor
const UTDLiveRoomConfig({bool showControlsBar = true, bool enableMinimize = true, bool autoHostCamera = false, bool frontCameraOnJoin = true, bool mirrorLocalVideo = true, int maxGuestTiles = 3, ..., UTDRoomTheme theme = const UTDRoomTheme(), UTDRoomStrings? strings, ...})

Configuration for UTDLiveRoom: shared room behaviour, live video behaviour, theming, section/tile builder overrides, video effects, and user attributes.

参数

  • showControlsBarbool默认值 = true

    Render the built-in controls bar.

  • enableMinimizebool默认值 = true

    Allow minimizing the room to an overlay.

  • useSpeakerWhenJoiningbool默认值 = true

    Route audio to the speaker on join.

  • showGoLiveButtonbool默认值 = true

    Show the built-in centered Go Live button during host preview.

  • autoHostCamerabool默认值 = false

    Host publishes the camera immediately on connect, skipping self-preview.

  • frontCameraOnJoinbool默认值 = true

    Start on the front camera.

  • mirrorLocalVideobool默认值 = true

    Mirror the local camera tile (selfie view).

  • maxGuestTilesint默认值 = 3

    Max simultaneous guest tiles (host excluded); enforced server-side too.

  • hostFitVideoViewFit默认值 = VideoViewFit.cover

    How the host's full-bleed video is fitted.

  • guestFitVideoViewFit默认值 = VideoViewFit.cover

    How each floating guest tile's video is fitted.

  • themeUTDRoomTheme默认值 = const UTDRoomTheme()

    Color tokens for the built-in UI.

  • stringsUTDRoomStrings?默认值 = null

    Localized strings; null = English defaults.

  • headerWidgetWidget?默认值 = null

    Override for the room header section.

  • messagesWidgetWidget?默认值 = null

    Override for the chat/messages area.

  • controlsBarWidgetWidget?默认值 = null

    Override for the controls bar.

  • guestTileFooterBuilderWidget Function(BuildContext, String)?默认值 = null

    Overlay at the bottom of each guest tile, receives the guest identity.

  • onStageTapvoid Function()?默认值 = null

    Called when the empty host-video stage area is tapped (e.g. tap-hearts).

  • userInRoomAttributesMap<String, String>默认值 = const {}

    Attributes shared with other participants.

  • buildVideoProcessorTrackProcessor<VideoProcessorOptions> Function()?默认值 = null

    Factory building a fresh video-effects (beauty/filter) processor per camera capture.

UTDRoomThemeconstructor
const UTDRoomTheme({Color background, Color surface, Color onSurface, Color primary, Color danger, Color seatRingSpeaking, Color badgeHost, Color badgeAdmin, ...})

Color tokens for the package's built-in default UI. Every field has a dark-room default, so const UTDRoomTheme() is a complete, usable theme.

参数

  • backgroundColor默认值 = Color(0xFF14121C)

    Full-screen room background.

  • surfaceColor默认值 = Color(0xFF1C1C28)

    Surface behind grouped content.

  • onSurfaceColor默认值 = Colors.white

    Primary foreground color for text/icons.

  • primaryColor默认值 = Color(0xFF6C5CE7)

    Accent / call-to-action color.

  • dangerColor默认值 = Color(0xFFE74C3C)

    Destructive color (leave, kick, ban, mute).

  • seatRingSpeakingColor默认值 = Color(0xFF2ECC71)

    Ring around a tile whose occupant is speaking.

  • badgeHostColor默认值 = Color(0xFFFFA726)

    Badge color for the host role.

  • badgeAdminColor默认值 = Color(0xFF448AFF)

    Badge color for the admin role.

copyWithmethod
UTDRoomTheme copyWith({Color? background, Color? surface, Color? primary, Color? danger, ...})

Returns a copy of the theme with the given tokens overridden — rebrand without replacing whole widgets.

Models & enums

Data types for participants, seats, roles, bans, chat, and exceptions.

UTDParticipantclass
const UTDParticipant({required String id, required String name, bool isMicEnabled = false, bool isSpeaking = false, Map<String, String> attributes = const {}})

A room participant: id, display name, mic/speaking state, and custom attributes (e.g. 'fr' frame, 'frt' frame type, 'cn' color name).

参数

  • idString必填

    Unique user ID.

  • nameString必填

    Display name.

  • isMicEnabledbool默认值 = false

    Whether the participant's mic is on.

  • isSpeakingbool默认值 = false

    Whether the participant is currently speaking.

  • attributesMap<String, String>默认值 = const {}

    Custom participant attributes.

UTDRoleenum
enum UTDRole { visitor, audience, guest, admin, host }

The known engine roles, lowest to highest privilege. The room owner is identified separately (owner_identity), not by these roles.

SeatStateclass
const SeatState({required int index, String? occupantUserId, Map<String, String> attributes = const {}})

One tile in the live room: index 0 = host, 1..N = guest tiles. On the wire this is a backend seat.

参数

  • indexint必填

    Tile/seat index (0 = host).

  • occupantUserIdString?默认值 = null

    User occupying the tile; null = empty.

  • attributesMap<String, String>默认值 = const {}

    Occupant attributes (name, avatar, fr, frt).

UTDRoleChangeEventclass
const UTDRoleChangeEvent({required String identity, required String role, String? previousRole})

Realtime _role_change event broadcast to all participants. Server-sent, so identify the affected user from identity (the LiveKit sender is null).

参数

  • identityString必填

    Affected user's identity.

  • roleString必填

    New role.

  • previousRoleString?默认值 = null

    Role before the change.

UTDChatMessageclass
UTDChatMessage({required String senderUserId, required String senderName, required String text, required DateTime timestamp, Map<String, dynamic> userData = const {}, String? messageID})

A chat message. The text field is untrusted, peer-supplied input relayed verbatim — render as plain text only.

参数

  • senderUserIdString必填

    Sender's identity.

  • senderNameString必填

    Sender's display name.

  • textString必填

    Message body (untrusted plain text).

  • timestampDateTime必填

    When the message was created.

  • userDataMap<String, dynamic>默认值 = const {}

    Optional sender metadata.

  • messageIDString?默认值 = auto

    Message id; defaults to a millisecond timestamp string.

UTDBanNoticeclass
const UTDBanNotice({String? roomName, String? reason, DateTime? expiresAt, UTDBanSource source = UTDBanSource.dataMessage})

A ban (or forced-exit) notice delivered to the local user, with named constructors for data-message, disconnect, token-403, and signed-in-elsewhere sources.

参数

  • roomNameString?默认值 = null

    Room the ban applies to; null = global.

  • reasonString?默认值 = null

    Ban reason when known.

  • expiresAtDateTime?默认值 = null

    Expiry; null = permanent.

  • sourceUTDBanSource默认值 = UTDBanSource.dataMessage

    Where the notice originated.

UTDBannedExceptionclass
const UTDBannedException([String message = 'User is banned', int statusCode = 403])

Thrown by token generation when the server returns 403 User is banned.

参数

  • messageString默认值 = 'User is banned'

    Error message.

  • statusCodeint默认值 = 403

    HTTP status code.

准备好与 UTD 一起构建了吗？

创建账户，为主钱包充值，按需开启你所需要的服务。

创建免费账户