1<?xml version="1.0" encoding="utf-8"?> 2<node> 3 <!-- 4 org.qemu.Display1.VM: 5 6 This interface is implemented on ``/org/qemu/Display1/VM``. 7 --> 8 <interface name="org.qemu.Display1.VM"> 9 <!-- 10 Name: 11 12 The name of the VM. 13 --> 14 <property name="Name" type="s" access="read"/> 15 16 <!-- 17 UUID: 18 19 The UUID of the VM. 20 --> 21 <property name="UUID" type="s" access="read"/> 22 23 <!-- 24 ConsoleIDs: 25 26 The list of consoles available on ``/org/qemu/Display1/Console_$id``. 27 --> 28 <property name="ConsoleIDs" type="au" access="read"/> 29 30 <!-- 31 Interfaces: 32 33 This property lists extra interfaces provided by the 34 /org/qemu/Display1/VM object, and can be used to detect 35 the capabilities with which they are communicating. 36 37 Unlike the standard D-Bus Introspectable interface, querying this 38 property does not require parsing XML. 39 40 (earlier version of the display interface do not provide this property) 41 --> 42 <property name="Interfaces" type="as" access="read"/> 43 </interface> 44 45 <!-- 46 org.qemu.Display1.Console: 47 48 This interface is implemented on ``/org/qemu/Display1/Console_$id``. You 49 may discover available consoles through introspection or with the 50 :dbus:prop:`org.qemu.Display1.VM.ConsoleIDs` property. 51 52 A console is attached to a video device head. It may be "Graphic" or 53 "Text" (see :dbus:prop:`Type` and other properties). 54 55 Interactions with a console may be done with 56 :dbus:iface:`org.qemu.Display1.Keyboard`, 57 :dbus:iface:`org.qemu.Display1.Mouse` and 58 :dbus:iface:`org.qemu.Display1.MultiTouch` interfaces when available. 59 --> 60 <interface name="org.qemu.Display1.Console"> 61 <!-- 62 RegisterListener: 63 @listener: a Unix socket FD, for peer-to-peer D-Bus communication. 64 65 Register a console listener, which will receive display updates, until 66 it is disconnected. 67 68 Multiple listeners may be registered simultaneously. 69 70 The listener is expected to implement the 71 :dbus:iface:`org.qemu.Display1.Listener` interface. 72 --> 73 <method name="RegisterListener"> 74 <?if $(env.HOST_OS) == windows?> 75 <arg type="ay" name="listener" direction="in"> 76 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/> 77 </arg> 78 <?else?> 79 <arg type="h" name="listener" direction="in"/> 80 <?endif?> 81 </method> 82 83 <!-- 84 SetUIInfo: 85 @width_mm: the physical display width in millimeters. 86 @height_mm: the physical display height in millimeters. 87 @xoff: horizontal offset, in pixels. 88 @yoff: vertical offset, in pixels. 89 @width: console width, in pixels. 90 @height: console height, in pixels. 91 92 Modify the dimensions and display settings. 93 --> 94 <method name="SetUIInfo"> 95 <arg name="width_mm" type="q" direction="in"/> 96 <arg name="height_mm" type="q" direction="in"/> 97 <arg name="xoff" type="i" direction="in"/> 98 <arg name="yoff" type="i" direction="in"/> 99 <arg name="width" type="u" direction="in"/> 100 <arg name="height" type="u" direction="in"/> 101 </method> 102 103 <!-- 104 Label: 105 106 A user-friendly name for the console (for ex: "VGA"). 107 --> 108 <property name="Label" type="s" access="read"/> 109 110 <!-- 111 Head: 112 113 Graphical device head number. 114 --> 115 <property name="Head" type="u" access="read"/> 116 117 <!-- 118 Type: 119 120 Console type ("Graphic" or "Text"). 121 --> 122 <property name="Type" type="s" access="read"/> 123 124 <!-- 125 Width: 126 127 Console width, in pixels. 128 --> 129 <property name="Width" type="u" access="read"/> 130 131 <!-- 132 Height: 133 134 Console height, in pixels. 135 --> 136 <property name="Height" type="u" access="read"/> 137 138 <!-- 139 DeviceAddress: 140 141 The device address (ex: "pci/0000/02.0"). 142 --> 143 <property name="DeviceAddress" type="s" access="read"/> 144 145 <!-- 146 Interfaces: 147 148 This property lists extra interfaces provided by the 149 ``/org/qemu/Display1/Console_$id`` object, and can be used to detect the 150 capabilities with which they are communicating. 151 152 Unlike the standard D-Bus Introspectable interface, querying this 153 property does not require parsing XML. 154 155 (earlier version of the display interface do not provide this property) 156 --> 157 <property name="Interfaces" type="as" access="read"/> 158 </interface> 159 160 <!-- 161 org.qemu.Display1.Keyboard: 162 163 This interface is optionally implemented on 164 ``/org/qemu/Display1/Console_$id`` (see 165 :dbus:iface:`~org.qemu.Display1.Console`). 166 --> 167 <interface name="org.qemu.Display1.Keyboard"> 168 <!-- 169 Press: 170 @keycode: QEMU key number (xtkbd + special re-encoding of high bit) 171 172 Send a key press event. 173 --> 174 <method name="Press"> 175 <arg type="u" name="keycode" direction="in"/> 176 </method> 177 178 <!-- 179 Release: 180 @keycode: QEMU key number (xtkbd + special re-encoding of high bit) 181 182 Send a key release event. 183 --> 184 <method name="Release"> 185 <arg type="u" name="keycode" direction="in"/> 186 </method> 187 188 <!-- 189 Modifiers: 190 191 The active keyboard modifiers:: 192 193 Scroll = 1 << 0 194 Num = 1 << 1 195 Caps = 1 << 2 196 --> 197 <property name="Modifiers" type="u" access="read"/> 198 </interface> 199 200 <!-- 201 org.qemu.Display1.Mouse: 202 203 This interface is optionally implemented on 204 ``/org/qemu/Display1/Console_$id`` (see 205 :dbus:iface:`~org.qemu.Display1.Console` documentation). 206 207 .. _dbus-button-values: 208 209 **Button values**:: 210 211 Left = 0 212 Middle = 1 213 Right = 2 214 Wheel-up = 3 215 Wheel-down = 4 216 Side = 5 217 Extra = 6 218 --> 219 <interface name="org.qemu.Display1.Mouse"> 220 <!-- 221 Press: 222 @button: :ref:`button value<dbus-button-values>`. 223 224 Send a mouse button press event. 225 --> 226 <method name="Press"> 227 <arg type="u" name="button" direction="in"/> 228 </method> 229 230 <!-- 231 Release: 232 @button: :ref:`button value<dbus-button-values>`. 233 234 Send a mouse button release event. 235 --> 236 <method name="Release"> 237 <arg type="u" name="button" direction="in"/> 238 </method> 239 240 <!-- 241 SetAbsPosition: 242 @x: X position, in pixels. 243 @y: Y position, in pixels. 244 245 Set the mouse pointer position. 246 247 Returns an error if not :dbus:prop:`IsAbsolute`. 248 --> 249 <method name="SetAbsPosition"> 250 <arg type="u" name="x" direction="in"/> 251 <arg type="u" name="y" direction="in"/> 252 </method> 253 254 <!-- 255 RelMotion: 256 @dx: X-delta, in pixels. 257 @dy: Y-delta, in pixels. 258 259 Move the mouse pointer position, relative to the current position. 260 261 Returns an error if :dbus:prop:`IsAbsolute`. 262 --> 263 <method name="RelMotion"> 264 <arg type="i" name="dx" direction="in"/> 265 <arg type="i" name="dy" direction="in"/> 266 </method> 267 268 <!-- 269 IsAbsolute: 270 271 Whether the mouse is using absolute movements. 272 --> 273 <property name="IsAbsolute" type="b" access="read"/> 274 </interface> 275 276 <!-- 277 org.qemu.Display1.MultiTouch: 278 279 This interface in implemented on ``/org/qemu/Display1/Console_$id`` (see 280 :dbus:iface:`~org.qemu.Display1.Console` documentation). 281 282 .. _dbus-kind-values: 283 284 **Kind values**:: 285 286 Begin = 0 287 Update = 1 288 End = 2 289 Cancel = 3 290 --> 291 <interface name="org.qemu.Display1.MultiTouch"> 292 <!-- 293 SendEvent: 294 @kind: The touch event kind 295 @num_slot: The slot number. 296 @x: The x coordinates. 297 @y: The y coordinates. 298 299 Send a touch gesture event. 300 --> 301 <method name="SendEvent"> 302 <arg type="u" name="kind" direction="in"/> 303 <arg type="t" name="num_slot" direction="in"/> 304 <arg type="d" name="x" direction="in"/> 305 <arg type="d" name="y" direction="in"/> 306 </method> 307 308 <!-- 309 MaxSlots: 310 311 The maximum number of slots. 312 --> 313 <property name="MaxSlots" type="i" access="read"/> 314 </interface> 315 316 <!-- 317 org.qemu.Display1.Listener: 318 319 This client-side interface must be available on 320 ``/org/qemu/Display1/Listener`` when registering the peer-to-peer 321 connection with :dbus:meth:`~org.qemu.Display1.Console.Register`. 322 --> 323 <interface name="org.qemu.Display1.Listener"> 324 <!-- 325 Scanout: 326 @width: display width, in pixels. 327 @height: display height, in pixels. 328 @stride: data stride, in bytes. 329 @pixman_format: image format (ex: ``PIXMAN_X8R8G8B8``). 330 @data: image data. 331 332 Resize and update the display content. 333 334 The data to transfer for the display update may be large. The preferred 335 scanout method is :dbus:meth:`ScanoutDMABUF`, used whenever possible. 336 --> 337 <method name="Scanout"> 338 <arg type="u" name="width" direction="in"/> 339 <arg type="u" name="height" direction="in"/> 340 <arg type="u" name="stride" direction="in"/> 341 <arg type="u" name="pixman_format" direction="in"/> 342 <arg type="ay" name="data" direction="in"> 343 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/> 344 </arg> 345 </method> 346 347 <!-- 348 Update: 349 @x: X update position, in pixels. 350 @y: Y update position, in pixels. 351 @width: update width, in pixels. 352 @height: update height, in pixels. 353 @stride: data stride, in bytes. 354 @pixman_format: image format (ex: ``PIXMAN_X8R8G8B8``). 355 @data: display image data. 356 357 Update the display content. 358 359 This method is only called after a :dbus:meth:`Scanout` call. 360 --> 361 <method name="Update"> 362 <arg type="i" name="x" direction="in"/> 363 <arg type="i" name="y" direction="in"/> 364 <arg type="i" name="width" direction="in"/> 365 <arg type="i" name="height" direction="in"/> 366 <arg type="u" name="stride" direction="in"/> 367 <arg type="u" name="pixman_format" direction="in"/> 368 <arg type="ay" name="data" direction="in"> 369 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/> 370 </arg> 371 </method> 372 373 <?if $(env.HOST_OS) != windows?> 374 <!-- 375 ScanoutDMABUF: 376 @dmabuf: the DMABUF file descriptor. 377 @width: display width, in pixels. 378 @height: display height, in pixels. 379 @stride: stride, in bytes. 380 @fourcc: DMABUF fourcc. 381 @modifier: DMABUF modifier. 382 @y0_top: whether Y position 0 is the top or not. 383 384 Resize and update the display content with a DMABUF. 385 --> 386 <method name="ScanoutDMABUF"> 387 <arg type="h" name="dmabuf" direction="in"/> 388 <arg type="u" name="width" direction="in"/> 389 <arg type="u" name="height" direction="in"/> 390 <arg type="u" name="stride" direction="in"/> 391 <arg type="u" name="fourcc" direction="in"/> 392 <!-- xywh? --> 393 <arg type="t" name="modifier" direction="in"/> 394 <arg type="b" name="y0_top" direction="in"/> 395 </method> 396 397 <!-- 398 UpdateDMABUF: 399 @x: the X update position, in pixels. 400 @y: the Y update position, in pixels. 401 @width: the update width, in pixels. 402 @height: the update height, in pixels. 403 404 Update the display content with the current DMABUF and the given region. 405 --> 406 <method name="UpdateDMABUF"> 407 <arg type="i" name="x" direction="in"/> 408 <arg type="i" name="y" direction="in"/> 409 <arg type="i" name="width" direction="in"/> 410 <arg type="i" name="height" direction="in"/> 411 </method> 412 <?endif?> 413 414 <!-- 415 Disable: 416 417 Disable the display (turn it off). 418 --> 419 <method name="Disable"> 420 </method> 421 422 <!-- 423 MouseSet: 424 @x: X mouse position, in pixels. 425 @y: Y mouse position, in pixels. 426 @on: whether the mouse is visible or not. 427 428 Set the mouse position and visibility. 429 --> 430 <method name="MouseSet"> 431 <arg type="i" name="x" direction="in"/> 432 <arg type="i" name="y" direction="in"/> 433 <arg type="i" name="on" direction="in"/> 434 </method> 435 436 <!-- 437 CursorDefine: 438 @width: cursor width, in pixels. 439 @height: cursor height, in pixels. 440 @hot_x: hot-spot X position, in pixels. 441 @hot_y: hot-spot Y position, in pixels. 442 @data: the cursor data. 443 444 Set the mouse cursor shape and hot-spot. The "data" must be ARGB, 32-bit 445 per pixel. 446 --> 447 <method name="CursorDefine"> 448 <arg type="i" name="width" direction="in"/> 449 <arg type="i" name="height" direction="in"/> 450 <arg type="i" name="hot_x" direction="in"/> 451 <arg type="i" name="hot_y" direction="in"/> 452 <arg type="ay" name="data" direction="in"> 453 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/> 454 </arg> 455 </method> 456 457 <!-- 458 Interfaces: 459 460 This property lists extra interfaces provided by the 461 /org/qemu/Display1/Listener object, and can be used to detect 462 the capabilities with which they are communicating. 463 464 Unlike the standard D-Bus Introspectable interface, querying this 465 property does not require parsing XML. 466 467 (earlier version of the display interface do not provide this property) 468 --> 469 <property name="Interfaces" type="as" access="read"/> 470 </interface> 471 472 <!-- 473 org.qemu.Display1.Listener.Win32.Map: 474 475 This optional client-side interface can complement 476 org.qemu.Display1.Listener on ``/org/qemu/Display1/Listener`` for Windows 477 specific shared memory scanouts. 478 --> 479 <?if $(env.HOST_OS) == windows?> 480 <interface name="org.qemu.Display1.Listener.Win32.Map"> 481 <!-- 482 ScanoutMap: 483 @handle: the shared map handle value. 484 @offset: mapping offset. 485 @width: display width, in pixels. 486 @height: display height, in pixels. 487 @stride: stride, in bytes. 488 @pixman_format: image format (ex: ``PIXMAN_X8R8G8B8``). 489 490 Resize and update the display content with a shared map. 491 --> 492 <method name="ScanoutMap"> 493 <arg type="t" name="handle" direction="in"/> 494 <arg type="u" name="offset" direction="in"/> 495 <arg type="u" name="width" direction="in"/> 496 <arg type="u" name="height" direction="in"/> 497 <arg type="u" name="stride" direction="in"/> 498 <arg type="u" name="pixman_format" direction="in"/> 499 </method> 500 501 <!-- 502 UpdateMap: 503 @x: the X update position, in pixels. 504 @y: the Y update position, in pixels. 505 @width: the update width, in pixels. 506 @height: the update height, in pixels. 507 508 Update the display content with the current shared map and the given region. 509 --> 510 <method name="UpdateMap"> 511 <arg type="i" name="x" direction="in"/> 512 <arg type="i" name="y" direction="in"/> 513 <arg type="i" name="width" direction="in"/> 514 <arg type="i" name="height" direction="in"/> 515 </method> 516 </interface> 517 <?endif?> 518 519 <!-- 520 org.qemu.Display1.Listener.Win32.D3d11: 521 522 This optional client-side interface can complement 523 org.qemu.Display1.Listener on ``/org/qemu/Display1/Listener`` for Windows 524 specific Direct3D texture sharing of the scanouts. 525 --> 526 <interface name="org.qemu.Display1.Listener.Win32.D3d11"> 527 <!-- 528 ScanoutTexture2d: 529 @handle: the NT handle for the shared texture (to be opened back with ID3D11Device1::OpenSharedResource1). 530 @texture_width: texture width, in pixels. 531 @texture_height: texture height, in pixels. 532 @y0_top: whether Y position 0 is the top or not. 533 @x: the X scanout position, in pixels. 534 @y: the Y scanout position, in pixels. 535 @width: the scanout width, in pixels. 536 @height: the scanout height, in pixels. 537 538 Resize and update the display content with a Direct3D 11 2D texture. 539 You must acquire and release the associated KeyedMutex 0 during rendering. 540 --> 541 <method name="ScanoutTexture2d"> 542 <arg type="t" name="handle" direction="in"/> 543 <arg type="u" name="texture_width" direction="in"/> 544 <arg type="u" name="texture_height" direction="in"/> 545 <arg type="b" name="y0_top" direction="in"/> 546 <arg type="u" name="x" direction="in"/> 547 <arg type="u" name="y" direction="in"/> 548 <arg type="u" name="width" direction="in"/> 549 <arg type="u" name="height" direction="in"/> 550 </method> 551 552 <!-- 553 UpdateTexture2d: 554 @x: the X update position, in pixels. 555 @y: the Y update position, in pixels. 556 @width: the update width, in pixels. 557 @height: the update height, in pixels. 558 559 Update the display content with the current Direct3D 2D texture and the given region. 560 You must acquire and release the associated KeyedMutex 0 during rendering. 561 --> 562 <method name="UpdateTexture2d"> 563 <arg type="i" name="x" direction="in"/> 564 <arg type="i" name="y" direction="in"/> 565 <arg type="i" name="width" direction="in"/> 566 <arg type="i" name="height" direction="in"/> 567 </method> 568 </interface> 569 570 <!-- 571 org.qemu.Display1.Clipboard: 572 573 This interface must be implemented by both the client and the server on 574 ``/org/qemu/Display1/Clipboard`` to support clipboard sharing between 575 the client and the guest. 576 577 Once :dbus:meth:`Register`'ed, method calls may be sent and received in both 578 directions. Unregistered callers will get error replies. 579 580 .. _dbus-clipboard-selection: 581 582 **Selection values**:: 583 584 Clipboard = 0 585 Primary = 1 586 Secondary = 2 587 588 .. _dbus-clipboard-serial: 589 590 **Serial counter** 591 592 To solve potential clipboard races, clipboard grabs have an associated 593 serial counter. It is set to 0 on registration, and incremented by 1 for 594 each grab. The peer with the highest serial is the clipboard grab owner. 595 596 When a grab with a lower serial is received, it should be discarded. 597 598 When a grab is attempted with the same serial number as the current grab, 599 the one coming from the client should have higher priority, and the client 600 should gain clipboard grab ownership. 601 --> 602 <interface name="org.qemu.Display1.Clipboard"> 603 <!-- 604 Register: 605 606 Register a clipboard session and reinitialize the serial counter. 607 608 The client must register itself, and is granted an exclusive 609 access for handling the clipboard. 610 611 The server can reinitialize the session as well (to reset the counter). 612 --> 613 <method name="Register"/> 614 615 <!-- 616 Unregister: 617 618 Unregister the clipboard session. 619 --> 620 <method name="Unregister"/> 621 <!-- 622 Grab: 623 @selection: a :ref:`selection value<dbus-clipboard-selection>`. 624 @serial: the current grab :ref:`serial<dbus-clipboard-serial>`. 625 @mimes: the list of available content MIME types. 626 627 Grab the clipboard, claiming current clipboard content. 628 --> 629 <method name="Grab"> 630 <arg type="u" name="selection"/> 631 <arg type="u" name="serial"/> 632 <arg type="as" name="mimes"/> 633 </method> 634 635 <!-- 636 Release: 637 @selection: a :ref:`selection value<dbus-clipboard-selection>`. 638 639 Release the clipboard (does nothing if not the current owner). 640 --> 641 <method name="Release"> 642 <arg type="u" name="selection"/> 643 </method> 644 645 <!-- 646 Request: 647 @selection: a :ref:`selection value<dbus-clipboard-selection>` 648 @mimes: requested MIME types (by order of preference). 649 @reply_mime: the returned data MIME type. 650 @data: the clipboard data. 651 652 Request the clipboard content. 653 654 Return an error if the clipboard is empty, or the requested MIME types 655 are unavailable. 656 --> 657 <method name="Request"> 658 <arg type="u" name="selection"/> 659 <arg type="as" name="mimes"/> 660 <arg type="s" name="reply_mime" direction="out"/> 661 <arg type="ay" name="data" direction="out"> 662 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/> 663 </arg> 664 </method> 665 666 <!-- 667 Interfaces: 668 669 This property lists extra interfaces provided by the 670 /org/qemu/Display1/Clipboard object, and can be used to detect 671 the capabilities with which they are communicating. 672 673 Unlike the standard D-Bus Introspectable interface, querying this 674 property does not require parsing XML. 675 676 (earlier version of the display interface do not provide this property) 677 --> 678 <property name="Interfaces" type="as" access="read"/> 679 </interface> 680 681 <!-- 682 org.qemu.Display1.Audio: 683 684 Audio backend may be available on ``/org/qemu/Display1/Audio``. 685 --> 686 <interface name="org.qemu.Display1.Audio"> 687 <!-- 688 RegisterOutListener: 689 @listener: a Unix socket FD, for peer-to-peer D-Bus communication. 690 691 Register an audio backend playback handler. 692 693 Multiple listeners may be registered simultaneously. 694 695 The listener is expected to implement the 696 :dbus:iface:`org.qemu.Display1.AudioOutListener` interface. 697 --> 698 <method name="RegisterOutListener"> 699 <?if $(env.HOST_OS) == windows?> 700 <arg type="ay" name="listener" direction="in"> 701 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/> 702 </arg> 703 <?else?> 704 <arg type="h" name="listener" direction="in"/> 705 <?endif?> 706 </method> 707 708 <!-- 709 RegisterInListener: 710 @listener: a Unix socket FD, for peer-to-peer D-Bus communication. 711 712 Register an audio backend record handler. 713 714 Multiple listeners may be registered simultaneously. 715 716 The listener is expected to implement the 717 :dbus:iface:`org.qemu.Display1.AudioInListener` interface. 718 --> 719 <method name="RegisterInListener"> 720 <?if $(env.HOST_OS) == windows?> 721 <arg type="ay" name="listener" direction="in"> 722 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/> 723 </arg> 724 <?else?> 725 <arg type="h" name="listener" direction="in"/> 726 <?endif?> 727 </method> 728 729 <!-- 730 Interfaces: 731 732 This property lists extra interfaces provided by the 733 /org/qemu/Display1/Audio object, and can be used to detect 734 the capabilities with which they are communicating. 735 736 Unlike the standard D-Bus Introspectable interface, querying this 737 property does not require parsing XML. 738 739 (earlier version of the display interface do not provide this property) 740 --> 741 <property name="Interfaces" type="as" access="read"/> 742 </interface> 743 744 <!-- 745 org.qemu.Display1.AudioOutListener: 746 747 This client-side interface must be available on 748 ``/org/qemu/Display1/AudioOutListener`` when registering the peer-to-peer 749 connection with :dbus:meth:`~org.qemu.Display1.Audio.RegisterOutListener`. 750 --> 751 <interface name="org.qemu.Display1.AudioOutListener"> 752 <!-- 753 Init: 754 @id: the stream ID. 755 @bits: PCM bits per sample. 756 @is_signed: whether the PCM data is signed. 757 @is_float: PCM floating point format. 758 @freq: the PCM frequency in Hz. 759 @nchannels: the number of channels. 760 @bytes_per_frame: the bytes per frame. 761 @bytes_per_second: the bytes per second. 762 @be: whether using big-endian format. 763 764 Initializes a PCM playback stream. 765 --> 766 <method name="Init"> 767 <arg name="id" type="t" direction="in"/> 768 <arg name="bits" type="y" direction="in"/> 769 <arg name="is_signed" type="b" direction="in"/> 770 <arg name="is_float" type="b" direction="in"/> 771 <arg name="freq" type="u" direction="in"/> 772 <arg name="nchannels" type="y" direction="in"/> 773 <arg name="bytes_per_frame" type="u" direction="in"/> 774 <arg name="bytes_per_second" type="u" direction="in"/> 775 <arg name="be" type="b" direction="in"/> 776 </method> 777 778 <!-- 779 Fini: 780 @id: the stream ID. 781 782 Finish & close a playback stream. 783 --> 784 <method name="Fini"> 785 <arg name="id" type="t" direction="in"/> 786 </method> 787 788 <!-- 789 SetEnabled: 790 @id: the stream ID. 791 792 Resume or suspend the playback stream. 793 --> 794 <method name="SetEnabled"> 795 <arg name="id" type="t" direction="in"/> 796 <arg name="enabled" type="b" direction="in"/> 797 </method> 798 799 <!-- 800 SetVolume: 801 @id: the stream ID. 802 @mute: whether the stream is muted. 803 @volume: the volume per-channel. 804 805 Set the stream volume and mute state (volume without unit, 0-255). 806 --> 807 <method name="SetVolume"> 808 <arg name="id" type="t" direction="in"/> 809 <arg name="mute" type="b" direction="in"/> 810 <arg name="volume" type="ay" direction="in"> 811 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/> 812 </arg> 813 </method> 814 815 <!-- 816 Write: 817 @id: the stream ID. 818 @data: the PCM data. 819 820 PCM stream to play. 821 --> 822 <method name="Write"> 823 <arg name="id" type="t" direction="in"/> 824 <arg type="ay" name="data" direction="in"> 825 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/> 826 </arg> 827 </method> 828 829 <!-- 830 Interfaces: 831 832 This property lists extra interfaces provided by the 833 /org/qemu/Display1/AudioOutListener object, and can be used to detect 834 the capabilities with which they are communicating. 835 836 Unlike the standard D-Bus Introspectable interface, querying this 837 property does not require parsing XML. 838 839 (earlier version of the display interface do not provide this property) 840 --> 841 <property name="Interfaces" type="as" access="read"/> 842 </interface> 843 844 <!-- 845 org.qemu.Display1.AudioInListener: 846 847 This client-side interface must be available on 848 ``/org/qemu/Display1/AudioInListener`` when registering the peer-to-peer 849 connection with :dbus:meth:`~org.qemu.Display1.Audio.RegisterInListener`. 850 --> 851 <interface name="org.qemu.Display1.AudioInListener"> 852 <!-- 853 Init: 854 @id: the stream ID. 855 @bits: PCM bits per sample. 856 @is_signed: whether the PCM data is signed. 857 @is_float: PCM floating point format. 858 @freq: the PCM frequency in Hz. 859 @nchannels: the number of channels. 860 @bytes_per_frame: the bytes per frame. 861 @bytes_per_second: the bytes per second. 862 @be: whether using big-endian format. 863 864 Initializes a PCM record stream. 865 --> 866 <method name="Init"> 867 <arg name="id" type="t" direction="in"/> 868 <arg name="bits" type="y" direction="in"/> 869 <arg name="is_signed" type="b" direction="in"/> 870 <arg name="is_float" type="b" direction="in"/> 871 <arg name="freq" type="u" direction="in"/> 872 <arg name="nchannels" type="y" direction="in"/> 873 <arg name="bytes_per_frame" type="u" direction="in"/> 874 <arg name="bytes_per_second" type="u" direction="in"/> 875 <arg name="be" type="b" direction="in"/> 876 </method> 877 878 <!-- 879 Fini: 880 @id: the stream ID. 881 882 Finish & close a record stream. 883 --> 884 <method name="Fini"> 885 <arg name="id" type="t" direction="in"/> 886 </method> 887 888 <!-- 889 SetEnabled: 890 @id: the stream ID. 891 892 Resume or suspend the record stream. 893 --> 894 <method name="SetEnabled"> 895 <arg name="id" type="t" direction="in"/> 896 <arg name="enabled" type="b" direction="in"/> 897 </method> 898 899 <!-- 900 SetVolume: 901 @id: the stream ID. 902 @mute: whether the stream is muted. 903 @volume: the volume per-channel. 904 905 Set the stream volume and mute state (volume without unit, 0-255). 906 --> 907 <method name="SetVolume"> 908 <arg name="id" type="t" direction="in"/> 909 <arg name="mute" type="b" direction="in"/> 910 <arg name="volume" type="ay" direction="in"> 911 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/> 912 </arg> 913 </method> 914 915 <!-- 916 Read: 917 @id: the stream ID. 918 @size: the amount to read, in bytes. 919 @data: the recorded data (which may be less than requested). 920 921 Read "size" bytes from the record stream. 922 --> 923 <method name="Read"> 924 <arg name="id" type="t" direction="in"/> 925 <arg name="size" type="t" direction="in"/> 926 <arg type="ay" name="data" direction="out"> 927 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/> 928 </arg> 929 </method> 930 931 <!-- 932 Interfaces: 933 934 This property lists extra interfaces provided by the 935 /org/qemu/Display1/AudioInListener object, and can be used to detect 936 the capabilities with which they are communicating. 937 938 Unlike the standard D-Bus Introspectable interface, querying this 939 property does not require parsing XML. 940 941 (earlier version of the display interface do not provide this property) 942 --> 943 <property name="Interfaces" type="as" access="read"/> 944 </interface> 945 946 <!-- 947 org.qemu.Display1.Chardev: 948 949 Character devices may be available on ``/org/qemu/Display1/Chardev_$id``. 950 951 They may be used for different kind of streams, which are identified via 952 their FQDN :dbus:prop:`Name`. 953 954 .. _dbus-chardev-fqdn: 955 956 Here are some known reserved kind names (the ``org.qemu`` prefix is 957 reserved by QEMU): 958 959 org.qemu.console.serial.0 960 A serial console stream. 961 962 org.qemu.monitor.hmp.0 963 A QEMU HMP human monitor. 964 965 org.qemu.monitor.qmp.0 966 A QEMU QMP monitor. 967 968 org.qemu.usbredir 969 A usbredir stream. 970 --> 971 <interface name="org.qemu.Display1.Chardev"> 972 <!-- 973 Register: 974 @stream: a Unix FD to redirect the stream to. 975 976 Register a file-descriptor for the stream handling. 977 978 The current handler, if any, will be replaced. 979 --> 980 <method name="Register"> 981 <?if $(env.HOST_OS) == windows?> 982 <arg type="ay" name="listener" direction="in"> 983 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/> 984 </arg> 985 <?else?> 986 <arg type="h" name="stream" direction="in"/> 987 <?endif?> 988 </method> 989 990 <!-- 991 SendBreak: 992 993 Send a break event to the character device. 994 --> 995 <method name="SendBreak"/> 996 997 <!-- 998 Name: 999 1000 The FQDN name to identify the kind of stream. See :ref:`reserved 1001 names<dbus-chardev-fqdn>`. 1002 --> 1003 <property name="Name" type="s" access="read"/> 1004 1005 <!-- 1006 FEOpened: 1007 1008 Whether the front-end side is opened. 1009 --> 1010 <property name="FEOpened" type="b" access="read"/> 1011 1012 <!-- 1013 Echo: 1014 1015 Whether the input should be echo'ed (for serial streams). 1016 --> 1017 <property name="Echo" type="b" access="read"/> 1018 1019 <!-- 1020 Owner: 1021 1022 The D-Bus unique name of the registered handler. 1023 --> 1024 <property name="Owner" type="s" access="read"/> 1025 1026 <!-- 1027 Interfaces: 1028 1029 This property lists extra interfaces provided by the 1030 ``/org/qemu/Display1/Chardev_$i`` object, and can be used to detect 1031 the capabilities with which they are communicating. 1032 1033 Unlike the standard D-Bus Introspectable interface, querying this 1034 property does not require parsing XML. 1035 1036 (earlier version of the display interface do not provide this property) 1037 --> 1038 <property name="Interfaces" type="as" access="read"/> 1039 </interface> 1040</node> 1041