Browse Source

cmAudDspIF.h : Added comments.

master
kevin 8 years ago
parent
commit
b24a484f81
1 changed files with 13 additions and 2 deletions
  1. 13
    2
      cmAudDspIF.h

+ 13
- 2
cmAudDspIF.h View File

@@ -5,10 +5,22 @@
5 5
 extern "C" {
6 6
 #endif
7 7
 
8
+  // This class provides a two-way interface to the audio DSP system.
9
+  // It is designed to work independenty of the physical
10
+  // method of communication.  For example, when used by
11
+  // cmAudDspLocal, it  supports in memory transfer of messages
12
+  // between the application and the audio-DSP engine.
13
+  // Another implementation however could use it to support
14
+  // a networked communication scheme to a remote audio-DSP
15
+  // system.  Note that in either case, however, this class
16
+  // resides with, and is linked to, the application, and not
17
+  // the engine.  
18
+  
8 19
   // This API has two basic responsibilities:
9 20
   //
10 21
   // 1) Provides a function based interface to the audio DSP system for the
11
-  // client application.
22
+  // client application.  This is more convenient, and safer, than the lower level
23
+  // message based interface provided by cmAudDsp.h.
12 24
   //    The client calls these API functions to send commands to the audio DSP
13 25
   //    system. Internally the cmAdIfxxx functions converts the commands to 
14 26
   //    raw message packets and passes them to a transmission service
@@ -30,7 +42,6 @@ extern "C" {
30 42
   //    Note that this entire chain of calls occurs in the client thread
31 43
   //    and in the context of the cmAdIfDispatchMsgToHost() procedure.
32 44
                          
33
-  
34 45
 
35 46
   enum
36 47
   {

Loading…
Cancel
Save