youtube-viewer |
youtube-viewer - YouTube from command line.
See: youtube-viewer --help youtube-viewer --tricks youtube-viewer --examples youtube-viewer --stdin-help
When set to 1
, auto-generated captions will be retrieved. By default, auto-generated captions are ignored.
The preferred quality for the audio-track:
best # best audio quality available (<=192kbps)
medium # medium audio quality (<=128kbps)
low # low audio quality (<=50kbps)
The option can also be set to a numeric value N in order to select an audio-track with <= Nkbps.
Enable autoplay mode, which will continuously play related videos.
Bypass age-restricted videos, using our internal method.
However, these streaming URLs are heavily throttled by YouTube.
When this option is disabled, a fallback method will be used instead (yt-dlp
/youtube-dl
or invidious instances).
Bypass age-restricted videos using an YouTube Account Proxy.
Cache directory where to save temporary files.
Use colors for text.
The sorting order for comments. Valid values: "time", "relevance".
Display a confirmation message after each video played.
Command to convert videos.
Default value:
"ffmpeg -i *IN* *OUT*"
*IN* gets replaced with the input file.
*OUT* gets replaced with the output file.
Format to convert each downloaded video into. (e.g.: "mp3"
).
Load cookies from a file. Useful to overcome the "429: Too Many Requests" issue.
The file must be a # Netscape HTTP Cookie File
. Same format as youtube-dl
requires.
See also:
https://github.com/ytdl-org/youtube-dl#how-do-i-pass-cookies-to-youtube-dl
When downloading a video, copy the closed-caption (if any) in the same folder with the video.
If merge_into_mkv
and merge_with_captions
are both enabled, there is no need to enable this option.
An array of hash values specifying a custom layout for video results.
align # "left" or "right"
color # any color supported by Term::ANSIColor
text # the actual text
width # width allocated for the text
The value for width
can be either a number of characters (e.g.: 20) or can be a percentage of the terminal width (e.g.: "15%").
The special tokens for text
are listed in:
youtube-viewer --tricks
For better formatting, it's highly recommended to install Unicode::GCString or Text::CharWidth.
An array of hash values specifying a custom layout for channel results.
An array of hash values specifying a custom layout for playlist results.
Include or exclude streams in "Dynamic Adaptive Streaming over HTTP" (DASH) format.
Enable debug/verbose mode, which will print some extra information.
Valid values: 0, 1, 2, 3.
Play downloaded videos.
Download videos with wget
.
Download videos with `yt-dlp` or `youtube-dl`.
By enabling this option and setting the value of ytdl_cmd
to "yt-dlp"
, download speed will be greatly improved.
Directory where to download files and where to save converted files.
Load proxy settings from *_proxy
environment variables (if any).
When downloading a video, make the filename compatible with the FAT32 filesystem.
Additionally, if Text::Unidecode is available, then Unicode characters are converted to ASCII equivalents.
Path to the ffmpeg
program.
Force the extraction of the streaming URLs to always use the fallback method (youtube-dl / invidious).
Play videos in fullscreen mode.
Download closed-captions for videos (if any).
Read the terminal width (`stty size`).
Prefer or ignore High Frame Rate (HFR) video streams.
Try to disable this option if the videos are lagging or dropping frames.
Highlight color used to highlight watched videos.
Any color supported by Term::ANSIColor can be used.
Highlight watched videos.
Enable or disable support for input history.
Requires Term::ReadLine::Gnu.
File where to save the input history.
Maximum number of entries in the history file.
When the limit is reached, the first half of the history file will be deleted.
Set the value to -1
for no limit.
Language code for categories. Default: "en_US".
Set HTTP(S)/SOCKS proxy, using the format:
'proto://domain.tld:port/'
If authentication is required, use:
'proto://user:pass@domain.tld:port/'
For example, to use Tor, install LWP::Protocol::socks and set this value to:
"socks://127.0.0.1:9050"
Ignore videos in AV1 format.
An array of video projections to ignore.
For example, to prefer rectangular projections of 360° videos, use:
ignored_projections => ["mesh", "equirectangular"],
Interactive mode, prompting for user-input.
Keep the original video after conversion. When set to 0
, the original video will be deleted.
How many results to display per page.
During download, merge the audio+video files into an MKV container.
Requires ffmpeg
.
Arguments for ffmpeg
how to merge the files.
Include closed-captions inside the MKV container (if any).
Search order for videos.
Valid values:
date – Sorted in reverse chronological order.
rating – Sorted from highest to lowest rating.
relevance – By relevance to the search query. (default)
title – Sorted alphabetically by title.
videoCount – Sory by number of videos (for channels).
viewCount – Sorted from highest to lowest number of views.
Page number of results.
Prefer videos in AV1 format. (just for testing)
Prefer videos in MP4 (AVC) format.
Try to enable this option if the videos are lagging or dropping frames.
Prefer audio streams in M4A (AAC) format.
By default, the OPUS format for audio is preferred.
The publishedAfter
option indicates that the API response should only contain resources created at or after the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
The publishedBefore
option indicates that the API response should only contain resources created before or at the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
The regionCode
option instructs the API to return search results for videos that can be viewed in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. (default: "US")
When download_and_play
is enabled, remove the file after playing it.
Preferred resolution for videos.
Valid values: best, 2160p, 1440p, 1080p, 720p, 480p, 360p, 240p, 144p, audio.
The safeSearch
option indicates whether the search results should include restricted content as well as standard content.
Valid values: "strict", "moderate", "none".
Show extra info for videos when selected.
When downloading, skip if the file already exists locally.
Skip already watched/downloaded videos.
Enable or disable support for split videos. Split-videos are videos that do not include audio and video in the same file.
Disable this option if the videos are loading too slowly, as non-split videos are not throttled by YouTube. Although, the highest resolution of non-split videos is 360p.
List of SRT languages in the order of preference.
Sorting order for subscriptions.
Valid values:
alphabetical – Sort alphabetically.
relevance – Sort by relevance.
unread – Sort by order of activity.
How many recent videos to fetch from each channel in local subscription videos (-ls
).
Valid values are between 1 and 50.
Thousands separator character for numbers >= 1000.
HTTPS timeout value in seconds. The default value is 10 seconds.
Token that is used to identify the user agent on the network. The agent value is sent as the User-Agent
header in the requests.
The format of filename for downloaded files.
The available special tokens are listed in:
youtube-viewer --tricks
Filter out from results videos with less than video_min_seconds
seconds.
The selected video player defined the video_players
table.
A table of video players.
The keys for each player are:
arg # any arguments for the video player
audio # option specifying the *AUDIO* file
cmd # the main player command
fs # the fullscreen option
novideo # the no-video mode option
srt # option specifying the *SUB* file
The videoCaption
option indicates whether the API should filter video search results based on whether they have captions.
Valid values:
any – Do not filter results based on caption availability.
closedCaption – Only include videos that have captions.
none – Only include videos that do not have captions.
The videoDefinition
option lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos.
Valid values:
any – Return all videos, regardless of their resolution.
high – Only retrieve HD videos.
standard – Only retrieve videos in standard definition.
The videoDimension
option lets you restrict a search to only retrieve 2D or 3D videos.
Valid values:
2d – Restrict search results to exclude 3D videos.
3d – Restrict search results to only include 3D videos.
any – Include both 3D and non-3D videos in returned results.
The videoDuration
parameter filters video search results based on their duration.
Valid values: "any", "short", "long".
Valid values:
any – Do not filter video search results based on their duration.
long – Only include videos longer than 20 minutes.
medium – Only include videos that are between 4-20 minutes.
short – Only include videos that are less than 4 minutes long.
The videoLicense
option filters search results to only include videos with a particular license.
Valid values:
any – All videos, regardless of which license they have.
creativeCommon – Only return videos that have a "Creative Commons" license.
youtube – Only return videos that have the standard YouTube license.
The videoSyndicated
option lets you to restrict a search to only videos that can be played outside youtube.com.
Valid values:
any – Return all videos, syndicated or not.
true – Only retrieve syndicated videos.
Remember watched videos across multiple sessions.
The video IDs are saved in the filename specified by watch_history_file
.
This option is also required for --watched-videos
.
File where to save the video IDs of watched/downloaded videos when watch_history
is set to a true value.
Command for wget
when download_with_wget
is set to a true value.
Path to a list of YouTube channels, using the following format:
ChannelID NAME
The channels can be listed with the command-line option: -fc
.
Format for sprintf()
for constructing an YouTube video URL given the video ID.
Use youtube-dl
for videos with encrypted signatures.
When set to 0
, invidious instances will be used instead.
Command for yt-dlp
or youtube-dl
when ytdl
is set to a true value.
The configuration files are:
~/.config/youtube-viewer/youtube-viewer.conf
~/.config/youtube-viewer/gtk-youtube-viewer.conf
https://developers.google.com/youtube/v3/docs/
https://github.com/trizen/youtube-viewer
Copyright 2010-2024 Trizen.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See https://dev.perl.org/licenses/ for more information.
youtube-viewer |