@tencent-rtc/mcp 1.4.7 → 1.6.0

package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md

@@ -0,0 +1,438 @@
+## Introduction
+
+`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.
+
+> **Important: **
+>
+
+> Use the **LiveSeatStore.create** factory method to create a `LiveSeatStore` instance, passing a valid live room ID.
+>
+
+> **Note: **
+>
+
+> Seat state updates are delivered through the **liveSeatState** publisher. Subscribe to it to receive real-time updates of seat data in the room.
+>
+
+## Features
+- **Seat Management**: Take seat, leave seat, lock seat, unlock seat operations.
+
+- **User Management**: Kick user off seat, move user to specified seat.
+
+- **Featured Host Management**: In templates that support a featured host slot, set a seated user as a featured host or remove a featured host.
+
+- **Device Control**: Remote control of user's camera and microphone.
+
+- **Event Listening**: Listen to seat-related events.
+
+## Subscribable Data
+
+**LiveSeatState** fields are described below:
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|seatList|ValueListenable<List<SeatInfo>>|Seat list.|
+|canvas|ValueListenable<LiveCanvas>|Canvas information.|
+|speakingUsers|ValueListenable<Map<String,int>>|Speaking users.|
+|avStatistics|ValueListenable<List<AVStatistics>>|Audio and video statistics.|
+
+## API List
+
+|**Function**|**Description**|
+|---------|---------|
+|LiveSeatStore.create|Create seat management instance.|
+|addLiveSeatEventListener|Seat event callbacks.|
+|removeLiveSeatEventListener|Seat event callbacks.|
+|takeSeat|Take seat.|
+|leaveSeat|Leave seat.|
+|lockSeat|Lock seat.|
+|unlockSeat|Unlock seat.|
+|kickUserOutOfSeat|Kick user off seat.|
+|moveUserToSeat|Move user.|
+|setFeaturedHost|Set a featured host.|
+|revokeFeaturedHost|Revoke a featured host.|
+|openRemoteCamera|Open remote camera.|
+|closeRemoteCamera|Close remote camera.|
+|openRemoteMicrophone|Open remote microphone.|
+|closeRemoteMicrophone|Close remote microphone.|
+
+### Creating Instance
+
+#### LiveSeatStore.create
+
+Create seat management instance.
+
+### Observing State and Events
+
+#### addLiveSeatEventListener
+
+Add seat event listener.
+``` dart
+void addLiveSeatEventListener(LiveSeatListener listener);
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|listener|LiveSeatListener|Listener.|
+
+#### removeLiveSeatEventListener
+
+Remove seat event listener.
+``` dart
+void removeLiveSeatEventListener(LiveSeatListener listener);
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|listener|LiveSeatListener|Listener.|
+
+### Seat Operations
+
+#### takeSeat
+
+Take seat.
+``` dart
+Future<CompletionHandler> takeSeat(int seatIndex);
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|seatIndex|int|Seat index.|
+
+#### leaveSeat
+
+Leave seat.
+``` dart
+Future<CompletionHandler> leaveSeat();
+```
+
+**Version**
+
+Supported since version 3.5.
+
+#### lockSeat
+
+Lock seat.
+``` dart
+Future<CompletionHandler> lockSeat(int seatIndex);
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|seatIndex|int|Seat index.|
+
+#### unlockSeat
+
+Unlock seat.
+``` dart
+Future<CompletionHandler> unlockSeat(int seatIndex);
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|seatIndex|int|Seat index.|
+
+### User Management
+
+#### kickUserOutOfSeat
+
+Kick user off seat.
+``` dart
+Future<CompletionHandler> kickUserOutOfSeat(String userID);
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|userID|String|User ID.|
+
+#### moveUserToSeat
+
+Move user to seat.
+``` dart
+Future<CompletionHandler> moveUserToSeat({
+  required String userID,
+  required int targetIndex,
+  MoveSeatPolicy policy = MoveSeatPolicy.abortWhenOccupied,
+});
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|userID|String|User ID.|
+|targetIndex|int|Target seat index.|
+|policy|MoveSeatPolicy|Move policy.|
+
+### Featured Host Management
+
+#### setFeaturedHost
+
+Set featured host.
+``` dart
+Future<CompletionHandler> setFeaturedHost(String userID);
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|userID|String|User ID.|
+
+#### revokeFeaturedHost
+
+Revoke featured host.
+``` dart
+Future<CompletionHandler> revokeFeaturedHost(String userID);
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|userID|String|User ID.|
+
+### Remote Device Control
+
+#### openRemoteCamera
+
+Open remote camera.
+``` dart
+Future<CompletionHandler> openRemoteCamera({
+  required String userID,
+  required DeviceControlPolicy policy,
+});
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|userID|String|User ID.|
+|policy|DeviceControlPolicy|Device control policy.|
+
+#### closeRemoteCamera
+
+Close remote camera.
+``` dart
+Future<CompletionHandler> closeRemoteCamera(String userID);
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|userID|String|User ID.|
+
+#### openRemoteMicrophone
+
+Open remote microphone.
+``` dart
+Future<CompletionHandler> openRemoteMicrophone({
+  required String userID,
+  required DeviceControlPolicy policy,
+});
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|userID|String|User ID.|
+|policy|DeviceControlPolicy|Device control policy.|
+
+#### closeRemoteMicrophone
+
+Close remote microphone.
+``` dart
+Future<CompletionHandler> closeRemoteMicrophone(String userID);
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|userID|String|User ID.|
+
+## Data Structures
+
+### MoveSeatPolicy
+
+Move seat policy.
+
+|**Enum Value**|**Description**|
+|---------|---------|
+|abortWhenOccupied|Abort when occupied.|
+|forceReplace|Force replace.|
+|swapPosition|Swap position.|
+
+### DeviceControlPolicy
+
+Device control policy.
+
+|**Enum Value**|**Description**|
+|---------|---------|
+|unlockOnly|Unlock only.|
+
+### SuspendStatus
+
+User suspend status.
+
+|**Enum Value**|**Description**|
+|---------|---------|
+|none|Not suspended.|
+|inBackground|User suspended in background.|
+|inCalling|User is on a phone call.|
+
+### LiveSeatListener
+
+Seat related callback events.
+
+**Methods**
+
+|**Method**|**Description**|
+|---------|---------|
+|onLocalCameraOpenedByAdmin|Triggeredwhenthelocalcameraisopenedbyanadmin.|
+|onLocalCameraClosedByAdmin|Triggeredwhenthelocalcameraisclosedbyanadmin.|
+|onLocalMicrophoneOpenedByAdmin|Triggeredwhenthelocalmicrophoneisopenedbyanadmin.|
+|onLocalMicrophoneClosedByAdmin|Triggeredwhenthelocalmicrophoneisclosedbyanadmin.|
+
+### SeatUserInfo
+
+Seat user information.
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|userID|String|User ID.|
+|userName|String|User name.|
+|avatarURL|String|Avatar URL.|
+|role|Role|User role.|
+|liveID|String|Live room ID.|
+|microphoneStatus|DeviceStatus|Microphone status.|
+|allowOpenMicrophone|bool|Whether microphone can be opened.|
+|cameraStatus|DeviceStatus|Camera status.|
+|allowOpenCamera|bool|Whether camera can be opened.|
+|userSuspendStatus|SuspendStatus|User suspend status.|
+
+### RegionInfo
+
+Seat view coordinate information.
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|x|int|X coordinate.|
+|y|int|Y coordinate.|
+|w|int|Width.|
+|h|int|Height.|
+|zorder|int|Z-order.|
+
+### AVStatistics
+
+Audio and video statistics information.
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|userID|String|User ID.|
+|videoBitrate|int|Local video bitrate.|
+|videoWidth|int|Local video width.|
+|videoHeight|int|Local video height.|
+|frameRate|int|Local video frame rate.|
+|audioSampleRate|int|Audio sample rate.|
+|audioBitrate|int|Audio bitrate.|
+
+### SeatInfo
+
+Seat information.
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|index|int|Seat index.|
+|isLocked|bool|Whether locked.|
+|userInfo|SeatUserInfo|User information.|
+|region|RegionInfo|Region information.|
+|isFeaturedHost|bool|Whether the user on this seat is currently a featured host. Can only be true in templates that support featured host slots.|
+
+### LiveCanvas
+
+Live canvas.
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|w|int|Width.|
+|h|int|Height.|
+|templateID|int|Template ID.|
+
+### LiveSeatState
+
+Seat state data provided by LiveSeatStore.
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|seatList|ValueListenable<List<SeatInfo>>|Seat list.|
+|canvas|ValueListenable<LiveCanvas>|Canvas information.|
+|speakingUsers|ValueListenable<Map<String,int>>|Speaking users.|
+|avStatistics|ValueListenable<List<AVStatistics>>|Audio and video statistics.|

package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md

@@ -0,0 +1,190 @@
+## Introduction
+
+`LoginStore` provides a complete set of login management APIs, including user login, logout, and personal information settings. Through this class, you can manage user login status and user profiles.
+
+> **Important: **
+>
+
+> Use **shared** singleton object to access the `LoginStore` instance.
+>
+
+> **Note: **
+>
+
+> Login status updates are delivered through **loginState** publisher. Subscribe to it to receive real-time updates about login status.
+>
+
+## Features
+- **User Login**: Supports login using SDK application ID, user ID and user signature.
+
+- **User Logout**: Supports user logout operation.
+
+- **Personal Information Settings**: Supports setting user nickname, avatar, gender and other personal information.
+
+## Subscribable Data
+
+**LoginState** fields are described below:
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|loginStatus|LoginStatus|Login status.|
+|loginUserInfo|UserProfile?|Logged-in user information.|
+
+## API List
+
+|**Function**|**Description**|
+|---------|---------|
+|shared|Singleton object.|
+|loginEventStream|Login event stream.|
+|login|Login.|
+|logout|Logout.|
+|setSelfInfo|Set personal information.|
+|setCertificateID(apnsCertificateID:voipCertificateID:)|Set offline push certificate IDs.|
+
+### Getting Instance
+
+#### shared
+
+Singleton object.
+``` dart
+static LoginStore get shared => LoginStoreImpl.instance;
+```
+
+**Version**
+
+Supported since version 3.5.
+
+### Events Handling
+
+#### loginEventStream
+
+Login event stream.
+
+Login event stream. It is recommended to listen to this stream before calling **login**, so that you can receive login-related events in a timely manner.
+
+**Data Structures：**LoginEvent
+
+### Login Operations
+
+#### login
+
+Login.
+``` dart
+Future<CompletionHandler> login({
+  required int sdkAppID,
+  required String userID,
+  required String userSig,
+});
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|sdkAppID|int|SDK application ID. Get this from **TRTC console**(https://console.trtc.io/app).|
+|userID|String|User ID. The recommended length limit is 32 bytes, and only uppercase and lowercase English letters (a-zA-Z), digits (0-9), underscores, and hyphens are allowed.|
+|userSig|String|User signature. For the generation of userSig, please refer to the **Secure authentication with userSig**(https://trtc.io/document/35166).|
+
+#### logout
+
+Logout.
+``` dart
+Future<CompletionHandler> logout();
+```
+
+**Version**
+
+Supported since version 3.5.
+
+#### setSelfInfo
+
+Set personal information.
+``` dart
+Future<CompletionHandler> setSelfInfo({required UserProfile userInfo});
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|userProfile|UserProfile|User profile.|
+
+### Push Configuration
+
+#### setCertificateID(apnsCertificateID:voipCertificateID:)
+
+Set offline push certificate IDs.
+
+## Data Structures
+
+### LoginStatus
+
+Login status.
+
+|**Enum Value**|**Description**|
+|---------|---------|
+|unlogin|Not logged in.|
+|logined|Logged in.|
+
+### AllowType
+
+Friend verification type.
+
+|**Enum Value**|**Value**|**Description**|
+|---------|---------|---------|
+|allowAny|0|Allow anyone.|
+|needConfirm|1|Need confirmation.|
+|denyAny|2|Deny anyone.|
+
+### Gender
+
+Gender.
+
+|**Enum Value**|**Value**|**Description**|
+|---------|---------|---------|
+|unknown|0|Unknown.|
+|male|1|Male.|
+|female|2|Female.|
+
+### LoginEvent
+
+Login event.
+
+|**Enum Value**|**Description**|
+|---------|---------|
+|kickedOffline|Current user kicked offline.|
+|loginExpired|Login ticket expired.|
+
+### UserProfile
+
+User profile.
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|userID|String|User ID.|
+|nickname|String?|Nickname.|
+|avatarURL|String?|Avatar URL.|
+|selfSignature|String?|Personal signature.|
+|gender|Gender?|Gender.|
+|role|int?|Role. This field has no business restrictions, so you can safely use any valid integer value.|
+|level|int?|Level. This field has no business restrictions, so you can safely use any valid integer value.|
+|birthday|int?|Birthday. This field has no business restrictions, so you can safely use any valid integer value.|
+|allowType|AllowType?|Friend verification type.|
+|customInfo|Map<String,String>?|Custom information.|
+
+### LoginState
+
+Login state.
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|loginStatus|LoginStatus|Login status.|
+|loginUserInfo|UserProfile?|Logged-in user information.|