class Gosu::Channel

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.

Defined in:

gosu/channel.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pointer : Pointer(UInt8)) #

[View source]

Instance Method Detail

def pan=(double : Float64) #

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.


[View source]
def pause #

Pauses the sample, to be resumed afterwards.

NOTE The sample will still occupy a playback channel while paused.


[View source]
def paused? #

Returns whether the sample is paused.


[View source]
def playing? #

Returns whether the sample is playing.


[View source]
def resume #

Resumes playback of the sample.


[View source]
def speed=(double : Float64) #

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.


[View source]
def stop #

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.


[View source]
def volume=(double : Float64) #

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


[View source]