Blame src/api/doxy/glossary_scripts.dp

Packit 3ff1e7
/** @page glossary_scripts Glossary: Scripts
Packit 3ff1e7
Packit 3ff1e7
@section glossary_scripts Glossary: Scripts
Packit 3ff1e7
Packit 3ff1e7
@subsection c_script Common script
Packit 3ff1e7
Packit 3ff1e7
A libquvi script that may be imported from a @ref m_script or a
Packit 3ff1e7
@ref pl_script. The common scripts reside under the "common/"
Packit 3ff1e7
subdirectory in the script tree. These scripts contain the
Packit 3ff1e7
reusable Lua code that is being used by the other scripts.
Packit 3ff1e7
Packit 3ff1e7
@code
Packit 3ff1e7
local C = require 'quvi/const' -- would import 'quvi/const' (of "common") as C
Packit 3ff1e7
@endcode
Packit 3ff1e7
Packit 3ff1e7
@subsection m_script Media script
Packit 3ff1e7
Packit 3ff1e7
A libquvi script written for a website (media/*.lua) that is
Packit 3ff1e7
responsible for parsing the media properties.
Packit 3ff1e7
Packit 3ff1e7
@note
Packit 3ff1e7
  - Media scripts are expected to return >0 streams (qargs.stream[i].url)
Packit 3ff1e7
  - All other properties are optional
Packit 3ff1e7
Packit 3ff1e7
@sa @ref QuviMediaProperty
Packit 3ff1e7
Packit 3ff1e7
@subsection pl_script Playlist script
Packit 3ff1e7
Packit 3ff1e7
A libquvi script written for a website (playlist/*.lua) that is
Packit 3ff1e7
responsible for parsing the playlist properties.
Packit 3ff1e7
Packit 3ff1e7
@note
Packit 3ff1e7
  - None of the returned properties are mandatory
Packit 3ff1e7
  - Playlist scripts may not return any results
Packit 3ff1e7
Packit 3ff1e7
@sa @ref parse_playlist
Packit 3ff1e7
Packit 3ff1e7
@subsection scan_script Scan script
Packit 3ff1e7
Packit 3ff1e7
A libquvi script written for scanning URL contents for embedded media
Packit 3ff1e7
URLs.
Packit 3ff1e7
Packit 3ff1e7
@note
Packit 3ff1e7
  - None of the returned properties are mandatory
Packit 3ff1e7
  - Scan scripts may not return any results
Packit 3ff1e7
Packit 3ff1e7
@sa @ref scan_media
Packit 3ff1e7
Packit 3ff1e7
@subsection u_script Utility script
Packit 3ff1e7
Packit 3ff1e7
libquvi-scripts contain misc. utility scripts, some of which are used
Packit 3ff1e7
by the library directly (util/*.lua), some of which may be used
Packit 3ff1e7
from the media scripts (lua/common/quvi/*.lua) by importing them first.
Packit 3ff1e7
Packit 3ff1e7
@subsection sub_script Subtitle script
Packit 3ff1e7
Packit 3ff1e7
A libquvi script written to retrieve the available @ref sub_type and
Packit 3ff1e7
@ref sub_lang properties.
Packit 3ff1e7
Packit 3ff1e7
@subsection subex_script Subtitle export script
Packit 3ff1e7
Packit 3ff1e7
A libquvi script written to export the @ref sub_data into the
Packit 3ff1e7
requested format, e.g. SubRip.
Packit 3ff1e7
*/