]> Repos - portaudio/commitdiff
altered isActive and isStopped accessor documentation to say return value of 1 for...
authorrossbencina <rossbencina@0f58301d-fd10-0410-b4af-bbb618454e57>
Wed, 12 Jun 2002 03:02:13 +0000 (03:02 +0000)
committerrossbencina <rossbencina@0f58301d-fd10-0410-b4af-bbb618454e57>
Wed, 12 Jun 2002 03:02:13 +0000 (03:02 +0000)
docs/PaStreamStateDiagram.gif
docs/proposals.html

index b8955b35791c5f840c04e8cfa418fc91c9bb6a59..d1fcae0b6e01e226b8c6d2d096360a7ca5152c1c 100644 (file)
Binary files a/docs/PaStreamStateDiagram.gif and b/docs/PaStreamStateDiagram.gif differ
index 9b35bb5b30370cd33acb8d3a009ce68adc156203..7c0dc4fb99087f8435dae763778d511b581c4950 100644 (file)
@@ -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
 </PRE>
 
 <P>