zul.med

Class Audio

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zul.med.Audio

public class Audio
extends Widget

An audio clip.

An extension to XUL. Only works for browsers supporting HTML5 audio tag (since ZK 7.0.0).

Field Summary

Fields inherited from class zk.Widget

$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName

Fields inherited from class zk.Object

$class, $oid

Method Summary

Modifier and Type	Method and Description
String	getPreload() Returns whether and how the audio should be loaded.
String	getSrc() Returns the src.
boolean	isAutoplay() Returns whether to auto start playing the audio.
boolean	isControls() Returns whether to display the audio controls.
boolean	isLoop() Returns whether to play the audio repeatedly.
boolean	isMuted() Returns whether to mute the audio.
void	pause() Pauses the audio at the client.
void	play() Plays the audio at the client.
void	setAutoplay(boolean autoplay) Sets whether to auto start playing the audio.
void	setControls(boolean controls) Sets whether to display the audio controls.
void	setLoop(boolean loop) Sets whether to play the audio repeatedly.
void	setMuted(boolean muted) Sets whether to mute the audio.
void	setPreload(String preload) Sets whether and how the audio should be loaded.
void	setSrc(String src) Sets the src.
void	stop() Stops the audio at the client.

Methods inherited from class zul.Widget

afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class zk.Widget

$, $f, $f, $f, $init, $n, $n, $o, $s, $service, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindMissingAncestors, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doPaste_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getCssflex, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTabindex, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealElement, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onAfterSize, onChildAdded_, onChildRemoved_, onChildRenderDefer_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, rerenderLater_, rerenderNow_, scrollIntoView, sendAU_, set, set, setAction, setChildren, setCssflex, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTabindex, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallFireSizedLaterWhenAddChd_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, unbindDoubleTap_, unbindSwipe_, unbindTapHold_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setSrc

public void setSrc(String src)

Sets the src.

Parameters:

src -

getSrc

public String getSrc()

Returns the src.

Default: null.

Returns:

String

setAutoplay

public void setAutoplay(boolean autoplay)

Sets whether to auto start playing the audio.

Parameters:

autoplay -

isAutoplay

public boolean isAutoplay()

Returns whether to auto start playing the audio.

Default: false.

Returns:

boolean

setPreload

public void setPreload(String preload)

Sets whether and how the audio should be loaded. Refer to Preload Attribute Description for details.

Parameters:

preload -

Since:

7.0.0

getPreload

public String getPreload()

Returns whether and how the audio should be loaded.

Default: null.

Returns:

String

Since:

7.0.0

setControls

public void setControls(boolean controls)

Sets whether to display the audio controls.

Parameters:

controls -

Since:

7.0.0

isControls

public boolean isControls()

Returns whether to display the audio controls.

Default: false.

Returns:

boolean

Since:

7.0.0

setLoop

public void setLoop(boolean loop)

Sets whether to play the audio repeatedly.

Parameters:

loop -

isLoop

public boolean isLoop()

Returns whether to play the audio repeatedly.

Default: false.

Returns:

boolean

setMuted

public void setMuted(boolean muted)

Sets whether to mute the audio.

Parameters:

muted -

Since:

7.0.0

isMuted

public boolean isMuted()

Returns whether to mute the audio.

Default: false.

Returns:

boolean

Since:

7.0.0

play

public void play()

Plays the audio at the client.

stop

public void stop()

Stops the audio at the client.

pause

public void pause()

Pauses the audio at the client.