@tencent-rtc/mcp 1.4.7 → 1.6.0

package/resource/knowledge/chat/urls/sdk/web.md

@@ -0,0 +1,80 @@
+# Web — SDK official documentation URL map
+## A — SDK integration and initialization (Web & Mini Program)
+
+| Query | Documentation |
+|-------|---------------|
+| Web SDK integration and initialization (V4) | `https://trtc.io/document/34309` |
+| Web SDK initialization | `https://trtc.io/document/47967` |
+
+## B — Login and logout
+
+| Query | Documentation |
+|-------|---------------|
+| Login (`login` API) | `https://trtc.io/document/47970` |
+| Logout (`logout` API) | `https://trtc.io/document/47970` |
+
+## C — SDK API usage
+
+| Query | Documentation |
+|-------|---------------|
+| SDK message types overview | `https://trtc.io/document/47990` |
+| Text message (createTextMessage → sendMessage) | `https://trtc.io/document/47993` |
+| Group @ message (createTextAtMessage → sendMessage) | `https://trtc.io/document/47993` |
+| Image message (createImageMessage → sendMessage) | `https://trtc.io/document/47993` |
+| Voice message (createVoiceMessage → sendMessage) | `https://trtc.io/document/47993` |
+| Video message (createVideoMessage → sendMessage) | `https://trtc.io/document/47993` |
+| File message (createFileMessage → sendMessage) | `https://trtc.io/document/47993` |
+| Custom message (createCustomMessage → sendMessage) | `https://trtc.io/document/47993` |
+| Face message (createFaceMessage → sendMessage) | `https://trtc.io/document/47993` |
+| Location message (createLocationMessage → sendMessage) | `https://trtc.io/document/47993` |
+| Merger message (createMergerMessage → sendMessage) | `https://trtc.io/document/48002` |
+| Forward message (createForwardMessage → sendMessage) | `https://trtc.io/document/48002` |
+| Send message parameter configuration (sendMessage parameters) | `https://trtc.io/document/47993` |
+| Receive messages (EVENT.MESSAGE_RECEIVED) | `https://trtc.io/document/47996` |
+| Get message history (getMessageList) | `https://trtc.io/document/47999` |
+| Modify message (modifyMessage) | `https://trtc.io/document/48005` |
+| Delete message (deleteMessage) | `https://trtc.io/document/48010` |
+| Clear history messages (clearHistoryMessage) | `https://trtc.io/document/53498` |
+| Recall message (revokeMessage) | `https://trtc.io/document/48015` |
+| Online messages | `https://trtc.io/document/48018` |
+| Read receipts (one-to-one and group) | `https://trtc.io/document/48021` |
+| Query messages (findMessage) | `https://trtc.io/document/48024` |
+| Targeted group message | `https://trtc.io/document/52716` |
+| Do-not-disturb (setMessageRemindType) | `https://trtc.io/document/48031` |
+| Message extension (poll / chain scenarios) | `https://trtc.io/document/54166` |
+| Message reactions | `https://trtc.io/document/60749` |
+| Message translation (translateText) | `https://trtc.io/document/55857` |
+| Voice-to-text (convertVoiceToText) | `https://trtc.io/document/60751` |
+| Conversation storage limits | `https://trtc.io/document/48328` |
+| Conversation list (getConversationList) | `https://trtc.io/document/48325` |
+| Conversation profile (getConversationProfile) | `https://trtc.io/document/48322` |
+| Unread message count (getTotalUnreadMessageCount) | `https://trtc.io/document/48319` |
+| Pin conversation (pinConversation) | `https://trtc.io/document/48316` |
+| Delete conversation (deleteConversation) | `https://trtc.io/document/48313` |
+| Conversation draft (setConversationDraft) | `https://trtc.io/document/56184` |
+| Conversation mark (markConversation) | `https://trtc.io/document/50291` |
+| Conversation groups | `https://trtc.io/document/50289` |
+| Group types and capabilities overview | `https://trtc.io/document/48169` |
+| Standard group management | `https://trtc.io/document/48465` |
+| Group profile (getGroupProfile / updateGroupProfile) | `https://trtc.io/document/48184` |
+| Group member management | `https://trtc.io/document/48180` |
+| Group member profile | `https://trtc.io/document/48177` |
+| Group custom attributes | `https://trtc.io/document/48174` |
+| Group counter (groupCounter) | `https://trtc.io/document/56042` |
+| Community and topics | `https://trtc.io/document/48171` |
+| User profile (getMyProfile / getUserProfile / updateMyProfile) | `https://trtc.io/document/48161` |
+| User status (getUserStatus / subscribeUserStatus) | `https://trtc.io/document/49561` |
+| Friend management | `https://trtc.io/document/48158` |
+| Friend groups | `https://trtc.io/document/48155` |
+| Block list | `https://trtc.io/document/48152` |
+| Follow and followers | `https://trtc.io/document/66035` |
+| Cloud search messages (searchCloudMessages) | `https://trtc.io/document/67677` |
+| Cloud search users (searchUsers) | `https://trtc.io/document/67679` |
+| Cloud search groups (searchGroups) | `https://trtc.io/document/67681` |
+| Cloud search group members (searchGroupMembers) | `https://trtc.io/document/67683` |
+
+## D — Version upgrade guide
+
+| Query | Documentation |
+|-------|---------------|
+| V4 Changelog | `https://trtc.io/document/34281` |

package/resource/knowledge/chat/urls/webhook.md

@@ -0,0 +1,68 @@
+# Server Webhooks — official documentation URL map
+## Webhook overview
+
+| Query | Documentation |
+|-------|---------------|
+| Webhook overview / configuration / specification | `https://trtc.io/document/34354` |
+
+## Online status webhooks
+
+| Query | Documentation |
+|-------|---------------|
+| User status change webhook | `https://trtc.io/document/34357` |
+
+## Profile and relationship webhooks
+
+| Query | Documentation |
+|-------|---------------|
+| Before add friend webhook | `https://trtc.io/document/43468` |
+| Before add friend response webhook | `https://trtc.io/document/43467` |
+| After add friend webhook | `https://trtc.io/document/34359` |
+| After delete friend webhook | `https://trtc.io/document/34360` |
+| After add to blocklist webhook | `https://trtc.io/document/34361` |
+| After remove from blocklist webhook | `https://trtc.io/document/34362` |
+
+## Follow webhooks
+
+| Query | Documentation |
+|-------|---------------|
+| After follow user webhook | `https://trtc.io/document/70355` |
+| After unfollow user webhook | `https://trtc.io/document/70356` |
+
+## One-to-one message webhooks
+
+| Query | Documentation |
+|-------|---------------|
+| Set one-to-one message extension webhook | `https://trtc.io/document/76006` |
+| Before send one-to-one message webhook | `https://trtc.io/document/34364` |
+| After send one-to-one message webhook | `https://trtc.io/document/34365` |
+| After one-to-one message read report webhook | `https://trtc.io/document/43465` |
+| After one-to-one message recall webhook | `https://trtc.io/document/43466` |
+
+## Group system webhooks
+
+| Query | Documentation |
+|-------|---------------|
+| Set group message extension webhook | `https://trtc.io/document/76007` |
+| Before create group webhook | `https://trtc.io/document/34368` |
+| After create group webhook | `https://trtc.io/document/34369` |
+| Before apply to join group webhook | `https://trtc.io/document/34370` |
+| Before invite to group webhook | `https://trtc.io/document/34371` |
+| After new member joined group webhook | `https://trtc.io/document/34372` |
+| After member left group webhook | `https://trtc.io/document/34373` |
+| Before send group message webhook | `https://trtc.io/document/34374` |
+| After send group message webhook | `https://trtc.io/document/34375` |
+| After group full webhook | `https://trtc.io/document/34376` |
+| After group disbanded webhook | `https://trtc.io/document/34377` |
+| After group profile changed webhook | `https://trtc.io/document/34378` |
+| After group message recalled webhook | `https://trtc.io/document/46979` |
+| AVChatRoom member online status webhook | `https://trtc.io/document/48734` |
+| Group message send exception webhook | `https://trtc.io/document/49462` |
+| Before create topic webhook | `https://trtc.io/document/49463` |
+| After create topic webhook | `https://trtc.io/document/49464` |
+| After disband topic webhook | `https://trtc.io/document/49465` |
+| After topic profile modified webhook | `https://trtc.io/document/49466` |
+| After group member profile changed webhook | `https://trtc.io/document/60393` |
+| After group custom attribute changed webhook | `https://trtc.io/document/60394` |
+| After read receipt webhook | `https://trtc.io/document/60395` |
+| After change group owner webhook | `https://trtc.io/document/60396` |

package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md

@@ -0,0 +1,286 @@
+## Introduction
+
+`AudioEffectStore` provides a complete set of audio effect management APIs, including voice changer effects, reverb effects, and ear monitor functionality. Through this class, anchors can adjust their voice effects in real-time during live streaming to enhance the experience.
+
+> **Important: **
+>
+
+> Use the **AudioEffectStore.shared** singleton to get the `AudioEffectStore` instance. The set effects will automatically become invalid after leaving the room, and need to be set again for the next room entry.
+>
+
+> **Note: **
+>
+
+> Audio effect state updates are delivered through the **audioEffectState** publisher. Subscribe to it to receive real-time updates about voice changer, reverb, and ear monitor states.
+>
+
+> **Warning: **
+>
+
+> Due to the very high hardware latency of Bluetooth earphones, the ear monitor feature cannot be enabled when the anchor is wearing Bluetooth earphones. Please prompt the anchor to wear wired earphones in the user interface.
+>
+
+## Features
+- **Voice Changer Effects**: Supports multiple voice changer effects such as child, little girl, uncle, etc.
+
+- **Reverb Effects**: Supports multiple reverb effects such as KTV, small room, auditorium, etc.
+
+- **Ear Monitor**: Anchors can hear their own voice in earphones, suitable for singing scenarios.
+
+- **Volume Control**: Supports fine-grained ear monitor volume adjustment.
+
+## Subscribable Data
+
+**AudioEffectState** fields are described below:
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|audioChangerType|StateFlow<AudioChangerType>|Voice changer state.|
+|audioReverbType|StateFlow<AudioReverbType>|Reverb state.|
+|isEarMonitorOpened|StateFlow<Boolean>|Ear monitor enabled.|
+|earMonitorVolume|StateFlow<Int>|Ear monitor volume, with a value range from 0 to 100.<br>If the volume is still too low after setting it to 100, you can set the volume to a maximum of 150, but a volume exceeding 100 may cause distortion, please operate with caution.|
+
+## API List
+
+|**Function**|**Description**|
+|---------|---------|
+|AudioEffectStore.shared|Get singleton instance.|
+|setAudioChangerType|Set voice changer effect.|
+|setAudioReverbType|Set reverb effect.|
+|setVoiceEarMonitorEnable|Enable/disable ear monitor.|
+|setVoiceEarMonitorVolume|Set ear monitor volume.|
+|reset|Reset to default state.|
+
+### Getting Instance
+
+#### AudioEffectStore.shared
+
+Get singleton instance.
+
+### Voice Changer Settings
+
+#### setAudioChangerType
+
+Set voice changer effect.
+``` kotlin
+abstract fun setAudioChangerType(type: AudioChangerType)
+```
+
+Through this interface, you can set the voice changer effect for human voice.
+
+Voice changer effects can be applied to human voice, and the voice is processed secondarily through acoustic algorithms to obtain a timbre different from the original sound.
+
+**Version**
+
+Supported since version 3.5.
+
+**When to Call**
+
+Call after entering the room and when voice changer effect is needed.
+
+**Notes**
+
+> **Note: **
+>
+
+> The set effect will automatically become invalid after leaving the room. If you need the corresponding effect for the next room entry, you need to call this interface again to set it.
+>
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|type|AudioChangerType|Voice changer effect type.|
+
+### Reverb Settings
+
+#### setAudioReverbType
+
+Set reverb effect.
+``` kotlin
+abstract fun setAudioReverbType(type: AudioReverbType)
+```
+
+Through this interface, you can set the reverb effect for human voice.
+
+Reverb effects can be applied to human voice, and the sound is processed through acoustic algorithms to simulate the presence in various different environments.
+
+**Version**
+
+Supported since version 3.5.
+
+**When to Call**
+
+Call after entering the room and when reverb effect is needed.
+
+**Notes**
+
+> **Note: **
+>
+
+> The set effect will automatically become invalid after leaving the room. If you need the corresponding effect for the next room entry, you need to call this interface again to set it.
+>
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|type|AudioReverbType|Reverb effect type.|
+
+### Ear Monitor Settings
+
+#### setVoiceEarMonitorEnable
+
+Enable/disable ear monitor.
+``` kotlin
+abstract fun setVoiceEarMonitorEnable(enable: Boolean)
+```
+
+After the anchor enables ear monitor, they can hear their own voice captured by the microphone in the earphones. This effect is suitable for anchor singing application scenarios.
+
+**Version**
+
+Supported since version 3.5.
+
+**Use Cases**
+
+Suitable for anchor singing scenarios, allowing anchors to hear their own voice in real time to adjust their singing performance.
+
+**When to Call**
+
+Call after entering the room and when the anchor is wearing wired earphones.
+
+**Notes**
+
+> **Warning: **
+>
+
+> Due to the very high hardware latency of Bluetooth earphones, this effect cannot be enabled when the anchor is wearing Bluetooth earphones. Please try to prompt the anchor to wear wired earphones in the user interface.
+>
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|enable|Boolean|Whether to enable ear monitor.|
+
+#### setVoiceEarMonitorVolume
+
+Set ear monitor volume.
+``` kotlin
+abstract fun setVoiceEarMonitorVolume(volume: Int)
+```
+
+Through this interface, you can set the volume of the sound in the ear monitor effect.
+
+**Version**
+
+Supported since version 3.5.
+
+**When to Call**
+
+Call after enabling the ear monitor feature.
+
+**Notes**
+
+> **Note: **
+>
+
+> If the volume is still too low after setting it to 100, you can set the volume to a maximum of 150, but a volume exceeding 100 may cause distortion, please operate with caution.
+>
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|volume|Int|Ear monitor volume, with a value range from 0 to 100. (Range: Value range from 0 to 100, exceeding 100 may cause distortion) (Default: 100).|
+
+### Reset
+
+#### reset
+
+Reset to default state.
+``` kotlin
+abstract fun reset()
+```
+
+Reset all audio effect settings to default values, including disabling voice changer effect, disabling reverb effect, disabling ear monitor, and resetting ear monitor volume.
+
+**Version**
+
+Supported since version 3.5.
+
+**When to Call**
+
+Call when you need to restore the default audio effect settings, for example before leaving the live room.
+
+## Data Structures
+
+### AudioChangerType
+
+Voice changer effect type.
+
+|**Enum Value**|**Value**|**Description**|
+|---------|---------|---------|
+|NONE|0|Disable effect.|
+|CHILD|1|Child.|
+|LITTLE_GIRL|2|Little girl.|
+|MAN|3|Uncle.|
+|HEAVY_METAL|4|Heavy metal.|
+|COLD|5|Cold.|
+|FOREIGNER|6|Foreign accent.|
+|TRAPPED_BEAST|7|Trapped beast.|
+|FATSO|8|Otaku.|
+|STRONG_CURRENT|9|Strong current.|
+|HEAVY_MACHINERY|10|Heavy machinery.|
+|ETHEREAL|11|Ethereal.|
+
+### AudioReverbType
+
+Reverb effect type.
+
+|**Enum Value**|**Value**|**Description**|
+|---------|---------|---------|
+|NONE|0|Disable effect.|
+|KTV|1|KTV.|
+|SMALL_ROOM|2|Small room.|
+|AUDITORIUM|3|Auditorium.|
+|DEEP|4|Deep.|
+|LOUD|5|Loud.|
+|METALLIC|6|Metallic.|
+|MAGNETIC|7|Magnetic.|
+
+### AudioEffectState
+
+Audio effect related state data provided by AudioEffectStore.
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|audioChangerType|StateFlow<AudioChangerType>|Voice changer state.|
+|audioReverbType|StateFlow<AudioReverbType>|Reverb state.|
+|isEarMonitorOpened|StateFlow<Boolean>|Ear monitor enabled.|
+|earMonitorVolume|StateFlow<Int>|Ear monitor volume, with a value range from 0 to 100.<br>If the volume is still too low after setting it to 100, you can set the volume to a maximum of 150, but a volume exceeding 100 may cause distortion, please operate with caution.|
+
+## Usage Example
+``` kotlin
+// Get singleton instance
+val store = AudioEffectStore.shared()
+// Subscribe to state changes
+lifecycleScope.launch {
+    store.audioEffectState.audioChangerType.collect { type ->
+        println("Current voice changer: $type")
+    }
+}
+lifecycleScope.launch {
+    store.audioEffectState.audioReverbType.collect { type ->
+        println("Current reverb: $type")
+    }
+}
+// Set voice changer effect
+store.setAudioChangerType(AudioChangerType.LITTLE_GIRL)
+// Set reverb effect
+store.setAudioReverbType(AudioReverbType.KTV)
+// Enable ear monitor
+store.setVoiceEarMonitorEnable(true)
+store.setVoiceEarMonitorVolume(80)
+```

package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md

@@ -0,0 +1,174 @@
+## Introduction
+
+`BarrageStore` provides a complete set of barrage management APIs, including sending text barrages, sending custom barrages, and adding local tip messages. Through this class, you can implement barrage interaction functionality in live rooms.
+
+> **Important: **
+>
+
+> Use the **BarrageStore.create** factory method to create a `BarrageStore` instance, which requires a valid live room ID.
+>
+
+> **Note: **
+>
+
+> Barrage state updates are delivered through the **barrageState** publisher. Subscribe to it to receive real-time updates of barrage data in the room.
+>
+
+## Features
+- **Text Barrage**: Supports sending plain text barrage messages.
+
+- **Custom Barrage**: Supports sending custom format barrages (such as barrages with special effects).
+
+- **Local Tips**: Supports adding tip messages visible only locally.
+
+## Subscribable Data
+
+**BarrageState** fields are described below:
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|messageList|StateFlow<List<Barrage>>|Barrage message list of the current room, supports real-time updates and can be subscribed to.|
+
+## API List
+
+|**Function**|**Description**|
+|---------|---------|
+|BarrageStore.create|Create barrage management instance.|
+|customMessageEvent|Custom message Flow event.|
+|sendTextMessage|Send text barrage.|
+|sendCustomMessage|Send custom barrage.|
+|appendLocalTip|Add local tip message.|
+
+### Creating Instance
+
+#### BarrageStore.create
+
+Create barrage management instance.
+
+### Events Handling
+
+#### customMessageEvent
+
+Custom message Flow event.
+
+Custom message event, representing one-time events for custom messages in the barrage system.
+
+**Data Structures：**CustomMessageEvent
+
+### Sending Barrage
+
+#### sendTextMessage
+
+Send a text type barrage. After sending successfully, the receiver can obtain barrage messages by subscribing to messageList in BarrageState in advance.
+``` kotlin
+abstract fun sendTextMessage(
+        text: String?,
+        extensionInfo: Map<String, String>?,
+        completion: CompletionHandler?
+    )
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|text|String?|Text barrage content.|
+|extensionInfo|Map<String,String>?|Extension information, can contain custom fields (such as specifying barrage color, font size, etc.).|
+|completion|CompletionHandler?|Completion callback (success/failure status).|
+
+#### sendCustomMessage
+
+Send a custom type barrage message. After sending successfully, the receiver can receive custom messages by subscribing to the customMessageEvent event provided by BarrageStore.
+``` kotlin
+abstract fun sendCustomMessage(
+        businessID: String?,
+        data: String?,
+        completion: CompletionHandler?
+    )
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|businessID|String?|Business identifier ID, used to distinguish custom barrages from different business scenarios.|
+|data|String?|Custom data content, usually JSON format string, used to pass business custom data.|
+|completion|CompletionHandler?|Completion callback (success/failure status).|
+
+### Local Messages
+
+#### appendLocalTip
+
+Add local tip message (add tip or operation feedback message locally, visible only to the current client).
+``` kotlin
+abstract fun appendLocalTip(message: Barrage)
+```
+
+**Version**
+
+Supported since version 3.5.
+
+**Notes**
+
+> **Note: **
+>
+
+> This message is only displayed locally and will not be sent to other users through the network.
+>
+
+**Parameters**
+
+|**Parameter**|**Type**|**Description**|
+|---------|---------|---------|
+|message|Barrage|Local barrage message (such as system tips, operation feedback, etc., visible only to the current user).|
+
+## Data Structures
+
+### BarrageType
+
+Barrage type enumeration, used to distinguish different barrage message types.
+
+|**Enum Value**|**Value**|**Description**|
+|---------|---------|---------|
+|TEXT|0|Text type barrage, contains plain text content.|
+|CUSTOM|1|Custom type barrage, supports business custom data format (such as barrages with special effects, interactive messages, etc.).|
+
+### Barrage
+
+Barrage data model, containing complete attribute information of a single barrage.
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|liveID|String|Unique identifier ID of the live room/voice chat room the barrage belongs to.|
+|sender|LiveUserInfo|User information of the barrage sender (such as user ID, nickname, avatar, etc.).|
+|sequence|Long|Unique sequence ID of the barrage message, used for message sorting and deduplication.|
+|timestampInSecond|Long|Barrage sending timestamp (unit: seconds), used to display sending time order.|
+|messageType|BarrageType|Barrage message type (text or custom).|
+|textContent|String|Message content of text type barrage, i.e., the text content of the barrage.|
+|extensionInfo|Map<String,String>|Barrage extension information, customizable fields (such as display style, priority, etc.). Valid when messageType is TEXT.|
+|businessID|String|Business identifier ID of custom type barrage, used to distinguish custom barrages from different business scenarios.|
+|data|String|Specific data content of custom type barrage (usually JSON format string), valid when messageType is CUSTOM.|
+
+### BarrageState
+
+Barrage state, managing the barrage data state of the current room.
+
+|**Property**|**Type**|**Description**|
+|---------|---------|---------|
+|messageList|StateFlow<List<Barrage>>|Barrage message list of the current room, supports real-time updates and can be subscribed to.|
+
+### CustomMessageEvent
+
+Custom message event, representing one-time events for custom messages in the barrage system.
+
+|**Enum Value**|**Parameter**|**Parameter Type**|**Description**|
+|---------|---------|---------|---------|
+|CustomMessageReceived|barrage|Barrage|Event triggered when a custom message is received in the room.|