Changeset 57404 in vbox for trunk

Timestamp:

Aug 18, 2015 8:54:43 AM (10 years ago)

Author:

vboxsync

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

102168

Message:

Comments.

File:

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

trunk/include/VBox/vmm/pdmaudioifs.h

@@ -112 +112 @@
 #endif
 
+/**
+ * Audio direction.
+ */
 typedef enum PDMAUDIODIR
 {
-    PDMAUDIODIR_UNKNOWN = 0,
-    PDMAUDIODIR_IN      = 1,
-    PDMAUDIODIR_OUT     = 2,
-    PDMAUDIODIR_BOTH    = 3
+    PDMAUDIODIR_UNKNOWN    = 0,
+    PDMAUDIODIR_IN         = 1,
+    PDMAUDIODIR_OUT        = 2,
+    PDMAUDIODIR_DUPLEX     = 3,
+    /** Hack to blow the type up to 32-bit. */
+    PDMAUDIODIR_32BIT_HACK = 0x7fffffff
 } PDMAUDIODIR;
 
+/**
+ * Audio mixer controls.
+ */
 typedef enum PDMAUDIOMIXERCTL
 {
@@ -131 +139 @@
 } PDMAUDIOMIXERCTL;
 
+/**
+ * Audio recording sources.
+ */
 typedef enum PDMAUDIORECSOURCE
 {
@@ -502 +513 @@
                                            PPDMAUDIOSTREAMCFG pCfg, PPDMAUDIOGSTSTRMOUT *ppGstStrmOut));
 
+    /**
+     * Plays (transfers) all available samples via the connected host backend.
+     *
+     * @returns VBox status code.
+     * @param   pInterface           Pointer to the interface structure containing the called function pointer.
+     * @param   pcSamplesPlayed      Number of samples played. Optional.
+     */
     DECLR3CALLBACKMEMBER(int, pfnPlayOut, (PPDMIAUDIOCONNECTOR pInterface, uint32_t *pcSamplesPlayed));
 
@@ -626 +644 @@
     DECLR3CALLBACKMEMBER(int, pfnFiniOut, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOHSTSTRMOUT pHstStrmOut));
 
+    /**
+     * Returns whether the specified audio direction in the backend is enabled or not.
+     *
+     * @param   pInterface          Pointer to the interface structure containing the called function pointer.
+     * @param   enmDir              Audio direction to check status for.
+     */
     DECLR3CALLBACKMEMBER(bool, pfnIsEnabled, (PPDMIHOSTAUDIO pInterface, PDMAUDIODIR enmDir));