6.4.1 Normal clients

This section deals with normal clients (as opposed to section 6.4.2 Server interfaces.)

CCA_Client_Name

From client, non-NULL string

Set the client's user-visible name.

From client, NULL string

Request the client's user-visible name.

From server

This will only be sent in response to a CCA_Client_Name with a NULL string. The string will be NULL if the client has not set a user-visible name, and the name itself if it has.

CCA_Jack_Client_Name

@anchor{Normal CCA_Jack_Client_Name}

From client, non-NULL string

Tell the server what name the client is connected to JACK with. Clients should only ever send one non-NULL CCA_Jack_Client_Name event. Note that you must send this event after calling jack_activate(); otherwise, the server will not be able to connect the client's ports.

From client, NULL string

Request the client name that the server thinks the client is connected to JACK with.

From server

This will only be sent in response to a CCA_Jack_Client_Name with a NULL string. The string will be NULL if the client has not set a JACK client name, and the client name itself if it has.

CCA_Alsa_Client_ID

@anchor{Normal CCA_Alsa_Client_ID} To communicate ALSA client IDs within events, use the first character of a two character string of the form { id, '\0' } as the event string. A convenience function, cca_alsa_client_id, exists to do this for you (see @xref{cca_alsa_client_id}.)

From client, non-NULL string

Tell the server what ID the client is connected to ALSA with. Clients should only ever send one non-NULL CCA_Alsa_Client_ID event.

From client, NULL string

Request the client ID that the server thinks the client is connected to ALSA with.

From server

This will only be sent in response to a CCA_Alsa_Client_ID with a NULL string. The string will be NULL if the client has not set an ALSA client ID, and a string containing the ALSA client ID as described above if it has.

CCA_Save_File

From server

Tell the client to save all its data to files within a specific directory. The event string will never be NULL and will contain the name of the directory in which the client should save its data. Clients must always send a CCA_Save_File event back to the server when they have finished saving their data. The client should not rely on the directory existing after it has sent its CCA_Save_File event back. It is valid behaviour for a client to save no files within the directory. Files should always be overwritten (ie, using the "w" flag with fopen(),) preferably without user confirmation if you care for their sanity.

From client

Tell the server that the client has finished saving its data within the directory it was told to. The string is ignored.

CCA_Restore_File

From server

Tell the client to load all its data from files within a specific directory. The event string will never be NULL and will contain the name of the directory from which the client should load its data. Clients must always send a CCA_Restore_File event back to the server when they have finished restoring their data. The client should not rely on the directory existing after it has sent its CCA_Restore_File event back.

From client

Tell the server that the client has finished restoring its data from within the directory it was told to. The string is ignored.

CCA_Save_Data_Set

From server

Tell the client to send all its configuration data to the server with a number of configs. The client must always send a CCA_Save_Data_Set event back to the server when it has finished sending its configs. The event string will always be NULL.

From client

Tell the server that the client has finished sending its configs to the server. The event string is ignored.

CCA_Restore_Data_Set

From server

Tell the client to immediately expect a stream of configs from the server. This event will only be sent if there are one or more configs to be sent. The event string will always be NULL. The client must always send a CCA_Restore_Data_Set back to the server when it has recieved all of its configs.

From client

Tell the server that the client has finished recieving its configs from the server. The event string is ignored.

CCA_Save

From client

Tell the server to save the project that the client is attached to.

From server

Never occurs.

CCA_Quit

From client

Tell the server to close all clients in the project that the client is attached to.

From server

The client should immediately quit without saving. No more events will be sent by the server and the client's connection will be terminated.

Go to the first, previous, next, last section, table of contents.