professional audio NDK  1.1.3
Public Member Functions
android::IAPAInterface Class Reference

An interface for a APA Client. More...

#include <IAPAInterface.h>

Inheritance diagram for android::IAPAInterface:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 IAPAInterface ()
virtual ~IAPAInterface ()
virtual int init ()=0
virtual int sendCommand (const char *command)=0
virtual IJackClientInterfacegetJackClientInterface ()=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)

Detailed Description

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.


Constructor & Destructor Documentation

Constructor

virtual android::IAPAInterface::~IAPAInterface ( ) [inline, virtual]

Destructor


Member Function Documentation

Return the jack client interface that you implemented.
If you don't use the jack client, return null.

Returns:
jack interface
virtual int android::IAPAInterface::init ( ) [pure virtual]

When user call SapaService.register(),
It is called right after the library loaded

IAPAInterface_register.jpg
IJackClientInterface init sequence diagram

Initialize your APA Client.

Returns:
if success, use APA_RETURN_SUCCESS
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.

IAPAInterface_request.jpg
IJackClientInterface request sequence diagram
Parameters:
whatthe parameter 'query' in queryData() will be sent as a parameter 'what'. [in]
ext1the parameter 'extrra' in queryData() will be sent as a parameter 'ext1'. [in]
capacitythe maximum size of the data pointer[in]
lenthe written data size [in/out]
datathe writeen data pointer [in/out]
Returns:
if success, use APA_RETURN_SUCCESS
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.

IAPAInterface_response.jpg
IJackClientInterface response sequence diagram
Parameters:
messagean sending text message

Here is the call graph for this function:

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

IAPAInterface_response.jpg
IJackClientInterface response sequence diagram
Parameters:
ext1an extra parameter, You can define
lenthe written data size
datathe written data pointer

Here is the call graph for this function:

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.

IAPAInterface_response.jpg
IJackClientInterface response sequence diagram
Parameters:
messagean sending text message
idan id

Here is the call graph for this function:

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.

IAPAInterface_sendCommand.jpg
IJackClientInterface sendCommand sequence diagram
Parameters:
command: command string
Returns:
if success, use APA_RETURN_SUCCESS

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.

Parameters:
itfIAPAResponseInterface object

The documentation for this class was generated from the following file: