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

- (Song) initialize(filename) - (Song) initialize(window, filename)

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.



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

def initialize(filename); end

Class Attribute Details

+ (Gosu::Song?) current_song (readonly)

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

Returns:



614
615
616
# File 'rdoc/gosu.rb', line 614

def current_song
  @current_song
end

Instance Attribute Details

- (Float) volume

Returns the song's playback volume.

Returns:

  • (Float)

    the song's playback volume.



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

def volume
  @volume
end

Instance Method Details

- (void) pause

This method returns an undefined value.

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



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

def pause; end

- (true, false) paused?

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

Returns:

  • (true, false)

    whether the song is paused.



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

def paused?; end

- (void) play(looping = false)

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.



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

def play(looping=false); end

- (true, false) playing?

Returns whether the song is playing.

Returns:

  • (true, false)

    whether the song is playing.



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

def playing?; end

- (void) stop

This method returns an undefined value.

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



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

def stop; end