Skip to content

Commit fdee456

Browse files
authored
Merge pull request #25 from AgoraIO-Community/dev/readme-ios
[FIX] update readme and filepath
2 parents 84bd408 + 3ad2955 commit fdee456

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

iOS/Scenes/ConvoAI/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,28 @@ This section mainly describes how to quickly run the Conversational AI Demo.
4646
static let TTS_PARAMS: [String : Any] = <TTS Parameters>
4747
```
4848

49-
### ⚙️ 2. Source Code Sitemap
49+
## 🗂️ 2. Source Code Sitemap
50+
51+
### ⚙️ 2.1 Basic Sitemap
5052

5153
| Path | Description |
5254
| ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
53-
| [AgentManager.swift](ConvoAI/Classes/Manager/AgentManager.swift) | Conversational AI API implementation and models |
55+
| [AgentManager.swift](ConvoAI/Classes/Manager/AgentManager.swift) | Conversational AI API implementation |
5456
| [RTCManager.swift](ConvoAI/Classes/Manager/RTCManager.swift) | RTC related implementations |
5557
| [AgentPreferenceManager.swift](ConvoAI/Classes/Manager/AgentPreferenceManager.swift) | Agent state management |
5658
| [Main/](ConvoAI/Classes/Main) | UI components and view cotrollers |
5759
| [Main/Chat](ConvoAI/Classes/Main/Chat) | Chat view and controllers |
5860
| [AgentInformationViewController.swift](ConvoAI/Classes/Main/Setting/VC/AgentInformationViewController.swift) | Information dialog showing agent status |
5961
| [AgentSettingViewController.swift](ConvoAI/Classes/Main/Setting/VC/AgentSettingViewController.swift) | Settings dialog for agent configuration |
6062
| [Utils/](ConvoAI/Classes/Utils) | Utility classes and helper functions |
61-
| [ConversationSubtitleController.swift](ConvoAI/Classes/Utils/ConversationSubtitleController.swift) | Subtitle rendering component |
63+
| [SubRender/](ConvoAI/Classes/Utils/SubRender) | Subtitle rendering component |
64+
65+
### 2.2 Real-time Subtitles
66+
67+
When interacting with conversational agents, you may need real-time subtitles to display your conversations with the agent.
68+
- To implement this feature, you need to use the [Open Source Subtitle Processing Module](ConvoAI/Classes/Utils/SubRender)
69+
- ⚠️ The Open Source subtitle processing module is developed in Swift. If your project is a pure OC project, you can refer to Apple's official documentation [Importing Swift into Objective-C](https://developer.apple.com/documentation/swift/importing-swift-into-objective-c) to integrate the corresponding files into your project
70+
6271

6372
## 📚 3. Related Resources
6473

0 commit comments

Comments
 (0)