Module: MediaWiktory::Wikipedia::Modules::Videoinfo

Defined in:
lib/mediawiktory/wikipedia/modules/videoinfo.rb

Overview

Extends imageinfo to include video source (derivatives) information

The "submodule" (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for Actions::Query and its submodules):

api.query             # returns Actions::Query
   .prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
   .limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL

All submodule's parameters are documented as its public methods, see below.

Instance Method Summary collapse

Instance Method Details

#badfilecontexttitle(value) ⇒ self

If badfilecontexttitleprop=badfile is set, this is the page title used when evaluating the MediaWiki:Bad image list

Parameters:

  • value (String)

Returns:

  • (self) 


122
123
124
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 122

def badfilecontexttitle(value)
  merge(vibadfilecontexttitle: value.to_s)
end

#continue(value) ⇒ self

When more results are available, use this to continue.

Parameters:

  • value (String)

Returns:

  • (self) 


130
131
132
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 130

def continue(value)
  merge(vicontinue: value.to_s)
end

#end(value) ⇒ self

Timestamp to stop listing at.

Parameters:

  • value (Time)

Returns:

  • (self) 


54
55
56
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 54

def end(value)
  merge(viend: value.iso8601)
end

#extmetadatafilter(*values) ⇒ self

If specified and non-empty, only these keys will be returned for viprop=extmetadata.

Parameters:

  • values (Array<String>)

Returns:

  • (self) 


101
102
103
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 101

def extmetadatafilter(*values)
  values.inject(self) { |res, val| res._extmetadatafilter(val) }
end

#extmetadatalanguage(value) ⇒ self

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.

Parameters:

  • value (String)

Returns:

  • (self) 


86
87
88
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 86

def extmetadatalanguage(value)
  merge(viextmetadatalanguage: value.to_s)
end

#extmetadatamultilang ⇒ self

If translations for extmetadata property are available, fetch all of them.

Returns:

  • (self) 


93
94
95
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 93

def extmetadatamultilang()
  merge(viextmetadatamultilang: 'true')
end

#limit(value) ⇒ self

How many file revisions to return per file.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


38
39
40
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 38

def limit(value)
  merge(vilimit: value.to_s)
end

#localonly(value) ⇒ self

Look only for files in the local repository.

Parameters:

  • value (String)

Returns:

  • (self) 


138
139
140
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 138

def localonly(value)
  merge(vilocalonly: value.to_s)
end

#metadataversion(value) ⇒ self

Version of metadata to use. If latest is specified, use latest version. Defaults to 1 for backwards compatibility.

Parameters:

  • value (String)

Returns:

  • (self) 


78
79
80
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 78

def metadataversion(value)
  merge(vimetadataversion: value.to_s)
end

#prop(*values) ⇒ self

Which file information to get:

Parameters:

  • values (Array<String>) —

    Allowed values: "timestamp" (Adds timestamp for the uploaded version), "user" (Adds the user who uploaded each file version), "userid" (Add the ID of the user that uploaded each file version), "comment" (Comment on the version), "parsedcomment" (Parse the comment on the version), "canonicaltitle" (Adds the canonical title of the file), "url" (Gives URL to the file and the description page), "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), "mime" (Adds MIME type of the file), "thumbmime" (Adds MIME type of the image thumbnail (requires url and param viurlwidth)), "mediatype" (Adds the media type of the file), "metadata" (Lists Exif metadata for the version of the file), "commonmetadata" (Lists file format generic metadata for the version of the file), "extmetadata" (Lists formatted metadata combined from multiple sources. Results are HTML formatted), "archivename" (Adds the filename of the archive version for non-latest versions), "bitdepth" (Adds the bit depth of the version), "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).

Returns:

  • (self) 


25
26
27
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 25

def prop(*values)
  values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end

#start(value) ⇒ self

Timestamp to start listing from.

Parameters:

  • value (Time)

Returns:

  • (self) 


46
47
48
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 46

def start(value)
  merge(vistart: value.iso8601)
end

#urlheight(value) ⇒ self

Similar to viurlwidth.

Parameters:

  • value (Integer)

Returns:

  • (self) 


70
71
72
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 70

def urlheight(value)
  merge(viurlheight: value.to_s)
end

#urlparam(value) ⇒ self

A handler specific parameter string. For example, PDFs might use page15-100px. viurlwidth must be used and be consistent with viurlparam.

Parameters:

  • value (String)

Returns:

  • (self) 


114
115
116
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 114

def urlparam(value)
  merge(viurlparam: value.to_s)
end

#urlwidth(value) ⇒ self

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.

Parameters:

  • value (Integer)

Returns:

  • (self) 


62
63
64
 
# File 'lib/mediawiktory/wikipedia/modules/videoinfo.rb', line 62

def urlwidth(value)
  merge(viurlwidth: value.to_s)
end