/usr/share/gir-1.0/GSound-1.0.gir is in libgsound-dev 1.0.2-1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 | <?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="GObject" version="2.0"/>
<include name="Gio" version="2.0"/>
<c:include name="gsound.h"/>
<namespace name="GSound"
version="1.0"
shared-library="libgsound.so.0"
c:identifier-prefixes="GSound"
c:symbol-prefixes="gsound">
<constant name="ATTR_APPLICATION_ICON"
value="application.icon"
c:type="GSOUND_ATTR_APPLICATION_ICON">
<doc xml:space="preserve">Binary icon data in PNG format for the application this sound event
is triggered by.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_APPLICATION_ICON_NAME"
value="application.icon_name"
c:type="GSOUND_ATTR_APPLICATION_ICON_NAME">
<doc xml:space="preserve">An icon name for the application this sound event is triggered by,
as defined in the XDG icon naming specification.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_APPLICATION_ID"
value="application.id"
c:type="GSOUND_ATTR_APPLICATION_ID">
<doc xml:space="preserve">An identifier for the program this sound event was triggered
by. (e.g. "org.gnu.emacs").
> This attribute will automatically be added to the #GSoundContext with
> the #GApplication:application-id if you are using #GApplication, so you
> normally do not need to supply this yourself.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_APPLICATION_LANGUAGE"
value="application.language"
c:type="GSOUND_ATTR_APPLICATION_LANGUAGE">
<doc xml:space="preserve">The locale string the application that is triggering this sound
event is running in. A POSIX locale string such as de_DE@euro.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_APPLICATION_NAME"
value="application.name"
c:type="GSOUND_ATTR_APPLICATION_NAME">
<doc xml:space="preserve">The name of the application this sound event was triggered by as
human readable string. (e.g. "GNU Emacs") Localized if possible and
applicable.
> This attribute will automatically be added to the #GSoundContext if
> it has previously been set with g_set_application_name(), so you normally
> do not need to supply this yourself.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_APPLICATION_PROCESS_BINARY"
value="application.process.binary"
c:type="GSOUND_ATTR_APPLICATION_PROCESS_BINARY">
<doc xml:space="preserve">The path to the process binary of the process that is triggering this sound event.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_APPLICATION_PROCESS_HOST"
value="application.process.host"
c:type="GSOUND_ATTR_APPLICATION_PROCESS_HOST">
<doc xml:space="preserve">The host name of the host the process that is triggering this sound event runs on.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_APPLICATION_PROCESS_ID"
value="application.process.id"
c:type="GSOUND_ATTR_APPLICATION_PROCESS_ID">
<doc xml:space="preserve">The unix PID of the process that is triggering this sound event, formatted as string.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_APPLICATION_PROCESS_USER"
value="application.process.user"
c:type="GSOUND_ATTR_APPLICATION_PROCESS_USER">
<doc xml:space="preserve">The user that owns the process that is triggering this sound event.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_APPLICATION_VERSION"
value="application.version"
c:type="GSOUND_ATTR_APPLICATION_VERSION">
<doc xml:space="preserve">A version number for the program this sound event was triggered
by. (e.g. "22.2")</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_CANBERRA_CACHE_CONTROL"
value="canberra.cache-control"
c:type="GSOUND_ATTR_CANBERRA_CACHE_CONTROL">
<doc xml:space="preserve">A special attribute 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 attribute is not explicitly passed to gsound_context_play_simple()
or gsound_context_play_full() it will default to "never". If it is not
explicitly passed to gsound_context_cache() it will default to "permanent".
If the list of attributes is handed on to the sound server this
attribute is stripped from it.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_CANBERRA_ENABLE"
value="canberra.enable"
c:type="GSOUND_ATTR_CANBERRA_ENABLE">
<doc xml:space="preserve">A special attribute that can be used to control whether any sounds
are played at all. If this attribute is "1" or unset sounds are
played as normal. However, if it is "0" all calls to
gsound_context_play_simple() or `play_full()` will fail with
GSOUND_ERROR_DISABLED.
If the list of attributes is handed on to the sound server this
attribute is stripped from it.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_CANBERRA_FORCE_CHANNEL"
value="canberra.force_channel"
c:type="GSOUND_ATTR_CANBERRA_FORCE_CHANNEL">
<doc xml:space="preserve">A special attribute that can be used to control on which channel a
sound is played. The value should be one of mono, front-left,
front-right, front-center, rear-left, rear-right, rear-center, lfe,
front-left-of-center, front-right-of-center, side-left, side-right,
top-center, top-front-left, top-front-right, top-front-center,
top-rear-left, top-rear-right, top-rear-center. This attribute is
only honoured by some backends, other backends may choose to ignore
it completely.
If the list of attributes is handed on to the sound server this
attribute is stripped from it.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_CANBERRA_VOLUME"
value="canberra.volume"
c:type="GSOUND_ATTR_CANBERRA_VOLUME">
<doc xml:space="preserve">A special attribute 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 attributes is handed on to the sound server this
attribute is stripped from it.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_CANBERRA_XDG_THEME_NAME"
value="canberra.xdg-theme.name"
c:type="GSOUND_ATTR_CANBERRA_XDG_THEME_NAME">
<doc xml:space="preserve">A special attribute that can be used to control the XDG sound theme that
is used for this sample.
If the list of attributes is handed on to the sound server this
attribute is stripped from it.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_CANBERRA_XDG_THEME_OUTPUT_PROFILE"
value="canberra.xdg-theme.output-profile"
c:type="GSOUND_ATTR_CANBERRA_XDG_THEME_OUTPUT_PROFILE">
<doc xml:space="preserve">A special attribute that can be used to control the XDG sound theme
output profile that is used for this sample.
If the list of attributes is handed on to the sound server this
attribute is stripped from it.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_EVENT_DESCRIPTION"
value="event.description"
c:type="GSOUND_ATTR_EVENT_DESCRIPTION">
<doc xml:space="preserve">A descriptive string for the sound event. Localized if possible and applicable.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_EVENT_ID"
value="event.id"
c:type="GSOUND_ATTR_EVENT_ID">
<doc xml:space="preserve">A textual id for an event sound, as mandated by the XDG sound naming specification.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_EVENT_MOUSE_BUTTON"
value="event.mouse.button"
c:type="GSOUND_ATTR_EVENT_MOUSE_BUTTON">
<doc xml:space="preserve">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.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_EVENT_MOUSE_HPOS"
value="event.mouse.hpos"
c:type="GSOUND_ATTR_EVENT_MOUSE_HPOS">
<doc xml:space="preserve">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.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_EVENT_MOUSE_VPOS"
value="event.mouse.vpos"
c:type="GSOUND_ATTR_EVENT_MOUSE_VPOS">
<doc xml:space="preserve">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.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_EVENT_MOUSE_X"
value="event.mouse.x"
c:type="GSOUND_ATTR_EVENT_MOUSE_X">
<doc xml:space="preserve">If this sound event was triggered by a mouse input event, the X
position of the mouse cursor on the screen, formatted as string.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_EVENT_MOUSE_Y"
value="event.mouse.y"
c:type="GSOUND_ATTR_EVENT_MOUSE_Y">
<doc xml:space="preserve">If this sound event was triggered by a mouse input event, the Y
position of the mouse cursor on the screen, formatted as string.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_MEDIA_ARTIST"
value="media.artist"
c:type="GSOUND_ATTR_MEDIA_ARTIST">
<doc xml:space="preserve">The artist of this media. Localized if possible and applicable.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_MEDIA_FILENAME"
value="media.filename"
c:type="GSOUND_ATTR_MEDIA_FILENAME">
<doc xml:space="preserve">The file name this media was or can be loaded from.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_MEDIA_ICON"
value="media.icon"
c:type="GSOUND_ATTR_MEDIA_ICON">
<doc xml:space="preserve">An icon for this media in binary PNG format.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_MEDIA_ICON_NAME"
value="media.icon_name"
c:type="GSOUND_ATTR_MEDIA_ICON_NAME">
<doc xml:space="preserve">An icon name as defined in the XDG icon naming specifcation.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_MEDIA_LANGUAGE"
value="media.language"
c:type="GSOUND_ATTR_MEDIA_LANGUAGE">
<doc xml:space="preserve">The language this media is in, in some standard POSIX locale string, such as "de_DE".</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_MEDIA_NAME"
value="media.name"
c:type="GSOUND_ATTR_MEDIA_NAME">
<doc xml:space="preserve">A name describing the media being played. Localized if possible and applicable.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_MEDIA_ROLE"
value="media.role"
c:type="GSOUND_ATTR_MEDIA_ROLE">
<doc xml:space="preserve">The "role" this media is played in. For event sounds the string
"event". For other cases strings like "music", "video", "game", ...</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_MEDIA_TITLE"
value="media.title"
c:type="GSOUND_ATTR_MEDIA_TITLE">
<doc xml:space="preserve">A (song) title describing the media being played. Localized if possible and applicable.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_DESKTOP"
value="window.desktop"
c:type="GSOUND_ATTR_WINDOW_DESKTOP">
<doc xml:space="preserve">If this sound event was triggered by a window on the screen and the
windowing system supports multiple desktops, a comma seperated list
of indexes of the desktops this window is visible on. If this
attribute is an empty string, it is visible on all desktops
(i.e. 'sticky'). The first desktop is 0. (e.g. "0,2,3")</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_HEIGHT"
value="window.height"
c:type="GSOUND_ATTR_WINDOW_HEIGHT">
<doc xml:space="preserve">If this sound event was triggered by a window on the screen, the
pixel height of the window.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_HPOS"
value="window.hpos"
c:type="GSOUND_ATTR_WINDOW_HPOS">
<doc xml:space="preserve">If this sound event was triggered by a window on the screen, the X
position of the center of the window as fractional value between 0
and 1, formatted as string, 0 reflecting the left side of the
screen, 1 the right side.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_ICON"
value="window.icon"
c:type="GSOUND_ATTR_WINDOW_ICON">
<doc xml:space="preserve">If this sound event was triggered by a window on the screen, binary
icon data in PNG format for this window.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_ICON_NAME"
value="window.icon_name"
c:type="GSOUND_ATTR_WINDOW_ICON_NAME">
<doc xml:space="preserve">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.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_ID"
value="window.id"
c:type="GSOUND_ATTR_WINDOW_ID">
<doc xml:space="preserve">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.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_NAME"
value="window.name"
c:type="GSOUND_ATTR_WINDOW_NAME">
<doc xml:space="preserve">If this sound event was triggered by a window on the screen, the
name of this window as human readable string.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_VPOS"
value="window.vpos"
c:type="GSOUND_ATTR_WINDOW_VPOS">
<doc xml:space="preserve">If this sound event was triggered by a window on the screen, the Y
position of the center of the window as fractional value between 0
and 1, formatted as string, 0 reflecting the top side of the
screen, 1 the bottom side.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_WIDTH"
value="window.width"
c:type="GSOUND_ATTR_WINDOW_WIDTH">
<doc xml:space="preserve">If this sound event was triggered by a window on the screen, the
pixel width of the window.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_X"
value="window.x"
c:type="GSOUND_ATTR_WINDOW_X">
<doc xml:space="preserve">If this sound event was triggered by a window on the screen, the X
position of the window measured from the top left corner of the
screen to the top left corner of the window.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_X11_DISPLAY"
value="window.x11.display"
c:type="GSOUND_ATTR_WINDOW_X11_DISPLAY">
<doc xml:space="preserve">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").</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_X11_MONITOR"
value="window.x11.monitor"
c:type="GSOUND_ATTR_WINDOW_X11_MONITOR">
<doc xml:space="preserve">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").</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_X11_SCREEN"
value="window.x11.screen"
c:type="GSOUND_ATTR_WINDOW_X11_SCREEN">
<doc xml:space="preserve">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").</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_X11_XID"
value="window.x11.xid"
c:type="GSOUND_ATTR_WINDOW_X11_XID">
<doc xml:space="preserve">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.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ATTR_WINDOW_Y"
value="window.y"
c:type="GSOUND_ATTR_WINDOW_Y">
<doc xml:space="preserve">If this sound event was triggered by a window on the screen, the y
position of the window measured from the top left corner of the
screen to the top left corner of the window.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<class name="Context"
c:symbol-prefix="context"
c:type="GSoundContext"
parent="GObject.Object"
glib:type-name="GSoundContext"
glib:get-type="gsound_context_get_type"
glib:type-struct="ContextClass">
<doc xml:space="preserve">ca: the wrapped context
Wrapper for ca_context.</doc>
<implements name="Gio.Initable"/>
<constructor name="new" c:identifier="gsound_context_new" throws="1">
<doc xml:space="preserve">Creates and initializes a new #GSoundContext. If the an error occured
during initialization, #NULL is returned and @error will be set
appropriately.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A new #GSoundContext</doc>
<type name="Context" c:type="GSoundContext*"/>
</return-value>
<parameters>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GCancellable, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</constructor>
<method name="cache"
c:identifier="gsound_context_cache"
shadowed-by="cachev"
introspectable="0">
<doc xml:space="preserve">Requests that a sound be cached on the server. See [#caching][gsound-GSound-Context#caching].</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #GSoundContext</doc>
<type name="Context" c:type="GSoundContext*"/>
</instance-parameter>
<parameter name="error" transfer-ownership="none">
<doc xml:space="preserve">Return location for error</doc>
<type name="GLib.Error" c:type="GError**"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">A %NULL-terminated list of attribute-value pairs</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="cachev"
c:identifier="gsound_context_cachev"
shadows="cache"
throws="1">
<doc xml:space="preserve">Requests that a sound be cached on the server. See [#caching][gsound-GSound-Context#caching].
This function is intented to be used by language bindings.</doc>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #GSoundContext</doc>
<type name="Context" c:type="GSoundContext*"/>
</instance-parameter>
<parameter name="attrs" transfer-ownership="none">
<doc xml:space="preserve">Hash table of attrerties</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</method>
<method name="open" c:identifier="gsound_context_open" throws="1">
<doc xml:space="preserve">Attempts to open a connection to the backend sound driver. It is recommended
that you set context attributes with gsound_context_set_attributes() before
calling this function.
> A connection is automatically opened before playing or caching sounds,
> so you rarely need to call this yourself.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the output device was opened successfully, or %FALSE
(populating @error)</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #GSoundContext</doc>
<type name="Context" c:type="GSoundContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="play_full"
c:identifier="gsound_context_play_full"
shadowed-by="play_fullv"
introspectable="0">
<doc xml:space="preserve">Asynchronously request a sound to be played. When playback is finished
(or if an error occurs) then @callback will be called, following the
normal GIO async pattern.
If playback is cancelled via @cancellable, then @callback will be called
with #G_IO_ERROR_CANCELLED.
If you do not need notification of when playback is complete, you should
use gsound_context_play_simple().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #GSoundContext</doc>
<type name="Context" c:type="GSoundContext*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GCancellable, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="2">
<doc xml:space="preserve">callback</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">User data passed to @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">A %NULL-terminated list of attribute-value pairs</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="play_full_finish"
c:identifier="gsound_context_play_full_finish"
throws="1">
<doc xml:space="preserve">Finish an async operation started by gsound_context_play_full(). You
must call this function in the callback to free memory and receive any
errors which occurred.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if playing finished successfully</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #GSoundContext</doc>
<type name="Context" c:type="GSoundContext*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve">Result object passed to the callback of
gsound_context_play_full()</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</method>
<method name="play_fullv"
c:identifier="gsound_context_play_fullv"
shadows="play_full">
<doc xml:space="preserve">Asynchronously request a sound to be played. When playback is finished
(or if an error occurs) then @callback will be called, following the
normal GIO async pattern.
If playback is cancelled via @cancellable, then @callback will be called
with #G_IO_ERROR_CANCELLED.
If you do not need notification of when playback is complete, you should
use gsound_context_play_simple().
This function is intented to be used by language bindings.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #GSoundContext</doc>
<type name="Context" c:type="GSoundContext*"/>
</instance-parameter>
<parameter name="attrs" transfer-ownership="none">
<doc xml:space="preserve">Attributes</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GCancellable, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve">callback</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">user_data</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="play_simple"
c:identifier="gsound_context_play_simple"
shadowed-by="play_simplev"
introspectable="0">
<doc xml:space="preserve">The basic "fire-and-forget" play command. This function will not block, and
just sends a request to the sound server before immediately returning.
If you need to know when a sound finishes playing then you should call
gsound_context_play_full() instead.
You can cancel playback at any time by calling g_cancellable_cancel() on
@cancellable, if supplied.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, or %FALSE, populating @error</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #GSoundContext</doc>
<type name="Context" c:type="GSoundContext*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GCancellable, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="error" transfer-ownership="none">
<doc xml:space="preserve">Return location for error, or %NULL</doc>
<type name="GLib.Error" c:type="GError**"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">A %NULL-terminated list of attribute-value pairs</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="play_simplev"
c:identifier="gsound_context_play_simplev"
shadows="play_simple"
throws="1">
<doc xml:space="preserve">The basic "fire-and-forget" play command. This function will not block, and
just sends a request to the sound server before immediately returning.
If you need to know when a sound finishes playing then you should call
gsound_context_play_full() instead.
You can cancel playback at any time by calling g_cancellable_cancel() on
@cancellable, if supplied.
This function is intented to be used by language bindings.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE on error</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #GSoundContext</doc>
<type name="Context" c:type="GSoundContext*"/>
</instance-parameter>
<parameter name="attrs" transfer-ownership="none">
<doc xml:space="preserve">Attributes</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GCancellable</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="set_attributes"
c:identifier="gsound_context_set_attributes"
shadowed-by="set_attributesv"
introspectable="0">
<doc xml:space="preserve">Set attributes or change attributes on @context. Subsequent calls to this
function calling the same attributes will override the earlier values.
Note that GSound will set the #GSOUND_ATTR_APPLICATION_NAME and
#GSOUND_ATTR_APPLICATION_ID for you if using #GApplication, so you do
not normally need to set these yourself.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if attributes were updated successfully</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #GSoundContext</doc>
<type name="Context" c:type="GSoundContext*"/>
</instance-parameter>
<parameter name="error" transfer-ownership="none">
<doc xml:space="preserve">Return location for error</doc>
<type name="GLib.Error" c:type="GError**"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">%NULL terminated list of attribute name-value pairs</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="set_attributesv"
c:identifier="gsound_context_set_attributesv"
shadows="set_attributes"
throws="1">
<doc xml:space="preserve">Set attributes or change attributes on @context. Subsequent calls to this
function calling the same attributes will override the earlier values.
Note that GSound will set the #GSOUND_ATTR_APPLICATION_NAME and
#GSOUND_ATTR_APPLICATION_ID for you if using #GApplication, so you do
not normally need to set these yourself.
This function is intented to be used by language bindings.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if attributes were updated successfully</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #GSoundContext</doc>
<type name="Context" c:type="GSoundContext*"/>
</instance-parameter>
<parameter name="attrs" transfer-ownership="none">
<doc xml:space="preserve">Hash table of attributes to set</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</method>
<method name="set_driver"
c:identifier="gsound_context_set_driver"
throws="1">
<doc xml:space="preserve">Sets the libcanberra driver to @driver, for example "pulse", "alsa" or "null".
You normally do not need to set this yourself.
Note that this function may return %TRUE even if the specified driver is
not available: see the libcanberra documentation for details.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the libcanberra driver was set successfully</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">A #GSoundContext</doc>
<type name="Context" c:type="GSoundContext*"/>
</instance-parameter>
<parameter name="driver" transfer-ownership="none">
<doc xml:space="preserve">libcanberra driver to use</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
</class>
<record name="ContextClass"
c:type="GSoundContextClass"
disguised="1"
glib:is-gtype-struct-for="Context">
</record>
<enumeration name="Error"
c:type="GSoundError"
glib:error-domain="gsound - error - quark">
<member name="notsupported"
value="-1"
c:identifier="GSOUND_ERROR_NOTSUPPORTED">
</member>
<member name="invalid" value="-2" c:identifier="GSOUND_ERROR_INVALID">
</member>
<member name="state" value="-3" c:identifier="GSOUND_ERROR_STATE">
</member>
<member name="oom" value="-4" c:identifier="GSOUND_ERROR_OOM">
</member>
<member name="nodriver" value="-5" c:identifier="GSOUND_ERROR_NODRIVER">
</member>
<member name="system" value="-6" c:identifier="GSOUND_ERROR_SYSTEM">
</member>
<member name="corrupt" value="-7" c:identifier="GSOUND_ERROR_CORRUPT">
</member>
<member name="toobig" value="-8" c:identifier="GSOUND_ERROR_TOOBIG">
</member>
<member name="notfound" value="-9" c:identifier="GSOUND_ERROR_NOTFOUND">
</member>
<member name="destroyed"
value="-10"
c:identifier="GSOUND_ERROR_DESTROYED">
</member>
<member name="canceled" value="-11" c:identifier="GSOUND_ERROR_CANCELED">
</member>
<member name="notavailable"
value="-12"
c:identifier="GSOUND_ERROR_NOTAVAILABLE">
</member>
<member name="access" value="-13" c:identifier="GSOUND_ERROR_ACCESS">
</member>
<member name="io" value="-14" c:identifier="GSOUND_ERROR_IO">
</member>
<member name="internal" value="-15" c:identifier="GSOUND_ERROR_INTERNAL">
</member>
<member name="disabled" value="-16" c:identifier="GSOUND_ERROR_DISABLED">
</member>
<member name="forked" value="-17" c:identifier="GSOUND_ERROR_FORKED">
</member>
<member name="disconnected"
value="-18"
c:identifier="GSOUND_ERROR_DISCONNECTED">
</member>
</enumeration>
<function name="error_quark" c:identifier="gsound_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</namespace>
</repository>
|