wavex v0.14.1 Wavex.Chunk.Format

A format chunk.

Link to this section Summary

Types

t()

Functions

four_cc()

read(binary)

Read a format chunk

Link to this section Types

t()

t() :: %Wavex.Chunk.Format{
  bits_per_sample: pos_integer(),
  block_align: pos_integer(),
  byte_rate: pos_integer(),
  channels: pos_integer(),
  sample_rate: pos_integer()
}

Link to this section Functions

four_cc()

four_cc() :: Wavex.FourCC.t()

read(binary)

read(binary()) ::
  {:ok, t(), binary()}
  | {:error,
     Wavex.Error.BlockAlignMismatch.t()
     | Wavex.Error.ByteRateMismatch.t()
     | Wavex.Error.UnexpectedEOF.t()
     | Wavex.Error.UnexpectedFormatSize.t()
     | Wavex.Error.UnexpectedFourCC.t()
     | Wavex.Error.UnsupportedBitrate.t()
     | Wavex.Error.UnsupportedFormat.t()
     | Wavex.Error.ZeroChannels.t()}

Read a format chunk.