Request components
==================================
Once you know the core components of a request, everything will be easier to understand. They are **five**: *prefixes*, *commands*, *items*, *media elements*, and *brackets*. All of them are in the following example:

``!parallel Taxi Driver (1976) [You talking to me?] | The Wire S01E01 [20:20]``

Prefix
**********************
   
A prefix is the leading charachter of a request. It may vary among platforms.

Example's placement
   <**!**>parallel Taxi Driver (1976) [You talking to me?] | The Wire S01E01 [20:20]

Types
   * **Facebook**: ``!``
   * **Discord**: ``!``

Command
*********************

A command is the identifier of a request.

Example's placement
   !<**parallel**> Taxi Driver (1976) [You talking to me?] | The Wire S01E01 [20:20]

req
#######################

The ``req`` command can handle a **single** item.

Example
    *!req Princess Mononoke 1997 [1:52:44 --plus 500]*

   .. image:: _static/req.jpg
       :width: 400

parallel
#######################

The ``parallel`` command can handle up to **eight** items.


Example
    *!parallel Three Colors: Red 1994 [5:34] | In the Mood for Love 2000 [55:33]
    | The Shining 1980 [1:26:10] | Cries and Whispers 1972 [43:14] | Taxi Driver 1976
    [1:12 --plus 400] | Suspiria 1977 [42:46] | All About My Mother 1999 [8:40] |
    Perfect Blue 1997 [22:23] --dimensions 2x4 --aspect-quotient 1.6 --contrast -5*

   .. image:: _static/red.jpg
       :width: 400

swap
#######################

The ``swap`` command can handle up to **two** items: the first item is called ``source``; the second item is called ``destination``. It replaces the content of the ``destination`` with the content of the ``source``.

Example
    *!swap The Lighthouse 2019 [671-675 --remove-second][675 --remove-first] | Spider-Man 2 2004 [1149-1150] [1151 --plus 500 --x-crop-offset -50] [1:56:51 --plus 300 --x-crop-offset -50] [1154 --plus 500] [1154 --plus 200 --x-crop-offset -50] --dimensions 2x3 --color -100 --font helvetica --font-size 30 --y-offset 30 --stroke-width 5 --aspect-quotient 1.1 --border 3,3*

   .. image:: _static/swap.jpg
       :width: 400

palette
#######################

The ``palette`` command can handle a **single** item. It draws a palette of ten colors.

Example
    *!palette Princess Mononoke 1997 [1:52:44 --plus 500]*

   .. image:: _static/palette.jpg
       :width: 400

Item
*********************

An item is the part of a request that contains a **single** media element and certain amount of brackets. They are separated by *pipes* (``|``).

Example's placement
   !parallel <**Taxi Driver (1976) [You talking to me?]**> | <**The Wire S01E01 [20:20]**>


Media element
*********************

A media element is the source of quotes and timestamps.

Example's placement
   !parallel <**Taxi Driver (1976)**> [You talking to me?] | <**The Wire S01E01**> [20:20]

Movie
#######################
Represents a movie.

Supported content
   * quotes
   * timestamps

Search query
   * ``TITLE (YEAR)``

   .. note::
      Fuzzy (approximated) search is supported.

Episode
#######################
Represents an episode.

Supported content
   * quotes
   * timestamps


Search query
   * ``TV_SHOW SXXEXX``
   * ``TV_SHOW Season 1 Episode 1``

   .. note::
      Fuzzy (approximated) search is supported, but only for the TV Show title.

Music video
#######################
Represents a music video.

Supported content
   * timestamps

Search query
   * ``ARTIST - TITLE``

   .. note::
      Fuzzy (approximated) search is supported.

Album cover art
#######################
Represents an album cover art.

Supported content
   * timestamps (mocking)

   .. note::
      Mocking means that any timestamp can be requested, but the frame
      will always be the same.

Search query
   * ``ARTIST - ALBUM_TITLE !cover`` *(e.g. Kanye West - Yeezus !cover [0:0])*

    .. note::
        You can search for any release stored on
        `MusicBrainz <https://musicbrainz.org>`_

Artwork
#######################
Represents an artwork.

Supported content
   * timestamps (mocking)

   .. note::
      Mocking means that any timestamp can be requested, but the frame
      will always be the same.

Search query
   * ``MET_MUSEUM_ID !cover`` *(e.g. 123 !artwork [0:0])*

    .. note::
        You can request any artwork ID available on
        `MET Museum <https://www.metmuseum.org/art/collection>`_.

        The ID is extracted as follows:
        https://www.metmuseum.org/art/collection/search/726717?searchField=All
        where ``726717`` is the ID.


Bracket
*********************

A bracket is the identifier of content from a media element.

Example's placement
   !parallel Taxi Driver (1976) <**[You talking to me?]**> | The Wire S01E01 <**[20:20]**>

Types
   * **timestamp**: *e.g. 10:10*
   * **quote**: *e.g. You talking to me?*
   * **index**: *e.g 10-11*