Soundpool

https://pub.dev/documentation/soundpool/latest/
Admin
Soundpool is a Flutter package that caches audio tracks in memory for low-latency playback of short...
Tokens:17,313
Snippets:208
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### loadAndPlayUint8List Method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/loadAndPlayUint8List.html

Prepares sound for playing and plays immediately after loading. Loads sound data, buffers it for future playing and starts playing immediately when loaded. Returns soundId for future use in play (soundId > -1) or `-1` when sound file failed to load.

```APIDOC
## loadAndPlayUint8List

### Description
Prepares sound for playing and plays immediately after loading. Loads sound data, buffers it for future playing and starts playing immediately when loaded. Returns soundId for future use in play (soundId > -1) or `-1` when sound file failed to load.

See also:
  * loadUint8List, which allows for precaching the sound data

### Parameters
#### Path Parameters
- **rawSound** (Uint8List) - Required - The raw audio data to load and play.
- **priority** (int) - Optional - The priority for loading the sound. Defaults to `_DEFAULT_SOUND_PRIORITY`.
- **repeat** (int) - Optional - The number of times to repeat the sound. Defaults to 0 (play once).
- **rate** (double) - Optional - The playback rate of the sound. Defaults to 1.0.

### Platform Specific Notes
## web
`priority` and `repeat` are ignored. The sound is played only once.

### Return Value
- **int** - Returns the soundId for future use in play (soundId > -1) or `-1` when sound file failed to load.
```

--------------------------------

### playWithControls Method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/playWithControls.html

Starts playing the sound identified by `soundId` and returns an instance to control playback. Note that the `repeat` parameter is ignored on the web platform, where the sound is played only once.

```APIDOC
## playWithControls Method

### Description
Starts playing the sound identified by `soundId`. Returns an instance to control playback.

### Parameters
#### Path Parameters
- **soundId** (int) - Required - The ID of the sound to play.

#### Query Parameters
- **repeat** (int) - Optional - Defaults to 0. Ignored on web.
- **rate** (double) - Optional - Defaults to 1.0. The playback rate.

### Response
#### Success Response (AudioStreamControl)
An instance of `AudioStreamControl` that can be used to control the playback of the sound.
```

--------------------------------

### Play Sound with Controls

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/playWithControls.html

Starts playing a sound by its ID and returns an object to control playback. The 'repeat' parameter is ignored on web.

```dart
Future<AudioStreamControl> playWithControls(int soundId,
    {int repeat = 0, double rate = 1.0}) async {
  final streamId = await play(soundId, repeat: repeat, rate: rate);
  return AudioStreamControl._(this, streamId);
}
```

--------------------------------

### play

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/play.html

Plays sound identified by `soundId`. Returns streamId to further control playback or 0 if playing failed to start. For web, `repeat` is ignored and the sound is played only once.

```APIDOC
## play

### Description
Plays sound identified by `soundId`. Returns streamId to further control playback or 0 if playing failed to start.

### Parameters
#### Path Parameters
- **soundId** (int) - Required - The ID of the sound to play.
- **repeat** (int) - Optional - The number of times to repeat the sound. Defaults to 0 (play once). Ignored on web.
- **rate** (double) - Optional - The playback rate. Must be between 0.5 and 2.0. Defaults to 1.0.
```

--------------------------------

### SoundpoolOptionsWeb() Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsWeb-class.html

Initializes a new instance of the SoundpoolOptionsWeb class with default settings.

```APIDOC
## SoundpoolOptionsWeb()

### Description
Constructs a new SoundpoolOptionsWeb object with default values.

### Method
`SoundpoolOptionsWeb()`
```

--------------------------------

### Get stopped property

Source: https://pub.dev/documentation/soundpool/latest/soundpool/AudioStreamControl/stopped.html

Use this getter to check if the stream has been stopped. Note that this does not reflect the actual player state.

```dart
bool get stopped => _stopped;
```

--------------------------------

### Initialize and Play Sound with Soundpool

Source: https://pub.dev/packages/soundpool

Demonstrates how to initialize a Soundpool instance, load an audio file from assets, and play it. Ensure the audio file is correctly added to your project's assets.

```dart
import 'package:soundpool/soundpool.n';

Soundpool pool = Soundpool(streamType: StreamType.notification);

int soundId = await rootBundle.load("sounds/dices.m4a").then((ByteData soundData) {
  return pool.load(soundData);
});
int streamId = await pool.play(soundId);

```

--------------------------------

### Get StreamType in Soundpool

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/streamType.html

This code shows how to access the streamType getter. It returns the current stream type of the Soundpool instance.

```dart
StreamType get streamType => _streamType;
```

--------------------------------

### SoundpoolOptionsWeb.new

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsWeb/SoundpoolOptionsWeb.html

Creates a new instance of SoundpoolOptionsWeb. This is a constant constructor.

```APIDOC
## SoundpoolOptionsWeb()

### Description

This is the default constructor for the `SoundpoolOptionsWeb` class. It allows for the creation of a new instance with default settings.

### Method

`SoundpoolOptionsWeb.new`

### Parameters

This constructor does not accept any parameters.

### Request Example

```dart
const soundpoolOptions = SoundpoolOptionsWeb();
```

### Response

This constructor does not return a value in the traditional sense; it initializes a `SoundpoolOptionsWeb` object.
```

--------------------------------

### Load and Play Sound with Soundpool

Source: https://pub.dev/documentation/soundpool/latest/index.html

Demonstrates how to initialize Soundpool, load an audio file from assets, and play it. Ensure the audio file is in the project's assets and the Soundpool is configured with an appropriate stream type.

```dart
import 'package:soundpool/soundpool.n';
import 'package:flutter/services.dart' show rootBundle;

Soundpool pool = Soundpool(streamType: StreamType.notification);

int soundId = await rootBundle.load("sounds/dices.m4a").then((ByteData soundData) {
  return pool.load(soundData);
});
int streamId = await pool.play(soundId);

```

--------------------------------

### Get Playing State of AudioStreamControl

Source: https://pub.dev/documentation/soundpool/latest/soundpool/AudioStreamControl/playing.html

Returns true if the stream is not paused. This does not reflect actual player state; the sound may have finished any moment before by reaching the end.

```dart
bool get playing => _playing;
```

--------------------------------

### load method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/load.html

Prepares sound for playing by loading its raw byte data. Returns a sound ID for playback or -1 on failure.

```APIDOC
## load method

### Description
Prepares sound for playing by loading its raw byte data. Returns a sound ID for future use in `play` (soundId > -1) or `-1` when the sound file failed to load.

### Method Signature
`Future<int> load(ByteData rawSound, {int priority = _DEFAULT_SOUND_PRIORITY})`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **rawSound** (ByteData) - The raw byte data of the sound file.
- **priority** (int) - Optional. Used to control loading order. Defaults to `_DEFAULT_SOUND_PRIORITY`. Ignored on web.

### Request Example
```dart
load(await rootBundle.load("sounds/dices.m4a")); // loads file from assets
```

### Response
#### Success Response (int)
- Returns a soundId (int) greater than -1 if the sound loaded successfully.

#### Error Response (int)
- Returns -1 if the sound file failed to load.

### Implementation Notes
- On web, the `priority` parameter is ignored.
- The implementation internally calls `loadUint8List` with the byte buffer of the provided `ByteData`.
```

--------------------------------

### kDefault Constant

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsMacos-class.html

The default SoundpoolOptionsMacos instance.

```APIDOC
## kDefault

### Description
Provides a default instance of SoundpoolOptionsMacos.

### Type
const SoundpoolOptionsMacos
```

--------------------------------

### kDefault Constant

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsWeb-class.html

Provides a default instance of SoundpoolOptionsWeb.

```APIDOC
## kDefault

### Description
A constant representing the default SoundpoolOptionsWeb configuration.

### Type
`const SoundpoolOptionsWeb`
```

--------------------------------

### toOptionsMap() Method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsWeb-class.html

Converts the SoundpoolOptionsWeb object into a Map suitable for configuration.

```APIDOC
## toOptionsMap()

### Description
Returns a map representation of the SoundpoolOptionsWeb object's current settings.

### Method
`toOptionsMap() → Map<String, dynamic>`
```

--------------------------------

### toOptionsMap method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsMacos/toOptionsMap.html

Converts the Soundpool options to a Map<String, dynamic> for macOS.

```APIDOC
## toOptionsMap()

### Description
Converts the current Soundpool options into a map suitable for macOS configurations.

### Method Signature
Map<String, dynamic> toOptionsMap()

### Implementation
```dart
Map<String, dynamic> toOptionsMap() => {
      'enableRate': enableRate,
    };
```

### Returns
A `Map<String, dynamic>` containing the options.
```

--------------------------------

### loadAndPlay Web Platform Notes

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/loadAndPlay.html

On web platforms, the 'priority' and 'repeat' parameters are ignored, and the sound is played only once.

```APIDOC
## web
`priority` and `repeat` are ignored. The sound is played only once.
```

--------------------------------

### loadUint8List method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/loadUint8List.html

Prepares sound for playing by loading sound data and buffering it for future playback. Returns a soundId for use in the play method (soundId > -1) or -1 if the sound data failed to load. On web, the priority parameter is ignored.

```APIDOC
## loadUint8List

### Description
Prepares sound for playing. Loads sound data and buffers it for future playing.
Returns soundId for future use in play (soundId > -1) or `-1` when sound data failed to load.

### Parameters
#### Path Parameters
- **rawSound** (Uint8List) - Required - The raw sound data to load.
- **priority** (int) - Optional - The priority for loading the sound. Defaults to `_DEFAULT_SOUND_PRIORITY`. Ignored on web.

### Returns
- **int** - The soundId for the loaded sound, or -1 if loading failed.
```

--------------------------------

### Soundpool.fromOptions Factory Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/Soundpool.fromOptions.html

Use this factory constructor to create a Soundpool instance with custom options. It takes a `SoundpoolOptions` object, defaulting to `SoundpoolOptions.kDefault` if not provided.

```dart
factory Soundpool.fromOptions(
    {SoundpoolOptions options = SoundpoolOptions.kDefault}) {
  return Soundpool._(
    options._platformOptions,
    options.streamType,
    options.maxStreams,
  ).._connect();
}
```

--------------------------------

### loadAndPlayUri Method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/loadAndPlayUri.html

Prepares sound for playing and plays immediately after loading. Loads sound data from file pointed by `uri`. Returns soundId for future use in play (soundId > -1) or `-1` when sound file failed to load. See also: `loadUri`, which allows for precaching the sound data.

```APIDOC
## loadAndPlayUri

### Description
Prepares sound for playing and plays immediately after loading. Loads sound data from file pointed by `uri`. Returns soundId for future use in play (soundId > -1) or `-1` when sound file failed to load.

See also:
  * `loadUri`, which allows for precaching the sound data

### Parameters
#### Path Parameters
- **uri** (String) - Required - The URI of the sound file to load and play.
- **priority** (int) - Optional - The priority of the sound loading operation. Defaults to `_DEFAULT_SOUND_PRIORITY`. Ignored on web.
- **repeat** (int) - Optional - The number of times to repeat the sound. Defaults to 0 (play once). Ignored on web.
- **rate** (double) - Optional - The playback rate of the sound. Defaults to 1.0.

### Platform Notes
## web
`priority` and `repeat` are ignored. The sound is played only once.

### Return Value
- **int** - The sound ID if successful (greater than -1), or -1 if the sound file failed to load.
```

--------------------------------

### SoundpoolOptionsMacos Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsMacos-class.html

Initializes SoundpoolOptionsMacos with an optional enableRate parameter.

```APIDOC
## SoundpoolOptionsMacos()

### Description
Initializes SoundpoolOptionsMacos with an optional enableRate parameter.

### Parameters
#### Named Parameters
- **enableRate** (bool) - Optional - Defaults to `true`. When set, the `rate` value in Soundpool.play and Soundpool.setRate will have an effect.
```

--------------------------------

### Soundpool.fromOptions

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/Soundpool.fromOptions.html

Creates the Soundpool instance with stream type setting set.

```APIDOC
## Soundpool.fromOptions constructor

Soundpool.fromOptions({
  SoundpoolOptions options = SoundpoolOptions.kDefault,
})

Creates the Soundpool instance with stream type setting set.

### Parameters
#### Named Parameters
- **options** (SoundpoolOptions) - Optional - The SoundpoolOptions to configure the Soundpool instance. Defaults to SoundpoolOptions.kDefault.

### Implementation
```dart
factory Soundpool.fromOptions(
    {SoundpoolOptions options = SoundpoolOptions.kDefault}) {
  return Soundpool._(
    options._platformOptions,
    options.streamType,
    options.maxStreams,
  ).._connect();
}
```
```

--------------------------------

### SoundpoolOptionsMacos Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsMacos/SoundpoolOptionsMacos.html

Initializes SoundpoolOptionsMacos with optional parameters. The `enableRate` parameter defaults to true, controlling whether rate adjustment is enabled.

```dart
const SoundpoolOptionsMacos({this.enableRate = true});
```

--------------------------------

### SoundpoolOptionsAndroid()

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsAndroid-class.html

Default constructor for SoundpoolOptionsAndroid.

```APIDOC
## SoundpoolOptionsAndroid()

### Description
Default constructor for the SoundpoolOptionsAndroid class.

### Method
`SoundpoolOptionsAndroid()`
```

--------------------------------

### kDefault

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsAndroid-class.html

A constant instance of SoundpoolOptionsAndroid, representing default options.

```APIDOC
## kDefault

### Description
Provides a default, constant instance of `SoundpoolOptionsAndroid`.

### Constant
`const SoundpoolOptionsAndroid kDefault`
```

--------------------------------

### SoundpoolOptionsAndroid()

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsAndroid/SoundpoolOptionsAndroid.html

The default constructor for SoundpoolOptionsAndroid. It initializes a new instance of the class with default settings.

```APIDOC
## SoundpoolOptionsAndroid()

### Description
Creates a new SoundpoolOptionsAndroid instance with default settings.

### Method
const

### Endpoint
SoundpoolOptionsAndroid()

### Parameters
This constructor does not take any parameters.

### Request Example
```dart
const SoundpoolOptionsAndroid();
```

### Response
This is a constructor and does not return a value in the traditional sense. It initializes an object.
```

--------------------------------

### SoundpoolOptionsWeb Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsWeb/SoundpoolOptionsWeb.html

This is the default constructor for SoundpoolOptionsWeb. It does not take any arguments.

```javascript
const SoundpoolOptionsWeb();
```

--------------------------------

### toOptionsMap Method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsMacos-class.html

Converts the SoundpoolOptionsMacos object to a map.

```APIDOC
## toOptionsMap()

### Description
Converts the SoundpoolOptionsMacos object to a map representation.

### Returns
Map<String, dynamic>
```

--------------------------------

### SoundpoolOptionsIos Methods

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsIos-class.html

Provides methods for converting options to a map and for string representation.

```APIDOC
## SoundpoolOptionsIos Methods

### toOptionsMap()
- **Returns**: `Map<String, dynamic>`
- **Description**: Converts the Soundpool options to a map.

### toString()
- **Returns**: `String`
- **Description**: Returns a string representation of the Soundpool options object.
```

--------------------------------

### SoundpoolOptions Methods

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptions-class.html

Provides methods for interacting with SoundpoolOptions, including string representation and handling of non-existent method calls.

```APIDOC
## SoundpoolOptions Methods

### noSuchMethod
* **Signature**: noSuchMethod(Invocation invocation) → dynamic
* **Description**: Invoked when a nonexistent method or property is accessed.

### toString
* **Signature**: toString() → String
* **Description**: A string representation of this object.
```

--------------------------------

### SoundpoolOptionsWeb kDefault Constant Implementation

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsWeb/kDefault-constant.html

Defines the default instance of SoundpoolOptionsWeb.

```dart
static const kDefault = SoundpoolOptionsWeb();
```

--------------------------------

### SoundpoolOptions Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptions-class.html

Initializes a new instance of the SoundpoolOptions class with customizable parameters for cross-platform sound playback.

```APIDOC
## SoundpoolOptions Constructor

### Description
Initializes a new instance of the SoundpoolOptions class.

### Parameters
* **streamType** (StreamType) - Optional - The type of stream used by the pool. Defaults to `StreamType.music`.
* **maxStreams** (int) - Optional - Maximum number of parallel sounds being played. Defaults to `1`.
* **androidOptions** (SoundpoolOptionsAndroid) - Optional - Android specific options. Defaults to `SoundpoolOptionsAndroid.kDefault`.
* **iosOptions** (SoundpoolOptionsIos) - Optional - iOS specific options. Defaults to `SoundpoolOptionsIos.kDefault`.
* **webOptions** (SoundpoolOptionsWeb) - Optional - Web specific options. Defaults to `SoundpoolOptionsWeb.kDefault`.
* **macosOptions** (SoundpoolOptionsMacos) - Optional - MacOS specific options. Defaults to `SoundpoolOptionsMacos.kDefault`.
```

--------------------------------

### Soundpool Methods

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool-class.html

A collection of methods for managing audio playback, including loading, playing, pausing, resuming, stopping, and releasing sounds.

```APIDOC
## Soundpool Methods

### dispose() → void

Disposes soundpool.

### load(ByteData rawSound, {int priority = _DEFAULT_SOUND_PRIORITY}) → Future<int>

Prepares sound for playing.

### loadAndPlay(ByteData rawSound, {int priority = _DEFAULT_SOUND_PRIORITY, int repeat = 0, double rate = 1.0}) → Future<int>

Prepares sound for playing and plays immediately when loaded.

### loadAndPlayUint8List(Uint8List rawSound, {int priority = _DEFAULT_SOUND_PRIORITY, int repeat = 0, double rate = 1.0}) → Future<int>

Prepares sound for playing and plays immediately after loading.

### loadAndPlayUri(String uri, {int priority = _DEFAULT_SOUND_PRIORITY, int repeat = 0, double rate = 1.0}) → Future<int>

Prepares sound for playing and plays immediately after loading.

### loadUint8List(Uint8List rawSound, {int priority = _DEFAULT_SOUND_PRIORITY}) → Future<int>

Prepares sound for playing.

### loadUri(String uri, {int priority = _DEFAULT_SOUND_PRIORITY}) → Future<int>

Prepares sound for playing.

### noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

### pause(int streamId) → Future<void>

Pauses playing sound identified by `streamId`.

### play(int soundId, {int repeat = 0, double rate = 1.0}) → Future<int>

Plays sound identified by `soundId`.

### playWithControls(int soundId, {int repeat = 0, double rate = 1.0}) → Future<AudioStreamControl>

Starts playing the sound identified by `soundId`.

### release() → Future<void>

Releases loaded sounds.

### resume(int streamId) → Future<void>

Resumes playing sound identified by `streamId`.

### setRate({required int streamId, required double playbackRate}) → Future<void>

Sets playback rate. A value of 1.0 means normal speed, 0.5 - half speed, 2.0 - double speed.

### setVolume({int? soundId, int? streamId, double? volume, double? volumeLeft, double? volumeRight}) → Future<void>

Sets volume for playing sound identified by `soundId` or `streamId`.

### stop(int streamId) → Future<void>

Stops playing sound identified by `streamId`.

### toString() → String

A string representation of this object.
```

--------------------------------

### Soundpool Constructors

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool-class.html

Provides two ways to create an instance of the Soundpool class: one with default stream type and max streams, and another using SoundpoolOptions for more specific configurations.

```APIDOC
## Soundpool Constructors

### Soundpool({StreamType streamType = StreamType.music, int maxStreams = 1})

Creates the Soundpool instance with stream type setting set. Soundpool can play up to `maxStreams` of simultaneous streams.

### factory Soundpool.fromOptions({SoundpoolOptions options = SoundpoolOptions.kDefault})

Creates the Soundpool instance with stream type setting set.
```

--------------------------------

### Soundpool loadAndPlay Implementation

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/loadAndPlay.html

This is the core implementation of the loadAndPlay method. It first loads the sound using the load method and then plays it if the loading was successful.

```dart
Future<int> loadAndPlay(ByteData rawSound,
    {int priority = _DEFAULT_SOUND_PRIORITY,
    int repeat = 0,
    double rate = 1.0}) async {
  int soundId = await load(rawSound, priority: priority);
  if (soundId > -1) {
    play(soundId, repeat: repeat, rate: rate);
  }
  return soundId;
}
```

--------------------------------

### SoundpoolOptionsIos kDefault Constant Implementation

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsIos/kDefault-constant.html

This snippet shows the static constant declaration for kDefault, which initializes SoundpoolOptionsIos with its default settings.

```dart
static const kDefault = SoundpoolOptionsIos();
```

--------------------------------

### SoundpoolOptionsMacos Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsMacos/SoundpoolOptionsMacos.html

Initializes a new instance of the SoundpoolOptionsMacos class. The `enableRate` parameter controls whether rate-related features are enabled.

```APIDOC
## SoundpoolOptionsMacos Constructor

### Description

Initializes a new instance of the SoundpoolOptionsMacos class. The `enableRate` parameter controls whether rate-related features are enabled.

### Parameters

#### Named Parameters

- **enableRate** (bool) - Optional - Defaults to `true`. If `true`, rate-related features are enabled. If `false`, they are disabled.

### Implementation

```dart
const SoundpoolOptionsMacos({this.enableRate = true});
```
```

--------------------------------

### SoundpoolOptionsIos Constants

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsIos-class.html

Provides a default instance of SoundpoolOptionsIos.

```APIDOC
## SoundpoolOptionsIos Constants

### kDefault
- **Type**: `const SoundpoolOptionsIos`
- **Description**: A default instance of `SoundpoolOptionsIos`.
```

--------------------------------

### kDefault Constant Implementation

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsAndroid/kDefault-constant.html

This snippet shows the declaration of the kDefault constant, which is a static instance of SoundpoolOptionsAndroid.

```dart
static const kDefault = SoundpoolOptionsAndroid();
```

--------------------------------

### toOptionsMap Method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsAndroid/toOptionsMap.html

Converts the SoundpoolOptionsAndroid object into a Map<String, dynamic> representation.

```APIDOC
## toOptionsMap()

### Description
Converts the SoundpoolOptionsAndroid object into a Map<String, dynamic> representation.

### Method Signature
Map<String, dynamic> toOptionsMap()

### Implementation
```dart
Map<String, dynamic> toOptionsMap() => {};
```
```

--------------------------------

### Load and Play Sound from Assets

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/loadAndPlay.html

Loads a sound file from the application's assets and plays it immediately. This is a common use case for playing short sound effects.

```dart
loadAndPlay(await rootBundle.load("sounds/dices.m4a")); // loads file from assets
```

--------------------------------

### SoundpoolOptionsIos Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsIos/SoundpoolOptionsIos.html

Use this constructor to create an instance of SoundpoolOptionsIos. It allows setting `enableRate`, `audioSessionCategory`, and `audioSessionMode` for iOS audio playback.

```dart
const SoundpoolOptionsIos({
  this.enableRate = true,
  this.audioSessionCategory,
  this.audioSessionMode = AudioSessionMode.normal,
});
```

--------------------------------

### SoundpoolOptions Constants

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptions-class.html

Provides a default instance of SoundpoolOptions.

```APIDOC
## SoundpoolOptions Constants

### kDefault
* **Type**: const SoundpoolOptions
* **Description**: A default instance of SoundpoolOptions.
```

--------------------------------

### SoundpoolOptionsIos Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsIos-class.html

Initializes Soundpool options for iOS devices. You can configure audio session category and mode, and whether the rate property affects playback.

```APIDOC
## SoundpoolOptionsIos Constructor

### Description
Initializes Soundpool options for iOS devices. Allows configuration of audio session category, audio session mode, and whether the rate property affects playback.

### Parameters
- **enableRate** (bool) - Optional - Defaults to `true`. When set to `true`, the `rate` value in `Soundpool.play` and `Soundpool.setRate` will have an effect.
- **audioSessionCategory** (AudioSessionCategory?) - Optional - Specifies the audio session category for the shared AVAudioSession.
- **audioSessionMode** (AudioSessionMode) - Optional - Defaults to `AudioSessionMode.normal`. Specifies the audio session mode for the shared AVAudioSession.
```

--------------------------------

### kDefault Constant Implementation

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsMacos/kDefault-constant.html

This snippet shows the static constant declaration for kDefault, initializing SoundpoolOptionsMacos with default values.

```dart
static const kDefault = SoundpoolOptionsMacos();
```

--------------------------------

### toOptionsMap method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsIos/toOptionsMap.html

Converts the Soundpool options object into a Map<String, dynamic> representation. This is useful for serialization or passing options to native code.

```APIDOC
## toOptionsMap()

### Description
Converts the current Soundpool options into a map of string keys to dynamic values.

### Method Signature
`Map<String, dynamic> toOptionsMap()`

### Returns
A `Map<String, dynamic>` containing the following potential keys:
- `enableRate` (bool): Indicates if rate adjustment is enabled.
- `avSessionCategory` (String): The audio session category.
- `avSessionMode` (String): The audio session mode.

### Implementation Example
```dart
Map<String, dynamic> toOptionsMap() => {
  'enableRate': enableRate,
  'avSessionCategory': audioSessionCategory?.toString().split('.').last,
  'avSessionMode': audioSessionMode.toString().split('.').last,
};
```
```

--------------------------------

### SoundpoolOptionsAndroid Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsAndroid/SoundpoolOptionsAndroid.html

This is the default constructor for SoundpoolOptionsAndroid. It is used to create an instance with default settings.

```dart
const SoundpoolOptionsAndroid();
```

--------------------------------

### SoundpoolOptionsWeb webOptions Implementation

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptions/webOptions.html

This code declares the `webOptions` property for web-specific configurations within Soundpool.

```dart
final SoundpoolOptionsWeb webOptions;
```

--------------------------------

### toOptionsMap Method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsWeb/toOptionsMap.html

The toOptionsMap method converts the current Soundpool options into a Map<String, dynamic> format, suitable for serialization or further processing.

```APIDOC
## toOptionsMap Method

### Description
Converts Soundpool options to a Map<String, dynamic>.

### Signature
Map<String, dynamic> toOptionsMap()

### Implementation
```dart
Map<String, dynamic> toOptionsMap() => {};
```
```

--------------------------------

### loadAndPlay Method Signature

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/loadAndPlay.html

The loadAndPlay method takes raw sound data and optional parameters for playback. It returns a Future<int> representing the sound ID.

```APIDOC
Future<int> loadAndPlay(
  ByteData rawSound,
  {
  int priority = _DEFAULT_SOUND_PRIORITY,
  int repeat = 0,
  double rate = 1.0,
}
)
```

--------------------------------

### Declare Soundpool iOS Options

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptions/iosOptions.html

Declare the `iosOptions` property to hold iOS-specific configurations for Soundpool.

```dart
final SoundpoolOptionsIos iosOptions;
```

--------------------------------

### Load and Play Sound from URI (Dart)

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/loadAndPlayUri.html

Loads sound data from the specified URI and plays it immediately. Returns the sound ID if successful, or -1 if the sound file fails to load. On web, 'priority' and 'repeat' are ignored, and the sound plays only once.

```dart
Future<int> loadAndPlayUri(String uri,
    {int priority = _DEFAULT_SOUND_PRIORITY,
    int repeat = 0,
    double rate = 1.0}) async {
  assert(!_disposed, "Soundpool instance was already disposed");
  int soundId = await loadUri(uri, priority: priority);
  if (soundId > -1) {
    play(soundId, repeat: repeat, rate: rate);
  }
  return soundId;
}
```

--------------------------------

### Soundpool load method implementation

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/load.html

The implementation of the load method, which internally calls loadUint8List with the raw sound data.

```dart
Future<int> load(ByteData rawSound,
        {int priority = _DEFAULT_SOUND_PRIORITY}) =>
    loadUint8List(rawSound.buffer.asUint8List(), priority: priority);
```

--------------------------------

### toOptionsMap Method Implementation

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsIos/toOptionsMap.html

Converts Soundpool options to a map for iOS. It maps enableRate, audioSessionCategory, and audioSessionMode to their respective string representations.

```dart
Map<String, dynamic> toOptionsMap() => {
      'enableRate': enableRate,
      'avSessionCategory': audioSessionCategory?.toString().split('.').last,
      'avSessionMode': audioSessionMode.toString().split('.').last,
    };
```

--------------------------------

### SoundpoolOptions Properties

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptions-class.html

Exposes configurable properties for the SoundpoolOptions, allowing fine-tuning of sound playback.

```APIDOC
## SoundpoolOptions Properties

### androidOptions
* **Type**: SoundpoolOptionsAndroid
* **Description**: Android specific options.

### hashCode
* **Type**: int
* **Description**: The hash code for this object.

### iosOptions
* **Type**: SoundpoolOptionsIos
* **Description**: iOS specific options.

### macosOptions
* **Type**: SoundpoolOptionsMacos
* **Description**: MacOS specific options.

### maxStreams
* **Type**: int
* **Description**: Maximum number of parallel sounds being played.

### runtimeType
* **Type**: Type
* **Description**: A representation of the runtime type of the object.

### streamType
* **Type**: StreamType
* **Description**: The type of stream used by the pool.

### webOptions
* **Type**: SoundpoolOptionsWeb
* **Description**: Web specific options.
```

--------------------------------

### SoundpoolOptionsIos Properties

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsIos-class.html

Exposes properties for configuring audio session category, audio session mode, and the effect of the rate property on playback.

```APIDOC
## SoundpoolOptionsIos Properties

### audioSessionCategory
- **Type**: `AudioSessionCategory?`
- **Description**: Audio Session category for shared AVAudioSession.

### audioSessionMode
- **Type**: `AudioSessionMode`
- **Description**: Audio Session mode for shared AVAudioSession.

### enableRate
- **Type**: `bool`
- **Description**: When set to `true`, the `rate` value in `Soundpool.play` and `Soundpool.setRate` will have an effect. Defaults to `true`.
```

--------------------------------

### Soundpool toOptionsMap Implementation

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsAndroid/toOptionsMap.html

This is the basic implementation of the toOptionsMap method, returning an empty map.

```dart
Map<String, dynamic> toOptionsMap() => {};
```

--------------------------------

### loadUri Method Signature

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/loadUri.html

Loads sound data from a file pointed by `uri`. Returns soundId for future use in play (soundId > -1) or `-1` when sound file failed to load. The `priority` parameter is ignored on web.

```APIDOC
## loadUri Method

Future<int> loadUri(
  String uri,
  { int priority = _DEFAULT_SOUND_PRIORITY }
)

### Description
Prepares sound for playing. Loads sound data from file pointed by `uri`. Returns soundId for future use in play (soundId > -1) or `-1` when sound file failed to load.

### Platform Specifics
*   **web**: `priority` is ignored.

### Parameters
#### Path Parameters
*   **uri** (String) - Required - The URI of the sound file to load.
*   **priority** (int) - Optional - The priority of the sound loading operation. Ignored on web.

### Returns
*   (Future<int>) - A future that completes with the sound ID if successful, or -1 if loading failed.
```

--------------------------------

### SoundpoolOptions kDefault Constant Implementation

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptions/kDefault-constant.html

This constant is used to create a default SoundpoolOptions object.

```dart
static const kDefault = SoundpoolOptions();
```

--------------------------------

### Load and Play Sound from Uint8List

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/loadAndPlayUint8List.html

Loads sound data from a Uint8List, buffers it, and plays it immediately. Returns a sound ID (> -1) on success or -1 on failure. Priority and repeat parameters are ignored on web.

```dart
Future<int> loadAndPlayUint8List(Uint8List rawSound,
    {int priority = _DEFAULT_SOUND_PRIORITY,
    int repeat = 0,
    double rate = 1.0}) async {
  assert(!_disposed, "Soundpool instance was already disposed");
  int soundId = await loadUint8List(rawSound, priority: priority);
  if (soundId > -1) {
    play(soundId, repeat: repeat, rate: rate);
  }
  return soundId;
}
```

--------------------------------

### SoundpoolOptionsIos Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsIos/SoundpoolOptionsIos.html

The `SoundpoolOptionsIos` constructor allows you to customize audio session settings for iOS. You can enable or disable rate adjustments, and specify the audio session category and mode.

```APIDOC
## SoundpoolOptionsIos Constructor

### Description
Initializes a new instance of the `SoundpoolOptionsIos` class with customizable audio session options for iOS.

### Parameters
#### Named Parameters
- **enableRate** (bool) - Optional - Defaults to `true`. If `true`, allows rate adjustments for audio playback.
- **audioSessionCategory** (AudioSessionCategory?) - Optional - Specifies the audio session category. Can be null.
- **audioSessionMode** (AudioSessionMode) - Optional - Defaults to `AudioSessionMode.normal`. Sets the audio session mode.

### Example
```dart
const soundpoolOptions = SoundpoolOptionsIos(
  enableRate: false,
  audioSessionCategory: AudioSessionCategory.playback,
  audioSessionMode: AudioSessionMode.voiceProcessingOnly,
);
```
```

--------------------------------

### Soundpool Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/Soundpool.html

Creates a Soundpool instance with optional stream type and maximum simultaneous streams settings. Note that the `streamType` parameter is only effective on Android.

```APIDOC
## Soundpool Constructor

### Description
Creates the Soundpool instance with stream type setting set. Soundpool can play up to `maxStreams` of simultaneous streams.
_Note:_ Optional `streamType` parameter has effect on Android only.

### Parameters
#### Named Parameters
- **streamType** (StreamType) - Optional - Defaults to `StreamType.music`. Affects Android only.
- **maxStreams** (int) - Optional - Defaults to 1. The maximum number of simultaneous streams that can be played.

### Deprecated
This constructor is deprecated and `fromOptions` should be used instead.
```

--------------------------------

### SoundpoolOptions Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptions/SoundpoolOptions.html

The SoundpoolOptions constructor allows you to customize the behavior of the Soundpool, including stream type, maximum concurrent streams, and platform-specific options.

```APIDOC
## SoundpoolOptions Constructor

### Description
Initializes a new instance of the SoundpoolOptions class.

### Parameters
- **streamType** (StreamType) - Optional - The type of audio stream to use. Defaults to `StreamType.music`.
- **maxStreams** (int) - Optional - The maximum number of concurrent audio streams allowed. Defaults to `1`.
- **androidOptions** (SoundpoolOptionsAndroid) - Optional - Configuration options for Android. Defaults to `SoundpoolOptionsAndroid.kDefault`.
- **iosOptions** (SoundpoolOptionsIos) - Optional - Configuration options for iOS. Defaults to `SoundpoolOptionsIos.kDefault`.
- **webOptions** (SoundpoolOptionsWeb) - Optional - Configuration options for the web platform. Defaults to `SoundpoolOptionsWeb.kDefault`.
- **macosOptions** (SoundpoolOptionsMacos) - Optional - Configuration options for macOS. Defaults to `SoundpoolOptionsMacos.kDefault`.

### Implementation
```dart
const SoundpoolOptions({
  this.streamType = StreamType.music,
  this.maxStreams = 1,
  this.androidOptions = SoundpoolOptionsAndroid.kDefault,
  this.iosOptions = SoundpoolOptionsIos.kDefault,
  this.webOptions = SoundpoolOptionsWeb.kDefault,
  this.macosOptions = SoundpoolOptionsMacos.kDefault,
});
```
```

--------------------------------

### resume

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/resume.html

Resumes playing sound identified by `streamId`.

```APIDOC
## resume

### Description
Resumes playing sound identified by `streamId`.

### Method Signature
Future<void> resume(int streamId)

### Parameters
#### Path Parameters
- **streamId** (int) - Required - The ID of the sound stream to resume.

### Implementation Notes
- The web implementation of this method is noted as not working.
- Asserts are in place to ensure the Soundpool instance is not disposed and the `streamId` is valid (greater than 0).
```

--------------------------------

### Load sound from assets

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/load.html

Loads a sound file from the application's assets folder. This method returns a sound ID that can be used with the play method.

```dart
load(await rootBundle.load("sounds/dices.m4a")); // loads file from assets
```

--------------------------------

### setRate Method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/AudioStreamControl/setRate.html

Sets the playback rate for the audio stream. A value of 1.0 indicates normal speed, 0.5 indicates half speed, and 2.0 indicates double speed. The available range for playbackRate is between 0.5 and 2.0.

```APIDOC
## setRate

### Description
Sets playback rate. A value of 1.0 means normal speed, 0.5 - half speed, 2.0 - double speed.
Available value range: (0.5 - 2.0)

### Method Signature
Future setRate({
  required double playbackRate,
})
```

--------------------------------

### setVolume Method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/setVolume.html

Sets the volume for a specific sound or stream. You must provide either a general 'volume' or specific 'volumeLeft' and 'volumeRight' values. Note that on web platforms, 'volumeLeft' and 'volumeRight' are ignored, and only the 'volume' parameter is effective.

```APIDOC
## setVolume

### Description
Sets volume for playing sound identified by `soundId` or `streamId`. At least `volume` or both `volumeLeft` and `volumeRight` have to be passed.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **soundId** (int?) - Optional - Identifier for the sound.
- **streamId** (int?) - Optional - Identifier for the stream.
- **volume** (double?) - Optional - The desired volume level (0.0 to 1.0).
- **volumeLeft** (double?) - Optional - The desired volume for the left channel (0.0 to 1.0).
- **volumeRight** (double?) - Optional - The desired volume for the right channel (0.0 to 1.0).

### Request Example
```dart
// Example setting a uniform volume
await soundpool.setVolume(soundId: 1, volume: 0.5);

// Example setting stereo volume
await soundpool.setVolume(streamId: 101, volumeLeft: 0.7, volumeRight: 0.3);
```

### Response
#### Success Response (void)
This method returns `void` upon successful execution.

#### Response Example
```dart
// No response body for this operation
```

### Error Handling
- Throws an `AssertionError` if the Soundpool instance has been disposed.
- Throws an `AssertionError` if neither `soundId` nor `streamId` is provided.
- Throws an `AssertionError` if neither `volume` nor both `volumeLeft` and `volumeRight` are provided.
- Throws an `AssertionError` if `streamId` is not greater than 0.
- Throws an `AssertionError` if `soundId` is not greater than -1.
```

--------------------------------

### SoundpoolOptions Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptions/SoundpoolOptions.html

Use this constructor to create a SoundpoolOptions object. It allows setting the stream type, maximum number of concurrent streams, and platform-specific options for Android, iOS, Web, and macOS.

```dart
const SoundpoolOptions({
  this.streamType = StreamType.music,
  this.maxStreams = 1,
  this.androidOptions = SoundpoolOptionsAndroid.kDefault,
  this.iosOptions = SoundpoolOptionsIos.kDefault,
  this.webOptions = SoundpoolOptionsWeb.kDefault,
  this.macosOptions = SoundpoolOptionsMacos.kDefault,
});
```

--------------------------------

### enableRate Property

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsIos/enableRate.html

When set, the `rate` value in Soundpool.play and Soundpool.setRate will have an effect. Defaults to `true`.

```APIDOC
## enableRate Property

### Description

Controls whether the `rate` parameter in `Soundpool.play` and `Soundpool.setRate` is effective.

### Type

`bool`

### Default Value

`true`

### Implementation

```dart
final bool enableRate;
```
```

--------------------------------

### enableRate Property

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsMacos/enableRate.html

When set, the `rate` value in Soundpool.play and Soundpool.setRate will have an effect. Defaults to `true`.

```APIDOC
## enableRate Property

### Description

Controls whether the `rate` property affects playback speed.

### Type

bool

### Default Value

`true`

### Implementation

```dart
final bool enableRate;
```
```

--------------------------------

### Load Sound Data from Uint8List

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/loadUint8List.html

Loads sound data from a Uint8List and buffers it for playback. Returns a sound ID greater than -1 on success, or -1 on failure. The priority parameter is ignored on web.

```dart
Future<int> loadUint8List(Uint8List rawSound,
    {int priority = _DEFAULT_SOUND_PRIORITY}) async {
  assert(!_disposed, "Soundpool instance was already disposed");
  int poolId = await _soundpoolId.future;
  int soundId =
      await _platformInstance.loadUint8List(poolId, rawSound, priority);
  return soundId;
}
```

--------------------------------

### Soundpool Properties

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool-class.html

Exposes properties like hashCode, runtimeType, and streamType for inspecting the Soundpool instance.

```APIDOC
## Soundpool Properties

### hashCode → int

The hash code for this object.

### runtimeType → Type

A representation of the runtime type of the object.

### streamType → StreamType


```

--------------------------------

### setVolume Method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/AudioStreamControl/setVolume.html

Sets the volume for a playing sound identified by `soundId` or `streamId`. At least `volume` or both `volumeLeft` and `volumeRight` must be provided.

```APIDOC
## setVolume

### Description
Sets volume for playing sound identified by `soundId` or `streamId`.
At least `volume` or both `volumeLeft` and `volumeRight` have to be passed.

### Method Signature
```dart
Future setVolume({
  double? volume,
  double? volumeLeft,
  double? volumeRight,
})
```

### Parameters
#### Optional Parameters
- **volume** (double?) - The uniform volume level for the audio stream. Value should be between 0.0 and 1.0.
- **volumeLeft** (double?) - The volume level for the left audio channel. Value should be between 0.0 and 1.0.
- **volumeRight** (double?) - The volume level for the right audio channel. Value should be between 0.0 and 1.0.

### Notes
- You must provide either the `volume` parameter or both `volumeLeft` and `volumeRight` parameters.
- If `volume` is provided, it applies to both channels equally.
- If `volumeLeft` and `volumeRight` are provided, they control the respective channels independently.
```

--------------------------------

### release()

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/release.html

Releases loaded sounds and clears buffered audio resources. This method should be invoked when the Soundpool instance is no longer needed to prevent memory leaks.

```APIDOC
## release()

### Description
Releases loaded sounds and clears buffered audio resources. This method should be invoked when the Soundpool instance is no longer needed to prevent memory leaks.

### Method Signature
`Future<void> release()`

### Implementation Notes
This method asserts that the Soundpool instance has not already been disposed. It then retrieves the soundpool ID and calls the platform-specific release function.
```

--------------------------------

### setRate Method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/setRate.html

Sets the playback rate for a specific sound stream. The rate can be adjusted between 0.5 (half speed) and 2.0 (double speed).

```APIDOC
## setRate Method

### Description
Sets playback rate. A value of 1.0 means normal speed, 0.5 - half speed, 2.0 - double speed.
Available value range: (0.5 - 2.0)

### Method Signature
Future<void> setRate({
  required int streamId,
  required double playbackRate,
})

### Parameters
#### Path Parameters
- **streamId** (int) - Required - The ID of the sound stream to modify.
- **playbackRate** (double) - Required - The desired playback rate. Must be between 0.5 and 2.0.

### Request Example
```dart
// Assuming you have a Soundpool instance and a valid streamId
await soundpool.setRate(streamId: 1, playbackRate: 1.5);
```

### Response
This method returns a Future<void> and does not return any specific data upon success.
```

--------------------------------

### toString Method

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/toString.html

Returns a string representation of the Soundpool object, including its stream type and hash code. This is useful for debugging and logging.

```APIDOC
## toString Method

### Description
Provides a string representation of the Soundpool object, useful for debugging and logging.

### Signature
```dart
@override
String toString()
```

### Implementation
```dart
@override
String toString() {
  return 'Soundpool("$_streamType":$hashCode)';
}
```
```

--------------------------------

### SoundpoolOptions Operators

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptions-class.html

Defines operators for the SoundpoolOptions class, including equality comparison.

```APIDOC
## SoundpoolOptions Operators

### operator ==
* **Signature**: operator ==(Object other) → bool
* **Description**: The equality operator.
```

--------------------------------

### dispose()

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/dispose.html

Disposes the Soundpool instance. After calling this method, the Soundpool instance is no longer usable.

```APIDOC
## dispose()

### Description
Disposes the Soundpool instance. The Soundpool instance is not usable anymore after this method is called.

### Method Signature
```dart
void dispose()
```

### Implementation Notes
Sets an internal flag `_disposed` to true and unawaitedly disposes the underlying platform instance.
```

--------------------------------

### Deprecated Soundpool Constructor

Source: https://pub.dev/documentation/soundpool/latest/soundpool/Soundpool/Soundpool.html

This constructor is deprecated. Use `Soundpool.fromOptions` instead. It allows setting the stream type (primarily for Android) and the maximum number of simultaneous streams.

```dart
@Deprecated('Use `fromOptions` instead')
factory Soundpool(
        {StreamType streamType = StreamType.music, int maxStreams = 1}) =>
    Soundpool.fromOptions(
      options: SoundpoolOptions(
        streamType: streamType,
        maxStreams: maxStreams,
      ),
    );
```

--------------------------------

### Convert Soundpool Options to Map

Source: https://pub.dev/documentation/soundpool/latest/soundpool/SoundpoolOptionsMacos/toOptionsMap.html

This method converts the Soundpool options into a map. Use this when you need to serialize the options or pass them to a system that expects a map.

```dart
Map<String, dynamic> toOptionsMap() => {
      'enableRate': enableRate,
    };
```
Tokens:
Raw