Add mm_sound_stop_keysound()

[platform/core/multimedia/libmm-sound.git] / include / mm_sound_private.h

diff --git a/include/mm_sound_private.h b/include/mm_sound_private.h
index de2deac..9258ce7 100644 (file)
--- a/include/mm_sound_private.h
+++ b/include/mm_sound_private.h
@@ -59,17 +59,30 @@ typedef struct {
  * This function is to play key sound.
  *
  * @param      filename                [in] keytone filename to play
- * @param      volume_config   [in] Volume type & volume gain
+ * @param      volume_config   [in] volume type & volume gain
  *
  * @return     This function returns MM_ERROR_NONE on success, or negative value
  *                     with error code.
  *
  * @remark     This function provide low latency sound play (such as dialer keytone)
  *                     using fixed spec of wave file (44100Hz, mono channel)
- * @see                volume_type_t volume_gain_t mm_sound_volume_set_value
+ * @see                mm_sound_stop_keysound()
+ * @see                volume_type_t volume_gain_t
  */
 int mm_sound_play_keysound(const char *filename, int volume_config);
 
+/**
+ * This function is to stop key sound.
+ *
+ * @param      filename                [in] keytone filename to stop (can be null if whole exist keytones need stops)
+ *
+ * @return     This function returns MM_ERROR_NONE on success, or negative value
+ *                     with error code.
+ *
+ * @see                mm_sound_play_keysound()
+ */
+int mm_sound_stop_keysound(const char *filename);
+
 int mm_sound_boot_ready(int timeout_sec);
 
 int mm_sound_boot_play_sound(char* path);