zkmax.med

Class Camera

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zkmax.med.Camera

public class Camera
extends Widget

A camera, use to record video and take snapshot, have a preview screen.

Only works for browsers supporting HTML5 video tag

Since:

8.6.0

Author:

charlesqiu

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
void	countRecordTime() Compare record time and record length limit, if record time equals record length limit, fire LengthLimitExceed event.
String	getConstraints() Returns the constraints in JSON format String, About allowed constraints setting, see https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamConstraints Default: null.
int	getLengthLimit() Get the maximum record length limit, unit is "seconds".
int	getMaxsize() Get the max size setting of upload video and snapshot, unit is "KB".
String	getRecordFormat() Get the record video format, e.g., video/webm, video/mp4, video/ogg.
String	getSnapshotFormat() Get the snapshot image format, e.g., image/png, image/jpeg.
boolean	isAudio() Return whether to record sound while recording video.
void	isMaxsizeExceed() Compare record size and max size limit, if record size bigger than max size limit, fire MaxsizeExceed event.
boolean	isPreviewRecord() Return whether the preview screen is on.
boolean	isRecording() Return whether camera is recording.
void	pause() Pause recording.
void	requestCamera() Ask user for permissions to get media stream from camera and microphone, after permission is granted, init the video stream and preview screen according to the previewRecord attribute.
void	resume() Resume recording.
void	setAudio(boolean audio) Set whether to record sound while recording video.
void	setConstraints(String constraints) Sets the constraints in JSON format String, if not specify constraints, it will use {audio: this.isAudio(), video: true}.
void	setLengthLimit(int lengthLimit) Set the maximum record length limit, unit is "seconds".
void	setMaxsize(int maxsize) Set the max size of upload video and snapshot, unit is "KB".
void	setPreviewRecord(boolean previewRecord) Set whether the preview screen is on.
void	setRecordFormat(String recordFormat) Set the record video format, e.g., video/webm, video/mp4, video/ogg.
void	setRecording(boolean recording) setRecording(true) means start or resume recording.
void	setSnapshotFormat(String snapshotFormat) Set the snapshot image format, e.g., image/png, image/jpeg.
void	snapshot() Take a snapshot.
void	start() Start recording.
void	stop() Stop recording.
void	stopStreaming() Stop getting media stream from user's camera and microphone.
void	upload() Upload a blob data and fire an event according to eventName.

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

setPreviewRecord

public void setPreviewRecord(boolean previewRecord)

Set whether the preview screen is on. If you want to take a snapshot, must turn on preview screen, or nothing will happen.

Parameters:

previewRecord -

isPreviewRecord

public boolean isPreviewRecord()

Return whether the preview screen is on. If you want to take a snapshot, must turn on preview screen, or nothing will happen.

Default: true

Returns:

boolean

setMaxsize

public void setMaxsize(int maxsize)

Set the max size of upload video and snapshot, unit is "KB". Notice: Both video and snapshot files must smaller than max size, otherwise will trigger MaxsizeExceed event and nothing will upload.

Parameters:

maxsize -

getMaxsize

public int getMaxsize()

Get the max size setting of upload video and snapshot, unit is "KB".

Returns:

int

setAudio

public void setAudio(boolean audio)

Set whether to record sound while recording video.

Parameters:

audio -

isAudio

public boolean isAudio()

Return whether to record sound while recording video.

Default: true

Returns:

boolean

setLengthLimit

public void setLengthLimit(int lengthLimit)

Set the maximum record length limit, unit is "seconds". If recording time exceed length limit, recording will stop immediately and trigger LengthLimitExceed event.

Parameters:

lengthLimit -

getLengthLimit

public int getLengthLimit()

Get the maximum record length limit, unit is "seconds". If recording time exceed length limit, recording will stop immediately and trigger LengthLimitExceed event.

Default: 60

Returns:

int

setSnapshotFormat

public void setSnapshotFormat(String snapshotFormat)

Set the snapshot image format, e.g., image/png, image/jpeg. If the requested type is invalid or unspecified, it will use image/png.

Parameters:

snapshotFormat -

getSnapshotFormat

public String getSnapshotFormat()

Get the snapshot image format, e.g., image/png, image/jpeg. If the requested type is invalid or unspecified, it will use image/png.

Default: null.

Returns:

String

setRecordFormat

public void setRecordFormat(String recordFormat)

Set the record video format, e.g., video/webm, video/mp4, video/ogg. If the requested type is invalid or unspecified, it will use video/webm.

Parameters:

recordFormat -

getRecordFormat

public String getRecordFormat()

Get the record video format, e.g., video/webm, video/mp4, video/ogg. If the requested type is invalid or unspecified, it will use video/webm.

Default: null.

Returns:

String

setRecording

public void setRecording(boolean recording)

setRecording(true) means start or resume recording. setRecording(false) means stop recording. If you want to pause recording, please invoke pause().

Parameters:

recording -

isRecording

public boolean isRecording()

Return whether camera is recording.

Returns:

boolean

setConstraints

public void setConstraints(String constraints)

Sets the constraints in JSON format String, if not specify constraints, it will use {audio: this.isAudio(), video: true}. About allowed constraints setting, see https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamConstraints

Parameters:

constraints - constraints in JSON format String

getConstraints

public String getConstraints()

Returns the constraints in JSON format String, About allowed constraints setting, see https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamConstraints Default: null.

Returns:

String constraints in JSON format String

start

public void start()

Start recording.

requestCamera

public void requestCamera()

Ask user for permissions to get media stream from camera and microphone, after permission is granted, init the video stream and preview screen according to the previewRecord attribute.

stopStreaming

public void stopStreaming()

Stop getting media stream from user's camera and microphone.

stop

public void stop()

Stop recording.

pause

public void pause()

Pause recording.

resume

public void resume()

Resume recording.

countRecordTime

public void countRecordTime()

Compare record time and record length limit, if record time equals record length limit, fire LengthLimitExceed event.

snapshot

public void snapshot()

Take a snapshot.

isMaxsizeExceed

public void isMaxsizeExceed()

Compare record size and max size limit, if record size bigger than max size limit, fire MaxsizeExceed event.

upload

public void upload()

Upload a blob data and fire an event according to eventName.