Extension:TimedMediaHandler/API
Media
[edit]The videoinfo api is similar to the imageinfo api but returns information which is specific to audio/video media elements. Note that you cannot request BOTH imageinfo and videoinfo at the same time. This means that if you query lists of items, you will need to request only videos or only images if you need some of these details.
videoinfo | |
---|---|
This module cannot be used as a generator. | |
Prefix | vi |
Required rights | none |
Post only? | No |
Generated help | Current |
The following documentation is the output of Special: |
prop=videoinfo (vi)
- This module requires read rights.
- Source: TimedMediaHandler
- License: GPL-2.0-or-later
Extends imageinfo to include video source (derivatives) information
- viprop
Which file information to get:
- timestamp
- Adds timestamp for the uploaded version.
- user
- Adds the user who uploaded each file version. If the user has been revision deleted, a userhidden property will be returned.
- userid
- Add the ID of the user that uploaded each file version. If the user has been revision deleted, a userhidden property will be returned.
- comment
- Comment on the version. If the comment has been revision deleted, a commenthidden property will be returned.
- parsedcomment
- Parse the comment on the version. If the comment has been revision deleted, a commenthidden property will be returned.
- canonicaltitle
- Adds the canonical title of the file. If the file has been revision deleted, a filehidden property will be returned.
- url
- Gives URL to the file and the description page. If the file has been revision deleted, a filehidden property will be returned.
- size
- Adds the size of the file in bytes and the height, width and page count (if applicable).
- dimensions
- Alias for size.
- sha1
- Adds SHA-1 hash for the file. If the file has been revision deleted, a filehidden property will be returned.
- mime
- Adds MIME type of the file. If the file has been revision deleted, a filehidden property will be returned.
- thumbmime
- Adds MIME type of the image thumbnail (requires url and param viurlwidth). If the file has been revision deleted, a filehidden property will be returned.
- mediatype
- Adds the media type of the file. If the file has been revision deleted, a filehidden property will be returned.
- metadata
- Lists Exif metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
- commonmetadata
- Lists file format generic metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
- extmetadata
- Lists formatted metadata combined from multiple sources. Results are HTML formatted. If the file has been revision deleted, a filehidden property will be returned.
- archivename
- Adds the filename of the archive version for non-latest versions. If the file has been revision deleted, a filehidden property will be returned.
- bitdepth
- Adds the bit depth of the version. If the file has been revision deleted, a filehidden property will be returned.
- uploadwarning
- Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core.
- badfile
- Adds whether the file is on the MediaWiki:Bad image list
- derivatives
- Adds an array of the different format and quality versions of an audio or video file that are available.
- timedtext
- Adds an array of the subtitles, captions and descriptions of an audio or video file that are available.
- Values (separate with | or alternative): archivename, badfile, bitdepth, canonicaltitle, comment, commonmetadata, derivatives, dimensions, extmetadata, mediatype, metadata, mime, parsedcomment, sha1, size, thumbmime, timedtext, timestamp, uploadwarning, url, user, userid
- Default: timestamp|user
- vilimit
How many file revisions to return per file.
- Type: integer or max
- The value must be between 1 and 500.
- Default: 1
- vistart
Timestamp to start listing from.
- Type: timestamp (allowed formats)
- viend
Timestamp to stop listing at.
- Type: timestamp (allowed formats)
- viurlwidth
If viprop=url is set, a URL to an image scaled to this width will be returned.
For performance reasons if this option is used, no more than 50 scaled images will be returned.
- Type: integer
- Default: -1
- viurlheight
Similar to viurlwidth.
- Type: integer
- Default: -1
- vimetadataversion
Version of metadata to use. If latest is specified, use latest version. Defaults to 1 for backwards compatibility.
- Default: 1
- viextmetadatalanguage
What language to fetch extmetadata in. This affects both which translation to fetch, if multiple are available, as well as how things like numbers and various values are formatted.
- Default: en
- viextmetadatamultilang
If translations for extmetadata property are available, fetch all of them.
- Type: boolean (details)
- viextmetadatafilter
If specified and non-empty, only these keys will be returned for viprop=extmetadata.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- viurlparam
A handler specific parameter string. For example, PDFs might use page15-100px. viurlwidth must be used and be consistent with viurlparam.
- Default: (empty)
- vibadfilecontexttitle
If badfilecontexttitleprop=badfile is set, this is the page title used when evaluating the MediaWiki:Bad image list
- vicontinue
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
- vilocalonly
Look only for files in the local repository.
- Type: boolean (details)
Timed Text
[edit]timedtext | |
---|---|
This module cannot be used as a generator. | |
Prefix | |
Required rights | none |
Post only? | No |
Generated help | Current |
This API serves up subtitles and similar timed text tracks for media elements.
The following documentation is the output of Special: |
action=timedtext
- This module is internal or unstable, and you should not use it. Its operation may change without notice.
- This module requires read rights.
- Source: TimedMediaHandler
- License: GPL-2.0-or-later
Provides timed text content for usage by <track> elements
- title
The media file title for which to retrieve timed text
- pageid
The pageid of the media file for which to retrieve timed text
- Type: integer
- trackformat
The file format in which to return timed text
- This parameter is required.
- One of the following values: srt, vtt
- lang
The language of the timed text to retrieve
- Fetch an SRT subtitle file in German for the file Example.ogv
- api.php?action=timedtext&title=File:Example.ogv&lang=de&trackformat=vtt [open in sandbox]
Transcoding
[edit]transcodestatus | |
---|---|
This module cannot be used as a generator. | |
Prefix | |
Required rights | none |
Post only? | No |
Generated help | Current |
The following documentation is the output of Special: |
prop=transcodestatus
- This module requires read rights.
- Source: TimedMediaHandler
- License: GPL-2.0-or-later
Get transcode status for a given file page.
- Get transcode status for File:Clip.webm
- api.php?action=query&prop=transcodestatus&titles=File:Clip.webm [open in sandbox]
transcodereset | |
---|---|
This module cannot be used as a generator. | |
Prefix | |
Required rights | transcode-reset |
Post only? | Yes |
Generated help | Current |
The following documentation is the output of Special: |
action=transcodereset
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: TimedMediaHandler
- License: GPL-2.0-or-later
Users with the 'transcode-reset' right can reset and re-run a transcode job.
- title
The media file title.
- This parameter is required.
- transcodekey
The transcode key you wish to reset. Fetch from action=query&prop=transcodestatus.
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Reset all transcodes for File:Clip.webm
- api.php?action=transcodereset&title=File:Clip.webm&token=123ABC [open in sandbox]
- Reset the '360_560kbs.webm' transcode key for File:Clip.webm
- api.php?action=transcodereset&title=File:Clip.webm&transcodekey=360_560kbs.webm&token=123ABC [open in sandbox]