Added doxygen tag for UNDERLAY( false )

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / video-view / video-view.h

diff --git a/dali-toolkit/public-api/controls/video-view/video-view.h b/dali-toolkit/public-api/controls/video-view/video-view.h
index 71b9a45..f88a9b2 100644 (file)
--- a/dali-toolkit/public-api/controls/video-view/video-view.h
+++ b/dali-toolkit/public-api/controls/video-view/video-view.h
@@ -66,6 +66,12 @@ public:
   // Signal
   typedef Signal< void (VideoView&) > VideoViewSignalType; ///< Video playback finished signal type @ SINCE_1_1.38
 
+public:
+
+  /**
+   * @brief Enumeration for the start and end property ranges for this control.
+   * @SINCE_1_0.0
+   */
   enum PropertyRange
   {
     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,  ///< @SINCE_1_0.0
@@ -76,28 +82,38 @@ public:
     enum
     {
       /**
-       * @brief name "video", video file url as string type or Property::Map
+       * @brief name "video", video file url as string type or Property::Map.
        * @SINCE_1_1.38
        */
       VIDEO = PROPERTY_START_INDEX,
 
      /**
-       * @brief name "looping", looping status, true or false
+       * @brief name "looping", looping status, true or false.
        * @SINCE_1_1.38
        */
       LOOPING,
 
      /**
-       * @brief name "muted", mute status, true or false
+       * @brief name "muted", mute status, true or false.
        * @SINCE_1_1.38
        */
       MUTED,
 
      /**
-       * @brief name "volume", left and right volume scalar as float type, Property::Map with two values ( "left" and "right" )
+       * @brief name "volume", left and right volume scalar as float type, Property::Map with two values ( "left" and "right" ).
        * @SINCE_1_1.38
        */
-      VOLUME
+      VOLUME,
+
+     /**
+       * @brief name "underlay", Video rendering by underlay, true or false
+       * This shows video composited underneath the window by the system. This means it may ignore rotation of the video-view
+       * If false, video-view shows decoded frame images sequentially.
+       * If Platform or video plugin doesn't support decoded frame images, this should always be true.
+       * @SINCE_1_2.62
+       * @REMARK_RAWVIDEO
+       */
+      UNDERLAY
     };
   };
 
@@ -114,30 +130,32 @@ public:
 
   /**
    * @brief Creates an initialized VideoView.
-   * If the string is empty, VideoView will not display anything
+   * If the string is empty, VideoView will not display anything.
    *
    * @SINCE_1_1.38
+   * @REMARK_INTERNET
+   * @REMARK_STORAGE
    * @param[in] url The url of the video resource to display
    * @return A handle to a newly allocated Dali VideoView
    */
   static VideoView New( const std::string& url );
 
   /**
-   * @brief Create an uninitialized VideoView
+   * @brief Creates an uninitialized VideoView.
    * @SINCE_1_1.38
    */
   VideoView();
 
   /**
-   * @brief Destructor
+   * @brief Destructor.
    *
-   * This is non-virtual since derived Handel types must not contain data or virtual methods
+   * This is non-virtual since derived Handel types must not contain data or virtual methods.
    * @SINCE_1_1.38
    */
   ~VideoView();
 
   /*
-   * @brief Copy constructor
+   * @brief Copy constructor.
    *
    * @SINCE_1_1.38
    * @param[in] videoView VideoView to copy. The copied VideoView will point at the same implementation
@@ -148,20 +166,20 @@ public:
    * @brief Assignment operator.
    *
    * @SINCE_1_1.38
-   * @param[in] videoView The VideoView to assign from.
-   * @return The updated VideoView.
+   * @param[in] videoView The VideoView to assign from
+   * @return The updated VideoView
    */
   VideoView& operator=( const VideoView& videoView );
 
   /**
-   * @brief Downcast a handle to VideoView handle.
+   * @brief Downcasts a handle to VideoView handle.
    *
-   * If handle points to a VideoView the downcast produces valid
-   * handle. If not the returned handle is left uninitialized.
+   * If handle points to a VideoView, the downcast produces valid handle.
+   * If not, the returned handle is left uninitialized.
    *
    * @SINCE_1_1.38
    * @param[in] handle Handle to an object
-   * @return handle to a VideoView or an uninitialized handle
+   * @return Handle to a VideoView or an uninitialized handle
    */
   static VideoView DownCast( BaseHandle handle );
 
@@ -200,10 +218,10 @@ public:
   void Backward( int millisecond );
 
   /**
-   * @brief Connect to this signal to be notified when a video playback have finished.
+   * @brief Connects to this signal to be notified when a video playback is finished.
    *
    * @SINCE_1_1.38
-   * @return A signal object to connect with.
+   * @return A signal object to connect with
    */
   VideoViewSignalType& FinishedSignal();
 
@@ -214,7 +232,7 @@ public: // Not intended for application developers
    * @brief Creates a handle using the Toolkit::Internal implementation.
    *
    * @SINCE_1_1.38
-   * @param[in] implementation The VideoView implementation.
+   * @param[in] implementation The VideoView implementation
    */
   DALI_INTERNAL VideoView( Internal::VideoView& implementation );
 
@@ -222,7 +240,7 @@ public: // Not intended for application developers
    * @brief Allows the creation of this VideoView from an Internal::CustomActor pointer.
    *
    * @SINCE_1_1.38
-   * @param[in] internal A pointer to the internal CustomActor.
+   * @param[in] internal A pointer to the internal CustomActor
    */
   DALI_INTERNAL VideoView( Dali::Internal::CustomActor* internal );
   /// @endcond