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