Changeset 8a7d78cc in mainline for uspace/lib/drv/generic/remote_audio_mixer.c

Timestamp:

2013-04-10T19:25:16Z (12 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

1912b45

Parents:

b1dfe13

Message:

libdrv, audio_mixer: comments

File:

• uspace/lib/drv/generic/remote_audio_mixer.c (modified) (7 diffs)

uspace/lib/drv/generic/remote_audio_mixer.c

@@ -117 +117 @@
  * CLIENT SIDE
  */
+
+/**
+ * Query audio mixer for basic info (name and items count).
+ * @param[in] exch IPC exchange connected to the device
+ * @param[out] name Audio mixer string identifier
+ * @param[out] items Number of items controlled by the mixer.
+ * @return Error code.
+ */
 int audio_mixer_get_info(async_exch_t *exch, const char **name, unsigned *items)
 {
@@ -145 +153 @@
 }
 
+/**
+ * Query audio mixer for item specific info (name and channels count).
+ * @param[in] exch IPC exchange connected to the device
+ * @param[in] item The control item
+ * @param[out] name Control item string identifier.
+ * @param[out] channles Number of channels associated with this control item.
+ * @return Error code.
+ */
 int audio_mixer_get_item_info(async_exch_t *exch, unsigned item,
-    const char ** name, unsigned *channels)
+    const char **name, unsigned *channels)
 {
         if (!exch)
@@ -174 +190 @@
 }
 
+/**
+ * Query audio mixer for channel specific info (name and volume levels).
+ * @param[in] exch IPC exchange connected to the device.
+ * @param[in] item TH control item controlling the channel.
+ * @param[in] channel The channel.
+ * @param[out] name Audio channel string identifier.
+ * @param[out] volume_levels Number of volume levels.
+ * @return Error code.
+ */
 int audio_mixer_get_channel_info(async_exch_t *exch, unsigned item,
     unsigned channel, const char **name, unsigned *volume_levels)
@@ -204 +229 @@
 }
 
+/**
+ * Set MUTE status on an audio channel.
+ * @param[in] exch IPC exchange connected to the device.
+ * @param[in] item The control item controlling the channel.
+ * @param[in] channel The channel index.
+ * @param[in] mute_status A new MUTE status.
+ * @return Error code.
+ */
 int audio_mixer_channel_mute_set(async_exch_t *exch, unsigned item,
     unsigned channel, bool mute_status)
@@ -213 +246 @@
 }
 
+/**
+ * Get MUTE status on an audio channel.
+ * @param[in] exch IPC exchange connected to the device.
+ * @param[in] item The control item controlling the channel.
+ * @param[in] channel The channel index.
+ * @param[out] mute_status Currently set MUTE status.
+ * @return Error code.
+ */
 int audio_mixer_channel_mute_get(async_exch_t *exch, unsigned item,
     unsigned channel, bool *mute_status)
@@ -226 +267 @@
 }
 
+/**
+ * Set VOLUME LEVEL on an audio channel.
+ * @param[in] exch IPC exchange connected to the device.
+ * @param[in] item The control item controlling the channel.
+ * @param[in] channel The channel index.
+ * @param[in] volume A new VOLUME LEVEL.
+ * @return Error code.
+ */
 int audio_mixer_channel_volume_set(async_exch_t *exch, unsigned item,
     unsigned channel, unsigned volume)
@@ -235 +284 @@
 }
 
+/**
+ * Get VOLUME LEVEL on an audio channel.
+ * @param[in] exch IPC exchange connected to the device.
+ * @param[in] item The control item controlling the channel.
+ * @param[in] channel The channel index.
+ * @param[out] volume_current Currently set VOLUME LEVEL.
+ * @param[out] volume_max Maximum VOLUME LEVEL.
+ * @return Error code.
+ */
 int audio_mixer_channel_volume_get(async_exch_t *exch, unsigned item,
     unsigned channel, unsigned *volume_current, unsigned *volume_max)