Multimedia.getInfo (Method)
Returns a structure containing general (and considerable) information about a multimedia file.
Returns:
MultimediaFile_GetInfo_Result (struct)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
ChannelID | MultimediaChannelID | ID of multimedia channel. |
ChannelName | NonNullString_255 | Name of the multimedia channel. |
Extension | PlainText | The multimedia file's extension. |
extReferenceID | MultimediaReferenceID_EmptyString | Reference ID assigned by external multimedia service or CommonSpot reference ID stored at extenal service for a multimedia file or an empty string. |
FileName | Filename_EmptyString | The multimedia file name. |
IsExternal | Boolean | Boolean flag that tells if this object is associated with an external multimedia service. |
IsPublic | Boolean | Boolean flag which when true indicates that the multimedia file is public. |
Length | NonNegativeInteger | Playing length of the item. |
OrigHeight | NonNegativeInteger | The multimedia file's original height. |
OrigWidth | NonNegativeInteger | The multimedia file's original width. |
ServiceID | MultimediaServiceID | ID of multimedia service. |
ServiceName | NonNullString_255 | Name of the multimedia service. |
Size | NonNegativeInteger | The image's size. |
ThumbnailImage | Filename_EmptyString | Thumbnail image for this item. |
ThumbnailImageURL | ServerRelativeURL_EmptyString | The URL to the thumbnail image for this item. |
Version | PositiveInteger | The multimedia file's version number. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
multimediaID | MultimediaOrPdfID | Required | ID of the multimedia file or PDF. |
Context:
License Requirements | (none) |
Permission Requirements | ContributorOrServerCode |
Deny Context | (none) |
Require Context | (none) |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None