1 /** @page glossary_termino Glossary: Terminology
3 @section m_format Media format (string)
5 A string used to describe the available format. It is typically
6 generated from the available media quality properties, e.g. the container
7 (e.g. "WebM"), the encoding (e.g. "VP8") and the height (e.g. "720p").
9 In some cases, it may just be a simple string, e.g. "hd" or "sd", depending
10 on the website and the properties available to the @ref m_script.
12 Format strings are generated by the to_fmt_s function found in
13 the many of the @ref m_script files.
15 @sa @ref query_formats
17 @section ms_url Media stream URL
19 An URL to the media stream.
20 This URL should not be confused with @ref m_url.
24 @section m_url Media URL
26 An URL to the media, e.g. "http://youtube.com/watch?v=foo".
27 This URL should not be confused with @ref ms_url.
29 @note A @ref m_script accesses this value via "qargs.input_url"
31 @section proto_cat Protocol category
33 An umbrella of different protocol categories that the media scripts
34 belong to. The category is determined by the media stream URL returned
37 For example, YouTube media stream URLs are of HTTP, youtube.lua
38 therefore returns the protocol category value of
39 QUVI_MEDIA_SCRIPT_PROTOCOL_CATEGORY_HTTP.
41 @sa QUVI_OPTION_MEDIA_SCRIPT_PROTOCOL_CATEGORY
42 @sa QuviMediaScriptProtocolCategory
44 @section plist Playlist
46 A collection of @ref m_url s.
48 @section sh_url Shortened URL
50 An URL that has been "compressed", or "shortened", by a service such as
53 @section verification Verification of an URL
55 Until libquvi 1.0 this was a process that took place @ref ms_url immediately
56 after returning it from a @ref m_script . The purpose of this process was to
57 retrieve the content-length, the content-type and the file extension
58 (parsed from the content-type) values.
60 This step was removed in libquvi 1.0, but an additional function set was
61 added to the API that could be used if necessary.
63 The "verification" is a loose term here, and is being called as such
64 (in 1.0) for historical reasons.
66 @note Works with HTTP(S) URLs only