Class: SDC::Music

Inherits:

Object

• Object
• SDC::Music

Defined in:

engine_docs/automatic_doc_Music.rb,
engine_docs/automatic_doc_Music.rb

Overview

Music track class

Instance Attribute Summary

• #looping ⇒ Boolean

  Looping property of the music track.

• #pitch ⇒ Float

  Pitch of the music track, with default 1.0.

• #volume ⇒ Float

  Volume of the music track, ranging from 0 to 100 (default).

Instance Method Summary

• #initialize ⇒ Music constructor

  Creates a music track (without content).

• #open_from_file(filename) ⇒ Boolean

  Loads the music track from file, returning true if loading was successful, else false.

• #pause ⇒ nil

  Pauses the music track if running.

• #play ⇒ nil

  Plays the music track from the beginning or resumes it if paused.

• #stop ⇒ nil

  Stops the music track if running.

Constructor Details

#initialize ⇒ Music

Creates a music track (without content)

# File 'engine_docs/automatic_doc_Music.rb', line 9

Instance Attribute Details

#looping ⇒ Boolean

Looping property of the music track

Returns:

• (Boolean)

# File 'engine_docs/automatic_doc_Music.rb', line 29

#pitch ⇒ Float

Pitch of the music track, with default 1.0

Returns:

• (Float)

# File 'engine_docs/automatic_doc_Music.rb', line 33

#volume ⇒ Float

Volume of the music track, ranging from 0 to 100 (default)

Returns:

• (Float)

# File 'engine_docs/automatic_doc_Music.rb', line 37

Instance Method Details

#open_from_file(filename) ⇒ Boolean

Loads the music track from file, returning true if loading was successful, else false.

Parameters:

• filename (String)

Returns:

• (Boolean)

# File 'engine_docs/automatic_doc_Music.rb', line 41

#pause ⇒ nil

Pauses the music track if running

Returns:

• (nil)

# File 'engine_docs/automatic_doc_Music.rb', line 24

#play ⇒ nil

Plays the music track from the beginning or resumes it if paused

Returns:

• (nil)

# File 'engine_docs/automatic_doc_Music.rb', line 14

#stop ⇒ nil

Stops the music track if running

Returns:

• (nil)

# File 'engine_docs/automatic_doc_Music.rb', line 19