Skip to content

Commit 9f4c9bd

Browse files
SiegeLordExSiegeLord
authored andcommitted
Clarify al_play_audio_stream docs.
1 parent 72bca80 commit 9f4c9bd

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/src/refman/audio.txt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,10 @@ Since: 5.2.3
144144

145145
### API: al_play_audio_stream
146146

147-
Loads and plays an audio file from disk as it is needed. This API can only play
148-
one audio stream at a time.
147+
Loads and plays an audio file, streaming from disk as it is needed. This API
148+
can only play one audio stream at a time. This requires a default mixer to be
149+
set, which is typically done via [al_reserve_samples], but can also be done via
150+
[al_set_default_mixer].
149151

150152
Returns the stream on success, NULL on failure. You must not destroy the
151153
returned stream, it will be automatically destroyed when the addon is shut
@@ -163,7 +165,10 @@ Since: 5.2.8
163165

164166
### API: al_play_audio_stream_f
165167

166-
Loads and plays an audio file from [ALLEGRO_FILE] stream as it is needed.
168+
Loads and plays an audio file from [ALLEGRO_FILE] stream, streaming it is
169+
needed. This API can only play one audio stream at a time. This requires a
170+
default mixer to be set, which is typically done via [al_reserve_samples], but
171+
can also be done via [al_set_default_mixer].
167172

168173
The file type is determined by the passed 'ident' parameter, which is a file
169174
name extension including the leading dot.

0 commit comments

Comments
 (0)