Blame doc/README.html

Packit 3ae693
 
Packit 3ae693
Packit 3ae693
<html xmlns="http://www.w3.org/1999/xhtml">
Packit 3ae693
Packit 3ae693
<head>
Packit 3ae693
<title>libcanberra 0.30</title>
Packit 3ae693
<link rel="stylesheet" type="text/css" href="style.css" />
Packit 3ae693
</head>
Packit 3ae693
Packit 3ae693
<body>
Packit 3ae693

libcanberra 0.30

Packit 3ae693
Packit 3ae693

Copyright 2008-2012 Lennart Poettering <mzyvopnaoreen (at) 0pointer (dot) de>

Packit 3ae693
Packit 3ae693
    Packit 3ae693
        
  • License
  • Packit 3ae693
        
  • News
  • Packit 3ae693
        
  • Overview
  • Packit 3ae693
        
  • Current Status
  • Packit 3ae693
        
  • Documentation
  • Packit 3ae693
        
  • Requirements
  • Packit 3ae693
        
  • Installation
  • Packit 3ae693
        
  • Acknowledgements
  • Packit 3ae693
        
  • Download
  • Packit 3ae693
    Packit 3ae693
    Packit 3ae693

    License

    Packit 3ae693
    Packit 3ae693

    This program is free software; you can redistribute it and/or

    Packit 3ae693
    modify it under the terms of the GNU Lesser General Public License as
    Packit 3ae693
    published by the Free Software Foundation, either version 2.1 of the
    Packit 3ae693
    License, or (at your option) any later version.

    Packit 3ae693
    Packit 3ae693

    This program is distributed in the hope that it will be useful, but

    Packit 3ae693
    WITHOUT ANY WARRANTY; without even the implied warranty of
    Packit 3ae693
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    Packit 3ae693
    Lesser General Public License for more details.

    Packit 3ae693
    Packit 3ae693

    News

    Packit 3ae693
    Packit 3ae693
    Tue 25 Sep
    Packit 3ae693
    2012:  

    Version

    Packit 3ae693
    0.30 released; Port to GStreamer 1.0.

    Packit 3ae693
    Packit 3ae693
    Tue 15 May
    Packit 3ae693
    2012:  

    Version

    Packit 3ae693
    0.29 released; A couple of bugfixes, drop GConf usage.

    Packit 3ae693
    Packit 3ae693
    Thu 24 Feb
    Packit 3ae693
    2011:  

    Version

    Packit 3ae693
    0.28 released; Hook properly into GNOME 3.0 sessions; this drops
    Packit 3ae693
    support for GNOME 2.0 sessions, but not applications.

    Packit 3ae693
    Packit 3ae693
    Fri 18 Feb
    Packit 3ae693
    2011:  

    Version

    Packit 3ae693
    0.27 released; Gtk+ 3.x fixes; add new tool to implement boot-up
    Packit 3ae693
    sounds when used with systemd; other fixes

    Packit 3ae693
    Packit 3ae693
    Mon 4 Oct
    Packit 3ae693
    2010:  

    Version

    Packit 3ae693
    0.26 released; Gtk+ 3.x fixes.

    Packit 3ae693
    Packit 3ae693
    Sun 13 Jun
    Packit 3ae693
    2010:  

    Version

    Packit 3ae693
    0.25 released; Optionally build with Gtk+ 3.x in addition to Gtk+ 2.x.

    Packit 3ae693
    Packit 3ae693
    Mon 19 Apr
    Packit 3ae693
    2010:  

    Version

    Packit 3ae693
    0.24 released; GTK code is now fine with GSEAL. Minor fixes in the
    Packit 3ae693
    PulseAudio backend, other fixes.

    Packit 3ae693
    Packit 3ae693
    Sat 20 Feb
    Packit 3ae693
    2010:  

    Version

    Packit 3ae693
    0.23 released; various minor fixes in the pulse and gstreamer
    Packit 3ae693
    backends as well in the Vala API. Support for the recently
    Packit 3ae693
    standardized Vorbis 6.1/7.1 multichannel modes.

    Packit 3ae693
    Packit 3ae693
    Tue 20 Oct
    Packit 3ae693
    2009:  

    Version

    Packit 3ae693
    0.22 released; small fix to make sure we don't dereference a null
    Packit 3ae693
    pointer. 

    Packit 3ae693
    Packit 3ae693
    Fri 16 Oct 2009:

    Packit 3ae693
    href="http://0pointer.de/lennart/projects/libcanberra/libcanberra-0.21.tar.gz">Version 0.21 released;
    Packit 3ae693
    suppress casting warning

    Packit 3ae693
    Packit 3ae693
    Thu 15 Oct 2009:

    Packit 3ae693
    href="http://0pointer.de/lennart/projects/libcanberra/libcanberra-0.20.tar.gz">Version 0.20 released;
    Packit 3ae693
    minor casting fix

    Packit 3ae693
    Packit 3ae693
    Wed 14 Oct 2009:

    Packit 3ae693
    href="http://0pointer.de/lennart/projects/libcanberra/libcanberra-0.19.tar.gz">Version 0.19 released;
    Packit 3ae693
    some important fixes for the Gtk support

    Packit 3ae693
    Packit 3ae693
    Sun 20 Sep 2009:

    Packit 3ae693
    href="http://0pointer.de/lennart/projects/libcanberra/libcanberra-0.18.tar.gz">Version 0.18 released;
    Packit 3ae693
    numerous updates for the Gtk support

    Packit 3ae693
    Packit 3ae693
    Fri 12 Sep 2009:

    Packit 3ae693
    href="http://0pointer.de/lennart/projects/libcanberra/libcanberra-0.17.tar.gz">Version 0.17 released;
    Packit 3ae693
    add vala vapi file; numerous updates to Gtk support

    Packit 3ae693
    Packit 3ae693
    Thu 27 Aug 2009:

    Packit 3ae693
    href="http://0pointer.de/lennart/projects/libcanberra/libcanberra-0.16.tar.gz">Version 0.16 released;
    Packit 3ae693
    add new <tt>ca_context_playing()</tt> call

    Packit 3ae693
    Packit 3ae693
    Wed 5 Aug 2009:

    Packit 3ae693
    href="http://0pointer.de/lennart/projects/libcanberra/libcanberra-0.15.tar.gz">Version 0.15 released;
    Packit 3ae693
    bug fixes

    Packit 3ae693
    Packit 3ae693
    Thu 2 Jul 2009:

    Packit 3ae693
    href="http://0pointer.de/lennart/projects/libcanberra/libcanberra-0.14.tar.gz">Version 0.14 released;
    Packit 3ae693
    bug fixes

    Packit 3ae693
    Packit 3ae693
    Tue 23 Jun 2009:

    Packit 3ae693
    href="http://0pointer.de/lennart/projects/libcanberra/libcanberra-0.13.tar.gz">Version 0.13 released;
    Packit 3ae693
    multichannel support; gtk multihead support; bug fixes

    Packit 3ae693
    Packit 3ae693
    Mon 13 Apr 2009:

    Packit 3ae693
    href="http://0pointer.de/lennart/projects/libcanberra/libcanberra-0.12.tar.gz">Version 0.12 released;
    Packit 3ae693
    changes include: various fixes and updates for the PulseAudio backend;
    Packit 3ae693
    detect forks and return an error for all functions in that case

    Packit 3ae693
    Packit 3ae693
    Wed 21 Jan
    Packit 3ae693
    2009:  

    Version

    Packit 3ae693
    0.11 released; changes include: major GStreamer backend fixes; update to libtool 2.2; a few other fixes

    Packit 3ae693
    Packit 3ae693
    Mon 6 Oct
    Packit 3ae693
    2008:  

    Version

    Packit 3ae693
    0.10 released; changes include: install Gtk+ module using GConf; a few other fixes

    Packit 3ae693
    Packit 3ae693
    Tue 9 Sep
    Packit 3ae693
    2008:  

    Version

    Packit 3ae693
    0.9 released; changes include: GStreamer fixes, include (optional)
    Packit 3ae693
    libtdb based lookup cache.

    Packit 3ae693
    Packit 3ae693
    Thu 28 Aug
    Packit 3ae693
    2008:  

    Version

    Packit 3ae693
    0.8 released; changes include: new OSS and GStreamer backend;
    Packit 3ae693
    portability fixes for FreeBSD/Solaris; the multi backend works now

    Packit 3ae693
    Packit 3ae693
    Thu 14 Aug
    Packit 3ae693
    2008:  

    Version

    Packit 3ae693
    0.7 released; changes include: documentation updates; various bug
    Packit 3ae693
    fixes; add this web site/README; allow playback of event sounds with
    Packit 3ae693
    only a sound file path specified; other changes

    Packit 3ae693
    Packit 3ae693

    Overview

    Packit 3ae693
    Packit 3ae693

    <tt>libcanberra</tt> is an implementation of

    Packit 3ae693
    the XDG
    Packit 3ae693
    Sound Theme and Name Specifications, for generating event sounds
    Packit 3ae693
    on free desktops, such
    Packit 3ae693
    as GNOME. It comes with several
    Packit 3ae693
    backends
    Packit 3ae693
    (ALSA, PulseAudio,
    Packit 3ae693
    OSS, GStreamer, null) and is
    Packit 3ae693
    designed to be portable. It consists of the following parts:

    Packit 3ae693
    Packit 3ae693
      Packit 3ae693
    1. <tt>libcanberra</tt>: the main library
    2. Packit 3ae693
    3. <tt>libcanberra-gtk</tt>: some glue code to make it easier to use <tt>libcanberra</tt> from Gtk+ applications
    4. Packit 3ae693
    5. <tt>libcanberra-gtk-module</tt>: a Gtk+ module that uses <tt>libcanberra-gtk</tt> to trigger input feedback event sounds
    6. Packit 3ae693
      Packit 3ae693
      Packit 3ae693

      For more information see the original announcement.

      Packit 3ae693
      Packit 3ae693

      Current Status

      Packit 3ae693
      Packit 3ae693

      <tt>libcanberra</tt> is mostly feature complete. For now however it

      Packit 3ae693
      includes backends only for ALSA, PulseAudio, OSS and GStreamer.

      Packit 3ae693
      Packit 3ae693

      <tt>libcanberra</tt> has been

      Packit 3ae693
      declared a
      Packit 3ae693
      blessed GNOME dependency.

      Packit 3ae693
      Packit 3ae693

      The OSS driver is incomplete: only sound files that are in a format

      Packit 3ae693
      natively understood by the sound card are supported. If the sample
      Packit 3ae693
      type, channel map or sampling rate of the sound file are not supported
      Packit 3ae693
      by the sound card no automatic conversion will take place and the file
      Packit 3ae693
      will not be played. Also note that the OSS backend is most likely
      Packit 3ae693
      incompatible with OSS4, due to subtle incompatibilities between OSS4
      Packit 3ae693
      and the OSS 3.x.

      Packit 3ae693
      Packit 3ae693

      It is recommended to always take the "shortest" path from

      Packit 3ae693
      libcanberra to the audio device. I.e. don't use the GStreamer plugin
      Packit 3ae693
      if libcanberra supports the final output target natively. Besides
      Packit 3ae693
      being more resource-friendly and less error-prone, some advanced
      Packit 3ae693
      functionality might get lost with each layer you add to your
      Packit 3ae693
      stack. For example: while you could use libcanberra's Gstreamer
      Packit 3ae693
      backend to output to a PulseAudio server this will not be able to make
      Packit 3ae693
      use of sample cacheing or will be able to attach additional meta data
      Packit 3ae693
      to the sounds played, which might be necessary for effects like
      Packit 3ae693
      positional event sounds.

      Packit 3ae693
      Packit 3ae693

      Documentation

      Packit 3ae693
      Packit 3ae693

      You may browse the gtkdoc

      Packit 3ae693
      generated programing
      Packit 3ae693
      documentation of the API.

      Packit 3ae693
      Packit 3ae693

      Requirements

      Packit 3ae693
      Packit 3ae693

      Currently, <tt>libcanberra</tt> is tested on Linux only.

      Packit 3ae693
      Packit 3ae693

      <tt>libcanberra</tt> was developed and tested on Fedora Rawhide

      Packit 3ae693
      from August 2008, it should work on most other Linux
      Packit 3ae693
      distributions (and maybe Unix versions) since it uses GNU autoconf and
      Packit 3ae693
      GNU libtool for source code configuration and shared library
      Packit 3ae693
      management.

      Packit 3ae693
      Packit 3ae693

      <tt>libcanberra</tt> has no dependencies besides the OGG Vorbis

      Packit 3ae693
      development headers and whatever the selected backends require. Gtk+
      Packit 3ae693
      support is optional. An optional lookup cache can be used if Samba's
      Packit 3ae693
      tdb trivial database is available.

      Packit 3ae693
      Packit 3ae693

      Installation

      Packit 3ae693
      Packit 3ae693

      As this package is made with the GNU autotools you should run

      Packit 3ae693
      <tt>./configure</tt> inside the distribution directory for configuring
      Packit 3ae693
      the source tree. After that you should run <tt>make</tt> for
      Packit 3ae693
      compilation and <tt>make install</tt> (as root) for installation of
      Packit 3ae693
      <tt>libcanberra</tt>.

      Packit 3ae693
      Packit 3ae693

      Acknowledgements

      Packit 3ae693
      Packit 3ae693

      Marc-André Lureau and Brian Cameron for the GStreamer backend.

      Packit 3ae693
      Packit 3ae693

      Joe Marcus Clarke for the OSS backend.

      Packit 3ae693
      Packit 3ae693

      Diego Elio Pettenò for various build system fixes.

      Packit 3ae693
      Packit 3ae693

      Download

      Packit 3ae693
      Packit 3ae693

      The newest release is always available from http://0pointer.de/lennart/projects/libcanberra/

      Packit 3ae693
      Packit 3ae693

      The current release is 0.30

      Packit 3ae693
      Packit 3ae693

      Get <tt>libcanberra</tt>'s development sources from the GIT repository (gitweb):

      Packit 3ae693
      Packit 3ae693
      git clone git://git.0pointer.de/libcanberra
      Packit 3ae693
      Packit 3ae693

      If you want to report bugs, have questions or want to be notified about new releases, please join the <tt>libcanberra-discuss</tt> mailing list.

      Packit 3ae693
      Packit 3ae693

      If you want to be notified about new git commits, please join the <tt>libcanberra-commits</tt> mailing list.

      Packit 3ae693
      Packit 3ae693

      <tt>libcanberra</tt>'s bugs are tracked at bugs.freedesktop.org.

      Packit 3ae693
      Packit 3ae693

      Packit 3ae693
      <address class="grey">Lennart Poettering <mzyvopnaoreen (at) 0pointer (dot) de>, September 2012</address>
      Packit 3ae693
      Packit 3ae693
      </body>
      Packit 3ae693
      </html>