canberra-gtk-play - play a sound event
canberra-gtk-play [--cache-control=permanent|volatile|never] [--description=description] [--display=display] [--file=file] [--help] [--id=identifier] [--loop=times] [--version] [gnome-std-options]
canberra-gtk-play(1) User Commands canberra-gtk-play(1)
NAME
canberra-gtk-play - play a sound event
SYNOPSIS
canberra-gtk-play [--cache-control=permanent|volatile|never]
[--description=description] [--display=display] [--file=file] [--help]
[--id=identifier] [--loop=times] [--version] [gnome-std-options]
DESCRIPTION
canberra-gtk-play is an application for playing sound events that are
specified by the FreeDesktop "XDG Sound Theme and Name Specification".
OPTIONS
The following options are supported:
--c, --cache-control=[permanent|volatile|never]
Specify how canberra-gtk-play will manage its cache control. The
value of "permanent" will cause the sample to be cached in the
server permanently. This is useful for very frequently used
sounds. The value of "volatile" may be used for caching sounds in
the sound server temporarily. They will expire after some time or
on cache pressure. The value of "never" may be used that should
never be cached, because they are only generated very seldomly or
only once.
Not all libcanberra backends support caching, and this option is
only functional if the backend being used does support this func-
tionality.
-d, --description=description
Specify a description for the sound event.
--display=display
Specify the X display to use.
-f, --file=file
Specify a file to play.
-?, --help
Display usage information.
-i, --id=identifier
Specify the event identifier to play. These identifier values are
specified in the "XDG Sound Theme and Name Specification".
-l, --loop=times
Specify the number of times to play the file. The default value is
1.
-v, --version
Display canberra-gtk-play version number.
gnome-std-options
Standard options available for use with most GNOME applications.
See gnome-std-options(7) for more information.
EXAMPLES
Example 1: Play the "desktop-login" sound event
example% canberra-gtk-play --id desktop-login --description="GNOME Login"
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+---------------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+---------------------------------+
|Availability | library/desktop/xdg/libcanberra |
+---------------+---------------------------------+
|Stability | Pass-through volatile |
+---------------+---------------------------------+
SEE ALSO
libcanberra(3lib), attributes(7), gnome-std-options(7)
NOTES
Written by Brian Cameron, Sun Microsystems Inc., 2009.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from http://0pointer.de/lennart/projects/libcan-
berra/libcanberra-0.30.tar.xz
Further information about this software can be found on the open source
community website at http://0pointer.de/lennart/projects/libcanberra/.
Solaris 11.4 7 Apr 2017 canberra-gtk-play(1)