mcpField
P
plaud-embedded-ios-sdk-skill

plaud-embedded-ios-sdk-skill

github.com/plaud-ai开发1343 次安装3 周前更新
代码仓库

关于 plaud-embedded-ios-sdk-skill

为在原生 iOS 应用中集成 Plaud Embedded iOS SDK 提供说明,涵盖设备绑定、音频传输和固件更新,也介绍其他应用技术栈的接入路径。

主要功能

  1. 01原生 iOS SDK 集成说明
  2. 02通过 BLE 和 WiFi 同步音频
  3. 03选择音频导出格式
  4. 04固件更新指导
  5. 05Starter App 部署说明

适用场景

  1. 01将 Plaud 录音设备连接到 iOS 应用
  2. 02同步设备录音供应用使用
  3. 03为跨平台应用接入 Plaud SDK

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/plaud-ai/plaud-embedded-skills --skill plaud-embedded-ios-sdk-skill

安装后在 Claude Code 中输入/plaud-embedded-ios-sdk-skill确认已加载。

附带文件references/project.yml

详细介绍

Plaud Embedded iOS SDK 技能

本技能提供有关如何实现 Plaud Embedded iOS SDK 的背景信息和说明。

何时使用本技能

当用户想要将其原生 iOS 应用连接到 Plaud 录音设备(Plaud NotePin S 和 Plaud Note Pro)时,请使用本技能。

开始使用本技能前,请确认用户已满足以下先决条件

先决条件
  • 已从 Plaud Developer Portal 获取 Plaud Embedded 凭据(CLIENT_ID、CLIENT_SECRET 和 API_KEY)
  • 能够通过 Plaud's Authentication API 获取 User Token

如果用户未满足这两项先决条件,请使用 plaud-embedded-project-setup-skill 获取说明

开始使用

请按照安装指南中的说明操作

兼容性要求
要求值
iOS 部署目标14.0+
Xcode16.0+(SDK 使用 Swift 6.0.3 构建)
架构arm64 仅限实体设备——不支持 iOS Simulator

SDK 以预构建框架的形式提供,克隆自 plaud-sdk-public,位于 sdk/ios/:

框架Xcode 操作
PlaudBleSDK.frameworkEmbed & Sign
PlaudWiFiSDK.frameworkEmbed & Sign
PlaudDeviceBasicSDK.frameworkEmbed & Sign
PlaudDeviceBasicSDK.bundleCopy Bundle Resources

请注意,iOS Embedded SDK 需要相应的权限——WiFi Fast Transfer 需要 Hotspot Configuration 权限。如何添加 bundle、框架和权限,请参阅示例 xCode 配置。

选择集成路径

Embedded SDK 是一个原生 iOS SDK,但根据用户所用的技术栈,有多种使用方式:

用户的技术栈路径前往
没有现有应用部署 Plaud 的 iOS Starter App见下文“如何部署 Plaud Starter App”
已有原生 iOS 应用直接实现 SDK见下文“如何实现 iOS Embedded SDK”
React Native 应用Plaud 的 Expo Native ModuleReact Native 文档 · embedded-react-native
Flutter 应用Plaud 的 plaud_sdk Flutter 插件Flutter 文档 · embedded-flutter
Web 应用使用 Plaud 的 Capacitor 插件封装为原生 iOS 应用Web 应用封装文档 · embedded-capacitor

React Native、Flutter 和 Capacitor 插件实现了基础功能(设备连接、文件同步、转录)。若要使用 WiFi Fast Transfer 等高级功能,请为插件添加方法,或直接使用原生 iOS SDK。

如何部署 Plaud Starter App

Plaud Starter App 是一款完整构建的 iOS 应用,已实现 Embedded SDK。

Starter App 提供了许多已实现的功能,用户可以立即使用。

引导用户克隆 Starter App 仓库,并按照 Starter App 指南中的步骤操作

重要:PlaudTemplateApp.xcodeproj 不受源代码控制,它由 project.yml 生成。用户必须安装 XcodeGen(brew install xcodegen),并在打开项目之前运行 xcodegen generate;修改任何 project.yml 后也必须重新运行该命令。

凭据应填入 PartnerConfig.xcconfig(USER_ACCESS_TOKEN、PLAUD_CLIENT_ID、PLAUD_API_KEY)。进行本地开发时,请在同一目录下创建一个被 git 忽略的 PartnerConfig.local.xcconfig,用于覆盖占位符。

如何实现 iOS 嵌入式 SDK

嵌入式 SDK 是一个 iOS 库,用于:

  1. 将 Plaud 设备连接(绑定)到用户的 iOS 移动应用,并解除绑定
  2. 通过 BLE 或 WiFi Fast Transfer(速度约快 10 倍)将 Plaud 设备中的音频同步到用户的移动应用,包括批量下载所有录音
  3. 导出多种格式的音频——.pcm(0)、.mp3(1)、.wav(2)、.opus(3)。建议使用 .mp3——它可在各种设备上播放,并且可直接用于转录上传 API
  4. 为已连接的 Plaud 设备进行固件无线(OTA)更新

两个高级门面分别是 PlaudDeviceAgent(BLE 生命周期、文件同步、固件)和 PlaudWiFiAgent(WiFi Fast Transfer),均通过各自的 .shared 单例访问。使用 initSDK(userAccessToken:customDomain:) 初始化一次,其中 customDomain 是 Plaud 域名,不包含 https:// 前缀(例如 platform-us.plaud.ai)。

SDK 由委托驱动——你需要实现协议(PlaudDeviceAgentProtocol、AudioExportCallback、PlaudWiFiAgentProtocol),以接收设备事件、传输进度和结果。

重要:Plaud 设备一次只能绑定到一个应用。请提醒用户在卸载应用前解除设备绑定——否则,在设备恢复之前,无法将其绑定到其他应用(或 Plaud 应用)。

注意:绑定和解除设备绑定时,请先调用 SDK 方法,再调用 API。这样可以确保云端状态反映设备的真实状态。如果设备绑定或解绑失败,请勿调用 API。

请参阅 iOS SDK 文档,了解 SDK 中包含的关键方法和协议。

对于高级门面未公开的行为,请参阅 Advanced iOS SDK usage docs,其中介绍了底层的 BleAgent、WiFiAgent 和 PlaudPartnerApiManager。高级和底层门面可以混合使用,但应以高级门面为主要驱动方式——它们负责处理合作伙伴预握手、E2EE 解密、音频格式转换和参数验证,而这些并非底层 Agent 所具备的功能。

如需进一步参考,请查看:

完成标准——完成嵌入式 SDK 的实现

当用户可以:

  • 将 Plaud 设备连接到其移动应用
  • 通过 BLE 或 WiFi 快速传输将 Plaud 设备中的音频文件同步到其应用
  • 从其应用中解除 Plaud 设备绑定(通过云端和 BLE)

评论

支持 Markdown