Class ecm.model.VideoItem
Extends
ecm.model.ContentItem.
Represents an item that contains (browser supported) Video or Audio
Defined in: <ecm\model\VideoItem.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
ecm.model.VideoItem(properties)
Encapsulates a video or audio item.
|
- Fields borrowed from class ecm.model.ContentItem:
- compoundDocumentType, contentSize, currentVersion, declaredAsRecord, hasHold, hasRoleBasedRedactions, isHierarchicalItemType, itemId, modifyPermissions, objectStore, originalId, permissions, resolveChoiceDisplayName, rootFolder, showCheckoutForReservation, vsId
- Fields borrowed from class ecm.model.Item:
- attributes, dataObject, deleted, entryTemplateId, locked, lockedUser, mimetype, parent, privileges, repository, resultSet
- Fields borrowed from class ecm.model._ModelObject:
- categorization, id, isRecurring, name, nameFilter, pane, status, type, userId
Method Summary
Method Attributes | Method Name and Description |
---|---|
Gets the content path to retrieve and stream a media file
|
|
Returns the default previewer to display a media item
|
|
isPlayable(item)
Returns true if this item is a multimedia document
|
|
onPlayerAnnotation(annotation, added, skipOnChange)
Fired when a player annotation is created/deleted on this item.
|
- Methods borrowed from class ecm.model.ContentItem:
- addNotelog, addRelated, addTags, addToFolder, checkIn, checkInDaejaContent, checkInLargeDocument, checkInRedaction, checkInUsingCORS, checkInUsingForm, clone, copyToFolder, deleteItemFromFolderContentCache, deleteShare, demoteVersion, getChildComponent, getContentClass, getContentUrl, getMarkingValues, getPageImageRequestParameters, getPageImageUrl, getPageVideoRequestParameters, getShareData, getSharedItemId, getSharedVersionNumber, getShareStatus, getSocialCount, getTagsPropertyName, getVersionNumber, hasContent, hasPrivilege, hasPrivilegeToDeleteShare, hasPrivilegeToDeleteShareCallback, isAttributeHidden, isAvailableForBoxCollaboration, isAvailableForSocialCollaboration, isBoxSharable, isChildComponentHidden, isCommentable, isDownloadCountable, isFolderContentsRetrieved, isNotelogable, isRecommendable, isSystemItem, isTaggable, isViewable, moveToFolder, onChange, onCollaborate, onCommentChanged, promoteVersion, refresh, removeFromFolder, retrieveAllItemsAndSubFolders, retrieveAllVersions, retrieveAttributes, retrieveBookmarks, retrieveBoxCollaborators, retrieveChildComponent, retrieveComments, retrieveContentElements, retrieveDownloadRecords, retrieveEntryTemplateFolderAssociations, retrieveFolderContents, retrieveFoldersFiledIn, retrieveNotelogs, retrievePermissions, retrieveProcessInformation, retrieveRecommendations, retrieveRelated, retrieveTags, retrieveTeamspace, retrieveThumbnail, retrieveVersion, saveAttributes, saveEntryTemplateFolderAssociations, share, unloadFolderContents, unloadRelated, update, updateNotelogs
- Methods borrowed from class ecm.model.Item:
- containsValue, getAttributeFormat, getAttributeType, getAttrLabel, getDisplayValue, getItemValue, getMimeClass, getModifyDate, getModifyUser, getPath, getStateClass, getUserInfo, getValue, getValues, hasAttribute, isAttributeReadOnly, isContentTiff, isDeclareRecordEntryTemplate, isDocumentEntryTemplate, isEntryTemplate, isFolder, isFolderEntryTemplate, isSystemProperty, setValue, setValues
- Methods borrowed from class ecm.model._ModelObject:
- destroy, getSortCriteria, own, toString
Constructor Detail
ecm.model.VideoItem(properties)
Encapsulates a video or audio item.
- Parameters:
- properties
- The properties of the item. The properties can be any of the public fields as defined below, plus those of the ecm.model.ContentItem, ecm.model.Item, and ecm.model._ModelObject.
Method Detail
getContentUrlPath()
Gets the content path to retrieve and stream a media file
getDefaultPreviewerId()
Returns the default previewer to display a media item
getPlayerType()
isPlayable(item)
Returns true if this item is a multimedia document
- Parameters:
- item
onPlayerAnnotation(annotation, added, skipOnChange)
Fired when a player annotation is created/deleted on this item.
- Parameters:
- annotation
- Instance of ecm.model.SocialItem.
- added
- A boolean value indicating whether a player annotation item was added (true) or edited (false)
- skipOnChange
- A boolean value to skip calling
onChange()
method.