API Reference

Complete reference for all SoundFile classes, functions, and enums.

Global Functions — sf_read, sf_write, sf_info, sf_check_format, sf_resample
SoundFile — Opened audio file handle with read, write, seek, blocks, and metadata
SfInfo — Immutable signal properties
SfMetadata — Immutable embedded string tags
Enums — AudioFormat, SampleFormat, FileMode, ResampleQuality
Exceptions — SoundFileException

Quick Reference

Global Functions

Function	Returns	Description
`sf_read(file, start?, stop?, always2d?, blocksize?)`	`[NDArray, SfInfo]`	Read audio file into NDArray
`sf_write(file, data, sampleRate, format?, subtype?)`	`void`	Write NDArray to audio file
`sf_info(file)`	`SfInfo`	Read file metadata without loading data
`sf_metadata(file)`	`SfMetadata`	Read string tags without loading audio
`sf_check_format(format, subtype)`	`bool`	Validate format/subtype compatibility
`sf_resample(data, inRate, outRate, quality?, chunkSize?)`	`NDArray`	Convert sample rate

SoundFile Instance

Method	Description
`read(?int $n)`	Read frames from current position
`write(NDArray $data)`	Write frames
`seek(int $offset, int $whence)`	Move position
`tell()`	Current position
`eof()`	End of file reached
`blocks(int $size)`	Generator yielding NDArrays
`close()`	Close the handle
`info()`	Full file metadata
`title()` / `setTitle()`	Metadata accessors

SfInfo

Method	Returns	Description
`duration()`	`float`	Duration in seconds
`nSamples()`	`int`	Total sample count
`withFrames($n)`	`self`	Builder — change frames