Changeset 70471 in vbox

Timestamp:

Jan 5, 2018 3:37:08 PM (7 years ago)

Author:

vboxsync

Message:

Audio/VBoxMMNotificationClient.cpp: Documentation.

File:

• trunk/src/VBox/Devices/Audio/VBoxMMNotificationClient.cpp (modified) (10 diffs)

trunk/src/VBox/Devices/Audio/VBoxMMNotificationClient.cpp

@@ -43 +43 @@
 }
 
+/**
+ * Uninitializes the mulitmedia notification client implementation.
+ */
 void VBoxMMNotificationClient::Dispose(void)
 {
@@ -55 +58 @@
 }
 
+/**
+ * Initializes the mulitmedia notification client implementation.
+ *
+ * @return  HRESULT
+ */
 HRESULT VBoxMMNotificationClient::Initialize(void)
 {
@@ -74 +82 @@
 }
 
+/**
+ * Registration callback implementation for storing our (required) contexts.
+ *
+ * @return  IPRT status code.
+ * @param   pDrvIns             Driver instance to register the notification client to.
+ * @param   pfnCallback         Audio callback to call by the notification client in case of new events.
+ */
 int VBoxMMNotificationClient::RegisterCallback(PPDMDRVINS pDrvIns, PFNPDMHOSTAUDIOCALLBACK pfnCallback)
 {
@@ -82 +97 @@
 }
 
+/**
+ * Unregistration callback implementation for cleaning up our mess when we're done handling
+ * with notifications.
+ */
 void VBoxMMNotificationClient::UnregisterCallback(void)
 {
@@ -88 +107 @@
 }
 
+/**
+ * Stub being called when attaching to the default audio endpoint.
+ * Does nothing at the moment.
+ */
 HRESULT VBoxMMNotificationClient::AttachToDefaultEndpoint(void)
 {
@@ -93 +116 @@
 }
 
+/**
+ * Stub being called when detaching from the default audio endpoint.
+ * Does nothing at the moment.
+ */
 void VBoxMMNotificationClient::DetachFromEndpoint(void)
 {
@@ -98 +125 @@
 }
 
+/**
+ * Handler implementation which is called when an audio device state
+ * has been changed.
+ *
+ * @return  HRESULT
+ * @param   pwstrDeviceId       Device ID the state is announced for.
+ * @param   dwNewState          New state the device is now in.
+ */
 STDMETHODIMP VBoxMMNotificationClient::OnDeviceStateChanged(LPCWSTR pwstrDeviceId, DWORD dwNewState)
 {
@@ -133 +168 @@
 }
 
+/**
+ * Handler implementation which is called when a new audio device has been added.
+ *
+ * @return  HRESULT
+ * @param   pwstrDeviceId       Device ID which has been added.
+ */
 STDMETHODIMP VBoxMMNotificationClient::OnDeviceAdded(LPCWSTR pwstrDeviceId)
 {
@@ -140 +181 @@
 }
 
+/**
+ * Handler implementation which is called when an audio device has been removed.
+ *
+ * @return  HRESULT
+ * @param   pwstrDeviceId       Device ID which has been removed.
+ */
 STDMETHODIMP VBoxMMNotificationClient::OnDeviceRemoved(LPCWSTR pwstrDeviceId)
 {
@@ -147 +194 @@
 }
 
+/**
+ * Handler implementation which is called when the device audio device has been
+ * changed.
+ *
+ * @return  HRESULT
+ * @param   eFlow                     Flow direction of the new default device.
+ * @param   eRole                     Role of the new default device.
+ * @param   pwstrDefaultDeviceId      ID of the new default device.
+ */
 STDMETHODIMP VBoxMMNotificationClient::OnDefaultDeviceChanged(EDataFlow eFlow, ERole eRole, LPCWSTR pwstrDefaultDeviceId)
 {