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        * @brief The play position (millisecond) of the video.
 122        * @details Name "playPosition", type Property::INTEGER
 123        * @SINCE_1_3_9
 124        */
 125       PLAY_POSITION
 126     };
 127   };
 128
 129 public:
 130
 131   /**
 132    * @brief Creates an initialized VideoView.
 133    * @SINCE_1_1.38
 134    * @return A handle to a newly allocated Dali ImageView
 135    *
 136    */
 137   static VideoView New();
 138
 139   /**
 140    * @brief Creates an initialized VideoView.
 141    * If the string is empty, VideoView will not display anything.
 142    *
 143    * @SINCE_1_1.38
 144    * @REMARK_INTERNET
 145    * @REMARK_STORAGE
 146    * @param[in] url The url of the video resource to display
 147    * @return A handle to a newly allocated Dali VideoView
 148    */
 149   static VideoView New( const std::string& url );
 150
 151   /**
 152    * @brief Creates an initialized VideoView.
 153    * @SINCE_1_3_9
 154    * @param[in] swCodec Video rendering by H/W codec if false
 155    * @return A handle to a newly allocated Dali ImageView
 156    *
 157    * @note If platform or target does not support sw codec, video-view shows an error message and video by default codec type
 158    */
 159   static VideoView New( bool swCodec );
 160
 161   /**
 162    * @brief Creates an initialized VideoView.
 163    * If the string is empty, VideoView will not display anything.
 164    *
 165    * @SINCE_1_3_9
 166    * @REMARK_INTERNET
 167    * @REMARK_STORAGE
 168    * @param[in] url The url of the video resource to display
 169    * @param[in] swCodec Video rendering by H/W codec if false
 170    * @return A handle to a newly allocated Dali VideoView
 171    *
 172    * @note If platform or target does not support sw codec, video-view shows an error message and video by default codec type
 173    */
 174   static VideoView New( const std::string& url, bool swCodec );
 175
 176   /**
 177    * @brief Creates an uninitialized VideoView.
 178    * @SINCE_1_1.38
 179    */
 180   VideoView();
 181
 182   /**
 183    * @brief Destructor.
 184    *
 185    * This is non-virtual since derived Handel types must not contain data or virtual methods.
 186    * @SINCE_1_1.38
 187    */
 188   ~VideoView();
 189
 190   /**
 191    * @brief Copy constructor.
 192    *
 193    * @SINCE_1_1.38
 194    * @param[in] videoView VideoView to copy. The copied VideoView will point at the same implementation
 195    */
 196   VideoView( const VideoView& videoView );
 197
 198   /**
 199    * @brief Assignment operator.
 200    *
 201    * @SINCE_1_1.38
 202    * @param[in] videoView The VideoView to assign from
 203    * @return The updated VideoView
 204    */
 205   VideoView& operator=( const VideoView& videoView );
 206
 207   /**
 208    * @brief Downcasts a handle to VideoView handle.
 209    *
 210    * If handle points to a VideoView, the downcast produces valid handle.
 211    * If not, the returned handle is left uninitialized.
 212    *
 213    * @SINCE_1_1.38
 214    * @param[in] handle Handle to an object
 215    * @return Handle to a VideoView or an uninitialized handle
 216    */
 217   static VideoView DownCast( BaseHandle handle );
 218
 219   /**
 220    * @brief Starts the video playback.
 221    * @SINCE_1_1.38
 222    */
 223   void Play();
 224
 225   /**
 226    * @brief Pauses the video playback.
 227    * @SINCE_1_1.38
 228    */
 229   void Pause();
 230
 231   /**
 232    * @brief Stops the video playback.
 233    * @SINCE_1_1.38
 234    */
 235   void Stop();
 236
 237   /**
 238    * @brief Seeks forward by the specified number of milliseconds.
 239    *
 240    * @SINCE_1_1.38
 241    * @param[in] millisecond The position for forward playback
 242    */
 243   void Forward( int millisecond );
 244
 245   /**
 246    * @brief Seeks backward by the specified number of milliseconds.
 247    *
 248    * @SINCE_1_1.38
 249    * @param[in] millisecond The position for backward playback
 250    */
 251   void Backward( int millisecond );
 252
 253   /**
 254    * @brief Connects to this signal to be notified when a video playback is finished.
 255    *
 256    * @SINCE_1_1.38
 257    * @return A signal object to connect with
 258    */
 259   VideoViewSignalType& FinishedSignal();
 260
 261 public: // Not intended for application developers
 262
 263   /// @cond internal
 264   /**
 265    * @brief Creates a handle using the Toolkit::Internal implementation.
 266    *
 267    * @SINCE_1_1.38
 268    * @param[in] implementation The VideoView implementation
 269    */
 270   DALI_INTERNAL VideoView( Internal::VideoView& implementation );
 271
 272   /**
 273    * @brief Allows the creation of this VideoView from an Internal::CustomActor pointer.
 274    *
 275    * @SINCE_1_1.38
 276    * @param[in] internal A pointer to the internal CustomActor
 277    */
 278   DALI_INTERNAL VideoView( Dali::Internal::CustomActor* internal );
 279   /// @endcond
 280
 281 };
 282
 283 /**
 284  * @}
 285  */
 286
 287 } // namespace Toolkit
 288
 289 } // namespace Dali
 290
 291 #endif // __DALI_TOOLKIT_VIDEO_VIEW_H__