cml/libcm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

cmAudDspIF.h : Added comments.

Browse Source
This commit is contained in:
kevin 2015-10-07 17:07:17 -04:00
parent 4dcc216ab5
commit b24a484f81
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
cmAudDspIF.h
View File

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