dali-toolkit/public-api/controls/video-view/video-view.h

   1 #ifndef __DALI_TOOLKIT_VIDEO_VIEW_H__
   2 #define __DALI_TOOLKIT_VIDEO_VIEW_H__
   3
   4 /*
   5  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Internal DALI_INTERNAL
  31 {
  32   class VideoView;
  33 } // namespace Internal
  34
  35 /**
  36  * @addtogroup dali_toolkit_controls_video_view
  37  * @{
  38  */
  39
  40 /**
  41  * @brief VideoView is a control for video playback and display.
  42  *
  43  * For working VideoView, a video plugin for a platform should be provided.
  44  *
  45  * Signals
  46  * | %Signal Name  | Method                  |
  47  * |---------------|-------------------------|
  48  * | finished      | @ref FinishedSignal()   |
  49  * @SINCE_1_1.38
  50  *
  51  * Actions
  52  * | %Action Name    | Attributes                                         | Description                                             |
  53  * |-----------------|----------------------------------------------------|---------------------------------------------------------|
  54  * | videoPlay       | Doesn't have attributes                            | Plays video. See @ref DoAction()                        |
  55  * | videoPause      | Doesn't have attributes                            | Pauses video. See @ref DoAction()                       |
  56  * | videoStop       | Doesn't have attributes                            | Stops video. See @ref DoAction()                        |
  57  * | videoForward    | The position ( millisecond ) for forward playback  | Sets forward position for playback. See @ref DoAction() |
  58  * | videoBackward   | The position ( millisecond ) for backward playback | Sets backward position for playback. See @ref DoAction()|
  59  * @SINCE_1_1.38
  60  *
  61  */
  62 class DALI_IMPORT_API VideoView: public Control
  63 {
  64 public:
  65
  66   // Signal
  67   typedef Signal< void (VideoView&) > VideoViewSignalType; ///< Video playback finished signal type @ SINCE_1_1.38
  68
  69 public:
  70
  71   /**
  72    * @brief Enumeration for the start and end property ranges for this control.
  73    * @SINCE_1_0.0
  74    */
  75   enum PropertyRange
  76   {
  77     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,  ///< @SINCE_1_0.0
  78   };
  79
  80   struct Property
  81   {
  82     enum
  83     {
  84       /**
  85        * @brief name "video", video file url as string type or Property::Map.
  86        * @SINCE_1_1.38
  87        * @REMARK_INTERNET
  88        * @REMARK_STORAGE
  89        */
  90       VIDEO = PROPERTY_START_INDEX,
  91
  92      /**
  93        * @brief name "looping", looping status, true or false.
  94        * @SINCE_1_1.38
  95        */
  96       LOOPING,
  97
  98      /**
  99        * @brief name "muted", mute status, true or false.
 100        * @SINCE_1_1.38
 101        */
 102       MUTED,
 103
 104      /**
 105        * @brief name "volume", left and right volume scalar as float type, Property::Map with two values ( "left" and "right" ).
 106        * @SINCE_1_1.38
 107        */
 108       VOLUME,
 109
 110      /**
 111        * @brief name "underlay", Video rendering by underlay, true or false
 112        * This shows video composited underneath the window by the system. This means it may ignore rotation of the video-view
 113        * If false, video-view shows decoded frame images sequentially.
 114        * If Platform or video plugin doesn't support decoded frame images, this should always be true.
 115        * @SINCE_1_2.62
 116        * @REMARK_RAWVIDEO
 117        */
 118       UNDERLAY
 119     };
 120   };
 121
 122 public:
 123
 124   /**
 125    * @brief Creates an initialized VideoView.
 126    * @SINCE_1_1.38
 127    * @return A handle to a newly allocated Dali ImageView
 128    *
 129    * @note VideoView will not display anything
 130    */
 131   static VideoView New();
 132
 133   /**
 134    * @brief Creates an initialized VideoView.
 135    * If the string is empty, VideoView will not display anything.
 136    *
 137    * @SINCE_1_1.38
 138    * @REMARK_INTERNET
 139    * @REMARK_STORAGE
 140    * @param[in] url The url of the video resource to display
 141    * @return A handle to a newly allocated Dali VideoView
 142    */
 143   static VideoView New( const std::string& url );
 144
 145   /**
 146    * @brief Creates an uninitialized VideoView.
 147    * @SINCE_1_1.38
 148    */
 149   VideoView();
 150
 151   /**
 152    * @brief Destructor.
 153    *
 154    * This is non-virtual since derived Handel types must not contain data or virtual methods.
 155    * @SINCE_1_1.38
 156    */
 157   ~VideoView();
 158
 159   /**
 160    * @brief Copy constructor.
 161    *
 162    * @SINCE_1_1.38
 163    * @param[in] videoView VideoView to copy. The copied VideoView will point at the same implementation
 164    */
 165   VideoView( const VideoView& videoView );
 166
 167   /**
 168    * @brief Assignment operator.
 169    *
 170    * @SINCE_1_1.38
 171    * @param[in] videoView The VideoView to assign from
 172    * @return The updated VideoView
 173    */
 174   VideoView& operator=( const VideoView& videoView );
 175
 176   /**
 177    * @brief Downcasts a handle to VideoView handle.
 178    *
 179    * If handle points to a VideoView, the downcast produces valid handle.
 180    * If not, the returned handle is left uninitialized.
 181    *
 182    * @SINCE_1_1.38
 183    * @param[in] handle Handle to an object
 184    * @return Handle to a VideoView or an uninitialized handle
 185    */
 186   static VideoView DownCast( BaseHandle handle );
 187
 188   /**
 189    * @brief Starts the video playback.
 190    * @SINCE_1_1.38
 191    */
 192   void Play();
 193
 194   /**
 195    * @brief Pauses the video playback.
 196    * @SINCE_1_1.38
 197    */
 198   void Pause();
 199
 200   /**
 201    * @brief Stops the video playback.
 202    * @SINCE_1_1.38
 203    */
 204   void Stop();
 205
 206   /**
 207    * @brief Seeks forward by the specified number of milliseconds.
 208    *
 209    * @SINCE_1_1.38
 210    * @param[in] millisecond The position for forward playback
 211    */
 212   void Forward( int millisecond );
 213
 214   /**
 215    * @brief Seeks backward by the specified number of milliseconds.
 216    *
 217    * @SINCE_1_1.38
 218    * @param[in] millisecond The position for backward playback
 219    */
 220   void Backward( int millisecond );
 221
 222   /**
 223    * @brief Connects to this signal to be notified when a video playback is finished.
 224    *
 225    * @SINCE_1_1.38
 226    * @return A signal object to connect with
 227    */
 228   VideoViewSignalType& FinishedSignal();
 229
 230 public: // Not intended for application developers
 231
 232   /// @cond internal
 233   /**
 234    * @brief Creates a handle using the Toolkit::Internal implementation.
 235    *
 236    * @SINCE_1_1.38
 237    * @param[in] implementation The VideoView implementation
 238    */
 239   DALI_INTERNAL VideoView( Internal::VideoView& implementation );
 240
 241   /**
 242    * @brief Allows the creation of this VideoView from an Internal::CustomActor pointer.
 243    *
 244    * @SINCE_1_1.38
 245    * @param[in] internal A pointer to the internal CustomActor
 246    */
 247   DALI_INTERNAL VideoView( Dali::Internal::CustomActor* internal );
 248   /// @endcond
 249
 250 };
 251
 252 /**
 253  * @}
 254  */
 255
 256 } // namespace Toolkit
 257
 258 } // namespace Dali
 259
 260 #endif // __DALI_TOOLKIT_VIDEO_VIEW_H__