src/api/doxy/glossary_termino.dp

   1 /** @page glossary_termino Glossary: Terminology
   2
   3 @section media_sect Media
   4
   5 @subsection m_prop Media property
   6
   7 A property that belongs to a medium, e.g. title. These are parsed and
   8 returned by a @ref m_script.
   9
  10 @sa QuviMediaProperty
  11 @sa quvi_get
  12
  13 @subsection m_stream_id Media stream ID
  14
  15 A string value that is used to identify the @ref m_stream. They are
  16 generated for each available media stream. They may vary per website.
  17
  18 The @ref m_stream_id typically consists of:
  19 @li Media container (e.g. "WebM")
  20 @li Media quality (e.g. "hd720")
  21 @li Video encoding (e.g. "VP8")
  22 @li Video height (e.g. "720")
  23
  24 A typical ID could look like:
  25 @verbatim
  26 $quality_$container_$encoding_$height(p)
  27 @endverbatim
  28
  29 Whether they are used in the @ref m_stream_id depends on whether the
  30 website has made the data available, and whether the @ref m_script parses
  31 the properties and uses them.
  32
  33 Sometimes these IDs may as simple as "hd" or "sd", although as of
  34 libquvi(-scripts) 0.9 the media scripts are expected to use the
  35 "standardized representation of the stream ID" whenever possible.
  36
  37 Example: Dailymotion
  38 @verbatim
  39 hq_mp4_h264_480p
  40 @endverbatim
  41
  42 Example: YouTube
  43
  44 Similar, but uses the container value instead of the video
  45 encoding value. It also uses the 'itag' value, which is specific to
  46 YouTube.
  47 @verbatim
  48 hd720_webm_i45_720p
  49 @endverbatim
  50
  51 @sa @ref parse_media
  52
  53 @subsection ms_prop Media stream property
  54
  55 A @ref m_prop that is specific to a @ref m_stream. Like with
  56 @ref m_prop, these are parsed and returned by a @ref m_script.
  57
  58 @sa QuviMediaProperty
  59 @sa quvi_get
  60
  61 @subsection m_stream Media stream
  62
  63 A stream of media, e.g. multimedia. Some websites provide >1 media
  64 streams for the hosted content, in which case the @ref m_script will
  65 usually try to parse the URLs to these streams and return them to the
  66 library.
  67
  68 @sa quvi_media_stream_select
  69 @sa QuviMediaProperty
  70 @sa @ref m_stream_url
  71 @sa quvi_get
  72
  73 @subsection m_stream_best Media stream: Best quality
  74
  75 The best quality stream is determined and flagged as such by
  76 a @ref m_script when there are >1 streams available.
  77 How the best quality stream is determined depends on the website and
  78 the @ref m_script.
  79
  80 The library uses the keyword 'best' with @ref quvi_media_stream_select
  81 to identify this stream.
  82
  83 @sa @ref select_stream
  84
  85 @subsection m_stream_default Media stream: Default quality
  86
  87 This is whatever the @ref m_script returns as the first stream. This
  88 stream is returned always.
  89
  90 @subsection sub_data Subtitle data
  91
  92 The subtitle data format varies per website, e.g. YouTube uses
  93 a custom timed-text (TT) format for CCs and TTSes. Generally speaking,
  94 the applications may ignore this format as the API has been designed
  95 so that the library provides the data in the requested format.
  96
  97 @sa @ref subex_script
  98
  99 @subsection sub_lang Subtitle language
 100
 101 An available subtitle language. Each @ref sub_type consists of
 102 (available) languages.
 103
 104 @sa @ref sub_type
 105
 106 @subsection sub_lang_id Subtitle language ID
 107
 108 A string value that is used to identify the @ref sub_lang. They are
 109 generated for each available language.
 110
 111 @subsection sub_type Subtitle type
 112
 113 Either a closed-caption (CC) or a text-to-speech (TTS, sometimes
 114 referred to as "automatic captions"). Each subtitle consists of a
 115 varying number of available languages.
 116
 117 @sa @ref sub_lang
 118
 119 @subsection m_url Media URL
 120
 121 An Internet address to the media, e.g. "http://youtube.com/watch?v=foo".
 122 This URL should not be confused with @ref m_stream_url.
 123
 124 @note This value is accessible to the scripts as "qargs.input_url"
 125
 126 @subsection m_stream_url Media stream URL
 127
 128 An Internet address to the @ref m_stream.
 129 This URL should not be confused with @ref m_url.
 130
 131 @section plist Playlist
 132
 133 A collection of @ref m_url s.
 134
 135 @section script_property Script property
 136
 137 A property of a script, that may be of either
 138 a @ref m_script, a @ref pl_script, a @ref scan_script or
 139 an @ref u_script.
 140
 141 @sa QuviScriptProperty
 142
 143 @section sh_url Shortened URL
 144
 145 An URL that has been "compressed", or "shortened", by a service such as
 146 is.gd or bit.ly .
 147
 148 @section verification Verification of an URL
 149
 150 A step, previously until libquvi 0.9, was called a "media stream URL
 151 verification process", during which the library would send an HTTP HEAD
 152 request to the server to query the content-type and the content-length.
 153 This step would also try to guess the file extension to the media from
 154 the content-type. This step took place immediately after returning a
 155 @ref m_stream_url from a @ref m_script.
 156
 157 The verification process step was removed in libquvi 0.9, but an
 158 additional function set was added to allow to querying this
 159 meta-info if necessary.
 160
 161 @note Works with HTTP(S) URLs only
 162 @sa http_metainfo
 163 */