Interflow

https://solarliner.dev/interflow/interflow
Admin
Interflow is a Rust library that abstracts platform-specific audio APIs, providing a unified...
Tokens:988
Snippets:10
Trust Score:5.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Interflow Modules API Reference

Source: https://solarliner.dev/interflow/interflow/interflow

Documentation for the core modules provided by the `interflow` Rust library, detailing their purpose and functionality.

```APIDOC
Modules:
  audio_buffer:
    Description: Audio buffer types and traits for audio data manipulation.
  backends:
    Description: Backends
  channel_map:
    Description: This module provides functionality for working with bitsets and channel mapping.
  duplex:
    Description: Module for simultaneous input/output audio processing
  prelude:
    Description: Prelude module for `interflow`. Use as a star-import.
  timestamp:
    Description: Module for handling timestamp and duration calculations in audio processing.
```

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

### Interflow Structs API Reference

Source: https://solarliner.dev/interflow/interflow/interflow

Documentation for the key data structures (structs) within the `interflow` Rust library, including their fields and purpose.

```APIDOC
Structs:
  AudioCallbackContext:
    Description: Plain-old-data object holding the passed-in stream configuration, as well as a general callback timestamp, which can be different from the input and output streams in case of cross-stream latencies; differences in timing can indicate desync.
  AudioInput:
    Description: Plain-old-data object holding references to the audio buffer and the associated time-keeping `Timestamp`. This timestamp is associated with the stream, and in the cases where the driver provides timing information, it is used instead of relying on sample-counting.
  AudioOutput:
    Description: Plain-old-data object holding references to the audio buffer and the associated time-keeping `Timestamp`. This timestamp is associated with the stream, and in the cases where the driver provides timing information, it is used instead of relying on sample-counting.
  Channel:
    Description: Audio channel description.
  DeviceType:
    Description: Represents the types/capabilities of an audio device.
  StreamConfig:
    Description: Configuration for an audio stream.
```

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

### Trait: AudioDevice

Source: https://solarliner.dev/interflow/interflow/interflow

Trait for types describing audio devices. Audio devices have zero or more inputs and outputs, and depending on the driver, can be duplex devices which can provide both of them at the same time natively.

```APIDOC
AudioDevice:
  Description: Trait for types describing audio devices. Audio devices have zero or more inputs and outputs, and depending on the driver, can be duplex devices which can provide both of them at the same time natively.
```

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

### Trait: AudioOutputDevice

Source: https://solarliner.dev/interflow/interflow/interflow

Trait for types which can provide output streams.

```APIDOC
AudioOutputDevice:
  Description: Trait for types which can provide output streams.
```

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

### Trait: AudioInputDevice

Source: https://solarliner.dev/interflow/interflow/interflow

Trait for types which can provide input streams.

```APIDOC
AudioInputDevice:
  Description: Trait for types which can provide input streams.
```

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

### Trait: AudioDriver

Source: https://solarliner.dev/interflow/interflow/interflow

Audio drivers provide access to the inputs and outputs of devices. Several drivers might provide the same accesses, some sharing it with other applications, while others work in exclusive mode.

```APIDOC
AudioDriver:
  Description: Audio drivers provide access to the inputs and outputs of devices. Several drivers might provide the same accesses, some sharing it with other applications, while others work in exclusive mode.
```

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

### Trait: AudioOutputCallback

Source: https://solarliner.dev/interflow/interflow/interflow

Trait of types which process output audio data. This is the trait that users will want to implement when processing an output device.

```APIDOC
AudioOutputCallback:
  Description: Trait of types which process output audio data. This is the trait that users will want to implement when processing an output device.
```

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

### Trait: AudioInputCallback

Source: https://solarliner.dev/interflow/interflow/interflow

Trait of types which process input audio data. This is the trait that users will want to implement when processing an input device.

```APIDOC
AudioInputCallback:
  Description: Trait of types which process input audio data. This is the trait that users will want to implement when processing an input device.
```

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

### Trait: AudioStreamHandle

Source: https://solarliner.dev/interflow/interflow/interflow

Trait for types which handles an audio stream (input or output).

```APIDOC
AudioStreamHandle:
  Description: Trait for types which handles an audio stream (input or output).
```

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

### Trait: SendEverywhereButOnWeb

Source: https://solarliner.dev/interflow/interflow/interflow

Marker trait for values which are Send everywhere but on the web (as WASM does not yet have web targets.

```APIDOC
SendEverywhereButOnWeb:
  Description: Marker trait for values which are Send everywhere but on the web (as WASM does not yet have web targets.
```
Tokens:
Raw