MultimediaService.getList (Method)
Returns a query describing the registed multimedia services.
Returns:
MultimediaService_GetList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| ChannelCount | NonNegativeInteger | Number of channels associated with this multimedia service. |
| 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. |
| Name | PlainText_NonNull_100 | Name that identifies this multimedia service. |
| PlayerCount | NonNegativeInteger | Number of players associated with this multimedia service. |
| PlayerTemplateCount | NonNegativeInteger | Number of templates associated with 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. |
| SupportsServiceLevelPlayers | Boolean | Boolean flag indicating whether this service supports creating players at the service level, i.e., globally availably across all channels. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| serviceID | MultimediaServiceID_0 | Optional. Defaults to '0'. | A multimedia service's ID. If this value is 0, CommonSpot will return information for all multimedia services. |
| serviceTypeFilter | MultimediaServiceTypeFilter | Optional. Defaults to 'All'. | The multimedia service type to filter by, either 'Local', 'External', or 'All'. |
| playlistSupportingServicesOnly | Boolean | Optional. Defaults to '0'. | If true, only services that support playlists are returned. |
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