Source:queue

Available since LÖVE 11.0
This function is not supported in earlier versions.

Queues SoundData for playback in a queueable Source.

This method requires the Source to be created via love.audio.newQueueableSource.

Function

Synopsis

success = Source:queue( soundData, length )

Arguments

SoundData soundData
The data to queue. The SoundData's sample rate, bit depth, and channel count must match the Source's.
number length (sounddata:getSize())
Length in bytes to queue.

Returns

boolean success
True if the data was successfully queued for playback, false if there were no available buffers to use for queueing.

Function

Synopsis

success = Source:queue( soundData, offset, length )

Arguments

SoundData soundData
The data to queue. The SoundData's sample rate, bit depth, and channel count must match the Source's.
number offset
Starting position in bytes to queue.
number length
Length in bytes to queue starting from specified offset.

Returns

boolean success
True if the data was successfully queued for playback, false if there were no available buffers to use for queueing.

Notes

To convert sample unit to bytes, multiply the sample unit by SoundData:getBitDepth() * SoundData:getChannelCount() / 8.

See Also

© 2006–2020 LÖVE Development Team
Licensed under the GNU Free Documentation License, Version 1.3.
https://love2d.org/wiki/Source:queue