HGamer3D-SFML-Binding-0.1.9: Windows Game Engine for the Haskell Programmer - SFML Bindings

Safe HaskellNone

HGamer3D.Bindings.SFML.ClassSoundStream

Synopsis

Documentation

deleteSource

Arguments

:: HG3DClass

classpointer - pointer of Class instance which is going to be deleted.

-> IO () 

Destructor.

playSource

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO () 

Pause the audio stream. - Details: This function pauses the stream if it was playing, otherwise (stream already paused or stopped) it has no effect.

Start or resume playing the audio stream. - Details: This function starts the stream if it was stopped, resumes it if it was paused, and restarts it from beginning if it was it already playing. This function uses its own thread so that it doesn't block the rest of the program while the stream is played.

pauseSource

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO () 

Stop playing the audio stream. - Details: This function stops the stream if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike pause()

stopSource

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO () 

Return the number of channels of the stream. - Details: 1 channel means a mono sound, 2 means stereo, etc.

getChannelCountSource

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int 

getSampleRateSource

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int 

Get the stream sample rate of the stream. - Details: The sample rate is the number of audio samples played per second. The higher, the better the quality.

setLoopSource

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

loop

-> IO () 

Tell whether or not the stream is in loop mode. - Details: setLoop

Set whether or not the stream should loop after reaching the end. - Details: If set, the stream will restart from beginning after reaching the end and so on, until it is stopped or setLoop(false) is called. The default looping state for streams is false.

getLoopSource

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

return value - True if the stream is looping, false otherwise