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

An interface for a JACK client. More...

#include <IJackClientInterface.h>

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

List of all members.

Public Member Functions

 IJackClientInterface ()
virtual ~IJackClientInterface ()
virtual int setUp (int argc, char *argv[])=0
virtual int tearDown ()=0
virtual int activate ()=0
virtual int deactivate ()=0
virtual int transport (TransportType type)=0
virtual int sendMidi (char *midi)=0

Detailed Description

An interface for a JACK client.

It is used for making Jack client on the APA client.


Constructor & Destructor Documentation

Constructor

Destructor


Member Function Documentation

virtual int android::IJackClientInterface::activate ( ) [pure virtual]

Activate jack client
It will be called when user call SapaProcessor.activate().

IJackClientInterface_activate.jpg
IJackClientInterface activate sequence diagram
Returns:
if success, use APA_RETURN_SUCCESS
virtual int android::IJackClientInterface::deactivate ( ) [pure virtual]

Deactivate jack client
It will be called when user call SapaProcessor.deactivate().

IJackClientInterface_deactivate.jpg
IJackClientInterface deactivate sequence diagram
Returns:
if success, use APA_RETURN_SUCCESS
virtual int android::IJackClientInterface::sendMidi ( char *  midi) [pure virtual]

Receive a MIDI string.
It will be called when user call SapaProcessor.sendCommand() with parameter starting with "midi:".
For example, if sendCommand("midi:aabbcc"), the "aabbcc" will be sent as parameter midi.

IJackClientInterface_sendMidi.jpg
IJackClientInterface sendMidi sequence diagram
Parameters:
midithe midi string
Returns:
if success, use APA_RETURN_SUCCESS
virtual int android::IJackClientInterface::setUp ( int  argc,
char *  argv[] 
) [pure virtual]

After loading your Wave module, It will be called when user call SapaService.register() after calling IAPAInterface.init()
Initialize your client.
by default, argc == 1, argv[0] == the alias of package name( the last name seperated by dot )
If you send extra parameters by newClient(), It will be add next.

IAPAInterface_register.jpg
IJackClientInterface setUp sequence diagram
Parameters:
argcargument count
argvarguments sent from the SapaProcessor constructor parameters, or plugin mainfest file
Returns:
if success, use APA_RETURN_SUCCESS
virtual int android::IJackClientInterface::tearDown ( ) [pure virtual]

Exit point
It will be called when user call SapaService.unregister() or the process suddenly died.

IJackClientInterface_tearDown.jpg
IJackClientInterface tearDown sequence diagram

Release resources.

Returns:
if success, use APA_RETURN_SUCCESS
virtual int android::IJackClientInterface::transport ( TransportType  type) [pure virtual]

Enable or disable transport feature of jack.
It will be called when user call SapaProcessor.setTransportEnabled().

IJackClientInterface_transport.jpg
IJackClientInterface transport sequence diagram
Parameters:
typeTRANSPORT_OFF, TRANSPORT_ON
Returns:
if success, use APA_RETURN_SUCCESS

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