Oxisynth

https://docs.rs/oxisynth/0.1.0/oxisynth/
Admin
Oxisynth is a Rust crate that provides a synthesizer object. It allows users to create a new...
Tokens:13,036
Snippets:169
Trust Score:9.1
Update:4 months ago
Show doc for...
Tokens:
Raw
### new

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Creates a new synthesizer object. The synthesizer starts playing as soon as it is created.

```APIDOC
## pub fn new

### Description
Creates a new synthesizer object. As soon as the synthesizer is created, it will start playing.

### Method
`new`

### Parameters
- **desc** (`SynthDescriptor`) - Description: The descriptor for the synthesizer configuration.

### Returns
- **Result<Self, SettingsError>**: A new Synth object if creation is successful, otherwise a SettingsError.
```

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

### Get Current Program, Bank, and SoundFont

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the currently selected program (preset), bank, and SoundFont ID for a given MIDI channel.

```rust
pub fn program( &self, channel: u8, ) -> Result<(Option<SoundFontId>, u32, u32), OxiError>
```

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

### Get Current Channel Preset

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the currently selected preset for a given MIDI channel.

```rust
pub fn channel_preset(&self, channel: u8) -> Option<Arc<Preset>>
```

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

### Synth::write

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Writes the synthesized audio output to a buffer. This is how you get the sound data out of the synthesizer.

```APIDOC
## Synth::write

### Description
Writes the results to a buffer.

### Method
`write(&mut self, buffer: &mut [f32])`

### Parameters
- **buffer** (&mut [f32]) - A mutable slice of f32 to write the audio samples into.

### Response
None explicitly documented, implies buffer is filled with audio data.
```

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

### Create Octave-Based Tuning

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Creates a new octave-based tuning. The array should contain derivation in cents from the well-tempered scale. For example, if pitches[0] equals -33, then the C-keys will be tuned 33 cents below the well-tempered C.

```rust
pub fn new_octave_tuning(pitch: &[f64; 12]) -> Self
```

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

### Get SoundFont by Index

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves a SoundFont from the stack based on its index. The top of the stack is index 0.

```rust
pub fn nth_sound_font(&self, num: usize) -> Option<&SoundFont>
```

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

### Get SoundFont by ID

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves a SoundFont from the stack using its unique ID.

```rust
pub fn sound_font(&self, id: SoundFontId) -> Option<&SoundFont>
```

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

### Get MIDI Channel Count

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Returns the number of MIDI channels the synthesizer is configured to use internally.

```rust
pub fn channel_count(&self) -> usize
```

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

### Get Master Gain

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the current master output gain setting of the synthesizer.

```rust
pub fn gain(&self) -> f32
```

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

### Get Pitch Wheel Sensitivity

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the current pitch wheel sensitivity setting for a given MIDI channel.

```rust
pub fn pitch_wheel_sensitivity(&self, channel: u8) -> Result<u8, OxiError>
```

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

### Get Tuning Slice

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Returns an immutable slice of the tuning data.

```rust
pub fn as_slice(&self) -> &[f64; 128]
```

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

### Get Bank Offset for SoundFont

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the current bank number offset for a given SoundFont.

```rust
pub fn bank_offset(&self, sfont_id: SoundFontId) -> Option<u32>
```

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

### Get Mutable Tuning Slice

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Returns a mutable slice of the tuning data.

```rust
pub fn as_slice_mut(&mut self) -> &mut [f64; 128]
```

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

### Get Pitch Bend Value

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the current pitch bend value for a given MIDI channel.

```rust
pub fn pitch_bend(&self, channel: u8) -> Result<u16, OxiError>
```

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

### Get Polyphony Limit

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the current polyphony limit setting of the synthesizer. This value may depend on the underlying FluidSynth version.

```rust
pub fn polyphony(&self) -> u32
```

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

### Get Preset Name

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Preset.html

Retrieves the name of the preset as a string slice. This method is part of the Preset struct's implementation.

```rust
pub fn name(&self) -> &str
```

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

### Get MIDI Control Value

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the current value of a MIDI control change (CC) message for a specific channel and controller number.

```rust
pub fn cc(&self, channel: u8, ctrl: u16) -> Result<u8, OxiError>
```

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

### Get Generator Parameter

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the current value of a synthesis generator parameter for a specific MIDI channel. This reflects values set by `set_gen()` or NRPN messages.

```rust
pub fn gen(&self, chan: u8, param: GeneratorType) -> Result<f32, OxiError>
```

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

### Get Preset Number

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Preset.html

Retrieves the specific number of the preset within its bank as a u32. This method is part of the Preset struct's implementation.

```rust
pub fn num(&self) -> u32
```

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

### Get Preset Bank Number

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Preset.html

Retrieves the bank number associated with the preset as a u32. This method is part of the Preset struct's implementation.

```rust
pub fn banknum(&self) -> u32
```

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

### Synth::new

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Creates a new synthesizer instance. Use the settings structure to specify the synthesizer characteristics.

```APIDOC
## Synth::new

### Description
Creates a new synthesizer instance. Use the settings structure to specify the synthesizer characteristics.

### Method
Associated Function

### Parameters
None explicitly documented for `new()` itself, but implies settings structure usage.

### Response
- Synth: A new instance of the Synth object.
```

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

### Tuning::new

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Creates a new Tuning instance with default values. This is a private constructor and not intended for direct use.

```APIDOC
## Tuning::new

### Description
Creates a new Tuning instance with default values.

### Signature
`pub fn new() -> Self`
```

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

### Select MIDI Program (Preset)

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Selects a specific preset (instrument) for a MIDI channel. This requires specifying the SoundFont ID, bank number, and preset number, allowing selection of any preset regardless of the SoundFont stack order.

```rust
pub fn select_program( &mut self, channel: u8, sfont_id: SoundFontId, bank_id: u32, preset_id: u8, ) -> Result<(), OxiError>
```

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

### write

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Writes sound samples to the internal sample data buffer.

```APIDOC
## pub fn write<S: IsSamples>

### Description
Write sound samples to the sample data buffer.

### Method
`&mut self`

### Parameters
- **samples** (`S: IsSamples`) - Description: The samples to write, conforming to the `IsSamples` trait.
```

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

### Create Key-Based Tuning

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Creates a new key-based tuning. The array should contain the pitch of every key in cents.

```rust
pub fn new_key_tuning(pitch: [f64; 128]) -> Self
```

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

### set_chorus_params

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Sets up the chorus effect. It should be turned on with Chorus::set_active(). If faulty parameters are given, all new settings are discarded. CPU time is proportional to `nr`.

```APIDOC
## pub fn set_chorus_params

### Description
Set up the chorus. It should be turned on with Chorus::set_active(). If faulty parameters are given, all new settings are discarded. Keep in mind, that the needed CPU time is proportional to `nr`.

### Method
`&mut self`

### Parameters
- **params** (`&ChorusParams`) - Description: The new chorus parameters to apply.
```

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

### write_cb

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Writes audio samples to a callback function.

```APIDOC
## pub fn write_cb<F: FnMut(usize, f32, f32)>

### Description
Writes audio samples using a callback function.

### Method
`&mut self`

### Parameters
- **len** (`usize`) - Description: The number of samples to write.
- **incr** (`usize`) - Description: The increment between samples.
- **cb** (`F: FnMut(usize, f32, f32)`) - Description: The callback function to receive sample data. It takes channel index, left sample, and right sample.
```

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

### default

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Returns the default Synth object.

```APIDOC
## fn default

### Description
Returns the default value for a Synth.

### Method
`default`

### Returns
- **Synth**: The default Synth object.
```

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

### Preset Methods

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Preset.html

Provides access to the properties of a Preset.

```APIDOC
## Preset Struct

### Description
The `Preset` struct represents a sound preset. It contains information about the preset's name, bank number, and preset number.

### Methods

#### `name()`

- **Description**: Returns the name of the preset as a string slice.
- **Signature**: `pub fn name(&self) -> &str`

#### `banknum()`

- **Description**: Returns the bank number of the preset as a `u32`.
- **Signature**: `pub fn banknum(&self) -> u32`

#### `num()`

- **Description**: Returns the preset number as a `u32`.
- **Signature**: `pub fn num(&self) -> u32`
```

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

### write_f64

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Writes audio samples as 64-bit floating-point numbers to provided buffers.

```APIDOC
## pub fn write_f64

### Description
Write samples as 64-bit floating-point numbers.

### Method
`&mut self`

### Parameters
- **len** (`usize`) - Description: The number of samples to write.
- **left_out** (`&mut [f64]`) - Description: Buffer for the left channel output.
- **loff** (`usize`) - Description: Offset for the left channel buffer.
- **lincr** (`usize`) - Description: Increment for the left channel buffer.
- **right_out** (`&mut [f64]`) - Description: Buffer for the right channel output.
- **roff** (`usize`) - Description: Offset for the right channel buffer.
- **rincr** (`usize`) - Description: Increment for the right channel buffer.
```

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

### write_f32

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Writes audio samples as 32-bit floating-point numbers to provided buffers.

```APIDOC
## pub fn write_f32

### Description
Write samples as 32-bit floating-point numbers.

### Method
`&mut self`

### Parameters
- **len** (`usize`) - Description: The number of samples to write.
- **left_out** (`&mut [f32]`) - Description: Buffer for the left channel output.
- **loff** (`usize`) - Description: Offset for the left channel buffer.
- **lincr** (`usize`) - Description: Increment for the left channel buffer.
- **right_out** (`&mut [f32]`) - Description: Buffer for the right channel output.
- **roff** (`usize`) - Description: Offset for the right channel buffer.
- **rincr** (`usize`) - Description: Increment for the right channel buffer.
```

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

### Synth::program

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the currently selected program (preset), bank, and SoundFont ID for a given MIDI channel.

```APIDOC
## Synth::program

### Description
Returns the program, bank, and SoundFont number of the preset on a given channel.

### Method
`program(&self, channel: u8) -> Result<(Option<SoundFontId>, u32, u32), OxiError>`

### Parameters
- **channel** (u8) - The MIDI channel (0-15).

### Response
- Result<(Option<SoundFontId>, u32, u32), OxiError>: A tuple containing the SoundFont ID (optional), bank ID, and program ID if successful, or an OxiError if the channel is invalid.
```

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

### Load a SoundFont

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Loads a SoundFont into the synthesizer's stack. The new SoundFont is placed on top, affecting preset search order. Presets are searched from the top of the stack downwards.

```rust
pub fn add_font(&mut self, font: SoundFont, reset_presets: bool) -> SoundFontId
```

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

### Tuning::new_key_tuning

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Creates a new key-based tuning with the specified pitches for each of the 128 keys.

```APIDOC
## Tuning::new_key_tuning

### Description
Create a new key-based tuning with given pitches. The array should contain the pitch of every key in cents.

### Signature
`pub fn new_key_tuning(pitch: [f64; 128]) -> Self`

### Parameters
* `pitch` - An array of 128 f64 values representing the pitch of each key in cents.
```

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

### Load SoundFont File

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.SoundFont.html

Loads a SoundFont file from a given reader. This operation can be slow due to I/O and potential decompression, consider using a secondary thread. The loaded SoundFont can be added to a synth.

```rust
pub fn load<F: Read + Seek>(file: &mut F) -> Result<Self, LoadError>
```

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

### CloneToUninit Trait Implementation (Nightly)

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ChorusParams.html

Experimental nightly feature for copying data to uninitialized memory.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

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

### Synth::select_program

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Selects a specific preset (program) for a channel, identified by SoundFont ID, bank number, and preset number. This allows direct selection bypassing the SoundFont stack order.

```APIDOC
## Synth::select_program

### Description
Select a preset for a channel. The preset is specified by the SoundFont ID, the bank number, and the preset number. This allows any preset to be selected and circumvents preset masking due to previously loaded SoundFonts on the SoundFont stack.

### Method
`select_program(&mut self, channel: u8, sfont_id: SoundFontId, bank_id: u32, preset_id: u8) -> Result<(), OxiError>`

### Parameters
- **channel** (u8) - The MIDI channel (0-15).
- **sfont_id** (SoundFontId) - The ID of the SoundFont containing the preset.
- **bank_id** (u32) - The bank number within the SoundFont.
- **preset_id** (u8) - The preset number within the bank.

### Response
- Result<(), OxiError>: Ok if successful, or an OxiError if any of the identifiers are invalid.
```

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

### Type Conversion: TryFrom<U> for T

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ReverbParams.html

Demonstrates a generic implementation for attempting conversion from one type to another, returning a Result.

```rust
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
```

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

### Type Conversion: TryInto<U> for T

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ReverbParams.html

Demonstrates a generic implementation for attempting conversion into another type, returning a Result.

```rust
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
```

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

### read_next

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Reads the next stereo audio sample pair from the synthesizer's output.

```APIDOC
## pub fn read_next

### Description
Reads the next stereo audio sample pair from the synthesizer's output.

### Method
`&mut self`

### Returns
- **(f32, f32)**: A tuple containing the left and right channel sample values.
```

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

### Select SoundFont for a Channel

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Assigns a specific SoundFont to a MIDI channel. This affects which SoundFont is used for playing notes on that channel.

```rust
pub fn select_sound_font( &mut self, channel: u8, sfont_id: SoundFontId, ) -> Result<(), OxiError>
```

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

### Synth::channel_preset

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the currently selected preset for a given MIDI channel.

```APIDOC
## Synth::channel_preset

### Description
Get the currently selected preset for a given channel.

### Method
`channel_preset(&self, channel: u8) -> Option<Arc<Preset>>`

### Parameters
- **channel** (u8) - The MIDI channel (0-15).

### Response
- Option<Arc<Preset>>: A reference-counted pointer to the Preset if found, otherwise None.
```

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

### CloneToUninit Trait Implementation for MidiEvent

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.MidiEvent.html

Provides an experimental, nightly-only API for cloning MidiEvent into uninitialized memory. Requires MidiEvent to implement Clone.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8) {
    🔬This is a nightly-only experimental API. (`clone_to_uninit`)
    Performs copy-assignment from `self` to `dest`. Read more
    Source
}
```

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

### Reset All Channel Presets

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Reinitializes the preset for all MIDI channels by sending bank select and program change messages. This is useful after loading or unloading SoundFonts to ensure correct instrument selection.

```rust
pub fn reset_program(&mut self)
```

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

### Any Trait Implementation

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ChorusParams.html

Provides runtime type information for any type T.

```rust
fn type_id(&self) -> TypeId
```

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

### Experimental Provide Method for RangeError

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.RangeError.html

Implements the nightly-only experimental provide() method for RangeError, allowing type-based access to error context.

```rust
fn provide<'a>(&'a self, request: &mut Request<'a>)
```

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

### Count Loaded SoundFonts

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Returns the total number of SoundFonts currently loaded into the synthesizer.

```rust
pub fn sound_font_count(&self) -> usize
```

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

### SoundFont::load

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.SoundFont.html

Loads a SoundFont™ file from a given reader. This operation can be slow due to I/O and potential decompression, and is recommended to be run on a secondary thread. The loaded SoundFont is thread-safe (Send and Sync).

```APIDOC
## SoundFont::load

### Description
Loads a SoundFont™ file from a given reader. Once loaded, it can be added to the synth using `crate::Synth::add_font()`.

This operation might be quite slow due to blocking IO operations and potential SF3 vorbis decompression, so you might consider loading on a secondary thread. SoundFont is both Send and Sync.

### Method
`pub fn load<F: Read + Seek>(file: &mut F) -> Result<Self, LoadError>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (Result)
- `Ok(SoundFont)`: If the SoundFont file is loaded successfully.
- `Err(LoadError)`: If there is an error during loading.

#### Response Example
None
```

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

### Synth::reset_program

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Reinitializes the preset for all channels by sending bank select and program change messages. This is useful after loading or unloading SoundFonts.

```APIDOC
## Synth::reset_program

### Description
Send a bank select and a program change to every channel to reinitialize the preset of the channel. This function is useful mainly after a SoundFont has been loaded, unloaded or reloaded.

### Method
`reset_program(&mut self)`

### Parameters
None

### Response
None explicitly documented, implies internal state update.
```

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

### SynthDescriptor Struct Definition

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.SynthDescriptor.html

Defines the structure for synthesizer configuration. This includes settings for reverb, chorus, drums, interpolation, polyphony, MIDI channels, gain, audio channels, audio groups, sample rate, and minimum note length.

```rust
pub struct SynthDescriptor {
    pub reverb_active: bool,
    pub chorus_active: bool,
    pub drums_channel_active: bool,
    pub interpolation: InterpolationMethod,
    pub polyphony: u16,
    pub midi_channels: u8,
    pub gain: f32,
    pub audio_channels: u8,
    pub audio_groups: u8,
    pub sample_rate: f32,
    pub min_note_length: u16,
}
```

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

### Create Owned Tuning

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Creates owned Tuning data from borrowed data, usually by cloning.

```rust
fn to_owned(&self) -> T
```

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

### Synth::nth_sound_font

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves a SoundFont by its index in the stack. The top of the stack is index 0.

```APIDOC
## Synth::nth_sound_font

### Description
Get a SoundFont by its index in the stack. The top of the stack has index zero.

### Method
`nth_sound_font(&self, num: usize) -> Option<&SoundFont>`

### Parameters
- **num** (usize) - The index of the SoundFont (0 <= num < sfcount).

### Response
- Option<&SoundFont>: A reference to the SoundFont if found, otherwise None.
```

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

### Send MIDI Event

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Sends a MIDI event to the synthesizer. This is the primary way to trigger notes, control changes, and other MIDI messages.

```rust
pub fn send_event(&mut self, event: MidiEvent) -> Result<(), OxiError>
```

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

### PartialEq Implementation for ReverbParams

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ReverbParams.html

Allows comparison of two ReverbParams instances for equality.

```rust
fn eq(&self, other: &ReverbParams) -> bool
```

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

### Any Trait Implementation for MidiEvent

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.MidiEvent.html

Provides runtime type information for MidiEvent. This is a blanket implementation for types that are 'static.

```rust
fn type_id(&self) -> TypeId {
    Gets the `TypeId` of `self`. Read more
    Source
}
```

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

### Select MIDI Bank

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Selects a MIDI bank for a given channel. This is typically used in conjunction with program changes to select specific instrument sounds.

```rust
pub fn select_bank(&mut self, channel: u8, bank: u32) -> Result<(), OxiError>
```

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

### Clone Tuning Into Existing

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Uses borrowed Tuning data to replace owned data, usually by cloning.

```rust
fn clone_into(&self, target: &mut T)
```

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

### Default Implementation for ReverbParams

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ReverbParams.html

Provides a default value for ReverbParams, useful for initializing with standard settings.

```rust
fn default() -> ReverbParams
```

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

### PartialEq Implementation for ChorusParams

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ChorusParams.html

Enables comparison of ChorusParams values for equality.

```rust
fn eq(&self, other: &ChorusParams) -> bool
```

```rust
fn ne(&self, other: &Rhs) -> bool
```

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

### Tuning::new_octave_tuning

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Creates a new octave-based tuning using the provided pitches, which represent deviations in cents from the well-tempered scale for each of the 12 notes in an octave.

```APIDOC
## Tuning::new_octave_tuning

### Description
Create a new octave-based tuning with given pitches. The array should contains derivation in cents from the well-tempered scale. For example, if pitches[0] equals -33, then the C-keys will be tuned 33 cents below the well-tempered C.

### Signature
`pub fn new_octave_tuning(pitch: &[f64; 12]) -> Self`

### Parameters
* `pitch` - A slice of 12 f64 values representing the deviation in cents from the well-tempered scale for each note in an octave.
```

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

### Set Synth Sample Rate

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Configures the sample rate for the synthesizer. This affects the quality and performance of the audio output.

```rust
pub fn set_sample_rate(&mut self, sample_rate: f32)
```

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

### Synth::sound_font_count

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Returns the total number of SoundFonts currently loaded in the synthesizer.

```APIDOC
## Synth::sound_font_count

### Description
Count the number of loaded SoundFonts.

### Method
`sound_font_count(&self) -> usize`

### Parameters
None

### Response
- usize: The number of loaded SoundFonts.
```

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

### Synth::add_font

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Loads a SoundFont into the synthesizer. The newly loaded SoundFont is placed on top of the SoundFont stack, affecting preset searching order.

```APIDOC
## Synth::add_font

### Description
Loads a SoundFont. The newly loaded SoundFont will be put on top of the SoundFont stack. Presets are searched starting from the SoundFont on the top of the stack, working the way down the stack until a preset is found.

### Method
`add_font(&mut self, font: SoundFont, reset_presets: bool) -> SoundFontId`

### Parameters
- **font** (SoundFont) - The SoundFont to load.
- **reset_presets** (bool) - Whether to reset presets after loading.

### Response
- SoundFontId: The ID of the newly loaded SoundFont.
```

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

### set_tuning

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Selects a tuning for a specified channel.

```APIDOC
## pub fn set_tuning

### Description
Select a tuning for a channel.

### Method
`&mut self`

### Parameters
- **chan** (`u8`) - Description: The channel to set the tuning for.
- **tuning** (`Option<Tuning>`) - Description: The tuning to apply. `None` to reset.

### Returns
- **Result<(), OxiError>**: Ok if successful, or an OxiError if the tuning could not be set.
```

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

### Preset Struct Definition

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Preset.html

Defines the structure of a Preset, which holds configuration for sound synthesis. The fields are private.

```rust
pub struct Preset { /* private fields */ }
```

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

### Default Implementation for ChorusParams

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ChorusParams.html

Provides a default value for ChorusParams.

```rust
fn default() -> ChorusParams
```

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

### Debug Implementation for ChorusParams

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ChorusParams.html

Enables formatting ChorusParams for debugging purposes.

```rust
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
```

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

### SoundFont Struct Definition

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.SoundFont.html

Defines the SoundFont struct with private fields. This is the basic structure for representing a SoundFont file.

```rust
pub struct SoundFont { /* private fields */ }
```

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

### Synth::send_event

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Sends a MIDI event to the synthesizer for processing. This is the primary way to trigger sounds and control parameters via MIDI.

```APIDOC
## Synth::send_event

### Description
Sends a MIDI event to the synthesizer.

### Method
`send_event(&mut self, event: MidiEvent) -> Result<(), OxiError>`

### Parameters
- **event** (MidiEvent) - The MIDI event to send.

### Response
- Result<(), OxiError>: Ok if the event was processed successfully, or an OxiError if there was an issue.
```

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

### Set Pitch Wheel Sensitivity

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Configures the sensitivity of the pitch wheel for a specific MIDI channel. This determines the range of pitch change per semitone.

```rust
pub fn set_pitch_wheel_sensitivity( &mut self, channel: u8, val: u8, ) -> Result<(), OxiError>
```

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

### Synth::pitch_wheel_sensitivity

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the current pitch wheel sensitivity setting for a specific MIDI channel.

```APIDOC
## Synth::pitch_wheel_sensitivity

### Description
Get the pitch wheel sensitivity for a specific MIDI channel.

### Method
`pitch_wheel_sensitivity(&self, channel: u8) -> Result<u8, OxiError>`

### Parameters
- **channel** (u8) - The MIDI channel (0-15).

### Response
- Result<u8, OxiError>: The sensitivity value if successful, or an OxiError if the channel is invalid.
```

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

### set_reverb_params

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Sets the parameters for the built-in reverb unit.

```APIDOC
## pub fn set_reverb_params

### Description
Set the parameters for the built-in reverb unit.

### Method
`&mut self`

### Parameters
- **params** (`&ReverbParams`) - Description: The new reverb parameters to apply.
```

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

### ChorusParams Struct Definition

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ChorusParams.html

Defines the structure for Chorus parameters, including number, level, speed, depth, and mode.

```rust
pub struct ChorusParams {
    pub nr: u32,
    pub level: f32,
    pub speed: f32,
    pub depth: f32,
    pub mode: ChorusMode,
}
```

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

### Clone Implementation for ReverbParams

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ReverbParams.html

Enables creating a duplicate of a ReverbParams instance.

```rust
fn clone(&self) -> ReverbParams
```

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

### Synth::select_sound_font

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Selects a SoundFont for a specific MIDI channel. This determines which SoundFont is used for rendering on that channel.

```APIDOC
## Synth::select_sound_font

### Description
Select a sfont for a given channel. This function allows to select a SoundFont for a specific MIDI channel.

### Method
`select_sound_font(&mut self, channel: u8, sfont_id: SoundFontId) -> Result<(), OxiError>`

### Parameters
- **channel** (u8) - The MIDI channel (0-15).
- **sfont_id** (SoundFontId) - The ID of the SoundFont to select.

### Response
- Result<(), OxiError>: Ok if successful, or an OxiError if the channel or SoundFont ID is invalid.
```

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

### chorus_params

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Queries the current parameters of the built-in chorus effect.

```APIDOC
## pub fn chorus_params

### Description
Query the current chorus params.

### Method
`&self`

### Returns
- **ChorusParams**: The current chorus parameters.
```

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

### ReverbParams Struct Definition

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ReverbParams.html

Defines the structure for reverb parameters, including room size, damping, width, and level.

```rust
pub struct ReverbParams {
    pub roomsize: f32,
    pub damp: f32,
    pub width: f32,
    pub level: f32,
}
```

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

### Into Trait Implementation for MidiEvent

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.MidiEvent.html

A blanket implementation of the Into trait, allowing conversion to any type U for which a From<T> for U implementation exists.

```rust
fn into(self) -> U {
    Calls `U::from(self)`.
    That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.
    Source
}
```

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

### Tuning Struct Definition

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Defines the private structure of the Tuning.

```rust
pub struct Tuning {
  /* private fields */
}
```

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

### Deprecated Description Method for RangeError

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.RangeError.html

Includes the deprecated description() method from the Error trait for RangeError. Use Display or to_string() instead.

```rust
fn description(&self) -> &str
```

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

### Clone Implementation for ChorusParams

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ChorusParams.html

Provides methods to duplicate and copy ChorusParams values.

```rust
fn clone(&self) -> ChorusParams
```

```rust
fn clone_from(&mut self, source: &Self)
```

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

### Set Master Gain

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Sets the master output gain for the synthesizer. This controls the overall volume of the audio output.

```rust
pub fn set_gain(&mut self, gain: f32)
```

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

### Synth Struct Definition

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Defines the basic structure of the synthesizer. It contains private fields and is typically instantiated using Synth::new().

```rust
pub struct Synth { /* private fields */ }
```

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

### reverb_params

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Queries the current parameters of the built-in reverb effect.

```APIDOC
## pub fn reverb_params

### Description
Query the current reverb params.

### Method
`&self`

### Returns
- **ReverbParams**: The current reverb parameters.
```

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

### Tuning::as_slice

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Returns an immutable reference to the internal pitch data as a slice of 128 f64 values.

```APIDOC
## Tuning::as_slice

### Description
Returns an immutable reference to the internal pitch data as a slice of 128 f64 values.

### Signature
`pub fn as_slice(&self) -> &[f64; 128]`
```

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

### Synth::channel_count

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Returns the number of MIDI channels the synthesizer is configured to use internally.

```APIDOC
## Synth::channel_count

### Description
Returns the number of MIDI channels that the synthesizer uses internally.

### Method
`channel_count(&self) -> usize`

### Parameters
None

### Response
- usize: The number of internal MIDI channels.
```

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

### Synth::select_bank

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Selects a MIDI bank for a specific channel. This is often used in conjunction with program changes.

```APIDOC
## Synth::select_bank

### Description
Select a MIDI bank for a specific channel.

### Method
`select_bank(&mut self, channel: u8, bank: u32) -> Result<(), OxiError>`

### Parameters
- **channel** (u8) - The MIDI channel (0-15).
- **bank** (u32) - The bank number to select.

### Response
- Result<(), OxiError>: Ok if successful, or an OxiError if the channel or bank is invalid.
```

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

### Set Bank Offset for SoundFont

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Applies an offset to the bank numbers within a specific SoundFont. This can be used to remap bank numbers without modifying the SoundFont itself.

```rust
pub fn set_bank_offset(&mut self, sfont_id: SoundFontId, offset: u32)
```

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

### SoundFontId Struct Definition (Private Fields)

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/type.SoundFontId.html

Shows the underlying struct definition for SoundFontId, indicating it has private fields. This is often used for internal representation.

```rust
pub struct SoundFontId { /* private fields */ }
```

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

### Tuning::as_slice_mut

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Returns a mutable reference to the internal pitch data as a slice of 128 f64 values, allowing modification.

```APIDOC
## Tuning::as_slice_mut

### Description
Returns a mutable reference to the internal pitch data as a slice of 128 f64 values, allowing modification.

### Signature
`pub fn as_slice_mut(&mut self) -> &mut [f64; 128]`
```

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

### Synth::sound_font

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves a SoundFont by its unique ID.

```APIDOC
## Synth::sound_font

### Description
Get a SoundFont specified by its ID.

### Method
`sound_font(&self, id: SoundFontId) -> Option<&SoundFont>`

### Parameters
- **id** (SoundFontId) - The ID of the SoundFont to retrieve.

### Response
- Option<&SoundFont>: A reference to the SoundFont if found, otherwise None.
```

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

### Synth::set_sample_rate

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Sets the sample rate for the synthesizer. This affects the audio output quality and performance.

```APIDOC
## Synth::set_sample_rate

### Description
Set synth sample rate.

### Method
`set_sample_rate(&mut self, sample_rate: f32)`

### Parameters
- **sample_rate** (f32) - The desired sample rate (e.g., 44100.0).
```

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

### PartialEq Trait Implementation for MidiEvent

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.MidiEvent.html

Enables comparison of two MidiEvent values for equality. This is used by the equality operator (==).

```rust
fn eq(&self, other: &MidiEvent) -> bool {
    Tests for `self` and `other` values to be equal, and is used by `==`.
    1.0.0 · Source
}
```

```rust
fn ne(&self, other: &Rhs) -> bool {
    Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
    Source
}
```

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

### From Trait Implementation for MidiEvent

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.MidiEvent.html

A blanket implementation of the From trait for any type T, returning the type itself. This allows converting a value into itself.

```rust
fn from(t: T) -> T {
    Returns the argument unchanged.
    Source
}
```

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

### Set Polyphony Limit

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Sets the maximum number of simultaneous notes (polyphony) the synthesizer can produce. Exceeding this limit may cause notes to be cut off.

```rust
pub fn set_polyphony(&mut self, polyphony: u16) -> Result<(), OxiError>
```

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

### Synth::gain

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the current master gain level of the synthesizer's audio output.

```APIDOC
## Synth::gain

### Description
Get the master gain.

### Method
`gain(&self) -> f32`

### Parameters
None

### Response
- f32: The current master gain level.
```

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

### TryInto Trait Implementation for MidiEvent

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.MidiEvent.html

A blanket implementation of the TryInto trait, allowing fallible conversion from type T to U, provided U implements TryFrom<T>.

```rust
type Error = <U as TryFrom<T>>::Error;

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error> {
    Performs the conversion.
    Source
}
```

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

### Default Tuning Value

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Tuning.html

Returns the default value for the Tuning type.

```rust
fn default() -> Self
```

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

### Borrow Trait Implementation for MidiEvent

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.MidiEvent.html

Allows borrowing a MidiEvent as a reference to another type. This is a blanket implementation.

```rust
fn borrow(&self) -> &T {
    Immutably borrows from an owned value. Read more
    Source
}
```

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

### TryFrom Trait Implementation for MidiEvent

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.MidiEvent.html

A blanket implementation of the TryFrom trait, allowing fallible conversion from type U to T, provided U implements Into<T>. The error type is Infallible.

```rust
type Error = Infallible;

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> {
    Performs the conversion.
    Source
}
```

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

### Synth::set_gain

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Sets the master gain level for the synthesizer's audio output.

```APIDOC
## Synth::set_gain

### Description
Set the master gain.

### Method
`set_gain(&mut self, gain: f32)`

### Parameters
- **gain** (f32) - The master gain level (typically between 0.0 and 1.0).
```

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

### Set Generator Parameter

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Changes the value of a synthesis generator parameter for a specific MIDI channel. This allows real-time control over synthesis characteristics, similar to sending NRPN messages.

```rust
pub fn set_gen( &mut self, chan: usize, param: GeneratorType, value: f32, ) -> Result<(), OxiError>
```

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

### Clone Trait Implementation for MidiEvent

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.MidiEvent.html

Provides the ability to create a duplicate of a MidiEvent value. This is a standard implementation for types that can be copied.

```rust
fn clone(&self) -> MidiEvent {
    Returns a duplicate of the value. Read more
    1.0.0 · Source
}
```

```rust
fn clone_from(&mut self, source: &Self) {
    Performs copy-assignment from `source`. Read more
    Source
}
```

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

### Synth::set_polyphony

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Sets the maximum number of simultaneous voices (polyphony) the synthesizer can produce. This helps manage CPU resources.

```APIDOC
## Synth::set_polyphony

### Description
Set the polyphony limit.

### Method
`set_polyphony(&mut self, polyphony: u16) -> Result<(), OxiError>`

### Parameters
- **polyphony** (u16) - The maximum number of simultaneous voices.

### Response
- Result<(), OxiError>: Ok if successful, or an OxiError if the polyphony value is invalid.
```

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

### Display Implementation for RangeError

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.RangeError.html

Provides a Display implementation for the RangeError enum, enabling user-friendly string representations.

```rust
impl<T: Debug> Display for RangeError<T>
fn fmt(&self, f: &mut Formatter<'_>) -> Result
```

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

### InterpolationMethod Enum Definition

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.InterpolationMethod.html

Defines the available interpolation methods for audio processing. Each variant corresponds to a specific interpolation algorithm with associated performance and quality characteristics.

```rust
pub enum InterpolationMethod {
    None = 0,
    Linear = 1,
    FourthOrder = 4,
    SeventhOrder = 7,
}
```

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

### Synth::bank_offset

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the current bank number offset for a given SoundFont.

```APIDOC
## Synth::bank_offset

### Description
Get the offset of the bank numbers in a SoundFont.

### Method
`bank_offset(&self, sfont_id: SoundFontId) -> Option<u32>`

### Parameters
- **sfont_id** (SoundFontId) - The ID of the SoundFont to query.

### Response
- Option<u32>: The bank offset if set, otherwise None.
```

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

### Remove a SoundFont

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Removes a SoundFont from the stack by its ID and deallocates it. Optionally resets presets if `reset_presets` is true.

```rust
pub fn remove_font( &mut self, id: SoundFontId, reset_presets: bool, ) -> Option<SoundFont>
```

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

### Synth::pitch_bend

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the current pitch bend value for a specific MIDI channel.

```APIDOC
## Synth::pitch_bend

### Description
Get the pitch bend value for a specific MIDI channel.

### Method
`pitch_bend(&self, channel: u8) -> Result<u16, OxiError>`

### Parameters
- **channel** (u8) - The MIDI channel (0-15).

### Response
- Result<u16, OxiError>: The pitch bend value (0-16383) if successful, or an OxiError if the channel is invalid.
```

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

### SettingsError Enum Definition

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.SettingsError.html

Defines the possible errors related to settings configuration in oxisynth. Each variant represents a specific type of configuration issue.

```rust
pub enum SettingsError {
    PolyphonyRange(RangeError<u16>),
    GainRange(RangeError<f32>),
    AudioChannelRange(RangeError<u8>),
    AudioGroupsRange(RangeError<u8>),
    SammpleRateRange(RangeError<f32>),
    MidiChannelsIsNotMultipleOf16,
}
```

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

### TryFrom Trait Implementation

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ChorusParams.html

Attempts to convert a value of type U into type T, returning a Result.

```rust
type Error = Infallible
```

```rust
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
```

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

### set_interpolation_method

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Sets the interpolation method for audio sample generation. This can be applied to a specific channel or all channels.

```APIDOC
## pub fn set_interpolation_method

### Description
Set the interpolation method for one channel (`Some(chan)`) or all channels (`None`).

### Method
`&mut self`

### Parameters
- **chan** (`Option<usize>`) - Description: Channel to apply the method to. `None` for all channels.
- **interp_method** (`InterpolationMethod`) - Description: The interpolation method to set.
```

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

### BorrowMut Trait Implementation for MidiEvent

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.MidiEvent.html

Allows mutable borrowing of a MidiEvent. This is a blanket implementation.

```rust
fn borrow_mut(&mut self) -> &mut T {
    Mutably borrows from an owned value. Read more
    Source
}
```

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

### Debug Implementation for RangeError

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.RangeError.html

Provides a Debug implementation for the RangeError enum, allowing it to be formatted for debugging purposes.

```rust
impl<T: Debug> Debug for RangeError<T>
fn fmt(&self, f: &mut Formatter<'_>) -> Result
```

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

### Synth::set_pitch_wheel_sensitivity

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Sets the pitch wheel sensitivity for a specific MIDI channel. This determines the range of the pitch bend effect.

```APIDOC
## Synth::set_pitch_wheel_sensitivity

### Description
Set the pitch wheel sensitivity for a specific MIDI channel.

### Method
`set_pitch_wheel_sensitivity(&mut self, channel: u8, val: u8) -> Result<(), OxiError>`

### Parameters
- **channel** (u8) - The MIDI channel (0-15).
- **val** (u8) - The sensitivity value (typically 2 semitones).

### Response
- Result<(), OxiError>: Ok if successful, or an OxiError if the channel is invalid.
```

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

### ToOwned Trait Implementation for MidiEvent

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.MidiEvent.html

Provides a way to create an owned version of a MidiEvent from a borrowed reference, typically by cloning. Requires MidiEvent to implement Clone.

```rust
type Owned = T;

fn to_owned(&self) -> T {
    Creates owned data from borrowed data, usually by cloning. Read more
    Source
}

fn clone_into(&self, target: &mut T) {
    Uses borrowed data to replace owned data, usually by cloning. Read more
    Source
}
```

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

### SoundFontId Type Alias Definition

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/type.SoundFontId.html

Defines SoundFontId as an alias for Index<SoundFont>. This is the primary declaration of the type alias.

```rust
pub type SoundFontId = Index<SoundFont>;
```

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

### Synth::polyphony

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Retrieves the current polyphony limit (maximum number of simultaneous voices) set for the synthesizer.

```APIDOC
## Synth::polyphony

### Description
Get the polyphony limit (FluidSynth >= 1.0.6).

### Method
`polyphony(&self) -> u32`

### Parameters
None

### Response
- u32: The current polyphony limit.
```

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

### Into Trait Implementation

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.ChorusParams.html

Converts a value of type T into type U, provided U implements From<T>.

```rust
fn into(self) -> U
```

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

### Synth::remove_font

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/struct.Synth.html

Removes a SoundFont from the stack and deallocates it. This can affect preset availability.

```APIDOC
## Synth::remove_font

### Description
Removes a SoundFont from the stack and deallocates it.

### Method
`remove_font(&mut self, id: SoundFontId, reset_presets: bool) -> Option<SoundFont>`

### Parameters
- **id** (SoundFontId) - The ID of the SoundFont to remove.
- **reset_presets** (bool) - Whether to reset presets after removal.

### Response
- Option<SoundFont>: The removed SoundFont if found, otherwise None.
```

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

### MidiEvent Enum Definition

Source: https://docs.rs/oxisynth/0.1.0/oxisynth/enum.MidiEvent.html

Defines the different types of MIDI events that can be represented. Each variant corresponds to a specific MIDI message type with its relevant parameters.

```rust
pub enum MidiEvent {
    NoteOn {
        channel: u8,
        key: u8,
        vel: u8,
    },
    NoteOff {
        channel: u8,
        key: u8,
    },
    ControlChange {
        channel: u8,
        ctrl: u8,
        value: u8,
    },
    AllNotesOff {
        channel: u8,
    },
    AllSoundOff {
        channel: u8,
    },
    PitchBend {
        channel: u8,
        value: u16,
    },
    ProgramChange {
        channel: u8,
        program_id: u8,
    },
    ChannelPressure {
        channel: u8,
        value: u8,
    },
    PolyphonicKeyPressure {
        channel: u8,
        key: u8,
        value: u8,
    },
    SystemReset,
}
```
Tokens:
Raw