Class: SDC::Sound

Inherits:

Object

• Object
• SDC::Sound

Defined in:

engine_docs/automatic_doc_Sound.rb,
engine_docs/automatic_doc_Sound.rb

Overview

Sound class holding a sound buffer

Instance Attribute Summary

• #pitch ⇒ Float

  Pitch of the sound, with default 1.0.

• #volume ⇒ Float

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

Instance Method Summary

• #initialize ⇒ Sound constructor

  Creates a sound (without content).

• #link_sound_buffer(sound_buffer) ⇒ true

  Links a sound buffer to this sound.

• #play ⇒ nil

  Pauses the sound if running.

• #stop ⇒ nil

  Stops the sound if running.

Constructor Details

#initialize ⇒ Sound

Creates a sound (without content)

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

Instance Attribute Details

#pitch ⇒ Float

Pitch of the sound, with default 1.0

Returns:

• (Float)

# File 'engine_docs/automatic_doc_Sound.rb', line 34

#volume ⇒ Float

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

Returns:

• (Float)

# File 'engine_docs/automatic_doc_Sound.rb', line 30

Instance Method Details

#link_sound_buffer(sound_buffer) ⇒ true

Links a sound buffer to this sound

Parameters:

• sound_buffer (SoundBuffer)

Returns:

• (true)

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

#play ⇒ nil

Pauses the sound if running

Returns:

• (nil)

# File 'engine_docs/automatic_doc_Sound.rb', line 20

#stop ⇒ nil

Stops the sound if running

Returns:

• (nil)

# File 'engine_docs/automatic_doc_Sound.rb', line 25