Formatting API
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / video-view / video-view-devel.h
1 #ifndef DALI_TOOLKIT_VIDEO_VIEW_DEVEL_H\r
2 #define DALI_TOOLKIT_VIDEO_VIEW_DEVEL_H\r
3 \r
4 /*\r
5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.\r
6  *\r
7  * Licensed under the Apache License, Version 2.0 (the "License");\r
8  * you may not use this file except in compliance with the License.\r
9  * You may obtain a copy of the License at\r
10  *\r
11  * http://www.apache.org/licenses/LICENSE-2.0\r
12  *\r
13  * Unless required by applicable law or agreed to in writing, software\r
14  * distributed under the License is distributed on an "AS IS" BASIS,\r
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
16  * See the License for the specific language governing permissions and\r
17  * limitations under the License.\r
18  *\r
19  */\r
20 \r
21 // EXTERNAL INCLUDES\r
22 #include <dali/devel-api/adaptor-framework/video-sync-mode.h>\r
23 \r
24 // INTERNAL INCLUDES\r
25 #include <dali-toolkit/public-api/controls/video-view/video-view.h>\r
26 #include <dali/public-api/animation/animation.h>\r
27 #include <dali/public-api/object/any.h>\r
28 \r
29 namespace Dali\r
30 {\r
31 namespace Toolkit\r
32 {\r
33 namespace DevelVideoView\r
34 {\r
35 /**\r
36  * @brief Returns the internal media player.\r
37  * @param[in] videoView The current VideoView\r
38  * @return The internal media player of current VideoView\r
39  */\r
40 DALI_TOOLKIT_API Any GetMediaPlayer(VideoView videoView);\r
41 \r
42 /**\r
43  * @brief Creates an initialized VideoView with synchronization mode.\r
44  *\r
45  * The syncMode is for synchronization between UI(transparent hole) and underlay video.\r
46  *\r
47  * @param[in] syncMode The synchronization mode between the UI (transparent hole) and VideoPlayer\r
48  * @return A handle to a newly allocated Dali VideoView\r
49  */\r
50 DALI_TOOLKIT_API VideoView New(VideoSyncMode syncMode);\r
51 \r
52 /**\r
53  * @brief Play the resize or move animation with synchronization between UI(transparent hole) and video player\r
54  *\r
55  * The resize and move animation's play() function is called.\r
56  * If the animation is played, UI and video player will work synchronization.\r
57  *\r
58  * @param[in] videoView The current VideoView\r
59  * @param[in] animation The animation for video view's resize or move.\r
60  */\r
61 DALI_TOOLKIT_API void PlayAnimation(VideoView videoView, Animation animation);\r
62 \r
63 } // namespace DevelVideoView\r
64 \r
65 } // namespace Toolkit\r
66 \r
67 } // namespace Dali\r
68 \r
69 #endif // DALI_TOOLKIT_VIDEO_VIEW_DEVEL_H\r