professional audio NDK
1.1.3
|
An interface for a APA Client. More...
#include <IAPAInterface.h>
Public Member Functions | |
IAPAInterface () | |
virtual | ~IAPAInterface () |
virtual int | init ()=0 |
virtual int | sendCommand (const char *command)=0 |
virtual IJackClientInterface * | getJackClientInterface ()=0 |
void | setResponseInterface (IAPAResponseInterface *itf) |
void | response (const char *message) |
void | response (const int32_t ext1, const size_t len, void const *data) |
virtual int | request (const char *what, const long ext1, const long capacity, size_t &len, void *const data)=0 |
void | response (const char *message, const int id) |
An interface for a APA Client.
This is the entry interface for processing module.
All of processing module has an APA Client.
You should implement this.
android::IAPAInterface::IAPAInterface | ( | ) | [inline] |
Constructor
virtual android::IAPAInterface::~IAPAInterface | ( | ) | [inline, virtual] |
Destructor
virtual IJackClientInterface* android::IAPAInterface::getJackClientInterface | ( | ) | [pure virtual] |
Return the jack client interface that you implemented.
If you don't use the jack client, return null.
virtual int android::IAPAInterface::init | ( | ) | [pure virtual] |
When user call SapaService.register(),
It is called right after the library loaded
Initialize your APA Client.
virtual int android::IAPAInterface::request | ( | const char * | what, |
const long | ext1, | ||
const long | capacity, | ||
size_t & | len, | ||
void *const | data | ||
) | [pure virtual] |
When user call SapaProcessor.queryData(), This will be called.
A data in processing module can be delivered to UI.
what | the parameter 'query' in queryData() will be sent as a parameter 'what'. [in] |
ext1 | the parameter 'extrra' in queryData() will be sent as a parameter 'ext1'. [in] |
capacity | the maximum size of the data pointer[in] |
len | the written data size [in/out] |
data | the writeen data pointer [in/out] |
void android::IAPAInterface::response | ( | const char * | message | ) | [inline] |
A message will be sent to UI
If you want to send a message to UI, Call this.
message | an sending text message |
void android::IAPAInterface::response | ( | const int32_t | ext1, |
const size_t | len, | ||
void const * | data | ||
) | [inline] |
An data will be sent to UI
If you want to send a data to UI, Call this
ext1 | an extra parameter, You can define |
len | the written data size |
data | the written data pointer |
void android::IAPAInterface::response | ( | const char * | message, |
const int | id | ||
) | [inline] |
A message will be sent to UI
If you want to send a message to UI, Call this.
message | an sending text message |
id | an id |
virtual int android::IAPAInterface::sendCommand | ( | const char * | command | ) | [pure virtual] |
Handle a command from UI
You can define your own command between UI and APA client.
When user call SapaProcessor.sendCommand(), It is called.
command | : command string |
void android::IAPAInterface::setResponseInterface | ( | IAPAResponseInterface * | itf | ) | [inline] |
Set the response interface in the system automatically.
So, Do NOT use.
If user call this, The message or data can NOT be received in the UI.
itf | IAPAResponseInterface object |