Multimedia (Component)

A multimedia element provides non-technical users with easy access to multimedia files local to CommonSpot, or uploaded to an external service like YouTube or Brightcove.

Methods marked below with [L] may be logged at the site level (if transaction logging is licensed and enabled by the administrator)

Customization is not supported for this component.

Methods:

changeOwner [L]	Changes a multimedia file's owner.
delete [L]	Deletes a multimedia file.
deleteInprogressOrInactiveMultimedia [L]	Deletes the multimedia files that are inactive due to interrupted upload or lost connection or cancelled upload.
getExternalObjects
getExternalObjectsCount	Returns count of objects that are eligible for import.
getInfo	Returns a structure containing general (and considerable) information about a multimedia file.
getInfoForUpload	Returns a struct containing values like token to upload a multimedia file to external service.
getOwnerID	Returns the owner's user or group ID of a multimedia object.
getReferringObjects	Returns zero or more structures, each containing information on elements that refer to this multimedia file. This method's arguments limit the amount of information CommonSpot returns.
getReferringObjectsCount	Returns the number of objects referring to this multimedia file. This number only includes the objects that are identified by this method's arguments.
getReferringPlaylists	Returns the details of referring Playlists for the given Multimedia File.
getSubsiteID	Returns the ID of the subsite in which the multimedia object resides.
getUploadStatus
getVersionList	Returns one or more structures, each containing information about an multimedia object's versions; for example, the multimedia file's description, file name, version time stamp, and so on.
importExternalObjects [L]	Imports selected multimedia objects from external multimedia service.
makeVersionCurrent [L]	Makes the specified version the multimedia object's active version.
move [L]	Moves the specified multimedia file from one subsite to another.
saveMetadata [L]	Saves Multimedia Gallery record, standard metadata and the external reference ID returned by the external multimedia service if the service is external service.