vx.Song

From vx
Jump to: navigation, search

Contents

[edit] vx.Song

A looping music track that can be played, and has moderately advanced seeking and pausing capabilities.

[edit] Constructors

vx.Song(filename)

  • Tries to load a song from disk.

[edit] Attributes

vx.Song.volume -> number (read/write)

  • The volume of this song in the range 0-100.

vx.Song.position -> number (read/write)

  • The position in this song, which depends on the file format being played as far as what this number represents.

[edit] Methods

vx.Song:Free()

  • Destroys the song handle. Any further sound operations on this object will probably not end so pretty.

vx.Song:Play([volume])

  • Plays the song. If volume is not specified, it assumes 100.

vx.Song:Stop()

  • Stops the song.

vx.Song:Pause()

  • Pauses the song, keeping track of position for later resume

vx.Song:Resume()

  • Plays the song, resuming from the position it was paused from. It'll probably not resume if the song was fully stopped.
Personal tools