From: Eunhae Choi <eunhae1.choi@samsung.com>
Date: Tue, 5 Dec 2017 09:59:51 +0000 (+0900)
Subject: [ACR-1119] modify the API reference about resource conflict
X-Git-Tag: submit/tizen_4.0/20171213.082554^0
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=b2c60e8919a13aaba0be9a2c35e092a6e2caaf3b;p=platform%2Fcore%2Fapi%2Fplayer.git

[ACR-1119] modify the API reference about resource conflict

- the player state will be one of IDLE, READY or PAUSED.
- application should get the exact state by calling player_get_state API

Change-Id: I9652c72b7dd2871d912184f26726a64081ecdf49
---

diff --git a/include/player.h b/include/player.h
index ca38159..e1bc904 100644
--- a/include/player.h
+++ b/include/player.h
@@ -99,7 +99,7 @@ typedef enum {
 	PLAYER_INTERRUPTED_BY_MEDIA,                /**< Interrupted by a non-resumable media application (Deprecated since 3.0)*/
 	PLAYER_INTERRUPTED_BY_CALL,                 /**< Interrupted by an incoming call (Deprecated since 3.0)*/
 	PLAYER_INTERRUPTED_BY_EARJACK_UNPLUG,       /**< Interrupted by unplugging headphones (Deprecated since 3.0)*/
-	PLAYER_INTERRUPTED_BY_RESOURCE_CONFLICT,    /**< Interrupted by a resource conflict and the player handle will be unprepared */
+	PLAYER_INTERRUPTED_BY_RESOURCE_CONFLICT,    /**< Interrupted by a resource conflict and the player handle will be paused or unprepared */
 	PLAYER_INTERRUPTED_BY_ALARM,                /**< Interrupted by an alarm (Deprecated since 3.0)*/
 	PLAYER_INTERRUPTED_BY_EMERGENCY,            /**< Interrupted by an emergency (Deprecated since 3.0)*/
 	PLAYER_INTERRUPTED_BY_NOTIFICATION,         /**< Interrupted by a notification (Deprecated since 3.0)*/
@@ -298,12 +298,15 @@ typedef void (*player_seek_completed_cb)(void *user_data);
 
 /**
  * @brief Called when the media player is interrupted.
- * @details If the code is #PLAYER_INTERRUPTED_BY_RESOURCE_CONFLICT, the player handle will be unprepared.
+ * @details If the code is #PLAYER_INTERRUPTED_BY_RESOURCE_CONFLICT,
+ *          the player state will be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, or #PLAYER_STATE_PAUSED.
+ *          Application should get exact state by calling player_get_state().
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
  * @param[in] code        The interrupted error code
  * @param[in] user_data   The user data passed from the callback registration function
  * @see player_set_interrupted_cb()
  * @see player_unset_interrupted_cb()
+ * @see player_get_state()
  */
 typedef void (*player_interrupted_cb)(player_interrupted_code_e code, void *user_data);