inc/FMediaIPlayerEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file                FMediaIPlayerEventListener.h
  20  * @brief               This is the header file for the %IPlayerEventListener interface.
  21  *
  22  * This header file contains the declarations of the %IPlayerEventListener interface.
  23  */
  24
  25 #ifndef _FMEDIA_IPLAYER_EVENT_LISTENER_H_
  26 #define _FMEDIA_IPLAYER_EVENT_LISTENER_H_
  27
  28 #include <FBaseRtIEventListener.h>
  29 #include <FMediaPlayerTypes.h>
  30
  31 namespace Tizen { namespace Media
  32 {
  33
  34 /**
  35  * @interface   IPlayerEventListener
  36  * @brief                       This interface provides a listener for media playing events.
  37  *
  38  * @since               2.0
  39  *
  40  * The %IPlayerEventListener interface specifies the methods used to notify the status of the media player during the media playing events.
  41  * The player engine works asynchronously. Therefore, it is important to implement this listener to ensure that the player flows correctly.
  42  * When each operation of the Player is completed, an event is generated, and a method from this class is called.
  43  *
  44  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/playing_audio.htm">Playing Audio</a> and
  45  <a href="../org.tizen.native.appprogramming/html/guide/media/playing_video.htm">Playing Video</a>.
  46  */
  47
  48 class _OSP_EXPORT_ IPlayerEventListener
  49         : virtual public Tizen::Base::Runtime::IEventListener
  50 {
  51
  52 public:
  53         /**
  54         * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
  55         *
  56         * @since                2.0
  57         */
  58         virtual ~IPlayerEventListener(void) {}
  59
  60         /**
  61         *       Called when an audio/video content is opened asynchronously.
  62         *
  63         *   @since              2.0
  64         *
  65         *       @param[in]       r                                                                      The cause of the error
  66         *       @exception       E_SUCCESS                                                      The method is successful.
  67         *       @exception       E_SYSTEM                                                       A system error has occurred.
  68         *       @exception       E_CONNECTION_FAILED                            The network connection has failed.
  69         *       @exception       E_FILE_NOT_FOUND                  The file cannot be found or accessed.
  70         *   @exception   E_UNSUPPORTED_FORMAT                           The specified format is not supported.
  71         *   @exception   E_UNSUPPORTED_CODEC                            The specified codec is not supported.
  72         *       @exception       E_OUT_OF_MEMORY                                        The memory is insufficient.
  73         *       @exception      E_RIGHT_EXPIRED                                 The content right has expired.
  74         *       @exception      E_RIGHT_NO_LICENSE                              The content has no license.
  75         *       @exception      E_RIGHT_FUTURE_USE                              The content right is for future use.
  76         *       @exception      E_DISPLAY_RIGHT_VIOLATED                                The display right is not valid for the specific output device. @b Since: @b 2.1
  77         *       @see            Player::OpenFile()
  78         *       @see            Player::OpenUrl()
  79         *       @see            Player::OpenBuffer()
  80         */
  81         virtual void OnPlayerOpened(result r) = 0;
  82
  83         /**
  84         *       Called when the Player reaches the end of the clip.
  85         *
  86         * @since                2.0
  87         */
  88         virtual void OnPlayerEndOfClip(void) = 0;
  89
  90         /**
  91         *       Called when the position of the audio/video content moves asynchronously.
  92         *
  93         * @since                2.0
  94         *
  95         *       @param[in] r                              The cause of the error
  96         *       @exception       E_SUCCESS              The method is successful.
  97         *       @exception       E_SYSTEM               A system error has occurred.
  98         *       @see                             Player::SeekTo()
  99         */
 100
 101         virtual void OnPlayerSeekCompleted(result r){};
 102
 103
 104         /**
 105         *       Called when the streaming data is being buffered.
 106         *
 107         * @since                2.0
 108         *
 109         *       @param[in]      percent         The percentage of buffering is completed
 110         *       @see                            Player::OpenUrl()
 111         */
 112         virtual void OnPlayerBuffering(int percent) = 0;
 113
 114         /**
 115         *       Called when an error has occurred while the Player is working.
 116         *
 117         * @since                2.0
 118         *
 119         *       @param[in]      r               A player error reason of type ::PlayerErrorReason
 120         *       @remarks
 121         *                               - While playing streaming media, the player might throw an error like ::PLAYER_ERROR_CONNECTION_LOST,
 122         *                               ::PLAYER_ERROR_STREAMING_TIMEOUT, ::PLAYER_ERROR_TRANSPORT, or ::PLAYER_ERROR_SERVER.
 123         *                               - If the content includes invalid data, ::PLAYER_ERROR_INVALID_DATA may occur.
 124         *       @see                            PlayerErrorReason
 125         */
 126         virtual void OnPlayerErrorOccurred(Tizen::Media::PlayerErrorReason r) = 0;
 127
 128
 129         /**
 130          *      Called when the Player is being interrupted by a task of higher priority than the %Player.
 131          *
 132          * @since               2.0
 133          */
 134         virtual void OnPlayerInterrupted(void) = 0;
 135
 136         /**
 137          *      Called when the interrupting Player has been released.
 138          *
 139          * @since               2.0
 140          */
 141         virtual void OnPlayerReleased(void) = 0;
 142         /**
 143         *       Called when an audio playback focus is changed to another application.
 144         *
 145         *       @since          2.0
 146         *       @remarks
 147         *                               - After the audio focus is being changed, the playback is paused or stopped and the state of this instance is changed to ::PLAYER_STATE_PAUSED or ::PLAYER_STATE_CLOSED.
 148         *                               - User interaction with the device is required for an application in @c PLAYER_STATE_PAUSED state to resume playing.
 149         *                               This is to avoid the occurrence of a race condition among applications that try to play without user interaction.
 150         *                               - An application can not play again even in the state of @c PLAYER_STATE_PAUSED due to the application which has a higher priority.
 151         */
 152         virtual void OnPlayerAudioFocusChanged(void) {}
 153 protected:
 154         //
 155         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 156         //
 157         // This method is reserved and may change its name at any time without prior notice.
 158         //
 159         // @since               2.0
 160         //
 161         virtual void IPlayerEventListener_Reserved1(void) {}
 162
 163         //
 164         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 165         //
 166         // This method is reserved and may change its name at any time without prior notice.
 167         //
 168         // @since               2.0
 169         //
 170         virtual void IPlayerEventListener_Reserved2(void) {}
 171
 172 };
 173
 174 }}  // Tizen::Media
 175
 176 #endif