Difference between revisions of "Libcanberra"

From ArchWiki
Jump to: navigation, search
(New article about libcanberra with some example code)
 
(update link(s) (avoid redirect))
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[Category:Development (English)]]
+
[[Category:Development]]
 +
{{Related articles start}}
 +
{{Related|GTK+}}
 +
{{Related|Libnotify}}
 +
{{Related articles end}}
 
'''Libcanberra''' is a simple abstract interface for playing event sounds. It implements the [http://freedesktop.org/wiki/Specifications/sound-theme-spec XDG Sound Theme and Naming Specifications] for generating event sounds on free desktops, such as GNOME. Further description [http://0pointer.de/lennart/projects/libcanberra/ here]
 
'''Libcanberra''' is a simple abstract interface for playing event sounds. It implements the [http://freedesktop.org/wiki/Specifications/sound-theme-spec XDG Sound Theme and Naming Specifications] for generating event sounds on free desktops, such as GNOME. Further description [http://0pointer.de/lennart/projects/libcanberra/ here]
  
 
==Installation==
 
==Installation==
  
The {{Pkg|libcanberra}} package is available from the Extra repository. Install libcanberra from a terminal with the following command:
+
Libcanberra can be installed with the package {{Pkg|libcanberra}}, available in the [[Official repositories]]. It contains the library and a GTK+ module.
{{Cli|# pacman -S libcanberra}}
+
{{Note|Usually you don't have to install libcanberra explicitly, since all applications that requires libcanberra depends on it.}}
+
  
[[ALSA]] backend is included in libcanberra package, [[GStreamer]] and [[PulseAudio]] backends can be installed optionally as separated packages:
+
You have to choose a backend to play sounds:
{{Cli|# pacman -S libcanberra-gstreamer libcanberra-pulse}}
+
*[[ALSA]] backend is included in {{Pkg|libcanberra}} package
 +
*[[GStreamer]] backend can be installed with package {{Pkg|libcanberra-gstreamer}}, available in the [[Official repositories]].
 +
*[[PulseAudio]] backend can be installed with package {{Pkg|libcanberra-pulse}}, available in the [[Official repositories]].
 +
*[[OSS]] backend can be installed with the package {{AUR|libcanberra-oss}}, available in the [[Arch User Repository]].
  
[[OSS]] backend is available in {{AUR|libcanberra-oss}} package from AUR.
+
Also, you have to install a sound theme in order to hear any event sound:
 +
*The default sound theme is 'freedesktop', which can be installed with the package {{Pkg|sound-theme-freedesktop}}, available in the [[Official repositories]].
 +
*Alternatively, you can install {{AUR|ubuntu-sounds}}, available in the [[Arch User Repository]].
  
In order to hear any event sound, you have to install a sound theme. The default sound theme is {{Pkg|sound-theme-freedesktop}}, which can be installed by the following command:
+
==Configuration==
{{Cli|# pacman -S sound-theme-freedesktop}}
+
By default, the GTK+ module is loaded automatically, when a GTK+ application launched. You can overwrite default settings in user's GtkSettings file:
Alternatively you could install {{AUR|ubuntu-sounds}} from AUR, and modify your sound theme setting.
+
{{hc|$HOME/.gtkrc-2.0 and $XDG_CONFIG_HOME/gtk-3.0/settings.ini|<nowiki>gtk-enable-event-sounds=true
 +
gtk-enable-input-feedback-sounds=true
 +
gtk-sound-theme-name=freedesktop</nowiki>}}
  
==Tips & Tricks==
+
In GNOME, these settings are managed by gnome-settings-daemon, and the configuration is available in GSettings under org.gnome.desktop.sound schema.
 +
 
 +
==Systemd==
 +
To enable bootup, shutdown and reboot sounds using canberra, run:
 +
 
 +
{{ic|<nowiki># systemctl enable canberra-system-bootup.service</nowiki>}}
 +
 
 +
==Tips and tricks==
  
 
===Write your own canberra app===
 
===Write your own canberra app===
Line 24: Line 40:
 
====Bash====
 
====Bash====
 
*Dependency: {{Pkg|libcanberra}}
 
*Dependency: {{Pkg|libcanberra}}
{{File|hallo_world.sh|<nowiki>#!/bin/bash
+
{{hc|hello_world.sh|<nowiki>#!/bin/bash
canberra-gtk-play -i phone-incoming-call -d "Hallo world"</nowiki>}}
+
canberra-gtk-play -i phone-incoming-call -d "hello world"</nowiki>}}
  
 
====C====
 
====C====
 
*Dependency: {{Pkg|libcanberra}}
 
*Dependency: {{Pkg|libcanberra}}
*Build with: {{Codeline|gcc -o hallo_world `pkg-config --cflags --libs glib-2.0 libcanberra` hallo_world.c}}
+
*Build with: {{ic|gcc hello_world.c -o hello_world `pkg-config --cflags --libs glib-2.0 libcanberra`}}
{{File|hallo_world.c|<nowiki>#include <glib.h>
+
{{hc|hello_world.c|<nowiki>#include <glib.h>
 
#include <canberra.h>
 
#include <canberra.h>
 
void main () {
 
void main () {
ca_context * Hallo;
+
ca_context * hello;
ca_context_create (&Hallo);
+
ca_context_create (&hello);
ca_context_play (Hallo, 0,
+
ca_context_play (hello, 0,
 
CA_PROP_EVENT_ID, "phone-incoming-call",
 
CA_PROP_EVENT_ID, "phone-incoming-call",
CA_PROP_EVENT_DESCRIPTION, "Hallo world",
+
CA_PROP_EVENT_DESCRIPTION, "hello world",
 
NULL);
 
NULL);
 
g_usleep (2000000);
 
g_usleep (2000000);
Line 45: Line 61:
 
*Dependency: {{Pkg|libcanberra}}
 
*Dependency: {{Pkg|libcanberra}}
 
*Makedependency: {{Pkg|vala}}
 
*Makedependency: {{Pkg|vala}}
*Build with: {{Codeline|valac --pkg libcanberra hallo_world.gs}}
+
*Build with: {{ic|valac --pkg libcanberra hello_world.gs}}
{{File|hallo_world.gs|<nowiki>uses
+
{{hc|hello_world.gs|<nowiki>uses
 
Canberra
 
Canberra
 
init
 
init
Hallo: Context
+
hello: Context
Context.create(out Hallo)
+
Context.create(out hello)
Hallo.play (0,
+
hello.play (0,
 
PROP_EVENT_ID, "phone-incoming-call",
 
PROP_EVENT_ID, "phone-incoming-call",
PROP_EVENT_DESCRIPTION, "Hallo world")
+
PROP_EVENT_DESCRIPTION, "hello world")
 
Thread.usleep (2000000)</nowiki>}}
 
Thread.usleep (2000000)</nowiki>}}
  
Line 59: Line 75:
 
*Dependency: {{Pkg|libcanberra}}
 
*Dependency: {{Pkg|libcanberra}}
 
*Makedependency: {{Pkg|vala}}
 
*Makedependency: {{Pkg|vala}}
*Build with: {{Codeline|valac --pkg libcanberra hallo_world.vala}}
+
*Build with: {{ic|valac --pkg libcanberra hello_world.vala}}
{{File|hallo_world.vala|<nowiki>using Canberra;
+
{{hc|hello_world.vala|<nowiki>using Canberra;
public class HalloWorld {
+
public class HelloWorld {
 
static void main () {
 
static void main () {
Context Hallo;
+
Context hello;
Context.create(out Hallo);
+
Context.create(out hello);
Hallo.play (0,
+
hello.play (0,
 
PROP_EVENT_ID, "phone-incoming-call",
 
PROP_EVENT_ID, "phone-incoming-call",
PROP_EVENT_DESCRIPTION, "Hallo world");
+
PROP_EVENT_DESCRIPTION, "hello world");
 
Thread.usleep (2000000);
 
Thread.usleep (2000000);
 
}
 
}
 
}</nowiki>}}
 
}</nowiki>}}
  
==More Resources==
+
==See also==
*[http://developer.gnome.org/libcanberra/0.28/ Libcanberra Reference Manual]
+
*[http://0pointer.de/lennart/projects/libcanberra/gtkdoc/ Libcanberra Reference Manual]

Revision as of 11:59, 24 February 2014

Related articles

Libcanberra is a simple abstract interface for playing event sounds. It implements the XDG Sound Theme and Naming Specifications for generating event sounds on free desktops, such as GNOME. Further description here

Installation

Libcanberra can be installed with the package libcanberra, available in the Official repositories. It contains the library and a GTK+ module.

You have to choose a backend to play sounds:

Also, you have to install a sound theme in order to hear any event sound:

Configuration

By default, the GTK+ module is loaded automatically, when a GTK+ application launched. You can overwrite default settings in user's GtkSettings file:

$HOME/.gtkrc-2.0 and $XDG_CONFIG_HOME/gtk-3.0/settings.ini
gtk-enable-event-sounds=true
gtk-enable-input-feedback-sounds=true
gtk-sound-theme-name=freedesktop

In GNOME, these settings are managed by gnome-settings-daemon, and the configuration is available in GSettings under org.gnome.desktop.sound schema.

Systemd

To enable bootup, shutdown and reboot sounds using canberra, run:

# systemctl enable canberra-system-bootup.service

Tips and tricks

Write your own canberra app

You can write your own libcanberra sound events easily in some programming languages, or you can simply use bash.

Bash

hello_world.sh
#!/bin/bash
canberra-gtk-play -i phone-incoming-call -d "hello world"

C

  • Dependency: libcanberra
  • Build with: gcc hello_world.c -o hello_world `pkg-config --cflags --libs glib-2.0 libcanberra`
hello_world.c
#include <glib.h>
#include <canberra.h>
void main () {
	ca_context * hello;
	ca_context_create (&hello);
	ca_context_play (hello, 0,
		CA_PROP_EVENT_ID, "phone-incoming-call",
		CA_PROP_EVENT_DESCRIPTION, "hello world",
		NULL);
	g_usleep (2000000);
}

Genie

  • Dependency: libcanberra
  • Makedependency: vala
  • Build with: valac --pkg libcanberra hello_world.gs
hello_world.gs
uses
	Canberra
init
	hello: Context
	Context.create(out hello)
	hello.play (0,
		PROP_EVENT_ID, "phone-incoming-call",
		PROP_EVENT_DESCRIPTION, "hello world")
	Thread.usleep (2000000)

Vala

  • Dependency: libcanberra
  • Makedependency: vala
  • Build with: valac --pkg libcanberra hello_world.vala
hello_world.vala
using Canberra;
public class HelloWorld {
	static void main () {
	Context hello;
	Context.create(out hello);
	hello.play (0,
		PROP_EVENT_ID, "phone-incoming-call",
		PROP_EVENT_DESCRIPTION, "hello world");
	Thread.usleep (2000000);
	}
}

See also