Changeset 89797 in vbox for trunk/include

Timestamp:

Jun 20, 2021 1:17:17 AM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

145254

Message:

pdmaudioifs.h: doxygen. bugref:9890

File:

• trunk/include/VBox/vmm/pdmaudioifs.h (modified) (4 diffs)

trunk/include/VBox/vmm/pdmaudioifs.h

@@ -33 +33 @@
  *
 @startuml
-skinparam componentStyle rectangular
+skinparam componentStyle rectangle
 
 component DevAudio {
@@ -58 +58 @@
   }
 }
-note right of DevAudio
+note top of DevAudio
     This could be DevHda, DevIchAc97
     or DevSB16.
 end note
 
+''note as LunNote
+''    There can be any number of LUNs.
+''
+''    The first LUN is normally used for
+''    connecting to the host audio device.
+''
+''    Then follows remote desktop, video
+''    recording, debugging and testing.
+''end note
+''LunNote .. LUN0
+''LunNote .. LUN1
+
 node "Driver Chain #0" {
     component "DrvAudio#0" {
+        () PDMIHOSTAUDIOPORT0
         () PDMIAUDIOCONNECTOR0
-        () PDMIHOSTAUDIOPORT0
     }
     component "DrvHostAudioWasApi" {
@@ -72 +84 @@
     }
 }
+PDMIHOSTAUDIOPORT0 <--> PDMIHOSTAUDIO0
 
 node "Driver Chain #1" {
@@ -82 +95 @@
     }
 }
-
+note bottom of DrvAudioVRDE
+    The backend driver is sometimes not configured if the component it represents
+    is not configured for the VM.  However, Main will still set up the LUN but
+    with just DrvAudio attached to simplify runtime activation of the component.
+    In the meanwhile, the DrvAudio instance works as if DrvHostAudioNull were attached.
+end note
+
+LUN1 <--> PDMIAUDIOCONNECTOR1
 LUN0 <--> PDMIAUDIOCONNECTOR0
-LUN1 <--> PDMIAUDIOCONNECTOR1
-
-PDMIHOSTAUDIOPORT0 <--> PDMIHOSTAUDIO0
+
 PDMIHOSTAUDIOPORT1 <--> PDMIHOSTAUDIO1