Skip to content

class_sampleplayer2d

reduz edited this page Apr 10, 2014 · 10 revisions

SamplePlayer2D

####Inherits: SoundPlayer2D ####Category: Core

Brief Description

Sample player for Positional 2D Sound.

Member Functions

Numeric Constants

  • INVALID_VOICE = -1 - If the voice is invalid, this is returned.
  • NEXT_VOICE = -2

Description

Sample player for Positional 2D Sound. Plays sound samples positionally, left and right depending on the distance/place on the screen.

Member Function Description

Set the sample library for the player.

Return the sample library used for the player.

  • void set_polyphony ( int voices )

Set the polyphony of the player (maximum amount of simultaneous voices).

  • int get_polyphony ( ) const

Return the polyphony of the player (maximum amount of simultaneous voices).

Play a sample, an internal polyphony id can be passed, or else it's assigned automatically. Returns a voice id which can be used to modify the voice parameters.

  • void voice_set_pitch_scale ( int voice, float ratio )

Change the pitch scale of a currently playing voice.

  • void voice_set_volume_scale_db ( int voice, float db )

Change the volume scale of a currently playing voice (using dB).

  • bool is_voice_active ( int voice ) const

Return true if a voice is still active (false if it stopped playing).

  • void stop_voice ( int voice )

Stop a given voice.

  • void stop_all ( )

Stop all playing voices.

Clone this wiki locally