Decoder

An object which can gradually decode a sound file.

Constructors

love.sound.newDecoder

Attempts to find a decoder for the encoded sound data in the specified file.

Functions

Decoder:clone	Create new copy of existing decoder.	11.3
Decoder:decode	Decodes a chunk of audio data to a SoundData.	11.0
Decoder:getBitDepth	Returns the number of bits per sample.	0.9.0
Decoder:getBits	Returns the number of bits per sample.		0.9.0
Decoder:getChannelCount	Returns the number of channels in the stream.	11.0
Decoder:getChannels	Returns the number of channels in the stream.		11.0
Decoder:getDuration	Gets the duration of the sound file.	0.10.0
Decoder:getSampleRate	Returns the sample rate of the Decoder.
Decoder:seek	Sets the currently playing position of the Decoder.	11.0
Object:release	Immediately destroys the object's Lua reference.	11.0
Object:type	Gets the type of the object as a string.
Object:typeOf	Checks whether an object is of a certain type.

Supertypes

• Object

Examples

Streaming music to a queueable Source

local decoder = love.sound.newDecoder("music.ogg")
local queueableSource = love.audio.newQueueableSource(decoder:getSampleRate(), decoder:getBitDepth(), decoder:getChannelCount())

local function buffer(loop)
  local freeBufferCount = queueableSource:getFreeBufferCount()
  for i = 1, freeBufferCount do
    local soundData = decoder:decode()
    if not soundData then
      -- the decoder reached the end of the file!
      if not loop then
        return
      end

      -- Reset the decoder to the start and decode from the start
      decoder:seek(0)
      soundData = decoder:decode()
    end
    queueableSource:queue(soundData)
  end
end

function love.load()
  -- when the queueable Source has no buffers left to process it stops playing
  -- buffer some data before starting to play!
  buffer(true)
  queueableSource:play()
end

function love.update(dt)
  -- keep buffering so it doesn't stop
  buffer(true)
end

See Also

• love.sound

Other Languages

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info