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.

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() Rewind 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:getDirection Gets the direction of the Source.
Source:getDistance Returns the reference and maximum distance of the source.
Source:getPitch Gets the current pitch of the Source.
Source:getPosition Gets the position of the Source.
Source:getRolloff Returns the rolloff factor of the source.
Source:getVelocity Gets the velocity of the Source.
Source:getVolume Gets the current volume of the Source.
Source:getVolumeLimits Returns the volume limits of the source.
Source:isLooping Returns whether the Source will loop.
Source:isPaused Returns whether the Source is paused.
Source:isStatic Returns whether the Source is static.
Source:isStopped Returns whether the Source is stopped.
Source:pause Pauses a source.
Source:play Plays a source.
Source:resume Resumes a paused source.
Source:rewind Rewinds a source.
Source:seek Sets the currently playing position of the Source.
Source:setDirection Sets the direction of the Source.
Source:setDistance Sets the reference and maximum distance of the source.
Source:setLooping Sets whether the Source should loop.
Source:setPitch Sets the pitch of the Source.
Source:setPosition Sets the position of the Source.
Source:setRolloff Sets the rolloff factor.
Source:setVelocity Sets the velocity of the Source.
Source:setVolume Sets the current volume of the Source.
Source:setVolumeLimits Sets the volume limits of the source.
Source:stop Stops a source.
Source:tell Gets the currently playing position of the Source.

Supertypes

Object

See Also


Other Languages

Personal tools