ZK Component Reference/Multimedia and Miscellaneous/Player

Player

• Java API: Player
• JavaScript API: Player

Employment/Purpose

An player 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 src="zk.mp4" controls="true" autoplay="true" loop="true" />

Supports HTML5

The player 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:

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

enableFullScreen

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

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

Properties

turnOffLight

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

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

Supported Events

Name	Event Type
None	None

• Inherited Supported Events: XulElement

Supported Children

*NONE

Use Cases

Version	Description	Example Location