Class: Gosu::Channel

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

Overview

Sample#play returns a Channel that represents the sound currently being played.

This object can be used to stop sounds dynamically, or to check whether they have finished.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#pan=(value) ⇒ Float (writeonly)

Set the amount of panning, i.e. the position of the sound when using stereo speakers. 0.0 is the centre, negative values are to the left, positive values are to the right. If something happens on the edge of the screen, a good value for pan would be ±0.1.

Parameters:

  • (Float)

Returns:

  • (Float) 

573
574
575
 
# File 'rdoc/gosu.rb', line 573

def pan=(value)
  @pan = value
end

#speed=(value) ⇒ Float (writeonly)

Sets the playback speed. A value of 2.0 will play the sample at 200% speed and one octave higher. A value of 0.5 will play the sample at 50% speed and one octave lower. The valid range of this property depends on the operating system, but values up to 8.0 should work.

Parameters:

  • (Float)

Returns:

  • (Float) 

567
568
569
 
# File 'rdoc/gosu.rb', line 567

def speed=(value)
  @speed = value
end

#volume=(value) ⇒ Float (writeonly)

Sets the playback volume, in the range [0.0; 1.0], where 0 is completely silent and 1 is full volume. Values outside of this range will be clamped to [0.0; 1.0].

Parameters:

  • (Float)

Returns:

  • (Float) 

561
562
563
 
# File 'rdoc/gosu.rb', line 561

def volume=(value)
  @volume = value
end

Instance Method Details

#pause ⇒ void

Note:

The sample will still occupy a playback channel while paused.

This method returns an undefined value.

Pauses the sample, to be resumed afterwards.


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

def pause; end

#paused? ⇒ true, false

Returns whether the sample is paused.

Returns:

  • (true, false) —

    whether the sample is paused.


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

def paused?; end

#playing? ⇒ true, false

Returns whether the sample is playing.

Returns:

  • (true, false) —

    whether the sample is playing.


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

def playing?; end

#resume ⇒ void

This method returns an undefined value.

Resumes playback of the sample.


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

def resume; end

#stop ⇒ void

This method returns an undefined value.

Stops playback of this sample instance. After calling this method, the sample instance is useless and can be discarded.

Calling `stop` after the sample has finished is harmless and has no effect.


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

def stop; end