Videoplayer"

From Documentation
Line 49: Line 49:
 
When user invoke <tt>play,pause or stop</tt> method, the paused property will change accordingly, so user can access the status of videoplayer by invoking <tt>isPaused()</tt>.
 
When user invoke <tt>play,pause or stop</tt> method, the paused property will change accordingly, so user can access the status of videoplayer by invoking <tt>isPaused()</tt>.
  
User can also set paused to true or false, paused="false" is same as invoking <tt>play()</tt>, paused="true" is same as invoking <tt>pause()</tt>
+
User can also set paused to true or false, paused="false" is same as invoking <tt>play()</tt>, paused="true" is same as invoking <tt>pause()</tt>.
  
 
<source lang="xml" >
 
<source lang="xml" >
Line 56: Line 56:
  
 
== volume ==
 
== volume ==
The videoplayer component provides volume property to change the volume, the type of value is double, valid value is between 0.0 to 1.0
+
The videoplayer component provides volume property to change the volume, the type of value is double, valid value is between 0.0 to 1.0.
  
 
<source lang="xml" >
 
<source lang="xml" >

Revision as of 02:20, 16 April 2018

Videoplayer

Employment/Purpose

An videoplayer component is used to play the video at the browser. Like audio, you could use the src property to specify an URL of an video resource, or the setContent method to specify a dynamically generated video. Developers might be able to control the play of an video by the play, stop and pause methods.

Example

Player-Sample.png

 <videoplayer src="zk.mp4" controls="true" autoplay="true" loop="true" />

Supports HTML5

The videoplayer component support HTML 5, like <video>, it includes the properties like autoplay, controls, loop, muted and preload.

Multiple Sources

Most browsers do not support all the video formats,so we could specify multiple source files in different formats for different browsers. For examples:

 <videoplayer src="zk.mp4, zk.webm, zk.ogg" />

enableFullScreen

The videoplayer component provides a client-side method enableFullScreen() to use full screen mode.

 <videoplayer id="player" src="zk.mp4" />
 <button xmlns:w="client" w:onClick="zk.$('$player').enableFullScreen()" />

Properties

turnOffLight

The videoplayer component provides theater mode, If turnOffLight="true", the whole page will cover by translucent black except <videoplayer>.

Player-turnOffLight.png

 <videoplayer src="zk.mp4" turnOffLight="true" />

currentTime

The videoplayer provieds currentTime property to decide which part of video to play, the type of value is seconds.

 <videoplayer src="zk.mp4" currentTime="60" />

paused

When user invoke play,pause or stop method, the paused property will change accordingly, so user can access the status of videoplayer by invoking isPaused().

User can also set paused to true or false, paused="false" is same as invoking play(), paused="true" is same as invoking pause().

 <videoplayer src="zk.mp4" paused="true" />

volume

The videoplayer component provides volume property to change the volume, the type of value is double, valid value is between 0.0 to 1.0.

 <videoplayer src="zk.mp4" volume="0.5" />

Supported Events

Name
Event Type
None None

Supported Children

*NONE

Use Cases

Version Description Example Location