Skip to content

Latest commit

 

History

History
212 lines (139 loc) · 4.46 KB

README.md

File metadata and controls

212 lines (139 loc) · 4.46 KB
Raw

Viurr

Download programmes from Viu

Prerequisites

Usage

Command Line Interface

Install globally

# npm
npm install -g viurr
# pnpm
pnpm install -g viurr

Inspect

# Inspect the details of an episode
viurr inspect episode <productId>
# Inspect details of a series
viurr inspect series <productId>
Option Description
--json Print the result in JSON format

Download

# Download files of an episode
viurr download episode <type> <productId>
# Download files of a series
viurr download series <type> <productId>

Options

type

cover | subtitle | video

Specify --help to see the available options of each type, for example:

$ viurr download episode video --help
viurr download episode video <productId>

Download video of an episode

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]
  --quality  Video quality
          [string] [choices: "1080p", "720p", "480p", "240p"] [default: "1080p"]

productId

The ID that can be found in the URL on viu.com, for example,

https://www.viu.com/ott/hk/zh-hk/vod/6979/男兒當入樽
                                     ----

The productId of this episode is 6979.

Examples

Cover image

$ viurr download episode cover 6979
Downloading cover image of 「男兒當入樽」 EP.1 【天才籃球員誕生】
Downloaded: /path/to/your/directory/男兒當入樽 EP.1 【天才籃球員誕生】.jpeg

Subtitle

$ viurr download episode subtitle 6979
Downloading subtitle of 「男兒當入樽」 EP.1 【天才籃球員誕生】 (Language: 繁體中文)
Downloaded: /path/to/your/directory/男兒當入樽 EP.1 【天才籃球員誕生】.chi.srt

Video

$ viurr download episode video 6979
Downloading video of 「男兒當入樽」 EP.1 【天才籃球員誕生】 (Quality: 1080p)

# encode in progress
Downloading video of 「男兒當入樽」 EP.1 【天才籃球員誕生】 (Quality: 1080p)
Encoding [872.93/fps] [1843.7 Kb/s] [23.5 MB] [00:01:46]

# after finished
Downloading video of 「男兒當入樽」 EP.1 【天才籃球員誕生】 (Quality: 1080p)
Downloaded: /path/to/your/directory/男兒當入樽 EP.1 【天才籃球員誕生】.mkv

This program uses FFmpeg to encode the HLS playlist file and output the video with the original codecs. (i.e. -c copy).

If you already have FFmpeg available in your PATH, then you are good to go, otherwise, you need to set the environment variable FFMPEG_PATH as the path to the executable FFmpeg.

Example:

FFMPEG_PATH=/path/to/ffmpeg viurr download episode video 6979

Note

  • download series is a shortcut to download episode to handle all available episodes in a series.
  • It is recommended to use inspect to see the available subtitles and video qualities before attempting to download the files.

Programmatic

Install as local module

# npm
npm install viurr --save
# pnpm
pnpm install viurr

Types

Learn more here

Inspect

import { inspect } from "viurr";

Inspect the details of an episode

inspect.episode(productId: string): Promise<IEpisode>

Inspect the details of a series

inspect.series(productId: string): Promise<ISeries>

Download

import { download } from "viurr";

Download the video in specific quality

download.video(productId: string, quality: QualityOption = '1080p'): Promise<[ISeries, IEpisode, string, IEncoder]>

Download the cover image

download.cover(productId: string): Promise<[ISeries, IEpisode, string]>

Download the subtitle in specific language in SRT format

download.subtitle(productId: string, languageId: LanguageFlag, temporary = false): Promise<[ISeries, IEpisode, string]>

TODO

  • Combine second subtitle
  • Interactive CLI
  • GUI

Build

pnpm build

Development

pnpm build:watch
pnpm cli

Test

Not available

License

MIT License

Disclaimer

This project is for technical testing and educational purposes only. The owner and contributors do not assume any legal responsibilities caused by the users. Users should be aware of and take the risks.