MultimediaService.getInfo (Method)
Returns a structure describing the specified multimedia service.
Returns:
MultimediaService_GetInfo_Struct (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Description | PlainText_NonNull | A service's description. |
| ID | MultimediaServiceID | Unique ID of this multimedia service. |
| isActive | Boolean | A boolean flag which when set to true indicates that this service is active. |
| isFactory | Boolean | A boolean flag which when set to true indicates that this service is a service installed by CommonSpot. |
| MaximumSize | NonNegativeInteger | Maximum file size in megabytes. 0 for no limit. |
| Name | PlainText_NonNull_100 | Name that identifies this multimedia service. |
| PublicServiceURL | ValidURL_EmptyString | The public URL to the service (ie for brightcove https://my.brightcove.com/, for youtube http://www.youtube.com). |
| ServicesIconURL | ServerRelativeURL_EmptyString | The server relative URL to an icon that represents the multimedia service. |
| SupportedFormats | PlainText_255 | Comma delimited list of file formats supported by this multimedia service. |
| SupportsChannelLevelPlayers | Boolean | True if this service can create players that exist only in one individual channel. |
| SupportsDefaultPlayer | Boolean | True if this service can set a default player. Generally this means that all players can play the same set of media formats. |
| SupportsLocalHosting | Boolean | True if this service allows files to be hosted at CommonSpot server. |
| SupportsPlaylists | Boolean | True if this service allows playlists. |
| SupportsServiceLevelPlayers | Boolean | True if this service can create players at the service level, i.e., global across all channels. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| serviceID | MultimediaServiceID | Required | The unique ID of the multimedia service to retrieve information for. |
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