[FEAT] ios skills agents.md

Author: HeZhengQing

iOS/.agent/skills/api-example-conventions/SKILL.md

@@ -0,0 +1,91 @@
+---
+name: api-example-conventions
+description: Structure conventions for iOS APIExample projects, including UIKit, SwiftUI, Objective-C, and Audio implementations
+compatibility: [Cursor, Kiro, Windsurf, Claude, Copilot]
+license: MIT
+metadata:
+  author: APIExample Team
+  version: 2.0.0
+  platform: iOS
+---
+
+# iOS API Example Conventions
+
+This SKILL contains structure conventions for different APIExample implementations on iOS platform. Load the corresponding convention document on demand based on your target project type.
+
+## iOS Project Types
+
+This repository contains the following iOS example projects:
+
+### 1. APIExample (Standard UIKit)
+
+**Directory:** `APIExample/`
+
+**Core Rules:**
+- **Example Directory:** `APIExample/APIExample/Examples/[Basic|Advanced]/<ExampleName>/`
+- **Files:**
+  - `<ExampleName>.swift` - Entry and Main classes
+  - `Base.lproj/<ExampleName>.storyboard`
+- **Classes:**
+  - Entry: `<ExampleName>Entry` inherits from `UIViewController`
+  - Main: `<ExampleName>Main` inherits from `BaseViewController`
+- **Storyboard IDs:**
+  - Entry scene: `EntryViewController`
+  - Main scene: `<ExampleName>`
+- **Menu Registration:** Add `MenuItem` to the `menus` array in `APIExample/APIExample/ViewController.swift`
+
+**Detailed Conventions:** Read `references/ios-uikit-conventions.md`
+
+### 2. APIExample-SwiftUI
+
+**Directory:** `APIExample-SwiftUI/`
+
+**Core Rules:**
+- Uses SwiftUI framework
+- Uses `@StateObject` and `@ObservableObject` for state management
+- Uses `UIViewRepresentable` to wrap video rendering views
+
+**Detailed Conventions:** Read `references/ios-swiftui-conventions.md`
+
+### 3. APIExample-OC (Objective-C)
+
+**Directory:** `APIExample-OC/`
+
+**Core Rules:**
+- Uses Objective-C language
+- Similar Entry/Main pattern as UIKit
+- Uses `.h` and `.m` files
+
+**Detailed Conventions:** Read `references/ios-objc-conventions.md`
+
+### 4. APIExample-Audio
+
+**Directory:** `APIExample-Audio/`
+
+**Core Rules:**
+- Focuses on audio-related features
+- Simplified UI implementation
+- Audio-specific API calls
+
+**Detailed Conventions:** Read `references/ios-audio-conventions.md`
+
+## Common Conventions
+
+Conventions shared across all iOS projects:
+
+1. **Example Naming:** Use PascalCase (e.g., `JoinChannelVideo`)
+2. **Categories:** Basic (basic features) and Advanced (advanced features)
+3. **SKILL Documentation:** Each example may include `SKILL.md` providing API usage guide
+4. **Code Style:** Follow official Swift/Objective-C coding standards
+5. **Configuration Management:** Use `KeyCenter` to manage App ID and Token
+6. **Global Settings:** Use `GlobalSettings.shared` to manage common configurations
+
+## Load on Demand
+
+When you need to work with specific example types:
+
+1. **UIKit Standard Examples:** Read `references/ios-uikit-conventions.md`
+2. **SwiftUI Examples:** Read `references/ios-swiftui-conventions.md`
+3. **Objective-C Examples:** Read `references/ios-objc-conventions.md`
+4. **Audio-Focused Examples:** Read `references/ios-audio-conventions.md`
+

iOS/.agent/skills/api-example-conventions/references/ios-audio-conventions.md

@@ -0,0 +1,55 @@
+# iOS Audio Platform API Example Conventions
+
+This document describes the structure conventions for examples in the `APIExample-Audio/` project.
+
+## Directory Structure
+
+- **Basic Examples:** `APIExample-Audio/APIExample-Audio/Examples/Basic/<ExampleName>/`
+- **Advanced Examples:** `APIExample-Audio/APIExample-Audio/Examples/Advanced/<ExampleName>/`
+
+## File Composition
+
+Similar to standard UIKit version, but focused on audio features:
+- Entry and Main classes
+- Simplified UI (no video rendering views)
+- Audio-specific configuration and controls
+
+## Audio-Specific Conventions
+
+### Audio-Focused Features
+
+- Audio capture and playback
+- Audio effects (reverb, voice changer, etc.)
+- Audio mixing
+- Custom audio source
+- Audio routing control
+
+### Simplified UI
+
+Since no video is involved, UI is more concise:
+- Channel control buttons
+- Audio status indicators
+- Audio effect parameter adjustments
+
+### API Call Focus
+
+```swift
+// Enable audio
+agoraKit.enableAudio()
+
+// Audio configuration
+agoraKit.setAudioProfile(.musicHighQuality)
+agoraKit.setAudioScenario(.gameStreaming)
+
+// Audio effects
+agoraKit.setLocalVoicePitch(1.0)
+agoraKit.setLocalVoiceEqualization(.band31, withGain: 0)
+```
+
+## Menu Registration
+
+Register example entry in `ViewController.swift`.
+
+## Detailed Conventions
+
+(To be supplemented with complete Audio platform conventions)

iOS/.agent/skills/api-example-conventions/references/ios-objc-conventions.md

@@ -0,0 +1,57 @@
+# iOS Objective-C Platform API Example Conventions
+
+This document describes the structure conventions for examples in the `APIExample-OC/` project.
+
+## Directory Structure
+
+- **Basic Examples:** `APIExample-OC/APIExample-OC/Examples/Basic/<ExampleName>/`
+- **Advanced Examples:** `APIExample-OC/APIExample-OC/Examples/Advanced/<ExampleName>/`
+
+## File Composition
+
+Each example typically contains:
+- Header file: `<ExampleName>.h`
+- Implementation file: `<ExampleName>.m`
+- Storyboard: `Base.lproj/<ExampleName>.storyboard`
+
+## Objective-C Specific Conventions
+
+### Entry and Main Pattern
+
+Similar to Swift version, but using Objective-C syntax:
+
+**Entry Class:**
+```objc
+@interface <ExampleName>Entry : UIViewController
+@end
+```
+
+**Main Class:**
+```objc
+@interface <ExampleName>Main : BaseViewController
+@end
+```
+
+### Delegate Methods
+
+Implement `AgoraRtcEngineDelegate` protocol:
+
+```objc
+@interface <ExampleName>Main () <AgoraRtcEngineDelegate>
+@end
+```
+
+### Property Declaration
+
+```objc
+@property (nonatomic, strong) AgoraRtcEngineKit *agoraKit;
+@property (nonatomic, weak) IBOutlet UIView *localVideoView;
+```
+
+## Menu Registration
+
+Register example entry in `ViewController.m`.
+
+## Detailed Conventions
+
+(To be supplemented with complete Objective-C platform conventions)

iOS/.agent/skills/api-example-conventions/references/ios-swiftui-conventions.md

@@ -0,0 +1,65 @@
+# iOS SwiftUI Platform API Example Conventions
+
+This document describes the structure conventions for examples in the `APIExample-SwiftUI/` project.
+
+## Directory Structure
+
+- **Basic Examples:** `APIExample-SwiftUI/APIExample-SwiftUI/Examples/Basic/<ExampleName>/`
+- **Advanced Examples:** `APIExample-SwiftUI/APIExample-SwiftUI/Examples/Advanced/<ExampleName>/`
+
+## File Composition
+
+Each example typically contains:
+- SwiftUI View file
+- ViewModel (using `@ObservableObject`)
+- Video rendering view wrapper (`UIViewRepresentable`)
+
+## SwiftUI-Specific Conventions
+
+### ViewModel Pattern
+
+```swift
+class <ExampleName>ViewModel: ObservableObject {
+    private var agoraKit: AgoraRtcEngineKit?
+    @Published var isJoined = false
+    @Published var remoteUsers: [UInt] = []
+    
+    func initializeEngine() { /* ... */ }
+    func joinChannel() { /* ... */ }
+    func leaveChannel() { /* ... */ }
+}
+```
+
+### View Structure
+
+```swift
+struct <ExampleName>View: View {
+    @StateObject private var viewModel = <ExampleName>ViewModel()
+    
+    var body: some View {
+        // UI implementation
+    }
+}
+```
+
+### Video Rendering Wrapper
+
+Use `UIViewRepresentable` to wrap UIKit's video rendering view:
+
+```swift
+struct VideoViewRepresentable: UIViewRepresentable {
+    let uid: UInt
+    let agoraKit: AgoraRtcEngineKit?
+    
+    func makeUIView(context: Context) -> UIView { /* ... */ }
+    func updateUIView(_ uiView: UIView, context: Context) { /* ... */ }
+}
+```
+
+## Menu Registration
+
+Register example entry in SwiftUI's navigation structure.
+
+## Detailed Conventions
+
+(To be supplemented with complete SwiftUI platform conventions)

iOS/.agent/skills/api-example-conventions/references/ios-uikit-conventions.md

@@ -0,0 +1,94 @@
+# iOS Platform API Example Conventions
+
+This document describes the structure conventions for examples in the iOS APIExample project. Please follow these conventions when adding or modifying any examples under `APIExample/APIExample/Examples/`.
+
+## Directory Structure
+
+- **Basic Examples:** `APIExample/APIExample/Examples/Basic/<ExampleName>/`
+- **Advanced Examples:** `APIExample/APIExample/Examples/Advanced/<ExampleName>/`
+
+The folder name is the **example identifier** (e.g., `VideoProcess`, `JoinChannelVideo`), using PascalCase without spaces.
+
+The folder typically contains:
+
+- One or more Swift files (e.g., `VideoProcess.swift`, `JoinChannelVideo.swift`), defining Entry and Main view controllers.
+- One storyboard: `Base.lproj/<ExampleName>.storyboard` (same name as identifier).
+
+## Swift: Entry and Main
+
+Each example contains two view controller roles:
+
+### Entry (Entry Page)
+
+- **Class Name:** `<ExampleName>Entry` (e.g., `VideoProcessEntry`, `JoinChannelVideoEntry`).
+- **Base Class:** `UIViewController`.
+- **Responsibilities:**
+  - Provide channel name input field and "Join" button (or equivalent controls).
+  - Optional: Collect resolution, frame rate, orientation, etc. (refer to `JoinChannelVideoEntry`).
+  - In the "Join" button callback:
+    - Read channel name (and any additional required parameters).
+    - Load **same-named storyboard**: `UIStoryboard(name: identifier, bundle: nil)`, where `identifier = "<ExampleName>"`.
+    - Instantiate Main VC: `storyBoard.instantiateViewController(withIdentifier: identifier) as? BaseViewController`.
+    - Set `newViewController.configs`, at least including `"channelName"`, plus other keys needed by Main (e.g., `"resolution"`, `"fps"`, `"orientation"`).
+    - Push Main VC: `navigationController?.pushViewController(newViewController, animated: true)`.
+
+### Main (Example Main Logic)
+
+- **Class Name:** `<ExampleName>Main`, or a single class name consistent with Main's identifier in storyboard (if no Main suffix, same as identifier).
+- **Base Class:** `BaseViewController`.
+- **Responsibilities:**
+  - Read channel name etc. from `configs` (e.g., `configs["channelName"] as? String`) and options passed from Entry.
+  - Create and configure `AgoraRtcEngineKit` (e.g., `KeyCenter.AppId`, `GlobalSettings.shared.area`), call `Util.configPrivatization(agoraKit:)` when needed.
+  - Implement specific Agora API calls (join channel, toggle audio/video, etc.).
+  - Conform to `AgoraRtcEngineDelegate` and other required protocols.
+
+Reference: `JoinChannelVideo.swift` (Entry + Main), `VideoProcess.swift` (Entry + Main).
+
+## Storyboard
+
+- **File Path:** `APIExample/Examples/<Basic|Advanced>/<ExampleName>/Base.lproj/<ExampleName>.storyboard`.
+- **Two Scenes:**
+
+  1. **Entry Scene**
+     - **Storyboard Identifier:** `EntryViewController`.
+     - **Custom Class:** `<ExampleName>Entry`, Module: `APIExample`.
+     - Connect channel input field and join button to Entry class (outlets and actions).
+
+  2. **Main Scene**
+     - **Storyboard Identifier:** `<ExampleName>` (consistent with folder name, e.g., `VideoProcess`, `JoinChannelVideo`).
+     - **Custom Class:** `<ExampleName>Main` (or actual Main class name used in code), Module: `APIExample`.
+     - Layout example main interface and connect outlets/actions to this class.
+
+- When entering from menu, **Entry is shown first**; after user clicks join, Main is instantiated and pushed in code.
+
+## Menu Registration
+
+- **File:** `APIExample/ViewController.swift`.
+- **Structure:** `menus` is an array of `MenuSection`, each section has `name` (e.g., `"Basic"`, `"Anvanced"`) and `rows: [MenuItem]`.
+
+When adding an example:
+
+- Append a `MenuItem` to the `rows` of the corresponding section.
+- **Field Description:**
+  - `name`: Display name in list (can add `.localized` if project uses internationalization).
+  - `storyboard`: Storyboard file name (**without** extension), consistent with example identifier, e.g., `"VideoProcess"`, `"JoinChannelVideo"`.
+  - `entry`: Usually `"EntryViewController"` (default).
+  - `controller`: Main VC's identifier or empty string `""`; since Entry pushes Main in this project, this is often `""` or consistent with Main's storyboard identifier.
+
+Example:
+
+```swift
+MenuItem(name: "Video Process".localized, storyboard: "VideoProcess", controller: "VideoProcess")
+```
+
+If an example's Entry class or identifier is different (e.g., KtvCopyrightMusic), set `entry` and `controller` accordingly so the main `ViewController` loads the correct initial VC from that storyboard.
+
+## Common Dependencies
+
+- **App ID:** `KeyCenter.AppId`.
+- **Region / Role / Resolution / Frame Rate / Orientation:** `GlobalSettings.shared` (e.g., `GlobalSettings.shared.area`, `getSetting(key: "resolution")`, etc.).
+- **Logging:** `LogUtils`, call `agoraKit.setLogFile(LogUtils.sdkLogPath())` when needed.
+- **Privatization:** After creating engine, call `Util.configPrivatization(agoraKit: agoraKit)`.
+- **Video Layout:** Use `AGEVideoLayout`, `AGEVideoContainer` / `Bundle.loadVideoView` to display local/remote views.
+
+Please keep naming and structure consistent with existing examples (e.g., `JoinChannelVideo`, `VideoProcess`) to maintain unified project style.