package mm

  1. Overview
  2. Docs
package mm
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Audio.RingbufferSource

Circular ringbuffers.

Sourcetype t

A ringbuffer.

Sourceval create : int -> int -> t

Create a ringbuffer of given number of channels and size (in samples).

Sourceval channels : t -> int

Number of channels of the ringbuffr.

Sourceval read_space : t -> int

Number of samples available for reading.

Sourceval write_space : t -> int

Number of samples available for writing.

Sourceval read_advance : t -> int -> unit

Advance the read pointer.

Sourceval write_advance : t -> int -> unit

Advance the write pointer.

Sourceval peek : t -> buffer -> unit

Fill in a buffer without changing read pointer.

Sourceval read : t -> buffer -> unit

Fill in a buffer and advance read pointer.

Sourceval write : t -> buffer -> unit

Write a buffer into the ringbuffer.

Sourceval transmit : t -> (buffer -> int) -> int
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct