Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
al_play_sample(3)					     al_play_sample(3)

NAME
       al_play_sample -	Allegro	5 API

SYNOPSIS
	      #include <allegro5/allegro_audio.h>

	      bool al_play_sample(ALLEGRO_SAMPLE *spl, float gain, float pan, float speed,
		 ALLEGRO_PLAYMODE loop,	ALLEGRO_SAMPLE_ID *ret_id)

DESCRIPTION
       Plays  a	 sample	 on  one  of  the  sample  instances created by	al_re-
       serve_samples(3).  Returns true on success, false on failure.  Playback
       may fail	because	all the	reserved sample	instances are currently	used.

       Parameters:

       o gain -	relative volume	at which the sample is played; 1.0 is normal.

       o pan  -	 0.0  is  centred,  -1.0 is left, 1.0 is right,	or ALLEGRO_AU-
	 DIO_PAN_NONE.

       o speed - relative speed	at which the sample is played; 1.0 is normal.

       o loop -	ALLEGRO_PLAYMODE_ONCE, ALLEGRO_PLAYMODE_LOOP, or ALLEGRO_PLAY-
	 MODE_BIDIR

       o ret_id	 -  if	non-NULL the variable which this points	to will	be as-
	 signed	an id representing the sample being played.

SEE ALSO
       ALLEGRO_PLAYMODE(3),  ALLEGRO_AUDIO_PAN_NONE(3),	 ALLEGRO_SAMPLE_ID(3),
       al_stop_sample(3), al_stop_samples(3).

Allegro	reference manual				     al_play_sample(3)

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=al_play_sample&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help