Skip to content

Commit d1b792c

Browse files
authored
docs: add gfm alerts to readme
1 parent f2bc688 commit d1b792c

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,8 @@ The error code is largely based on the Web Speech API error codes.
327327

328328
If you would like to persist the recognized audio for later use, you can enable the `recordingOptions.persist` option when calling `start()`. Enabling this setting will emit an `{ uri: string }` event object in the `audiostart` and `audioend` events with the local file path.
329329

330-
> Note: For Android, this is only supported on Android 13 and above. Call `supportsRecording()` to see if it's available before using this feature.
330+
> [!IMPORTANT]
331+
> For Android, this is only supported on Android 13 and above. Call `supportsRecording()` to see if it's available before using this feature.
331332
332333
Default audio output formats:
333334

@@ -412,7 +413,8 @@ function AudioPlayer(props: { source: string }) {
412413

413414
You can use the `audioSource.uri` option to transcribe audio files instead of using the microphone.
414415

415-
> **Important note**: This feature is available on Android 13+ and iOS. If the device does not support the feature, you'll receive an `error` event with the code `audio-capture`.
416+
> [!IMPORTANT]
417+
> This feature is available on Android 13+ and iOS. If the device does not support the feature, you'll receive an `error` event with the code `audio-capture`.
416418
417419
### Supported input audio formats
418420

@@ -747,7 +749,8 @@ getSupportedLocales({
747749

748750
Get list of speech recognition services available on the device.
749751

750-
> Note: this only includes services that are listed under `androidSpeechServicePackages` in your app.json as well as the core services listed under `forceQueryable` when running the command: `adb shell dumpsys package queries`
752+
> [!NOTE]
753+
> This only includes services that are listed under `androidSpeechServicePackages` in your app.json as well as the core services listed under `forceQueryable` when running the command: `adb shell dumpsys package queries`
751754
752755
```ts
753756
import { getSpeechRecognitionServices } from "expo-speech-recognition";
@@ -847,7 +850,8 @@ The device will display a dialog to download the model. Once the model is downlo
847850
848851
This function is an implementation of [AVAudioSession.setCategory](https://developer.apple.com/documentation/avfaudio/avaudiosession/1771734-setcategory) for iOS. For multimedia applications, you may want to set the audio session category and mode to control the audio routing.
849852
850-
> Note: when starting speech recognition, audio session category is changed to `playAndRecord` with option `defaultToSpeaker` and `allowBluetooth` and mode `measurement`. You can instead configure the audio session category and mode by passing the `iosCategory` option to the `start` function.
853+
> [!NOTE]
854+
> When starting speech recognition, the audio session category is changed to `playAndRecord` with option `defaultToSpeaker` and `allowBluetooth` and mode `measurement`. You can instead configure the audio session category and mode by passing the `iosCategory` option to the `start(..)` function.
851855
852856
```ts
853857
import {

0 commit comments

Comments
 (0)