2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
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
9 // http://www.apache.org/licenses/LICENSE-2.0
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.
19 * @file FMediaIPlayerEventListener.h
20 * @brief This is the header file for the %IPlayerEventListener interface.
22 * This header file contains the declarations of the %IPlayerEventListener interface.
25 #ifndef _FMEDIA_IPLAYER_EVENT_LISTENER_H_
26 #define _FMEDIA_IPLAYER_EVENT_LISTENER_H_
28 #include <FBaseRtIEventListener.h>
29 #include <FMediaPlayerTypes.h>
31 namespace Tizen { namespace Media
35 * @interface IPlayerEventListener
36 * @brief This interface provides a listener for media playing events.
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.
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>.
48 class _OSP_EXPORT_ IPlayerEventListener
49 : virtual public Tizen::Base::Runtime::IEventListener
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.
58 virtual ~IPlayerEventListener(void) {}
61 * Called when an audio/video content is opened asynchronously.
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 * @see Player::OpenFile()
77 * @see Player::OpenUrl()
78 * @see Player::OpenBuffer()
80 virtual void OnPlayerOpened(result r) = 0;
83 * Called when the Player reaches the end of the clip.
87 virtual void OnPlayerEndOfClip(void) = 0;
90 * Called when the position of the audio/video content moves asynchronously.
94 * @param[in] r The cause of the error
95 * @exception E_SUCCESS The method is successful.
96 * @exception E_SYSTEM A system error has occurred.
97 * @see Player::SeekTo()
100 virtual void OnPlayerSeekCompleted(result r){};
104 * Called when the streaming data is being buffered.
108 * @param[in] percent The percentage of buffering is completed
109 * @see Player::OpenUrl()
111 virtual void OnPlayerBuffering(int percent) = 0;
114 * Called when an error has occurred while the Player is working.
118 * @param[in] r A player error reason of type ::PlayerErrorReason
119 * @remarks While playing streaming media, the player might throw an error like ::PLAYER_ERROR_CONNECTION_LOST,
120 * ::PLAYER_ERROR_STREAMING_TIMEOUT, ::PLAYER_ERROR_TRANSPORT, or ::PLAYER_ERROR_SERVER. @n
121 * If the content includes invalid data, ::PLAYER_ERROR_INVALID_DATA may occur.
122 * @see PlayerErrorReason
124 virtual void OnPlayerErrorOccurred(Tizen::Media::PlayerErrorReason r) = 0;
128 * Called when the Player is being interrupted by a task of higher priority than the %Player.
132 virtual void OnPlayerInterrupted(void) = 0;
135 * Called when the interrupting Player has been released.
139 virtual void OnPlayerReleased(void) = 0;
141 * Called when an audio playback focus is changed to another application.
144 * @remarks After the audio focus is being changed, the playback is paused or stopped and the state of this instance is changed to @c PLAYER_STATE_PAUSED or @c PLAYER_STATE_CLOSED.
145 * @remarks User interaction with the device is required for an application in @c PLAYER_STATE_PAUSED state to resume playing. This is to avoid the occurrence of a race condition among applications that try to play without user interaction.
146 * @remarks An application can not play again even in the state of PLAYER_STATE_PAUSED due to the application which has a higher priority.
148 virtual void OnPlayerAudioFocusChanged(void) {}
151 // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
153 // This method is reserved and may change its name at any time without prior notice.
157 virtual void IPlayerEventListener_Reserved1(void) {}
160 // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
162 // This method is reserved and may change its name at any time without prior notice.
166 virtual void IPlayerEventListener_Reserved2(void) {}