docs: document synchronized sound-haptics API - #164
Open
piaskowyk wants to merge 1 commit into
Open
Conversation
Add parsePatternWithSound / sound documentation to the React Native, iOS, Android, Flutter, and KMP SDK pages: the new method/field, the Sound/SoundData type, the .wav default resolution, and the Android explicit-.ogg coupled path.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documents the new synchronized sound + haptics API across all five SDK pages (React Native, iOS, Android, Flutter, KMP).
Why
The feature (#162) added
parsePatternWithSound/ asoundfield to the Pattern Composer, but the SDK docs didn't cover it. This adds reference docs so developers can discover and use it.Changes
Per platform page (
docs/src/content/docs/sdk/*.mdx):usePatternComposer, thesound?field on thePatterntype, and a newSoundtype (coveringrequire()support and the dev-vs-release Metro URL caveat).parsePatternWithSound(hapticsData:uri:volume:offset:)method reference (Core Haptics audio event, bundle a local file, device-only).parsePatternWithSound(hapticsData, sound)method +SoundDatatype (explicit.oggfor the audio-coupled path, otherwise the audio + generated-haptics fallback).parsePatternWithSound(pattern, sound)method +Soundtype.parsePatternWithSound(pattern, sound)method +SoundDatatype.All pages document the shared rule: the format comes from the uri's extension, defaulting to
.wav, so a bare name likebeepresolvesbeep.wavon both platforms.Base branch
Stacked on
feat/audio-haptics-syncso the diff is docs-only. Retarget tomainonce the feature branch merges (or merge the feature first).Verification
npx astro buildindocs/completes successfully — all five SDK pages build with no errors.