This skill provides context and instructions on how to implement the Plaud Embedded SDK (currently iOS only, Android SDK coming soon).
When To Use This Skill
Use this skill when a user wants to connect their mobile app with Plaud recording devices (Plaud NotePin S and Plaud Note Pro).
Before getting started with this skill, make sure the user has the following prerequisites
Prerequisites
- Already has their Plaud Embedded credentials (
CLIENT_ID,CLIENT_SECRET, andAPI_KEY) from their Plaud Developer Portal - Has a way to retrieve their User Token via Plaud's Authentication API
If a user does not have both of these prerequisites, use the plaud-embedded-project-setup-skill for instructions
Getting Started
Follow the instructions in the Installation Guide
Please Note the compatibility version requirements and the entitlements necessary for the Embedded SDK for iOS. See the sample xCode config for how to include bundle, frameworks, and entitlements.
Choose Your Integration Path
The Embedded SDK is a native iOS SDK, but there are multiple ways to use it depending on the user's stack:
-
No existing app → Deploy Plaud's iOS Starter App. Jump to the "How to Deploy the Plaud Starter App" section.
-
Existing native iOS app → Implement the SDK directly. Jump to the "How to Implement the Embedded SDK for iOS" section.
-
React Native app → Use Plaud's Expo Native Module. Jump to the "How to Use the Embedded SDK from React Native" section.
-
Web app → Wrap it into a native iOS app with Plaud's Capacitor plugin. Jump to the "How to Use the Embedded SDK from a Web App (Capacitor)" section.
How to Deploy the Plaud Starter App
The Plaud Starter App is a fully built out iOS app with the Embedded SDK already implemented.
The Starter App comes with many built-out features the user can immediately use.
Direct the user to clone the Starter App repo and go through the steps in the Starter App Guide
How to Implement the Embedded SDK for iOS
The Embedded SDK is an iOS library for :
- Connecting (binding) and unbinding Plaud devices to the user's iOS mobile app
- Syncing audio from Plaud devices to the user's mobile app — via BLE or WiFi Fast Transfer (~10x faster), including batch download of all recordings
- Exporting audio in multiple formats (
.opus,.mp3,.wav,.pcm) - Firmware over-the-air (OTA) updates for connected Plaud devices
The SDK is delegate-driven — you implement protocols (PlaudDeviceAgentProtocol, AudioExportCallback, PlaudWiFiAgentProtocol) to receive device events, transfer progress, and results.
Use the iOS SDK documentation for the key methods and protocols included in the SDK. See the changelog for the latest SDK features.
For further reference, explore:
- The SDK repo to view the header files in the SDK
- The Plaud Starter App with the iOS Embedded SDK fully implemented
- The most relevant files to use as reference in the Starter App are:
How to Use the Embedded SDK from React Native
Plaud's iOS SDK can be used in React Native through an Expo Native Module. Plaud ships a plaud-sdk Expo module (with a typed JS/TypeScript interface) plus an example app.
Follow the React Native guide to clone the module, copy it into the user's Expo app, add BLE permissions, and call the SDK from JavaScript.
- Embedded React Native repo
- Install the dedicated skill for full codebase context:
npx skills add Plaud-AI/embedded-react-native
How to Use the Embedded SDK from a Web App (Capacitor)
Any web app can be turned into a native iOS app that connects to Plaud devices using Plaud's Capacitor plugin (PlaudPlugin), which is built on top of the native iOS SDK.
Follow the Web App to iOS guide to set up Capacitor, install the PlaudPlugin, and drive the SDK from your web app's JavaScript.
- Embedded Capacitor repo
- Install the dedicated skill for full codebase context:
npx skills add Plaud-AI/embedded-capacitor
How to Implement the Embedded SDK for Android
The Embedded SDK for Android is not out yet! Get started with using the SDK for the user's iOS in the meantime.
Definition of Done - Completed Implementation of the Embedded SDK
When the user can:
- Connect Plaud devices to their mobile app
- Sync audio files from Plaud devices to their app via BLE or WiFi fast transfer