SpatialSamplePlayer

Inherits: SpatialPlayer < Spatial < Node < Object

Category: Core

Brief Description

Member Functions

int get_polyphony ( ) const
SampleLibrary get_sample_library ( ) const
bool is_voice_active ( int voice ) const
int play ( String sample, int voice=-2 )
void set_polyphony ( int voices )
void set_sample_library ( SampleLibrary library )
void stop_all ( )
void stop_voice ( int voice )
void voice_set_pitch_scale ( int voice, float ratio )
void voice_set_volume_scale_db ( int voice, float db )

Numeric Constants

  • INVALID_VOICE = -1
  • NEXT_VOICE = -2

Member Function Description

int get_polyphony ( ) const

SampleLibrary get_sample_library ( ) const

bool is_voice_active ( int voice ) const

int play ( String sample, int voice=-2 )

void set_polyphony ( int voices )

void set_sample_library ( SampleLibrary library )

void stop_all ( )

void stop_voice ( int voice )

void voice_set_pitch_scale ( int voice, float ratio )

void voice_set_volume_scale_db ( int voice, float db )

© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/2.1/classes/class_spatialsampleplayer.html