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        */
  88       VIDEO = PROPERTY_START_INDEX,
  89
  90      /**
  91        * @brief name "looping", looping status, true or false.
  92        * @SINCE_1_1.38
  93        */
  94       LOOPING,
  95
  96      /**
  97        * @brief name "muted", mute status, true or false.
  98        * @SINCE_1_1.38
  99        */
 100       MUTED,
 101
 102      /**
 103        * @brief name "volume", left and right volume scalar as float type, Property::Map with two values ( "left" and "right" ).
 104        * @SINCE_1_1.38
 105        */
 106       VOLUME,
 107
 108      /**
 109        * @brief name "underlay", Video rendering by underlay, true or false
 110        * This shows video composited underneath the window by the system. This means it may ignore rotation of the video-view
 111        * @SINCE_1_2.62
 112        */
 113       UNDERLAY
 114     };
 115   };
 116
 117 public:
 118
 119   /**
 120    * @brief Creates an initialized VideoView.
 121    * @SINCE_1_1.38
 122    * @return A handle to a newly allocated Dali ImageView
 123    *
 124    * @note VideoView will not display anything
 125    */
 126   static VideoView New();
 127
 128   /**
 129    * @brief Creates an initialized VideoView.
 130    * If the string is empty, VideoView will not display anything.
 131    *
 132    * @SINCE_1_1.38
 133    * @REMARK_INTERNET
 134    * @REMARK_STORAGE
 135    * @param[in] url The url of the video resource to display
 136    * @return A handle to a newly allocated Dali VideoView
 137    */
 138   static VideoView New( const std::string& url );
 139
 140   /**
 141    * @brief Creates an uninitialized VideoView.
 142    * @SINCE_1_1.38
 143    */
 144   VideoView();
 145
 146   /**
 147    * @brief Destructor.
 148    *
 149    * This is non-virtual since derived Handel types must not contain data or virtual methods.
 150    * @SINCE_1_1.38
 151    */
 152   ~VideoView();
 153
 154   /*
 155    * @brief Copy constructor.
 156    *
 157    * @SINCE_1_1.38
 158    * @param[in] videoView VideoView to copy. The copied VideoView will point at the same implementation
 159    */
 160   VideoView( const VideoView& videoView );
 161
 162   /**
 163    * @brief Assignment operator.
 164    *
 165    * @SINCE_1_1.38
 166    * @param[in] videoView The VideoView to assign from
 167    * @return The updated VideoView
 168    */
 169   VideoView& operator=( const VideoView& videoView );
 170
 171   /**
 172    * @brief Downcasts a handle to VideoView handle.
 173    *
 174    * If handle points to a VideoView, the downcast produces valid handle.
 175    * If not, the returned handle is left uninitialized.
 176    *
 177    * @SINCE_1_1.38
 178    * @param[in] handle Handle to an object
 179    * @return Handle to a VideoView or an uninitialized handle
 180    */
 181   static VideoView DownCast( BaseHandle handle );
 182
 183   /**
 184    * @brief Starts the video playback.
 185    * @SINCE_1_1.38
 186    */
 187   void Play();
 188
 189   /**
 190    * @brief Pauses the video playback.
 191    * @SINCE_1_1.38
 192    */
 193   void Pause();
 194
 195   /**
 196    * @brief Stops the video playback.
 197    * @SINCE_1_1.38
 198    */
 199   void Stop();
 200
 201   /**
 202    * @brief Seeks forward by the specified number of milliseconds.
 203    *
 204    * @SINCE_1_1.38
 205    * @param[in] millisecond The position for forward playback
 206    */
 207   void Forward( int millisecond );
 208
 209   /**
 210    * @brief Seeks backward by the specified number of milliseconds.
 211    *
 212    * @SINCE_1_1.38
 213    * @param[in] millisecond The position for backward playback
 214    */
 215   void Backward( int millisecond );
 216
 217   /**
 218    * @brief Connects to this signal to be notified when a video playback is finished.
 219    *
 220    * @SINCE_1_1.38
 221    * @return A signal object to connect with
 222    */
 223   VideoViewSignalType& FinishedSignal();
 224
 225 public: // Not intended for application developers
 226
 227   /// @cond internal
 228   /**
 229    * @brief Creates a handle using the Toolkit::Internal implementation.
 230    *
 231    * @SINCE_1_1.38
 232    * @param[in] implementation The VideoView implementation
 233    */
 234   DALI_INTERNAL VideoView( Internal::VideoView& implementation );
 235
 236   /**
 237    * @brief Allows the creation of this VideoView from an Internal::CustomActor pointer.
 238    *
 239    * @SINCE_1_1.38
 240    * @param[in] internal A pointer to the internal CustomActor
 241    */
 242   DALI_INTERNAL VideoView( Dali::Internal::CustomActor* internal );
 243   /// @endcond
 244
 245 };
 246
 247 /**
 248  * @}
 249  */
 250
 251 } // namespace Toolkit
 252
 253 } // namespace Dali
 254
 255 #endif // __DALI_TOOLKIT_VIDEO_VIEW_H__