Add the remarks for handling interrupt

Change-Id: I3836ebdfe94c916fc96975fbe03a93368e46f752
Signed-off-by: EonseokLee <eonseok.lee@samsung.com>

diff --git a/inc/FMediaIAudioInEventListener.h b/inc/FMediaIAudioInEventListener.h
index ff9517a..7288be9 100644 (file)
--- a/inc/FMediaIAudioInEventListener.h
+++ b/inc/FMediaIAudioInEventListener.h
@@ -37,6 +37,10 @@ namespace Tizen { namespace Media
  *
  * @since              2.0
  *
+ * @remarks                    OnAudioInInterrupted() is called when the application is interrupted by another application and OnAudioInReleased() event can be called at the end of interruption.
+ *                     OnAudioInAudioFocusChanged() is called when the application is interrupted by another application but the end of interruption is not notified.
+ *                     So, the application should handle both events to work properly on various sound scenarios between applications.
+ *
  * The %IAudioInEventListener interface provides various methods that are called during the operations of %AudioIn.
  * %AudioIn captures audio data from the device in asynchronous mode,
  * and calls the listener's methods to pass the captured audio data.

diff --git a/inc/FMediaIAudioOutEventListener.h b/inc/FMediaIAudioOutEventListener.h
index f3d41c9..08d7a4e 100644 (file)
--- a/inc/FMediaIAudioOutEventListener.h
+++ b/inc/FMediaIAudioOutEventListener.h
@@ -36,6 +36,10 @@ class AudioOut;
  *
  * @since              2.0
  *
+ * @remarks                    OnAudioOutInterrupted() is called when the application is interrupted by another application and OnAudioOutReleased() event can be called at the end of interruption.
+ *                     OnAudioOutAudioFocusChanged() is called when the application is interrupted by another application but the end of interruption is not notified.
+ *                     So, the application should handle both events to work properly on various sound scenarios between applications.
+ *
  *  The %IAudioOutEventListener interface represents a listener that receives the AudioOut related events. The %AudioOut class works in asynchronous mode, and when the application plays audio data with the %AudioOut class,
  *  the caller must implement this interface to receive an event from %AudioOut.
  *

diff --git a/inc/FMediaIPlayerEventListener.h b/inc/FMediaIPlayerEventListener.h
index 1078ac4..3f414f4 100644 (file)
--- a/inc/FMediaIPlayerEventListener.h
+++ b/inc/FMediaIPlayerEventListener.h
@@ -37,6 +37,10 @@ namespace Tizen { namespace Media
  *
  * @since              2.0
  *
+ * @remarks                    OnPlayerInterrupted() is called when the application is interrupted by another application and OnPlayerReleased() event can be called at the end of interruption.
+ *                     OnPlayerAudioFocusChanged() is called when the application is interrupted by another application but the end of interruption is not notified.
+ *                     So, the application should handle both events to work properly on various sound scenarios between applications.
+ *
  * The %IPlayerEventListener interface specifies the methods used to notify the status of the media player during the media playing events.
  * The player engine works asynchronously. Therefore, it is important to implement this listener to ensure that the player flows correctly.
  * When each operation of the Player is completed, an event is generated, and a method from this class is called.

diff --git a/inc/FMediaITonePlayerEventListener.h b/inc/FMediaITonePlayerEventListener.h
index 334474d..533d726 100644 (file)
--- a/inc/FMediaITonePlayerEventListener.h
+++ b/inc/FMediaITonePlayerEventListener.h
@@ -37,6 +37,10 @@ class TonePlayer;
  *
  * @since              2.0
  *
+ * @remarks                    OnTonePlayerInterrupted() is called when the application is interrupted by another application and OnTonePlayerReleased() event can be called at the end of interruption.
+ *                     OnTonePlayerAudioFocusChanged() is called when the application is interrupted by another application but the end of interruption is not notified.
+ *                     So, the application should handle both events to work properly on various sound scenarios between applications.
+ *
  * The %ITonePlayerEventListener interface specifies the methods used to notify the status of the tone player.
  */