Source

A Source represents audio you can play back. You can do interesting things with Sources, like set the volume, pitch, and its position relative to the listener. Please note that positional audio only works for mono (i.e. non-stereo) sources.

The Source controls (play/pause/etc) act according to the following state table.

Stopped Playing Paused
play() Play No change Play
stop() No change Stop + Rewind Stop + Rewind
pause() No change Pause No change
resume() No change No change Play
rewind() No change Rewind + Play Rewind + Pause

And for fans of flowcharts (note: omitted calls have no effect, rewind does).

SourceControls.png

Constructors

love.audio.newSource Creates a new Source from a file, SoundData, or Decoder.

Functions

Object:type Gets the type of the object as a string.
Object:typeOf Checks whether an object is of a certain type.
Source:clone Creates an identical copy of the Source in the stopped state. Added since 0.9.1
Source:getAttenuationDistances Gets the reference and maximum attenuation distances of the Source. Added since 0.9.0
Source:getChannels Gets the number of channels in the Source. Added since 0.9.0
Source:getCone Gets the Source's directional volume cones. Added since 0.9.0
Source:getDirection Gets the direction of the Source. Added since 0.7.0
Source:getDistance Returns the reference and maximum distance of the source. Added since 0.8.0 Removed in 0.9.0
Source:getDuration Gets the duration of the Source. Added since 0.10.0
Source:getPitch Gets the current pitch of the Source.
Source:getPosition Gets the position of the Source. Added since 0.7.0
Source:getRolloff Returns the rolloff factor of the source. Added since 0.8.0
Source:getType Gets the type (static or stream) of the Source. Added since 0.10.0
Source:getVelocity Gets the velocity of the Source. Added since 0.7.0
Source:getVolume Gets the current volume of the Source.
Source:getVolumeLimits Returns the volume limits of the source. Added since 0.8.0
Source:isLooping Returns whether the Source will loop.
Source:isPaused Returns whether the Source is paused.
Source:isPlaying Returns whether the Source is playing. Added since 0.9.0
Source:isRelative Gets whether the Source's position and direction are relative to the listener. Added since 0.9.0
Source:isStatic Returns whether the Source is static. Added since 0.7.0 Removed in 0.10.0
Source:isStopped Returns whether the Source is stopped.
Source:pause Pauses a source. Added since 0.7.0
Source:play Plays a source. Added since 0.7.0
Source:resume Resumes a paused source. Added since 0.7.0
Source:rewind Rewinds a source. Added since 0.7.0
Source:seek Sets the currently playing position of the Source. Added since 0.8.0
Source:setAttenuationDistances Sets the reference and maximum attenuation distances of the Source. Added since 0.9.0
Source:setCone Sets the Source's directional volume cones. Added since 0.9.0
Source:setDirection Sets the direction of the Source. Added since 0.7.0
Source:setDistance Sets the reference and maximum distance of the source. Added since 0.8.0 Removed in 0.9.0
Source:setLooping Sets whether the Source should loop.
Source:setPitch Sets the pitch of the Source.
Source:setPosition Sets the position of the Source. Added since 0.7.0
Source:setRelative Sets whether the Source's position and direction are relative to the listener. Added since 0.9.0
Source:setRolloff Sets the rolloff factor. Added since 0.8.0
Source:setVelocity Sets the velocity of the Source. Added since 0.7.0
Source:setVolume Sets the current volume of the Source.
Source:setVolumeLimits Sets the volume limits of the source. Added since 0.8.0
Source:stop Stops a source. Added since 0.7.0
Source:tell Gets the currently playing position of the Source. Added since 0.8.0

Supertypes

See Also


Other Languages