canberra

canberra

Synopsis

#define             CA_PROP_MEDIA_NAME
#define             CA_PROP_MEDIA_TITLE
#define             CA_PROP_MEDIA_ARTIST
#define             CA_PROP_MEDIA_LANGUAGE
#define             CA_PROP_MEDIA_FILENAME
#define             CA_PROP_MEDIA_ICON
#define             CA_PROP_MEDIA_ICON_NAME
#define             CA_PROP_MEDIA_ROLE
#define             CA_PROP_EVENT_ID
#define             CA_PROP_EVENT_DESCRIPTION
#define             CA_PROP_EVENT_MOUSE_X
#define             CA_PROP_EVENT_MOUSE_Y
#define             CA_PROP_EVENT_MOUSE_HPOS
#define             CA_PROP_EVENT_MOUSE_VPOS
#define             CA_PROP_EVENT_MOUSE_BUTTON
#define             CA_PROP_WINDOW_NAME
#define             CA_PROP_WINDOW_ID
#define             CA_PROP_WINDOW_ICON
#define             CA_PROP_WINDOW_ICON_NAME
#define             CA_PROP_WINDOW_X11_DISPLAY
#define             CA_PROP_WINDOW_X11_SCREEN
#define             CA_PROP_WINDOW_X11_MONITOR
#define             CA_PROP_WINDOW_X11_XID
#define             CA_PROP_APPLICATION_NAME
#define             CA_PROP_APPLICATION_ID
#define             CA_PROP_APPLICATION_VERSION
#define             CA_PROP_APPLICATION_ICON
#define             CA_PROP_APPLICATION_ICON_NAME
#define             CA_PROP_APPLICATION_LANGUAGE
#define             CA_PROP_APPLICATION_PROCESS_ID
#define             CA_PROP_APPLICATION_PROCESS_BINARY
#define             CA_PROP_APPLICATION_PROCESS_USER
#define             CA_PROP_APPLICATION_PROCESS_HOST
#define             CA_PROP_CANBERRA_CACHE_CONTROL
#define             CA_PROP_CANBERRA_VOLUME
#define             CA_PROP_CANBERRA_XDG_THEME_NAME
#define             CA_PROP_CANBERRA_XDG_THEME_OUTPUT_PROFILE

typedef             ca_context;
void                (*ca_finish_callback_t)             (ca_context *c,
                                                         uint32_t id,
                                                         int error_code,
                                                         void *userdata);
int                 ca_context_create                   (ca_context **c);
int                 ca_context_destroy                  (ca_context *c);
int                 ca_context_open                     (ca_context *c);
int                 ca_context_set_driver               (ca_context *c,
                                                         const char *driver);
int                 ca_context_change_device            (ca_context *c,
                                                         const char *device);
int                 ca_context_change_props             (ca_context *c,
                                                         ...);
int                 ca_context_change_props_full        (ca_context *c,
                                                         ca_proplist *p);
int                 ca_context_play                     (ca_context *c,
                                                         uint32_t id,
                                                         ...);
int                 ca_context_play_full                (ca_context *c,
                                                         uint32_t id,
                                                         ca_proplist *p,
                                                         ca_finish_callback_t cb,
                                                         void *userdata);
int                 ca_context_cancel                   (ca_context *c,
                                                         uint32_t id);
int                 ca_context_cache                    (ca_context *c,
                                                         ...);
int                 ca_context_cache_full               (ca_context *c,
                                                         ca_proplist *p);
int                 ca_context_playing                  (ca_context *c,
                                                         uint32_t id,
                                                         int *playing);

const char *        ca_strerror                         (int code);

typedef             ca_proplist;
int                 ca_proplist_create                  (ca_proplist **p);
int                 ca_proplist_destroy                 (ca_proplist *p);
int                 ca_proplist_sets                    (ca_proplist *p,
                                                         const char *key,
                                                         const char *value);
int                 ca_proplist_setf                    (ca_proplist *p,
                                                         const char *key,
                                                         const char *format,
                                                         ...);
int                 ca_proplist_set                     (ca_proplist *p,
                                                         const char *key,
                                                         const void *data,
                                                         size_t nbytes);

Description

Details

CA_PROP_MEDIA_NAME

#define CA_PROP_MEDIA_NAME                         "media.name"

A name describing the media being played. Localized if possible and applicable.


CA_PROP_MEDIA_TITLE

#define CA_PROP_MEDIA_TITLE                        "media.title"

A (song) title describing the media being played. Localized if possible and applicable.


CA_PROP_MEDIA_ARTIST

#define CA_PROP_MEDIA_ARTIST                       "media.artist"

The artist of this media. Localized if possible and applicable.


CA_PROP_MEDIA_LANGUAGE

#define CA_PROP_MEDIA_LANGUAGE                     "media.language"

The language this media is in, in some standard POSIX locale string, such as "de_DE".


CA_PROP_MEDIA_FILENAME

#define CA_PROP_MEDIA_FILENAME                     "media.filename"

The file name this media was or can be loaded from.


CA_PROP_MEDIA_ICON

#define CA_PROP_MEDIA_ICON                         "media.icon"

An icon for this media in binary PNG format.


CA_PROP_MEDIA_ICON_NAME

#define CA_PROP_MEDIA_ICON_NAME                    "media.icon_name"

An icon name as defined in the XDG icon naming specifcation.


CA_PROP_MEDIA_ROLE

#define CA_PROP_MEDIA_ROLE                         "media.role"

The "role" this media is played in. For event sounds the string "event". For other cases strings like "music", "video", "game", ...


CA_PROP_EVENT_ID

#define CA_PROP_EVENT_ID                           "event.id"

A textual id for an event sound, as mandated by the XDG sound naming specification.


CA_PROP_EVENT_DESCRIPTION

#define CA_PROP_EVENT_DESCRIPTION                  "event.description"

A descriptive string for the sound event. Localized if possible and applicable.


CA_PROP_EVENT_MOUSE_X

#define CA_PROP_EVENT_MOUSE_X                      "event.mouse.x"

If this sound event was triggered by a mouse input event, the X position of the mouse cursor on the screen, formatted as string.


CA_PROP_EVENT_MOUSE_Y

#define CA_PROP_EVENT_MOUSE_Y                      "event.mouse.y"

If this sound event was triggered by a mouse input event, the Y position of the mouse cursor on the screen, formatted as string.


CA_PROP_EVENT_MOUSE_HPOS

#define CA_PROP_EVENT_MOUSE_HPOS                   "event.mouse.hpos"

If this sound event was triggered by a mouse input event, the X position of the mouse cursor as fractional value between 0 and 1, formatted as string, 0 reflecting the left side of the screen, 1 the right side.


CA_PROP_EVENT_MOUSE_VPOS

#define CA_PROP_EVENT_MOUSE_VPOS                   "event.mouse.vpos"

If this sound event was triggered by a mouse input event, the Y position of the mouse cursor as fractional value between 0 and 1, formatted as string, 0 reflecting the top end of the screen, 1 the bottom end.


CA_PROP_EVENT_MOUSE_BUTTON

#define CA_PROP_EVENT_MOUSE_BUTTON                 "event.mouse.button"

If this sound event was triggered by a mouse input event, the number of the mouse button that triggered it, formatted as string. 1 for left mouse button, 3 for right, 2 for middle.


CA_PROP_WINDOW_NAME

#define CA_PROP_WINDOW_NAME                        "window.name"

If this sound event was triggered by a window on the screen, the name of this window as human readable string.


CA_PROP_WINDOW_ID

#define CA_PROP_WINDOW_ID                          "window.id"

If this sound event was triggered by a window on the screen, some identification string for this window, so that the sound system can recognize specific windows.


CA_PROP_WINDOW_ICON

#define CA_PROP_WINDOW_ICON                        "window.icon"

If this sound event was triggered by a window on the screen, binary icon data in PNG format for this window.


CA_PROP_WINDOW_ICON_NAME

#define CA_PROP_WINDOW_ICON_NAME                   "window.icon_name"

If this sound event was triggered by a window on the screen, an icon name for this window, as defined in the XDG icon naming specification.


CA_PROP_WINDOW_X11_DISPLAY

#define CA_PROP_WINDOW_X11_DISPLAY                 "window.x11.display"

If this sound event was triggered by a window on the screen and the windowing system is X11, the X display name of the window (e.g. ":0").


CA_PROP_WINDOW_X11_SCREEN

#define CA_PROP_WINDOW_X11_SCREEN                  "window.x11.screen"

If this sound event was triggered by a window on the screen and the windowing system is X11, the X screen id of the window formatted as string (e.g. "0").


CA_PROP_WINDOW_X11_MONITOR

#define CA_PROP_WINDOW_X11_MONITOR                 "window.x11.monitor"

If this sound event was triggered by a window on the screen and the windowing system is X11, the X monitor id of the window formatted as string (e.g. "0").


CA_PROP_WINDOW_X11_XID

#define CA_PROP_WINDOW_X11_XID                     "window.x11.xid"

If this sound event was triggered by a window on the screen and the windowing system is X11, the XID of the window formatted as string.


CA_PROP_APPLICATION_NAME

#define CA_PROP_APPLICATION_NAME                   "application.name"

The name of the application this sound event was triggered by as human readable string. (e.g. "GNU Emacs") Localized if possible and applicable.


CA_PROP_APPLICATION_ID

#define CA_PROP_APPLICATION_ID                     "application.id"

An identifier for the program this sound event was triggered by. (e.g. "org.gnu.emacs").


CA_PROP_APPLICATION_VERSION

#define CA_PROP_APPLICATION_VERSION                "application.version"

A version number for the program this sound event was triggered by. (e.g. "22.2")


CA_PROP_APPLICATION_ICON

#define CA_PROP_APPLICATION_ICON                   "application.icon"

Binary icon data in PNG format for the application this sound event is triggered by.


CA_PROP_APPLICATION_ICON_NAME

#define CA_PROP_APPLICATION_ICON_NAME              "application.icon_name"

An icon name for the application this sound event is triggered by, as defined in the XDG icon naming specification.


CA_PROP_APPLICATION_LANGUAGE

#define CA_PROP_APPLICATION_LANGUAGE               "application.language"

The locale string the application that is triggering this sound event is running in. A POSIX locale string such as de_DEeuro.


CA_PROP_APPLICATION_PROCESS_ID

#define CA_PROP_APPLICATION_PROCESS_ID             "application.process.id"

The unix PID of the process that is triggering this sound event, formatted as string.


CA_PROP_APPLICATION_PROCESS_BINARY

#define CA_PROP_APPLICATION_PROCESS_BINARY         "application.process.binary"

The path to the process binary of the process that is triggering this sound event.


CA_PROP_APPLICATION_PROCESS_USER

#define CA_PROP_APPLICATION_PROCESS_USER           "application.process.user"

The user that owns the process that is triggering this sound event.


CA_PROP_APPLICATION_PROCESS_HOST

#define CA_PROP_APPLICATION_PROCESS_HOST           "application.process.host"

The host name of the host the process that is triggering this sound event runs on.


CA_PROP_CANBERRA_CACHE_CONTROL

#define CA_PROP_CANBERRA_CACHE_CONTROL             "canberra.cache-control"

A special property that can be used to control the automatic sound caching of sounds in the sound server. One of "permanent", "volatile", "never". "permanent" will cause this sample to be cached in the server permanently. This is useful for very frequently used sound events such as those used for input feedback. "volatile" may be used for cacheing sounds in the sound server temporarily. They will expire after some time or on cache pressure. Finally, "never" may be used for sounds that should never be cached, because they are only generated very seldomly or even only once at most (such as desktop login sounds).

If this property is not explicitly passed to ca_context_play() it will default to "never". If it is not explicitly passed to ca_context_cache() it will default to "permanent".

If the list of properties is handed on to the sound server this property is stripped from it.


CA_PROP_CANBERRA_VOLUME

#define CA_PROP_CANBERRA_VOLUME                    "canberra.volume"

A special property that can be used to control the volume this sound event is played in if the backend supports it. A floating point value for the decibel multiplier for the sound. 0 dB relates to zero gain, and is the default volume these sounds are played in.

If the list of properties is handed on to the sound server this property is stripped from it.


CA_PROP_CANBERRA_XDG_THEME_NAME

#define CA_PROP_CANBERRA_XDG_THEME_NAME            "canberra.xdg-theme.name"

A special property that can be used to control the XDG sound theme that is used for this sample.

If the list of properties is handed on to the sound server this property is stripped from it.


CA_PROP_CANBERRA_XDG_THEME_OUTPUT_PROFILE

#define CA_PROP_CANBERRA_XDG_THEME_OUTPUT_PROFILE  "canberra.xdg-theme.output-profile"

A special property that can be used to control the XDG sound theme output profile that is used for this sample.

If the list of properties is handed on to the sound server this property is stripped from it.


ca_context

typedef struct ca_context ca_context;

A libcanberra context object.


ca_finish_callback_t ()

void                (*ca_finish_callback_t)             (ca_context *c,
                                                         uint32_t id,
                                                         int error_code,
                                                         void *userdata);

Playback completion event callback. The context this callback is called in is undefined, it might or might not be called from a background thread, and from any stack frame. The code implementing this function may not call any libcanberra API call from this callback -- this might result in a deadlock. Instead it may only be used to asynchronously signal some kind of notification object (semaphore, message queue, ...).

c :

The libcanberra context this callback is called for

id :

The numerical id passed to the ca_context_play_full() when starting the event sound playback.

error_code :

A numerical error code describing the reason this callback is called. If CA_SUCCESS is passed in the playback of the event sound was successfully completed.

userdata :

Some arbitrary user data the caller of ca_context_play_full() passed in.

ca_context_create ()

int                 ca_context_create                   (ca_context **c);


ca_context_destroy ()

int                 ca_context_destroy                  (ca_context *c);


ca_context_open ()

int                 ca_context_open                     (ca_context *c);


ca_context_set_driver ()

int                 ca_context_set_driver               (ca_context *c,
                                                         const char *driver);


ca_context_change_device ()

int                 ca_context_change_device            (ca_context *c,
                                                         const char *device);


ca_context_change_props ()

int                 ca_context_change_props             (ca_context *c,
                                                         ...);


ca_context_change_props_full ()

int                 ca_context_change_props_full        (ca_context *c,
                                                         ca_proplist *p);


ca_context_play ()

int                 ca_context_play                     (ca_context *c,
                                                         uint32_t id,
                                                         ...);


ca_context_play_full ()

int                 ca_context_play_full                (ca_context *c,
                                                         uint32_t id,
                                                         ca_proplist *p,
                                                         ca_finish_callback_t cb,
                                                         void *userdata);


ca_context_cancel ()

int                 ca_context_cancel                   (ca_context *c,
                                                         uint32_t id);


ca_context_cache ()

int                 ca_context_cache                    (ca_context *c,
                                                         ...);


ca_context_cache_full ()

int                 ca_context_cache_full               (ca_context *c,
                                                         ca_proplist *p);


ca_context_playing ()

int                 ca_context_playing                  (ca_context *c,
                                                         uint32_t id,
                                                         int *playing);


ca_strerror ()

const char *        ca_strerror                         (int code);


ca_proplist

typedef struct ca_proplist ca_proplist;

A canberra property list object. Basically a hashtable.


ca_proplist_create ()

int                 ca_proplist_create                  (ca_proplist **p);


ca_proplist_destroy ()

int                 ca_proplist_destroy                 (ca_proplist *p);


ca_proplist_sets ()

int                 ca_proplist_sets                    (ca_proplist *p,
                                                         const char *key,
                                                         const char *value);


ca_proplist_setf ()

int                 ca_proplist_setf                    (ca_proplist *p,
                                                         const char *key,
                                                         const char *format,
                                                         ...);


ca_proplist_set ()

int                 ca_proplist_set                     (ca_proplist *p,
                                                         const char *key,
                                                         const void *data,
                                                         size_t nbytes);