1 #ifndef __DALI_TOOLKIT_VIDEO_VIEW_H__
2 #define __DALI_TOOLKIT_VIDEO_VIEW_H__
5 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali-toolkit/public-api/controls/control.h>
30 namespace Internal DALI_INTERNAL
33 } // namespace Internal
36 * @addtogroup dali_toolkit_controls_video_view
41 * @brief VideoView is a control for video playback and display.
43 * For working VideoView, a video plugin for a platform should be provided.
46 * | %Signal Name | Method |
47 * |---------------|-------------------------|
48 * | finished | @ref FinishedSignal() |
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()|
62 class DALI_IMPORT_API VideoView: public Control
67 typedef Signal< void (VideoView&) > VideoViewSignalType; ///< Video playback finished signal type @ SINCE_1_1.38
72 * @brief Enumeration for the start and end property ranges for this control.
77 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
85 * @brief name "video", video file url as string type or Property::Map.
88 VIDEO = PROPERTY_START_INDEX,
91 * @brief name "looping", looping status, true or false.
97 * @brief name "muted", mute status, true or false.
103 * @brief name "volume", left and right volume scalar as float type, Property::Map with two values ( "left" and "right" ).
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
120 * @brief Creates an initialized VideoView.
122 * @return A handle to a newly allocated Dali ImageView
124 * @note VideoView will not display anything
126 static VideoView New();
129 * @brief Creates an initialized VideoView.
130 * If the string is empty, VideoView will not display anything.
135 * @param[in] url The url of the video resource to display
136 * @return A handle to a newly allocated Dali VideoView
138 static VideoView New( const std::string& url );
141 * @brief Creates an uninitialized VideoView.
149 * This is non-virtual since derived Handel types must not contain data or virtual methods.
155 * @brief Copy constructor.
158 * @param[in] videoView VideoView to copy. The copied VideoView will point at the same implementation
160 VideoView( const VideoView& videoView );
163 * @brief Assignment operator.
166 * @param[in] videoView The VideoView to assign from
167 * @return The updated VideoView
169 VideoView& operator=( const VideoView& videoView );
172 * @brief Downcasts a handle to VideoView handle.
174 * If handle points to a VideoView, the downcast produces valid handle.
175 * If not, the returned handle is left uninitialized.
178 * @param[in] handle Handle to an object
179 * @return Handle to a VideoView or an uninitialized handle
181 static VideoView DownCast( BaseHandle handle );
184 * @brief Starts the video playback.
190 * @brief Pauses the video playback.
196 * @brief Stops the video playback.
202 * @brief Seeks forward by the specified number of milliseconds.
205 * @param[in] millisecond The position for forward playback
207 void Forward( int millisecond );
210 * @brief Seeks backward by the specified number of milliseconds.
213 * @param[in] millisecond The position for backward playback
215 void Backward( int millisecond );
218 * @brief Connects to this signal to be notified when a video playback is finished.
221 * @return A signal object to connect with
223 VideoViewSignalType& FinishedSignal();
225 public: // Not intended for application developers
229 * @brief Creates a handle using the Toolkit::Internal implementation.
232 * @param[in] implementation The VideoView implementation
234 DALI_INTERNAL VideoView( Internal::VideoView& implementation );
237 * @brief Allows the creation of this VideoView from an Internal::CustomActor pointer.
240 * @param[in] internal A pointer to the internal CustomActor
242 DALI_INTERNAL VideoView( Dali::Internal::CustomActor* internal );
251 } // namespace Toolkit
255 #endif // __DALI_TOOLKIT_VIDEO_VIEW_H__