Tizen Native API  6.0
Classes | Public Types | Public Member Functions | Static Public Member Functions
Dali::Toolkit::VideoView Class Reference
Video View

VideoView is a control for video playback and display. More...

Inheritance diagram for Dali::Toolkit::VideoView:
Dali::Toolkit::Control Dali::CustomActor Dali::Actor Dali::Handle Dali::BaseHandle

Classes

struct  DisplayMode
 The values of this enum determine how the video should be display mode to the view. More...
struct  Property
 Enumeration for the instance of properties belonging to the VideoView class. More...

Public Types

enum  PropertyRange
 Enumeration for the start and end property ranges for this control. More...
typedef Signal< void(VideoView &) > VideoViewSignalType
 Video playback finished signal type @ SINCE_1_1.38.

Public Member Functions

 VideoView ()
 Creates an uninitialized VideoView.
 ~VideoView ()
 Destructor.
 VideoView (const VideoView &videoView)
 Copy constructor.
VideoView & operator= (const VideoView &videoView)
 Assignment operator.
void Play ()
 Starts the video playback.
void Pause ()
 Pauses the video playback.
void Stop ()
 Stops the video playback.
void Forward (int millisecond)
 Seeks forward by the specified number of milliseconds.
void Backward (int millisecond)
 Seeks backward by the specified number of milliseconds.
VideoViewSignalType & FinishedSignal ()
 Connects to this signal to be notified when a video playback is finished.

Static Public Member Functions

static VideoView New ()
 Creates an initialized VideoView.
static VideoView New (const std::string &url)
 Creates an initialized VideoView. If the string is empty, VideoView will not display anything.
static VideoView New (bool swCodec)
 Creates an initialized VideoView.
static VideoView New (const std::string &url, bool swCodec)
 Creates an initialized VideoView. If the string is empty, VideoView will not display anything.
static VideoView DownCast (BaseHandle handle)
 Downcasts a handle to VideoView handle.

Detailed Description

VideoView is a control for video playback and display.

For working VideoView, a video plugin for a platform should be provided.

Signals | Signal Name | Method | |---------------|-------------------------| | finished | FinishedSignal() |

Since:
3.0, DALi version 1.1.38

Actions | Action Name | Attributes | Description | |-----------------|----------------------------------------------------|---------------------------------------------------------| | videoPlay | Doesn't have attributes | Plays video. See DoAction() | | videoPause | Doesn't have attributes | Pauses video. See DoAction() | | videoStop | Doesn't have attributes | Stops video. See DoAction() | | videoForward | The position ( millisecond ) for forward playback | Sets forward position for playback. See DoAction() | | videoBackward | The position ( millisecond ) for backward playback | Sets backward position for playback. See DoAction()|

Since:
3.0, DALi version 1.1.38

Member Enumeration Documentation

enum Dali::Toolkit::VideoView::PropertyRange

Enumeration for the start and end property ranges for this control.

Since:
3.0, DALi version 1.0.0
Enumerator:
PROPERTY_START_INDEX 
Since:
3.0, DALi version 1.0.0

Reimplemented from Dali::Toolkit::Control.

Constructor & Destructor Documentation

Dali::Toolkit::VideoView::VideoView ( )

Creates an uninitialized VideoView.

Since:
3.0, DALi version 1.1.38
Dali::Toolkit::VideoView::~VideoView ( )

Destructor.

This is non-virtual since derived Handel types must not contain data or virtual methods.

Since:
3.0, DALi version 1.1.38
Dali::Toolkit::VideoView::VideoView ( const VideoView &  videoView)

Copy constructor.

Since:
3.0, DALi version 1.1.38
Parameters:
[in]videoViewVideoView to copy. The copied VideoView will point at the same implementation

Member Function Documentation

void Dali::Toolkit::VideoView::Backward ( int  millisecond)

Seeks backward by the specified number of milliseconds.

Since:
3.0, DALi version 1.1.38
Parameters:
[in]millisecondThe position for backward playback
static VideoView Dali::Toolkit::VideoView::DownCast ( BaseHandle  handle) [static]

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.

Since:
3.0, DALi version 1.1.38
Parameters:
[in]handleHandle to an object
Returns:
Handle to a VideoView or an uninitialized handle

Reimplemented from Dali::Toolkit::Control.

VideoViewSignalType& Dali::Toolkit::VideoView::FinishedSignal ( )

Connects to this signal to be notified when a video playback is finished.

Since:
3.0, DALi version 1.1.38
Returns:
A signal object to connect with
void Dali::Toolkit::VideoView::Forward ( int  millisecond)

Seeks forward by the specified number of milliseconds.

Since:
3.0, DALi version 1.1.38
Parameters:
[in]millisecondThe position for forward playback
static VideoView Dali::Toolkit::VideoView::New ( ) [static]

Creates an initialized VideoView.

Since:
3.0, DALi version 1.1.38
Returns:
A handle to a newly allocated Dali ImageView

Reimplemented from Dali::Toolkit::Control.

static VideoView Dali::Toolkit::VideoView::New ( const std::string &  url) [static]

Creates an initialized VideoView. If the string is empty, VideoView will not display anything.

Since:
3.0, DALi version 1.1.38
Remarks:
http://tizen.org/privilege/internet is needed if url is a http or https address.
http://tizen.org/privilege/mediastorage is needed if url is relevant to media storage.
http://tizen.org/privilege/externalstorage is needed if url is relevant to external storage.
Parameters:
[in]urlThe url of the video resource to display
Returns:
A handle to a newly allocated Dali VideoView
static VideoView Dali::Toolkit::VideoView::New ( bool  swCodec) [static]

Creates an initialized VideoView.

Since:
4.0, DALi version 1.3.9
Parameters:
[in]swCodecVideo rendering by H/W codec if false
Returns:
A handle to a newly allocated Dali ImageView
Note:
If platform or target does not support sw codec, video-view shows an error message and video by default codec type
static VideoView Dali::Toolkit::VideoView::New ( const std::string &  url,
bool  swCodec 
) [static]

Creates an initialized VideoView. If the string is empty, VideoView will not display anything.

Since:
4.0, DALi version 1.3.9
Remarks:
http://tizen.org/privilege/internet is needed if url is a http or https address.
http://tizen.org/privilege/mediastorage is needed if url is relevant to media storage.
http://tizen.org/privilege/externalstorage is needed if url is relevant to external storage.
Parameters:
[in]urlThe url of the video resource to display
[in]swCodecVideo rendering by H/W codec if false
Returns:
A handle to a newly allocated Dali VideoView
Note:
If platform or target does not support sw codec, video-view shows an error message and video by default codec type
VideoView& Dali::Toolkit::VideoView::operator= ( const VideoView &  videoView)

Assignment operator.

Since:
3.0, DALi version 1.1.38
Parameters:
[in]videoViewThe VideoView to assign from
Returns:
The updated VideoView
void Dali::Toolkit::VideoView::Pause ( )

Pauses the video playback.

Since:
3.0, DALi version 1.1.38
void Dali::Toolkit::VideoView::Play ( )

Starts the video playback.

Since:
3.0, DALi version 1.1.38
void Dali::Toolkit::VideoView::Stop ( )

Stops the video playback.

Since:
3.0, DALi version 1.1.38