Menu
▾
▴
SF.net SVN: alleg:[15561] allegro/branches/5.1/docs/src/refman/audio.txt
|
From: <tj...@us...> - 2012-04-22 03:42:50
|
Revision: 15561
http://alleg.svn.sourceforge.net/alleg/?rev=15561&view=rev
Author: tjaden
Date: 2012-04-22 03:42:43 +0000 (Sun, 22 Apr 2012)
Log Message:
-----------
docs: Add See alsos to audio documentation.
Modified Paths:
--------------
allegro/branches/5.1/docs/src/refman/audio.txt
Modified: allegro/branches/5.1/docs/src/refman/audio.txt
===================================================================
--- allegro/branches/5.1/docs/src/refman/audio.txt 2012-04-22 03:41:58 UTC (rev 15560)
+++ allegro/branches/5.1/docs/src/refman/audio.txt 2012-04-22 03:42:43 UTC (rev 15561)
@@ -103,6 +103,8 @@
ALLEGRO_VOICE object (or to another ALLEGRO_MIXER object which is attached
to an ALLEGRO_VOICE object, etc).
+See also: [ALLEGRO_SAMPLE]
+
### API: ALLEGRO_AUDIO_STREAM
An ALLEGRO_AUDIO_STREAM object is used to stream generated audio to the sound
@@ -141,6 +143,7 @@
or an abstract device provided by the operating system.
To play back audio, you would attach a mixer or sample or stream to a voice.
+See also: [ALLEGRO_MIXER], [ALLEGRO_SAMPLE], [ALLEGRO_AUDIO_STREAM]
## Setting up audio
@@ -230,8 +233,11 @@
### API: al_detach_voice
-Detaches the sample or mixer stream from the voice.
+Detaches the mixer or sample or stream from the voice.
+See also: [al_attach_mixer_to_voice], [al_attach_sample_instance_to_voice],
+[al_attach_audio_stream_to_voice]
+
### API: al_attach_audio_stream_to_voice
Attaches an audio stream to a voice. The same rules as
@@ -245,6 +251,8 @@
Returns true on success, false on failure.
+See also: [al_detach_voice]
+
### API: al_attach_mixer_to_voice
Attaches a mixer to a voice. The same rules as [al_attach_sample_instance_to_voice]
@@ -252,6 +260,8 @@
Returns true on success, false on failure.
+See also: [al_detach_voice]
+
### API: al_attach_sample_instance_to_voice
Attaches a sample to a voice, and allows it to play. The sample's volume
@@ -264,6 +274,8 @@
Returns true on success, false on failure.
+See also: [al_detach_voice]
+
### API: al_get_voice_frequency
Return the frequency of the voice, e.g. 44100.
@@ -284,6 +296,8 @@
Return true if the voice is currently playing.
+See also: [al_set_voice_playing]
+
### API: al_set_voice_playing
Change whether a voice is playing or not.
@@ -293,6 +307,8 @@
Returns true on success, false on failure.
+See also: [al_get_voice_playing]
+
### API: al_get_voice_position
When the voice has a non-streaming object attached to it, e.g. a sample,
@@ -373,27 +389,38 @@
Return the channel configuration.
-See also: [ALLEGRO_CHANNEL_CONF].
+See also: [ALLEGRO_CHANNEL_CONF], [al_get_sample_depth],
+[al_get_sample_frequency], [al_get_sample_length], [al_get_sample_data]
### API: al_get_sample_depth
Return the audio depth.
-See also: [ALLEGRO_AUDIO_DEPTH].
+See also: [ALLEGRO_AUDIO_DEPTH], [al_get_sample_channels],
+[al_get_sample_frequency], [al_get_sample_length], [al_get_sample_data]
### API: al_get_sample_frequency
Return the frequency of the sample.
+See also: [al_get_sample_channels], [al_get_sample_depth],
+[al_get_sample_length], [al_get_sample_data]
+
### API: al_get_sample_length
Return the length of the sample in sample values.
+See also: [al_get_sample_channels], [al_get_sample_depth],
+[al_get_sample_frequency], [al_get_sample_data]
+
### API: al_get_sample_data
Return a pointer to the raw sample data.
+See also: [al_get_sample_channels], [al_get_sample_depth],
+[al_get_sample_frequency], [al_get_sample_length]
+
## Sample instance functions
### API: al_create_sample_instance
@@ -403,20 +430,28 @@
The argument may be NULL. You can then set the data later with
[al_set_sample].
+See also: [al_destroy_sample_instance]
+
### API: al_destroy_sample_instance
Detaches the sample stream from anything it may be attached to and frees
it (the sample data is *not* freed!).
+See also: [al_create_sample_instance]
+
### API: al_play_sample_instance
Play an instance of a sample data.
Returns true on success, false on failure.
+See also: [al_stop_sample_instance]
+
### API: al_stop_sample_instance
Stop an sample instance playing.
+See also: [al_play_sample_instance]
+
### API: al_get_sample_instance_channels
Return the channel configuration.
@@ -437,6 +472,8 @@
Return the length of the sample instance in sample values.
+See also: [al_set_sample_instance_length], [al_get_sample_instance_time]
+
### API: al_set_sample_instance_length
Set the length of the sample instance in sample values.
@@ -444,20 +481,28 @@
Return true on success, false on failure. Will fail if the sample instance is
currently playing.
+See also: [al_get_sample_instance_length]
+
### API: al_get_sample_instance_position
Get the playback position of a sample instance.
+See also: [al_set_sample_instance_position]
+
### API: al_set_sample_instance_position
Set the playback position of a sample instance.
Returns true on success, false on failure.
+See also: [al_get_sample_instance_position]
+
### API: al_get_sample_instance_speed
Return the relative playback speed.
+See also: [al_set_sample_instance_speed]
+
### API: al_set_sample_instance_speed
Set the relative playback speed. 1.0 is normal speed.
@@ -465,10 +510,14 @@
Return true on success, false on failure. Will fail if the sample instance is
attached directly to a voice.
+See also: [al_get_sample_instance_speed]
+
### API: al_get_sample_instance_gain
Return the playback gain.
+See also: [al_set_sample_instance_gain]
+
### API: al_set_sample_instance_gain
Set the playback gain.
@@ -476,6 +525,8 @@
Returns true on success, false on failure. Will fail if the sample instance
is attached directly to a voice.
+See also: [al_get_sample_instance_gain]
+
### API: al_get_sample_instance_pan
Get the pan value.
@@ -507,30 +558,43 @@
Return the length of the sample instance in seconds,
assuming a playback speed of 1.0.
+See also: [al_get_sample_instance_length]
+
### API: al_get_sample_instance_playmode
Return the playback mode.
+See also: [ALLEGRO_PLAYMODE], [al_set_sample_instance_playmode]
+
### API: al_set_sample_instance_playmode
Set the playback mode.
Returns true on success, false on failure.
+See also: [ALLEGRO_PLAYMODE], [al_get_sample_instance_playmode]
+
### API: al_get_sample_instance_playing
Return true if the sample instance is playing.
+See also: [al_set_sample_instance_playing]
+
### API: al_set_sample_instance_playing
Change whether the sample instance is playing.
Returns true on success, false on failure.
+See also: [al_get_sample_instance_playing]
+
### API: al_get_sample_instance_attached
Return whether the sample instance is attached to something.
+See also: [al_attach_sample_instance_to_mixer],
+[al_attach_sample_instance_to_voice], [al_detach_sample_instance]
+
### API: al_detach_sample_instance
Detach the sample instance from whatever it's attached to,
@@ -538,6 +602,9 @@
Returns true on success.
+See also: [al_attach_sample_instance_to_mixer],
+[al_attach_sample_instance_to_voice], [al_get_sample_instance_attached]
+
### API: al_get_sample
Return the sample data that the sample instance plays.
@@ -547,6 +614,8 @@
You may, however, check which sample buffer is being played by the sample
instance with [al_get_sample_data], and so on.
+See also: [al_set_sample]
+
### API: al_set_sample
Change the sample data that a sample instance plays. This can be quite an
@@ -568,6 +637,7 @@
Returns true on success, false on failure. On failure, the sample will
be stopped and detached from its parent.
+See also: [al_get_sample]
## Mixer functions
@@ -652,6 +722,8 @@
Return the mixer frequency.
+See also: [al_set_mixer_frequency]
+
### API: al_set_mixer_frequency
Set the mixer frequency. This will only work if the mixer is not attached to
@@ -659,6 +731,8 @@
Returns true on success, false on failure.
+See also: [al_get_mixer_frequency]
+
### API: al_get_mixer_channels
Return the mixer channel configuration.
@@ -693,7 +767,7 @@
Return the mixer quality.
-See also: [ALLEGRO_MIXER_QUALITY].
+See also: [ALLEGRO_MIXER_QUALITY], [al_set_mixer_quality]
### API: al_set_mixer_quality
@@ -702,7 +776,7 @@
Returns true on success, false on failure.
-See also: [ALLEGRO_MIXER_QUALITY].
+See also: [ALLEGRO_MIXER_QUALITY], [al_get_mixer_quality]
### API: al_get_mixer_playing
@@ -723,7 +797,7 @@
Return true if the mixer is attached to something.
See also: [al_attach_sample_instance_to_mixer], [al_attach_audio_stream_to_mixer],
-[al_attach_mixer_to_mixer]
+[al_attach_mixer_to_mixer], [al_detach_mixer]
### API: al_detach_mixer
@@ -809,6 +883,8 @@
be feeding, to wait for all pending buffers to finish playing.
The stream's playing state will change to false.
+See also: [al_destroy_audio_stream]
+
### API: al_rewind_audio_stream
Set the streaming file playing position to the beginning. Returns true on
@@ -881,8 +957,6 @@
Returns true on success, false on failure.
Will fail if the sample instance is attached directly to a voice.
-See also: [al_get_audio_stream_playing].
-
### API: al_get_audio_stream_playing
Return true if the stream is playing.
@@ -895,6 +969,8 @@
Returns true on success, false on failure.
+See also: [al_get_audio_stream_playing]
+
### API: al_get_audio_stream_playmode
Return the playback mode.
@@ -971,12 +1047,17 @@
[al_load_audio_stream], [al_load_audio_stream_f] and the format-specific
functions underlying those functions.
+See also: [al_get_audio_stream_position_secs],
+[al_get_audio_stream_length_secs]
+
### API: al_get_audio_stream_position_secs
Return the position of the stream in seconds.
Currently this can only be called on streams created with
[al_load_audio_stream].
+See also: [al_get_audio_stream_length_secs]
+
### API: al_get_audio_stream_length_secs
Return the length of the stream in seconds, if known.
@@ -986,6 +1067,8 @@
[al_load_audio_stream], [al_load_audio_stream_f] and the format-specific
functions underlying those functions.
+See also: [al_get_audio_stream_position_secs]
+
### API: al_set_audio_stream_loop_secs
Sets the loop points for the stream in seconds.
@@ -1008,7 +1091,7 @@
Returns true on success, false on error.
Returns false if unregistering an entry that doesn't exist.
-See also: [al_register_sample_loader_f]
+See also: [al_register_sample_loader_f], [al_register_sample_saver]
### API: al_register_sample_loader_f
@@ -1038,7 +1121,7 @@
Returns true on success, false on error.
Returns false if unregistering an entry that doesn't exist.
-See also: [al_register_sample_saver_f]
+See also: [al_register_sample_saver_f], [al_register_sample_loader]
### API: al_register_sample_saver_f
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|