/usr/share/gtk-doc/html/gsound/GSoundContext.html is in libgsound-doc 1.0.2-1.
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 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GSoundContext: GSound Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GSound Reference Manual">
<link rel="up" href="ch01.html" title="API Reference">
<link rel="prev" href="ch01.html" title="API Reference">
<link rel="next" href="gsound-GSound-Attributes.html" title="GSound Attributes">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GSoundContext.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GSoundContext.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GSoundContext.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gsound-GSound-Attributes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GSoundContext"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GSoundContext.top_of_page"></a>GSoundContext</span></h2>
<p>GSoundContext — GSound context object</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GSoundContext.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GSoundContext.html#GSOUND-ERROR:CAPS" title="GSOUND_ERROR">GSOUND_ERROR</a></td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-error-quark" title="gsound_error_quark ()">gsound_error_quark</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GSoundContext.html" title="GSoundContext"><span class="returnvalue">GSoundContext</span></a> *
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-context-new" title="gsound_context_new ()">gsound_context_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-context-open" title="gsound_context_open ()">gsound_context_open</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-context-set-attributes" title="gsound_context_set_attributes ()">gsound_context_set_attributes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-context-set-attributesv" title="gsound_context_set_attributesv ()">gsound_context_set_attributesv</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-context-set-driver" title="gsound_context_set_driver ()">gsound_context_set_driver</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-context-play-simple" title="gsound_context_play_simple ()">gsound_context_play_simple</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-context-play-simplev" title="gsound_context_play_simplev ()">gsound_context_play_simplev</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-context-play-full" title="gsound_context_play_full ()">gsound_context_play_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-context-play-fullv" title="gsound_context_play_fullv ()">gsound_context_play_fullv</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-context-play-full-finish" title="gsound_context_play_full_finish ()">gsound_context_play_full_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-context-cache" title="gsound_context_cache ()">gsound_context_cache</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GSoundContext.html#gsound-context-cachev" title="gsound_context_cachev ()">gsound_context_cachev</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GSoundContext.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GSoundContext.html#GSoundError" title="enum GSoundError">GSoundError</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GSoundContext.html#GSoundContext-struct" title="GSoundContext">GSoundContext</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GSoundContext.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> GSoundContext
</pre>
</div>
<div class="refsect1">
<a name="GSoundContext.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GSoundContext implements
<a href="https://developer.gnome.org/gio/unstable/GInitable.html">GInitable</a>.</p>
</div>
<div class="refsect1">
<a name="GSoundContext.description"></a><h2>Description</h2>
<p>A <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> is used for playing system sounds. The typical use pattern
is:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>Initialize the <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p></li>
<li class="listitem"><p>[Optional] Set any global attributes using <a class="link" href="GSoundContext.html#gsound-context-set-attributes" title="gsound_context_set_attributes ()"><code class="function">gsound_context_set_attributes()</code></a></p></li>
<li class="listitem"><p>[Optional] Cache any frequently-used sounds (for example, sound
effects for a game) using <a class="link" href="GSoundContext.html#gsound-context-cache" title="gsound_context_cache ()"><code class="function">gsound_context_cache()</code></a></p></li>
<li class="listitem"><p>Play sounds using <a class="link" href="GSoundContext.html#gsound-context-play-simple" title="gsound_context_play_simple ()"><code class="function">gsound_context_play_simple()</code></a> or <a class="link" href="GSoundContext.html#gsound-context-play-full" title="gsound_context_play_full ()"><code class="function">gsound_context_play_full()</code></a></p></li>
<li class="listitem"><p>Close the connection to the sound server and clean up the context using
<a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a></p></li>
</ul></div>
<p><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> implements the <a href="https://developer.gnome.org/gio/unstable/GInitable.html"><span class="type">GInitable</span></a> interface, so if created with
<a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-new"><code class="function">g_object_new()</code></a> (as typically happens with language bindings) then you must
call the <a href="https://developer.gnome.org/gio/unstable/GInitable.html#g-initable-init"><code class="function">g_initable_init()</code></a> method before attempting to use it.</p>
<div class="refsect2">
<a name="id-1.2.2.7.5"></a><h3>Simple Examples</h3>
<p>In C:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GSoundContext</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">ctx </span><span class="symbol">=</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>
<span class="usertype">GCancellable</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">cancellable </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/gio/unstable/GCancellable.html#g-cancellable-new">g_cancellable_new</a></span><span class="symbol">();</span>
<span class="usertype">GError</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">error </span><span class="symbol">=</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>
<span class="normal">ctx </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GSoundContext.html#gsound-context-new">gsound_context_new</a></span><span class="symbol">(</span><span class="normal">cancellable</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">error</span><span class="symbol">);</span>
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="comment">// handle error</span>
<span class="cbracket">}</span>
<span class="function"><a href="GSoundContext.html#gsound-context-play-simple">gsound_context_play_simple</a></span><span class="symbol">(</span><span class="normal">ctx</span><span class="symbol">,</span><span class="normal"> cancellable</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">error</span><span class="symbol">,</span>
<span class="normal"> <a href="gsound-GSound-Attributes.html#GSOUND-ATTR-EVENT-ID:CAPS">GSOUND_ATTR_EVENT_ID</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"phone-incoming-call"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="comment">// other attributes...</span>
<span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p> </p>
<p>or, using Python via GObject Introspection:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">from</span><span class="normal"> gi</span><span class="symbol">.</span><span class="normal">repository import GSound</span>
<span class="normal">ctx </span><span class="symbol">=</span><span class="normal"> GSound</span><span class="symbol">.</span><span class="function">Context</span><span class="symbol">()</span>
<span class="label">try:</span>
<span class="normal"> ctx</span><span class="symbol">.</span><span class="function">init</span><span class="symbol">();</span>
<span class="normal"> ctx</span><span class="symbol">.</span><span class="function">play_simple</span><span class="symbol">(</span><span class="cbracket">{</span><span class="normal"> GSound</span><span class="symbol">.</span><span class="normal">ATTR_EVENT_ID </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"phone-incoming-call"</span><span class="normal"> </span><span class="cbracket">}</span><span class="symbol">)</span>
<span class="label">except:</span>
<span class="preproc"> # Handle</span><span class="normal"> error</span>
<span class="normal"> pass</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>or using Vala:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="normal">try </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="usertype">var</span><span class="normal"> ctx </span><span class="symbol">=</span><span class="normal"> </span><span class="usertype">new</span><span class="normal"> GSound</span><span class="symbol">.</span><span class="function">Context</span><span class="symbol">();</span>
<span class="normal"> ctx</span><span class="symbol">.</span><span class="function">play_simple</span><span class="symbol">(</span><span class="normal">null</span><span class="symbol">,</span><span class="normal"> GSound</span><span class="symbol">.</span><span class="normal">Attribute</span><span class="symbol">.</span><span class="normal">EVENT_ID</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"phone-incoming-call"</span><span class="symbol">);</span>
<span class="cbracket">}</span><span class="normal"> </span><span class="keyword">catch</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">Error</span><span class="normal"> e</span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="comment">// handle error</span>
<span class="cbracket">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.2.7.6"></a><h3>
<code class="literal"><code class="function">play_simple()</code></code> versus <code class="literal"><code class="function">play_full()</code></code>
</h3>
<p>The above examples use the <a class="link" href="GSoundContext.html#gsound-context-play-simple" title="gsound_context_play_simple ()"><code class="function">gsound_context_play_simple()</code></a> method for
playing sounds. This is a "fire and forget" method which returns
immediately and does not block your program, and is suitable for most use
cases.</p>
<p>If you need to find out when the sound finished (for example to repeat the
sound) then you can use the <a class="link" href="GSoundContext.html#gsound-context-play-full" title="gsound_context_play_full ()"><code class="function">gsound_context_play_full()</code></a> version. This
is an asynchronous method using the standard GIO async pattern, which will
run the supplied <a href="https://developer.gnome.org/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> when the sound server has finished.
It is guaranteed that the callback will be run exactly once.</p>
<p>Note that calling <a class="link" href="GSoundContext.html#gsound-context-play-full" title="gsound_context_play_full ()"><code class="function">gsound_context_play_full()</code></a> with a <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> callback is not
equivalent to calling <a class="link" href="GSoundContext.html#gsound-context-play-simple" title="gsound_context_play_simple ()"><code class="function">gsound_context_play_simple()</code></a>. When calling
<code class="function">play_simple()</code>, errors which occur before the sound is passed to the sound
server are reported immediately, whereas with <code class="literal"><code class="function">play_full()</code></code> these are reported
in the callback. If you pass a <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> callback to <a class="link" href="GSoundContext.html#gsound-context-play-full" title="gsound_context_play_full ()"><code class="function">gsound_context_play_full()</code></a>
you will not be able to receive these errors, so it is strongly recommended
to avoid doing this and use <a class="link" href="GSoundContext.html#gsound-context-play-simple" title="gsound_context_play_simple ()"><code class="function">gsound_context_play_simple()</code></a> in the case when
you don't need to be notified when the sound has finished.</p>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.2.7.7"></a><h3>Passing Attributes</h3>
<p>GSound supplies information to the sound server by means of attributes.
Attributes can be set on the <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> itself using
<a class="link" href="GSoundContext.html#gsound-context-set-attributes" title="gsound_context_set_attributes ()"><code class="function">gsound_context_set_attributes()</code></a>, or supplied in a <code class="literal"><code class="function">play()</code></code> call. Attributes
set on the context will automatically applied to any subsequent <code class="literal"><code class="function">play()</code></code>
calls, unless overridden by that call.</p>
<p>In C and Vala, attributes are passed as <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of
(attribute, value) pairs. When using GObject introspection, attributes are
typically passed using a language-specific associated array, for example
a dict in Python or an object in JavaScript.</p>
<p>For the list of attributes supported by GSound, see
<a class="link" href="gsound-GSound-Attributes.html" title="GSound Attributes">GSound Attributes</a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="caching"></a><h3>Caching</h3>
<p>If supported by the sound server, frequently-used sounds may be cached. This
may be useful, for example, for sound effects in a game. To cache a sound,
either call <a class="link" href="GSoundContext.html#gsound-context-cache" title="gsound_context_cache ()"><code class="function">gsound_context_cache()</code></a>, or pass the special
<a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-CANBERRA-CACHE-CONTROL:CAPS" title="GSOUND_ATTR_CANBERRA_CACHE_CONTROL"><span class="type">GSOUND_ATTR_CANBERRA_CACHE_CONTROL</span></a> attribute to one of the <code class="literal"><code class="function">play()</code></code>
functions.</p>
<p>For example, in the startup code for a game you might include something
like the following (error checking omitted):</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GSoundContext</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">ctx </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GSoundContext.html#gsound-context-new">gsound_context_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
<span class="function"><a href="GSoundContext.html#gsound-context-cache">gsound_context_cache</a></span><span class="symbol">(</span><span class="normal">ctx</span><span class="symbol">,</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span>
<span class="normal"> <a href="gsound-GSound-Attributes.html#GSOUND-ATTR-MEDIA-FILENAME:CAPS">GSOUND_ATTR_MEDIA_FILENAME</a></span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"/path/to/player-spaceship-fire-laser.ogg"</span><span class="symbol">,</span>
<span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>There are three caching modes available, "permanent", "volatile" and "never".
The default mode when calling <a class="link" href="GSoundContext.html#gsound-context-cache" title="gsound_context_cache ()"><code class="function">gsound_context_cache()</code></a> is "permanent", and
the default mode for <a class="link" href="GSoundContext.html#gsound-context-play-simple" title="gsound_context_play_simple ()"><code class="function">gsound_context_play_simple()</code></a> and <code class="literal"><code class="function">play_full()</code></code> is
"never".</p>
<p>See the documentation for <a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-CANBERRA-CACHE-CONTROL:CAPS" title="GSOUND_ATTR_CANBERRA_CACHE_CONTROL"><span class="type">GSOUND_ATTR_CANBERRA_CACHE_CONTROL</span></a> for more
details.</p>
</div>
</div>
<div class="refsect1">
<a name="GSoundContext.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GSOUND-ERROR:CAPS"></a><h3>GSOUND_ERROR</h3>
<pre class="programlisting">#define GSOUND_ERROR (gsound_error_quark())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="gsound-error-quark"></a><h3>gsound_error_quark ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
gsound_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gsound-context-new"></a><h3>gsound_context_new ()</h3>
<pre class="programlisting"><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="returnvalue">GSoundContext</span></a> *
gsound_context_new (<em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates and initializes a new <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a>. If the an error occured
during initialization, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> is returned and <em class="parameter"><code>error</code></em>
will be set
appropriately.</p>
<div class="refsect3">
<a name="id-1.2.2.8.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for error</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.4.6"></a><h4>Returns</h4>
<p> A new <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsound-context-open"></a><h3>gsound_context_open ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gsound_context_open (<em class="parameter"><code><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> *context</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Attempts to open a connection to the backend sound driver. It is recommended
that you set context attributes with <a class="link" href="GSoundContext.html#gsound-context-set-attributes" title="gsound_context_set_attributes ()"><code class="function">gsound_context_set_attributes()</code></a> before
calling this function.</p>
<div class="blockquote"><blockquote class="blockquote"><p>A connection is automatically opened before playing or caching sounds,
so you rarely need to call this yourself.</p></blockquote></div>
<div class="refsect3">
<a name="id-1.2.2.8.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for error</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.5.7"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the output device was opened successfully, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
(populating <em class="parameter"><code>error</code></em>
)</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsound-context-set-attributes"></a><h3>gsound_context_set_attributes ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gsound_context_set_attributes (<em class="parameter"><code><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> *context</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Set attributes or change attributes on <em class="parameter"><code>context</code></em>
. Subsequent calls to this
function calling the same attributes will override the earlier values.</p>
<p>Note that GSound will set the <a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-NAME:CAPS" title="GSOUND_ATTR_APPLICATION_NAME"><span class="type">GSOUND_ATTR_APPLICATION_NAME</span></a> and
<a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-ID:CAPS" title="GSOUND_ATTR_APPLICATION_ID"><span class="type">GSOUND_ATTR_APPLICATION_ID</span></a> for you if using <a href="https://developer.gnome.org/gio/unstable/GApplication.html"><span class="type">GApplication</span></a>, so you do
not normally need to set these yourself.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="id-1.2.2.8.6.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for error</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated list of attribute name-value pairs</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.6.8"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if attributes were updated successfully</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsound-context-set-attributesv"></a><h3>gsound_context_set_attributesv ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gsound_context_set_attributesv (<em class="parameter"><code><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> *context</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *attrs</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Set attributes or change attributes on <em class="parameter"><code>context</code></em>
. Subsequent calls to this
function calling the same attributes will override the earlier values.</p>
<p>Note that GSound will set the <a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-NAME:CAPS" title="GSOUND_ATTR_APPLICATION_NAME"><span class="type">GSOUND_ATTR_APPLICATION_NAME</span></a> and
<a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-ID:CAPS" title="GSOUND_ATTR_APPLICATION_ID"><span class="type">GSOUND_ATTR_APPLICATION_ID</span></a> for you if using <a href="https://developer.gnome.org/gio/unstable/GApplication.html"><span class="type">GApplication</span></a>, so you do
not normally need to set these yourself.</p>
<p>This function is intented to be used by language bindings.</p>
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> gsound_context_set_attributes]</span></p>
<div class="refsect3">
<a name="id-1.2.2.8.7.8"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>attrs</p></td>
<td class="parameter_description"><p> Hash table of attributes to set. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for error, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.7.9"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if attributes were updated successfully</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsound-context-set-driver"></a><h3>gsound_context_set_driver ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gsound_context_set_driver (<em class="parameter"><code><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> *context</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *driver</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Sets the libcanberra driver to <em class="parameter"><code>driver</code></em>
, for example "pulse", "alsa" or "null".
You normally do not need to set this yourself.</p>
<p>Note that this function may return <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> even if the specified driver is
not available: see the libcanberra documentation for details.</p>
<div class="refsect3">
<a name="id-1.2.2.8.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>driver</p></td>
<td class="parameter_description"><p>libcanberra driver to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for error, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.8.7"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the libcanberra driver was set successfully</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsound-context-play-simple"></a><h3>gsound_context_play_simple ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gsound_context_play_simple (<em class="parameter"><code><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> *context</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>The basic "fire-and-forget" play command. This function will not block, and
just sends a request to the sound server before immediately returning.</p>
<p>If you need to know when a sound finishes playing then you should call
<a class="link" href="GSoundContext.html#gsound-context-play-full" title="gsound_context_play_full ()"><code class="function">gsound_context_play_full()</code></a> instead.</p>
<p>You can cancel playback at any time by calling <a href="https://developer.gnome.org/gio/unstable/GCancellable.html#g-cancellable-cancel"><code class="function">g_cancellable_cancel()</code></a> on
<em class="parameter"><code>cancellable</code></em>
, if supplied.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="id-1.2.2.8.9.8"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for error, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>A <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of attribute-value pairs</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.9.9"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, populating <em class="parameter"><code>error</code></em>
</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsound-context-play-simplev"></a><h3>gsound_context_play_simplev ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gsound_context_play_simplev (<em class="parameter"><code><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> *context</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *attrs</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>The basic "fire-and-forget" play command. This function will not block, and
just sends a request to the sound server before immediately returning.</p>
<p>If you need to know when a sound finishes playing then you should call
<a class="link" href="GSoundContext.html#gsound-context-play-full" title="gsound_context_play_full ()"><code class="function">gsound_context_play_full()</code></a> instead.</p>
<p>You can cancel playback at any time by calling <a href="https://developer.gnome.org/gio/unstable/GCancellable.html#g-cancellable-cancel"><code class="function">g_cancellable_cancel()</code></a> on
<em class="parameter"><code>cancellable</code></em>
, if supplied.</p>
<p>This function is intented to be used by language bindings.</p>
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> gsound_context_play_simple]</span></p>
<div class="refsect3">
<a name="id-1.2.2.8.10.9"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>attrs</p></td>
<td class="parameter_description"><p> Attributes. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for error</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.10.10"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsound-context-play-full"></a><h3>gsound_context_play_full ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gsound_context_play_full (<em class="parameter"><code><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> *context</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Asynchronously request a sound to be played. When playback is finished
(or if an error occurs) then <em class="parameter"><code>callback</code></em>
will be called, following the
normal GIO async pattern.</p>
<p>If playback is cancelled via <em class="parameter"><code>cancellable</code></em>
, then <em class="parameter"><code>callback</code></em>
will be called
with <a href="https://developer.gnome.org/gio/unstable/gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><span class="type">G_IO_ERROR_CANCELLED</span></a>.</p>
<p>If you do not need notification of when playback is complete, you should
use <a class="link" href="GSoundContext.html#gsound-context-play-simple" title="gsound_context_play_simple ()"><code class="function">gsound_context_play_simple()</code></a>.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="id-1.2.2.8.11.8"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p> callback. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data passed to <em class="parameter"><code>callback</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>A <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of attribute-value pairs</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsound-context-play-fullv"></a><h3>gsound_context_play_fullv ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gsound_context_play_fullv (<em class="parameter"><code><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> *context</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *attrs</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Asynchronously request a sound to be played. When playback is finished
(or if an error occurs) then <em class="parameter"><code>callback</code></em>
will be called, following the
normal GIO async pattern.</p>
<p>If playback is cancelled via <em class="parameter"><code>cancellable</code></em>
, then <em class="parameter"><code>callback</code></em>
will be called
with <a href="https://developer.gnome.org/gio/unstable/gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><span class="type">G_IO_ERROR_CANCELLED</span></a>.</p>
<p>If you do not need notification of when playback is complete, you should
use <a class="link" href="GSoundContext.html#gsound-context-play-simple" title="gsound_context_play_simple ()"><code class="function">gsound_context_play_simple()</code></a>.</p>
<p>This function is intented to be used by language bindings.</p>
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> gsound_context_play_full]</span></p>
<div class="refsect3">
<a name="id-1.2.2.8.12.9"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>attrs</p></td>
<td class="parameter_description"><p> Attributes. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p> callback. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user_data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsound-context-play-full-finish"></a><h3>gsound_context_play_full_finish ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gsound_context_play_full_finish (<em class="parameter"><code><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> *context</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Finish an async operation started by <a class="link" href="GSoundContext.html#gsound-context-play-full" title="gsound_context_play_full ()"><code class="function">gsound_context_play_full()</code></a>. You
must call this function in the callback to free memory and receive any
errors which occurred.</p>
<div class="refsect3">
<a name="id-1.2.2.8.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>Result object passed to the callback of
<a class="link" href="GSoundContext.html#gsound-context-play-full" title="gsound_context_play_full ()"><code class="function">gsound_context_play_full()</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for error</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.13.6"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if playing finished successfully</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsound-context-cache"></a><h3>gsound_context_cache ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gsound_context_cache (<em class="parameter"><code><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> *context</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Requests that a sound be cached on the server. See <a class="link" href="GSoundContext.html#caching" title="Caching"><span class="type">caching</span></a>.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="id-1.2.2.8.14.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for error</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>A <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of attribute-value pairs</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.14.7"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gsound-context-cachev"></a><h3>gsound_context_cachev ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gsound_context_cachev (<em class="parameter"><code><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> *context</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *attrs</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Requests that a sound be cached on the server. See <a class="link" href="GSoundContext.html#caching" title="Caching"><span class="type">caching</span></a>.</p>
<p>This function is intented to be used by language bindings.</p>
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> gsound_context_cache]</span></p>
<div class="refsect3">
<a name="id-1.2.2.8.15.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>attrs</p></td>
<td class="parameter_description"><p> Hash table of attrerties. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for error, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GSoundContext.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GSoundError"></a><h3>enum GSoundError</h3>
<div class="refsect3">
<a name="id-1.2.2.9.2.3"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-NOTSUPPORTED:CAPS"></a>GSOUND_ERROR_NOTSUPPORTED</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-INVALID:CAPS"></a>GSOUND_ERROR_INVALID</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-STATE:CAPS"></a>GSOUND_ERROR_STATE</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-OOM:CAPS"></a>GSOUND_ERROR_OOM</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-NODRIVER:CAPS"></a>GSOUND_ERROR_NODRIVER</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-SYSTEM:CAPS"></a>GSOUND_ERROR_SYSTEM</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-CORRUPT:CAPS"></a>GSOUND_ERROR_CORRUPT</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-TOOBIG:CAPS"></a>GSOUND_ERROR_TOOBIG</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-NOTFOUND:CAPS"></a>GSOUND_ERROR_NOTFOUND</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-DESTROYED:CAPS"></a>GSOUND_ERROR_DESTROYED</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-CANCELED:CAPS"></a>GSOUND_ERROR_CANCELED</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-NOTAVAILABLE:CAPS"></a>GSOUND_ERROR_NOTAVAILABLE</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-ACCESS:CAPS"></a>GSOUND_ERROR_ACCESS</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-IO:CAPS"></a>GSOUND_ERROR_IO</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-INTERNAL:CAPS"></a>GSOUND_ERROR_INTERNAL</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-DISABLED:CAPS"></a>GSOUND_ERROR_DISABLED</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-FORKED:CAPS"></a>GSOUND_ERROR_FORKED</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GSOUND-ERROR-DISCONNECTED:CAPS"></a>GSOUND_ERROR_DISCONNECTED</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GSoundContext-struct"></a><h3>GSoundContext</h3>
<pre class="programlisting">typedef struct _GSoundContext GSoundContext;</pre>
<p>Wrapper for ca_context.</p>
</div>
</div>
<div class="refsect1">
<a name="GSoundContext.see-also"></a><h2>See Also</h2>
<p><a href="http://0pointer.de/lennart/projects/libcanberra/gtkdoc/libcanberra-canberra.html#ca-context"><span class="type">ca_context</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|