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