ALSA: compress: update comment for sample rate in snd_codec

Signed-off-by: Vinod Koul <vinod.koul@intel.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
(cherry picked from commit d9afee6904caa7cf3c7f417f02e765db89d2b5dc)
Signed-off-by: Yuchen Song <yuchens@nvidia.com>
Change-Id: I7608d924613611222766a898a97c856a64c2eb68

diff --git a/include/uapi/sound/compress_params.h b/include/uapi/sound/compress_params.h
index 1114e380aecdb25f09737df9e3c61b7ad57166ef..8c23aebc82a51bf6a9db58b5ec23cb6114b3e12b 100644 (file)
--- a/include/uapi/sound/compress_params.h
+++ b/include/uapi/sound/compress_params.h
@@ -364,7 +364,8 @@ struct snd_codec_desc {
  * @ch_out: Number of output channels. In case of contradiction between
  *             this field and the channelMode field, the channelMode field
  *             overrides.
- * @sample_rate: Audio sample rate of input data
+ * @sample_rate: Audio sample rate of input data in Hz, use values like 48000
+ *             for this.
  * @bit_rate: Bitrate of encoded data. May be ignored by decoders
  * @rate_control: Encoding rate control. See SND_RATECONTROLMODE defines.
  *               Encoders may rely on profiles for quality levels.