/usr/share/gtk-doc/html/gsound/gsound-GSound-Attributes.html is in libgsound-doc 1.0.2-2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GSound Attributes: 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="GSoundContext.html" title="GSoundContext">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<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="#gsound-GSound-Attributes.description" class="shortcut">Description</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="GSoundContext.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gsound-GSound-Attributes"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gsound-GSound-Attributes.top_of_page"></a>GSound Attributes</span></h2>
<p>GSound Attributes — Attributes recognized by GSound</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gsound-GSound-Attributes.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-MEDIA-NAME:CAPS" title="GSOUND_ATTR_MEDIA_NAME">GSOUND_ATTR_MEDIA_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-MEDIA-TITLE:CAPS" title="GSOUND_ATTR_MEDIA_TITLE">GSOUND_ATTR_MEDIA_TITLE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-MEDIA-ARTIST:CAPS" title="GSOUND_ATTR_MEDIA_ARTIST">GSOUND_ATTR_MEDIA_ARTIST</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-MEDIA-LANGUAGE:CAPS" title="GSOUND_ATTR_MEDIA_LANGUAGE">GSOUND_ATTR_MEDIA_LANGUAGE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-MEDIA-FILENAME:CAPS" title="GSOUND_ATTR_MEDIA_FILENAME">GSOUND_ATTR_MEDIA_FILENAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-MEDIA-ICON:CAPS" title="GSOUND_ATTR_MEDIA_ICON">GSOUND_ATTR_MEDIA_ICON</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-MEDIA-ICON-NAME:CAPS" title="GSOUND_ATTR_MEDIA_ICON_NAME">GSOUND_ATTR_MEDIA_ICON_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-MEDIA-ROLE:CAPS" title="GSOUND_ATTR_MEDIA_ROLE">GSOUND_ATTR_MEDIA_ROLE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-EVENT-ID:CAPS" title="GSOUND_ATTR_EVENT_ID">GSOUND_ATTR_EVENT_ID</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-EVENT-DESCRIPTION:CAPS" title="GSOUND_ATTR_EVENT_DESCRIPTION">GSOUND_ATTR_EVENT_DESCRIPTION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-EVENT-MOUSE-X:CAPS" title="GSOUND_ATTR_EVENT_MOUSE_X">GSOUND_ATTR_EVENT_MOUSE_X</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-EVENT-MOUSE-Y:CAPS" title="GSOUND_ATTR_EVENT_MOUSE_Y">GSOUND_ATTR_EVENT_MOUSE_Y</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-EVENT-MOUSE-HPOS:CAPS" title="GSOUND_ATTR_EVENT_MOUSE_HPOS">GSOUND_ATTR_EVENT_MOUSE_HPOS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-EVENT-MOUSE-VPOS:CAPS" title="GSOUND_ATTR_EVENT_MOUSE_VPOS">GSOUND_ATTR_EVENT_MOUSE_VPOS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-EVENT-MOUSE-BUTTON:CAPS" title="GSOUND_ATTR_EVENT_MOUSE_BUTTON">GSOUND_ATTR_EVENT_MOUSE_BUTTON</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-NAME:CAPS" title="GSOUND_ATTR_WINDOW_NAME">GSOUND_ATTR_WINDOW_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-ID:CAPS" title="GSOUND_ATTR_WINDOW_ID">GSOUND_ATTR_WINDOW_ID</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-ICON:CAPS" title="GSOUND_ATTR_WINDOW_ICON">GSOUND_ATTR_WINDOW_ICON</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-ICON-NAME:CAPS" title="GSOUND_ATTR_WINDOW_ICON_NAME">GSOUND_ATTR_WINDOW_ICON_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-X:CAPS" title="GSOUND_ATTR_WINDOW_X">GSOUND_ATTR_WINDOW_X</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-Y:CAPS" title="GSOUND_ATTR_WINDOW_Y">GSOUND_ATTR_WINDOW_Y</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-WIDTH:CAPS" title="GSOUND_ATTR_WINDOW_WIDTH">GSOUND_ATTR_WINDOW_WIDTH</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-HEIGHT:CAPS" title="GSOUND_ATTR_WINDOW_HEIGHT">GSOUND_ATTR_WINDOW_HEIGHT</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-HPOS:CAPS" title="GSOUND_ATTR_WINDOW_HPOS">GSOUND_ATTR_WINDOW_HPOS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-VPOS:CAPS" title="GSOUND_ATTR_WINDOW_VPOS">GSOUND_ATTR_WINDOW_VPOS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-DESKTOP:CAPS" title="GSOUND_ATTR_WINDOW_DESKTOP">GSOUND_ATTR_WINDOW_DESKTOP</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-X11-DISPLAY:CAPS" title="GSOUND_ATTR_WINDOW_X11_DISPLAY">GSOUND_ATTR_WINDOW_X11_DISPLAY</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-X11-SCREEN:CAPS" title="GSOUND_ATTR_WINDOW_X11_SCREEN">GSOUND_ATTR_WINDOW_X11_SCREEN</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-X11-MONITOR:CAPS" title="GSOUND_ATTR_WINDOW_X11_MONITOR">GSOUND_ATTR_WINDOW_X11_MONITOR</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-WINDOW-X11-XID:CAPS" title="GSOUND_ATTR_WINDOW_X11_XID">GSOUND_ATTR_WINDOW_X11_XID</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-NAME:CAPS" title="GSOUND_ATTR_APPLICATION_NAME">GSOUND_ATTR_APPLICATION_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-ID:CAPS" title="GSOUND_ATTR_APPLICATION_ID">GSOUND_ATTR_APPLICATION_ID</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-VERSION:CAPS" title="GSOUND_ATTR_APPLICATION_VERSION">GSOUND_ATTR_APPLICATION_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-ICON:CAPS" title="GSOUND_ATTR_APPLICATION_ICON">GSOUND_ATTR_APPLICATION_ICON</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-ICON-NAME:CAPS" title="GSOUND_ATTR_APPLICATION_ICON_NAME">GSOUND_ATTR_APPLICATION_ICON_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-LANGUAGE:CAPS" title="GSOUND_ATTR_APPLICATION_LANGUAGE">GSOUND_ATTR_APPLICATION_LANGUAGE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-PROCESS-ID:CAPS" title="GSOUND_ATTR_APPLICATION_PROCESS_ID">GSOUND_ATTR_APPLICATION_PROCESS_ID</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-PROCESS-BINARY:CAPS" title="GSOUND_ATTR_APPLICATION_PROCESS_BINARY">GSOUND_ATTR_APPLICATION_PROCESS_BINARY</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-PROCESS-USER:CAPS" title="GSOUND_ATTR_APPLICATION_PROCESS_USER">GSOUND_ATTR_APPLICATION_PROCESS_USER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-APPLICATION-PROCESS-HOST:CAPS" title="GSOUND_ATTR_APPLICATION_PROCESS_HOST">GSOUND_ATTR_APPLICATION_PROCESS_HOST</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-CANBERRA-CACHE-CONTROL:CAPS" title="GSOUND_ATTR_CANBERRA_CACHE_CONTROL">GSOUND_ATTR_CANBERRA_CACHE_CONTROL</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-CANBERRA-VOLUME:CAPS" title="GSOUND_ATTR_CANBERRA_VOLUME">GSOUND_ATTR_CANBERRA_VOLUME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-CANBERRA-XDG-THEME-NAME:CAPS" title="GSOUND_ATTR_CANBERRA_XDG_THEME_NAME">GSOUND_ATTR_CANBERRA_XDG_THEME_NAME</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-CANBERRA-XDG-THEME-OUTPUT-PROFILE:CAPS" title="GSOUND_ATTR_CANBERRA_XDG_THEME_OUTPUT_PROFILE">GSOUND_ATTR_CANBERRA_XDG_THEME_OUTPUT_PROFILE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-CANBERRA-ENABLE:CAPS" title="GSOUND_ATTR_CANBERRA_ENABLE">GSOUND_ATTR_CANBERRA_ENABLE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gsound-GSound-Attributes.html#GSOUND-ATTR-CANBERRA-FORCE-CHANNEL:CAPS" title="GSOUND_ATTR_CANBERRA_FORCE_CHANNEL">GSOUND_ATTR_CANBERRA_FORCE_CHANNEL</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gsound-GSound-Attributes.description"></a><h2>Description</h2>
<p>Attributes which can be applied to a <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> or passed to one of
the <code class="literal"><code class="function">play()</code></code> or <code class="literal"><code class="function">cache()</code></code> methods.</p>
</div>
<div class="refsect1">
<a name="gsound-GSound-Attributes.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gsound-GSound-Attributes.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GSOUND-ATTR-MEDIA-NAME:CAPS"></a><h3>GSOUND_ATTR_MEDIA_NAME</h3>
<pre class="programlisting">#define GSOUND_ATTR_MEDIA_NAME "media.name"
</pre>
<p>A name describing the media being played. Localized if possible and applicable.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-MEDIA-TITLE:CAPS"></a><h3>GSOUND_ATTR_MEDIA_TITLE</h3>
<pre class="programlisting">#define GSOUND_ATTR_MEDIA_TITLE "media.title"
</pre>
<p>A (song) title describing the media being played. Localized if possible and applicable.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-MEDIA-ARTIST:CAPS"></a><h3>GSOUND_ATTR_MEDIA_ARTIST</h3>
<pre class="programlisting">#define GSOUND_ATTR_MEDIA_ARTIST "media.artist"
</pre>
<p>The artist of this media. Localized if possible and applicable.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-MEDIA-LANGUAGE:CAPS"></a><h3>GSOUND_ATTR_MEDIA_LANGUAGE</h3>
<pre class="programlisting">#define GSOUND_ATTR_MEDIA_LANGUAGE "media.language"
</pre>
<p>The language this media is in, in some standard POSIX locale string, such as "de_DE".</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-MEDIA-FILENAME:CAPS"></a><h3>GSOUND_ATTR_MEDIA_FILENAME</h3>
<pre class="programlisting">#define GSOUND_ATTR_MEDIA_FILENAME "media.filename"
</pre>
<p>The file name this media was or can be loaded from.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-MEDIA-ICON:CAPS"></a><h3>GSOUND_ATTR_MEDIA_ICON</h3>
<pre class="programlisting">#define GSOUND_ATTR_MEDIA_ICON "media.icon"
</pre>
<p>An icon for this media in binary PNG format.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-MEDIA-ICON-NAME:CAPS"></a><h3>GSOUND_ATTR_MEDIA_ICON_NAME</h3>
<pre class="programlisting">#define GSOUND_ATTR_MEDIA_ICON_NAME "media.icon_name"
</pre>
<p>An icon name as defined in the XDG icon naming specifcation.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-MEDIA-ROLE:CAPS"></a><h3>GSOUND_ATTR_MEDIA_ROLE</h3>
<pre class="programlisting">#define GSOUND_ATTR_MEDIA_ROLE "media.role"
</pre>
<p>The "role" this media is played in. For event sounds the string
"event". For other cases strings like "music", "video", "game", ...</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-EVENT-ID:CAPS"></a><h3>GSOUND_ATTR_EVENT_ID</h3>
<pre class="programlisting">#define GSOUND_ATTR_EVENT_ID "event.id"
</pre>
<p>A textual id for an event sound, as mandated by the XDG sound naming specification.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-EVENT-DESCRIPTION:CAPS"></a><h3>GSOUND_ATTR_EVENT_DESCRIPTION</h3>
<pre class="programlisting">#define GSOUND_ATTR_EVENT_DESCRIPTION "event.description"
</pre>
<p>A descriptive string for the sound event. Localized if possible and applicable.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-EVENT-MOUSE-X:CAPS"></a><h3>GSOUND_ATTR_EVENT_MOUSE_X</h3>
<pre class="programlisting">#define GSOUND_ATTR_EVENT_MOUSE_X "event.mouse.x"
</pre>
<p>If this sound event was triggered by a mouse input event, the X
position of the mouse cursor on the screen, formatted as string.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-EVENT-MOUSE-Y:CAPS"></a><h3>GSOUND_ATTR_EVENT_MOUSE_Y</h3>
<pre class="programlisting">#define GSOUND_ATTR_EVENT_MOUSE_Y "event.mouse.y"
</pre>
<p>If this sound event was triggered by a mouse input event, the Y
position of the mouse cursor on the screen, formatted as string.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-EVENT-MOUSE-HPOS:CAPS"></a><h3>GSOUND_ATTR_EVENT_MOUSE_HPOS</h3>
<pre class="programlisting">#define GSOUND_ATTR_EVENT_MOUSE_HPOS "event.mouse.hpos"
</pre>
<p>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.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-EVENT-MOUSE-VPOS:CAPS"></a><h3>GSOUND_ATTR_EVENT_MOUSE_VPOS</h3>
<pre class="programlisting">#define GSOUND_ATTR_EVENT_MOUSE_VPOS "event.mouse.vpos"
</pre>
<p>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.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-EVENT-MOUSE-BUTTON:CAPS"></a><h3>GSOUND_ATTR_EVENT_MOUSE_BUTTON</h3>
<pre class="programlisting">#define GSOUND_ATTR_EVENT_MOUSE_BUTTON "event.mouse.button"
</pre>
<p>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.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-NAME:CAPS"></a><h3>GSOUND_ATTR_WINDOW_NAME</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_NAME "window.name"
</pre>
<p>If this sound event was triggered by a window on the screen, the
name of this window as human readable string.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-ID:CAPS"></a><h3>GSOUND_ATTR_WINDOW_ID</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_ID "window.id"
</pre>
<p>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.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-ICON:CAPS"></a><h3>GSOUND_ATTR_WINDOW_ICON</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_ICON "window.icon"
</pre>
<p>If this sound event was triggered by a window on the screen, binary
icon data in PNG format for this window.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-ICON-NAME:CAPS"></a><h3>GSOUND_ATTR_WINDOW_ICON_NAME</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_ICON_NAME "window.icon_name"
</pre>
<p>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.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-X:CAPS"></a><h3>GSOUND_ATTR_WINDOW_X</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_X "window.x"
</pre>
<p>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.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-Y:CAPS"></a><h3>GSOUND_ATTR_WINDOW_Y</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_Y "window.y"
</pre>
<p>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.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-WIDTH:CAPS"></a><h3>GSOUND_ATTR_WINDOW_WIDTH</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_WIDTH "window.width"
</pre>
<p>If this sound event was triggered by a window on the screen, the
pixel width of the window.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-HEIGHT:CAPS"></a><h3>GSOUND_ATTR_WINDOW_HEIGHT</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_HEIGHT "window.height"
</pre>
<p>If this sound event was triggered by a window on the screen, the
pixel height of the window.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-HPOS:CAPS"></a><h3>GSOUND_ATTR_WINDOW_HPOS</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_HPOS "window.hpos"
</pre>
<p>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.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-VPOS:CAPS"></a><h3>GSOUND_ATTR_WINDOW_VPOS</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_VPOS "window.vpos"
</pre>
<p>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.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-DESKTOP:CAPS"></a><h3>GSOUND_ATTR_WINDOW_DESKTOP</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_DESKTOP "window.desktop"
</pre>
<p>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")</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-X11-DISPLAY:CAPS"></a><h3>GSOUND_ATTR_WINDOW_X11_DISPLAY</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_X11_DISPLAY "window.x11.display"
</pre>
<p>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").</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-X11-SCREEN:CAPS"></a><h3>GSOUND_ATTR_WINDOW_X11_SCREEN</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_X11_SCREEN "window.x11.screen"
</pre>
<p>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").</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-X11-MONITOR:CAPS"></a><h3>GSOUND_ATTR_WINDOW_X11_MONITOR</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_X11_MONITOR "window.x11.monitor"
</pre>
<p>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").</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-WINDOW-X11-XID:CAPS"></a><h3>GSOUND_ATTR_WINDOW_X11_XID</h3>
<pre class="programlisting">#define GSOUND_ATTR_WINDOW_X11_XID "window.x11.xid"
</pre>
<p>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.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-APPLICATION-NAME:CAPS"></a><h3>GSOUND_ATTR_APPLICATION_NAME</h3>
<pre class="programlisting">#define GSOUND_ATTR_APPLICATION_NAME "application.name"
</pre>
<p>The name of the application this sound event was triggered by as
human readable string. (e.g. "GNU Emacs") Localized if possible and
applicable.</p>
<div class="blockquote"><blockquote class="blockquote"><p>This attribute will automatically be added to the <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> if
it has previously been set with <a href="https://developer.gnome.org/glib/unstable/glib-Miscellaneous-Utility-Functions.html#g-set-application-name"><code class="function">g_set_application_name()</code></a>, so you normally
do not need to supply this yourself.</p></blockquote></div>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-APPLICATION-ID:CAPS"></a><h3>GSOUND_ATTR_APPLICATION_ID</h3>
<pre class="programlisting">#define GSOUND_ATTR_APPLICATION_ID "application.id"
</pre>
<p>An identifier for the program this sound event was triggered
by. (e.g. "org.gnu.emacs").</p>
<div class="blockquote"><blockquote class="blockquote"><p>This attribute will automatically be added to the <a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a> with
the <a href="https://developer.gnome.org/gio/unstable/GApplication.html#GApplication--application-id"><span class="type">“application-id”</span></a> if you are using <a href="https://developer.gnome.org/gio/unstable/GApplication.html"><span class="type">GApplication</span></a>, so you
normally do not need to supply this yourself.</p></blockquote></div>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-APPLICATION-VERSION:CAPS"></a><h3>GSOUND_ATTR_APPLICATION_VERSION</h3>
<pre class="programlisting">#define GSOUND_ATTR_APPLICATION_VERSION "application.version"
</pre>
<p>A version number for the program this sound event was triggered
by. (e.g. "22.2")</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-APPLICATION-ICON:CAPS"></a><h3>GSOUND_ATTR_APPLICATION_ICON</h3>
<pre class="programlisting">#define GSOUND_ATTR_APPLICATION_ICON "application.icon"
</pre>
<p>Binary icon data in PNG format for the application this sound event
is triggered by.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-APPLICATION-ICON-NAME:CAPS"></a><h3>GSOUND_ATTR_APPLICATION_ICON_NAME</h3>
<pre class="programlisting">#define GSOUND_ATTR_APPLICATION_ICON_NAME "application.icon_name"
</pre>
<p>An icon name for the application this sound event is triggered by,
as defined in the XDG icon naming specification.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-APPLICATION-LANGUAGE:CAPS"></a><h3>GSOUND_ATTR_APPLICATION_LANGUAGE</h3>
<pre class="programlisting">#define GSOUND_ATTR_APPLICATION_LANGUAGE "application.language"
</pre>
<p>The locale string the application that is triggering this sound
event is running in. A POSIX locale string such as de_DE<em class="parameter"><code>euro</code></em>
.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-APPLICATION-PROCESS-ID:CAPS"></a><h3>GSOUND_ATTR_APPLICATION_PROCESS_ID</h3>
<pre class="programlisting">#define GSOUND_ATTR_APPLICATION_PROCESS_ID "application.process.id"
</pre>
<p>The unix PID of the process that is triggering this sound event, formatted as string.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-APPLICATION-PROCESS-BINARY:CAPS"></a><h3>GSOUND_ATTR_APPLICATION_PROCESS_BINARY</h3>
<pre class="programlisting">#define GSOUND_ATTR_APPLICATION_PROCESS_BINARY "application.process.binary"
</pre>
<p>The path to the process binary of the process that is triggering this sound event.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-APPLICATION-PROCESS-USER:CAPS"></a><h3>GSOUND_ATTR_APPLICATION_PROCESS_USER</h3>
<pre class="programlisting">#define GSOUND_ATTR_APPLICATION_PROCESS_USER "application.process.user"
</pre>
<p>The user that owns the process that is triggering this sound event.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-APPLICATION-PROCESS-HOST:CAPS"></a><h3>GSOUND_ATTR_APPLICATION_PROCESS_HOST</h3>
<pre class="programlisting">#define GSOUND_ATTR_APPLICATION_PROCESS_HOST "application.process.host"
</pre>
<p>The host name of the host the process that is triggering this sound event runs on.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-CANBERRA-CACHE-CONTROL:CAPS"></a><h3>GSOUND_ATTR_CANBERRA_CACHE_CONTROL</h3>
<pre class="programlisting">#define GSOUND_ATTR_CANBERRA_CACHE_CONTROL "canberra.cache-control"
</pre>
<p>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).</p>
<p>If this attribute is not explicitly passed to <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> it will default to "never". If it is not
explicitly passed to <a class="link" href="GSoundContext.html#gsound-context-cache" title="gsound_context_cache ()"><code class="function">gsound_context_cache()</code></a> it will default to "permanent".</p>
<p>If the list of attributes is handed on to the sound server this
attribute is stripped from it.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-CANBERRA-VOLUME:CAPS"></a><h3>GSOUND_ATTR_CANBERRA_VOLUME</h3>
<pre class="programlisting">#define GSOUND_ATTR_CANBERRA_VOLUME "canberra.volume"
</pre>
<p>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.</p>
<p>If the list of attributes is handed on to the sound server this
attribute is stripped from it.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-CANBERRA-XDG-THEME-NAME:CAPS"></a><h3>GSOUND_ATTR_CANBERRA_XDG_THEME_NAME</h3>
<pre class="programlisting">#define GSOUND_ATTR_CANBERRA_XDG_THEME_NAME "canberra.xdg-theme.name"
</pre>
<p>A special attribute that can be used to control the XDG sound theme that
is used for this sample.</p>
<p>If the list of attributes is handed on to the sound server this
attribute is stripped from it.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-CANBERRA-XDG-THEME-OUTPUT-PROFILE:CAPS"></a><h3>GSOUND_ATTR_CANBERRA_XDG_THEME_OUTPUT_PROFILE</h3>
<pre class="programlisting">#define GSOUND_ATTR_CANBERRA_XDG_THEME_OUTPUT_PROFILE "canberra.xdg-theme.output-profile"
</pre>
<p>A special attribute that can be used to control the XDG sound theme
output profile that is used for this sample.</p>
<p>If the list of attributes is handed on to the sound server this
attribute is stripped from it.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-CANBERRA-ENABLE:CAPS"></a><h3>GSOUND_ATTR_CANBERRA_ENABLE</h3>
<pre class="programlisting">#define GSOUND_ATTR_CANBERRA_ENABLE "canberra.enable"
</pre>
<p>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
<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 <code class="literal"><code class="function">play_full()</code></code> will fail with
GSOUND_ERROR_DISABLED.</p>
<p>If the list of attributes is handed on to the sound server this
attribute is stripped from it.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSOUND-ATTR-CANBERRA-FORCE-CHANNEL:CAPS"></a><h3>GSOUND_ATTR_CANBERRA_FORCE_CHANNEL</h3>
<pre class="programlisting">#define GSOUND_ATTR_CANBERRA_FORCE_CHANNEL "canberra.force_channel"
</pre>
<p>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.</p>
<p>If the list of attributes is handed on to the sound server this
attribute is stripped from it.</p>
</div>
</div>
<div class="refsect1">
<a name="gsound-GSound-Attributes.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GSoundContext.html" title="GSoundContext"><span class="type">GSoundContext</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|