Sound Guide

Overview

@petnow/react-native-camera-ui includes six built-in sounds for drawing a pet's attention. Use the PetnowSound API to encourage a pet to look at the camera during capture. It works independently of the camera, so it plays even without a camera view.

Available Sounds

Full sound list

Basic Usage

Load the samples once with prepare() before playing any sound.

import { PetnowSound } from '@petnow/react-native-camera-ui';

await PetnowSound.prepare(); // Load samples (first time only)

1. Play a random sound

Automatically selects and plays a sound suitable for the species.

// Random sound for a dog
const handle = PetnowSound.play('random', 'DOG');

// Random sound for a cat
const handle = PetnowSound.play('random', 'CAT');

2. Play a specific sound

Choose and play a specific sound directly.

// Play the squeaky toy sound
const handle = PetnowSound.play('squeakyToy', 'DOG');

// Play the pspsps sound
const handle = PetnowSound.play('pspsps', 'CAT');

3. Stop a sound

To stop a sound, keep the handle returned when you played it.

// ⚠️ You won't be able to call stop() this way
PetnowSound.play('squeakyToy', 'DOG');  // return handle ignored

// ✅ Keep the handle to stop it
const handle = PetnowSound.play('squeakyToy', 'DOG');
// ... later
PetnowSound.stop(handle);

If play() returns -1, the sound did not play (prepare() was not called, or the sound is not mapped for the species). In that case, stop() does nothing.

4. Release resources

When you no longer need sounds, release the native audio resources.

PetnowSound.release();

Method summary

• sound: 'random' (selects a candidate suitable for the species) | 'pouringFood' | 'bagOfChips' | 'openingCan' | 'squeakyToy' | 'pspsps' | 'shakers'
• species: 'DOG' | 'CAT' — used for 'random' candidate selection (ignored for other sounds).

Next Steps

• Basic Usage — usePetnowCamera + CameraView, events, commands, and lifecycle
• Customization — Layering guide, buttons, and result UI on top of <CameraView>