MultimediaService.getSupportedFormats (Method)

Returns the supported file formats for this multimedia service, channel, or player.

Returns:

FileFormats_GetList_Result (query)

Each row of the returned query results has the following fields:

Field Name Type Description
Category FileFormatType The category of the file format i.e. Document, Image or Multimedia.
Extension PlainText_NonNull The file format's extension; for example, 'cfm'.
FormatDescription PlainText_NonNull The file format's description.
IconPath ServerRelativeURL_EmptyString A server-relative URL to an icon representing a page or document's type.
ID FileFormatID The file format's ID.
IsIndexable Boolean Boolean flag which when true indicates that the file format is fully text indexed.
MaxUploadSize NonNegativeInteger The maximum upload size in bytes. If this value is 0, no limit exists.
MimeType PlainText_NonNull The MIME type associated with this format.
SecurityID ID_0 The ID of the security record associated with this file format.

Arguments:

Name Type Required Description
serviceID MultimediaServiceID_0 Optional. Defaults to '0'. Id of the multimedia service or 0 for all.
templateID PlayerTemplateID_0 Optional. Defaults to '0'. ID of the multimedia player template or 0 for all.
channelID MultimediaChannelID_0 Optional. Defaults to '0'. ID of the multimedia channel or 0 for all.
playerID MultimediaPlayerID_0 Optional. Defaults to '0'. ID of the multimedia player or 0 for all.

Context:

License Requirements (none)
Permission Requirements ContributorOrServerCode
Deny Context (none)
Require Context (none)
Author Lock  

Error Codes:

None

Notes:

None