Model for assets of type 'video.'
implements: hash, method
bundle: standard information structure (sismodel)
since 5.2.0
Model for assets of type 'video.'
Model for assets where type attribute value starts with 'video.'
Defined hash keys
alt ↦ String
since 5.2.0
get 'alt' value (only available if VideoModel generated from VideoBoxTagModel)
aspectRatio ↦ String
since 5.2.0
get aspect ratio
autoplay ↦ Boolean
since 5.2.0
get value autoplay (Use compatibility@videomodel-use-defaults-without-poster="false" to read value always from video tag)
hasLock.<String:hashKey> ↦ Boolean
since 5.2.0
Check if the value accessed by the hash-key 'hashKey' within this model is secured by an active lock by permission rights management
-
Example:
model.hasLock.elem - is elem in model guarded by an active permission lock?
article.hasLock.text - Returns if there is a permission lock for text configured in 'article' ? (In this example 'article' is of of type ArticleModel)
height ↦ Integer
since 5.2.0
get height in pixel
isLocked.<String:hashKey> ↦ Boolean
since 5.2.0
Check if the value accessed by the hash-key 'hashKey' within this model is is locked for current user by permission rights management
-
Example:
model.isLocked.elem -- is value for elem in model locked for current logged-in user?
article.isLocked.text -- Returns if the value for 'text' within 'article' is locked (not accessible) for current user. (In this example 'article' is of of type ArticleModel)
mimetype ↦ String
since 5.2.0
get mime-type of video
permissionGroups ↦ sequence<PermissionGroupAssetModel| PermissionGroupAssetFeatureModel>
since 5.2.0
get values of feature 'censhare:module.oc.permission.group' or 'censhare:module.oc.permission.group-ref'
persistentSrc ↦ String
since 5.2.0
get persistent src-URL
poster ↦ ImageModel
since 5.2.0
get the poster image (only available if VideoModel generated from VideoBoxTagModel or by KeyVisualModel)
preview ↦ Image
since 5.2.0
get video from 'preview' storage
previewImage ↦ Image
since 5.4.0
get as image model
src ↦ String
since 5.2.0
get src-URL
title ↦ String
since 5.2.0
get title (only available if VideoModel generated from VideoBoxTagModel)
videoAspectRatio ↦ String
since 5.4.0
Returns aspect ratio of video (Use compatibility@videomodel-use-defaults-without-poster="false" to read value always from video tag)
videoDuration ↦ long
since 2018.2.3
get values of storage attribute (seconds)
width ↦ Integer
since 5.2.0
get width in pixel
Permission Verbs used
video.alt
since 5.2.0 'video.alt' - guards requests to '→alt'
video.aspectRatio
since 5.2.0 'video.aspectRatio' - guards requests to '→aspectRatio'
video.autoplay
since 5.2.0 'video.autoplay' - guards requests to '→autoplay'
video.duration
since 2018.2.3 'video.permissionGroups' - guards requests to '→permissionGroups'
video.height
since 5.2.0 'video.height' - guards requests to '→height'
video.mimetype
since 5.2.0 'video.mimetype' - guards requests to '→mimetype'
video.permissionGroups
since 5.2.0 'video.permissionGroups' - guards requests to '→permissionGroups'
video.persistentSrc
since 5.2.0 'video.persistentSrc' - guards requests to '→persistentSrc'
video.poster
since 5.2.0 'video.poster' - guards requests to '→poster'
video.preview
since 5.2.0 'video.preview' - guards requests to '→preview'
video.previewImage
since 5.4.0 'video.previewImage' - guards requests to '→previewImage'
video.src
since 5.2.0 'video.src' - guards requests to '→src'
video.storageitem
since 5.2.0 'video.storageitem' - prefixes requests to storageitems used as video.storageitem.360p where 360p is the storageKey
video.title
since 5.2.0 'video.title' - guards requests to '→title'
video.videoAspectRatio
since 5.4.0 'video.videoAspectRatio' - guards requests to '→videoAspectRatio'
video.width
since 5.2.0 'video.width' - guards requests to '→width'
Methods
[used as method](String:storageKey) ↦ VideoModel
since 5.2.0
get a model representing given 'storageKey'