Add guidance on what you should and shouldn't do inside the audio callback

dturner · dturner · commit bb63afa9a470 · 2018-08-27T17:56:25.000+01:00
diff --git a/docs/FullGuide.md b/docs/FullGuide.md
@@ -362,6 +362,22 @@ The callback does a non-blocking read from the input stream placing the data int
 
 Note that in this example it is assumed the input and output streams have the same number of channels, format and sample rate. The format of the streams can be mismatched - as long as the code handles the translations properly.
 
+#### Callback do's and don'ts 
+These are things the `onAudioReady` method should NOT do:
+
+- allocate memory using, for example, malloc() or new
+- any file operations such as opening, closing, reading or writing
+- any network operations such as streaming
+- use any mutexes or other synchronization primitives
+- sleep
+- stop or close the stream
+- Call read() or write() on the stream which invoked it
+
+The following methods are OK to call:
+
+- AudioStream::get*()
+- oboe::convertResultToText()
+
 ### Setting performance mode
 
 Every AudioStream has a *performance mode* which has a large effect on your app's behavior. There are three modes:
