Class: Gosu::Song

Inherits:
Object
  • Object
show all
Defined in:
rdoc/gosu.rb

Overview

Songs are less flexible than samples in that only one can be played at a time, with no panning or speed control.

See Also:

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filename) ⇒ Song #initialize(window, filename) ⇒ Song

Loads a song from a file.

(Passing a Window reference is not necessary anymore, please use the first overload instead.)

Parameters:

  • filename (String) —

    the path to load the song from.


632
 
# File 'rdoc/gosu.rb', line 632

def initialize(filename); end

Class Attribute Details

.current_song ⇒ Gosu::Song? (readonly)

Returns the song currently being played (even if it's paused), or nil if no song is playing.

Returns:


616
617
618
 
# File 'rdoc/gosu.rb', line 616

def current_song
  @current_song
end

Instance Attribute Details

#volume ⇒ Float

Returns the song's playback volume.

Returns:

  • (Float) —

    the song's playback volume.


621
622
623
 
# File 'rdoc/gosu.rb', line 621

def volume
  @volume
end

Instance Method Details

#pause ⇒ void

This method returns an undefined value.

Pauses playback of the song. The current song is unchanged.


649
 
# File 'rdoc/gosu.rb', line 649

def pause; end

#paused? ⇒ true, false

Returns true if this song is the current song and playback is paused.

Returns:

  • (true, false) —

    whether the song is paused.


654
 
# File 'rdoc/gosu.rb', line 654

def paused?; end

#play(looping = false) ⇒ void

This method returns an undefined value.

Starts or resumes playback of the song.

If another song is currently playing, it will be stopped and this song will be set as the current song.

If `looping` is false, the current song will be set to `nil` when this song finishes.

Parameters:

  • looping (true, false) (defaults to: false) —

    whether the song should play in a loop.


643
 
# File 'rdoc/gosu.rb', line 643

def play(looping=false); end

#playing? ⇒ true, false

Returns whether the song is playing.

Returns:

  • (true, false) —

    whether the song is playing.


664
 
# File 'rdoc/gosu.rb', line 664

def playing?; end

#stop ⇒ void

This method returns an undefined value.

Stops playback if this song is the current song. The current song is set to `nil`.


660
 
# File 'rdoc/gosu.rb', line 660

def stop; end