From: rossbencina Date: Wed, 12 Jun 2002 03:02:13 +0000 (+0000) Subject: altered isActive and isStopped accessor documentation to say return value of 1 for... X-Git-Tag: v19-devel-pre-restructure~13 X-Git-Url: https://andrewgundersen.net/repos?a=commitdiff_plain;h=51af47878bce759b1b987a1aae9bfd365896d897;p=portaudio altered isActive and isStopped accessor documentation to say return value of 1 for true instead of non-zero, since other non-zeros may be returned on error --- diff --git a/docs/PaStreamStateDiagram.gif b/docs/PaStreamStateDiagram.gif index b8955b3..d1fcae0 100644 Binary files a/docs/PaStreamStateDiagram.gif and b/docs/PaStreamStateDiagram.gif differ diff --git a/docs/proposals.html b/docs/proposals.html index 9b35bb5..7c0dc4f 100644 --- a/docs/proposals.html +++ b/docs/proposals.html @@ -564,8 +564,8 @@ In the Stopped state: Pa_StartStream() -> transitions to Active state Pa_StopStream() -> returns paStreamIsStopped error Pa_AbortStream()-> returns paStreamIsStopped error -Pa_IsStreamStopped() -> returns non-zero -Pa_IsStreamActive() -> returns zero +Pa_IsStreamStopped() -> returns one (1), or error code +Pa_IsStreamActive() -> returns zero (0), or error code In the Active state: Pa_StartStream() -> returns paStreamIsNotStopped error @@ -575,15 +575,15 @@ Pa_StopStream() -> stops calling the callback and blocks until Pa_AbortStream()-> if possible, discards all queued buffers instead of waiting for them to be played, otherwise same as Pa_StopStream() : transitions to Stopped state -Pa_IsStreamStopped() -> returns zero -Pa_IsStreamActive() -> returns non-zero +Pa_IsStreamStopped() -> returns zero (0), or error code +Pa_IsStreamActive() -> returns one (1), or error code In the Callback Finished state: Pa_StartStream() -> returns paStreamIsNotStopped error Pa_StopStream() -> transitions to Stopped state Pa_AbortStream()-> transitions to Stopped state -Pa_IsStreamStopped() -> returns zero -Pa_IsStreamActive() -> returns non-zero +Pa_IsStreamStopped() -> returns zero (0), or error code +Pa_IsStreamActive() -> returns zero (0), or error code