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.)



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

def initialize(filename); end

Class Attribute Details

.current_songGosu::Song? (readonly)

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



594
595
596
# File 'rdoc/gosu.rb', line 594

def current_song
  @current_song
end

Instance Attribute Details

#volumeFloat



599
600
601
# File 'rdoc/gosu.rb', line 599

def volume
  @volume
end

Instance Method Details

#pausevoid

This method returns an undefined value.

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



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

def pause; end

#paused?true, false

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



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

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.



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

def play(looping=false); end

#playing?true, false



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

def playing?; end

#stopvoid

This method returns an undefined value.

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



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

def stop; end