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