summaryrefslogtreecommitdiff
path: root/3rdparty/portaudio/doc/src/tutorial/terminating_portaudio.dox
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/portaudio/doc/src/tutorial/terminating_portaudio.dox')
-rw-r--r--3rdparty/portaudio/doc/src/tutorial/terminating_portaudio.dox20
1 files changed, 20 insertions, 0 deletions
diff --git a/3rdparty/portaudio/doc/src/tutorial/terminating_portaudio.dox b/3rdparty/portaudio/doc/src/tutorial/terminating_portaudio.dox
new file mode 100644
index 0000000..67f74f6
--- /dev/null
+++ b/3rdparty/portaudio/doc/src/tutorial/terminating_portaudio.dox
@@ -0,0 +1,20 @@
+/** @page terminating_portaudio Closing a Stream and Terminating PortAudio
+@ingroup tutorial
+
+When you are done with a stream, you should close it to free up resources:
+
+@code
+ err = Pa_CloseStream( stream );
+ if( err != paNoError ) goto error;
+@endcode
+
+We've already mentioned this in \ref initializing_portaudio, but in case you forgot, be sure to terminate PortAudio when you are done:
+
+@code
+ err = Pa_Terminate( );
+ if( err != paNoError ) goto error;
+@endcode
+
+Previous: \ref start_stop_abort | Next: \ref utility_functions
+
+*/ \ No newline at end of file