Automated recording of NHK World's 24/7 live stream. This system records each show into an individual video file complete with metadata and formatted filenames. Supports filtering shows by title so it records only what you want to watch.
This is an unofficial fan work made for personal use only. This project is in no way affiliated with NHK, NHK World, Japan International Broadcasting, Inc. or any other entities therein.
This is a maintenance fork of nhkrecord/nhk-record, created after NHK updated some core API endpoints. Do not expect any new features and if the original maintainer returns to the upstream project someday, it will be recommended to go back to using their repo after my fixes are pulled.
So please, watch the relevant pull request for any updates.
If you are running an existing instance of nhk-record that has stopped working, please update the "streamURL" variable located in your config.json to the URL as follows:
"streamUrl": "https://b-nhkwlive-ojp.nhkworld.jp/hls/live/2003459-b/nhkwlive-ojp-en/index_4M.m3u8",
This software is only tested on Linux and macOS. For running on Windows, Docker for Windows may be the best option. See Running as a docker container.
git clone [email protected]:CoordSpace/nhk-record.git
cd nhk-record
npm install
npm start -- [options]
Options can be specified via the CLI or via a config file.
--help Show help [boolean]
--version Show version number [boolean]
-a, --assets-url NHK assets url (for JS & thumbnails)
[string] [default: "https://www3.nhk.or.jp"]
-b, --safety-buffer Number of extra milliseconds to record
before and after scheduled airtime
[number] [default: 40000]
-c, --config Location of config file [string]
-C, --crop Attempt to automatically detect and
crop out breaking news banners
(requires re-encoding) (this uses a lot
of CPU & memory)
[boolean] [default: true]
-d, --save-dir Directory in which to save recorded
programmes
[string] [default: "/recordings/"]
-f, --log-file Location of log file
[string] [default: "/logs/nhk-record.log"]
-i, --stream-url URL from which to record stream
[string] [default: "https://b-nhkwlive-ojp.webcdn.stream.ne.jp/hls/live/200345
9-b/nhkwlive-ojp-en/index_4M.m3u8"]
-j, --thread-limit Maximum threads to use for video
processing [number] [default: 0]
-k, --log-level-console Logging level to output to console
[string] [choices: "debug", "info", "error", "none", "silly"] [default:
"debug"]
-K, --keep-original, --keep-untrimmed If any post-processing options are
enabled, also keep the original copy
[boolean] [default: true]
-l, --log-level-file Logging level to output to log file
[string] [choices: "debug", "info", "error", "none", "silly"] [default:
"debug"]
-m, --match-pattern Glob pattern of desired program name
(can be used multiple times)
[array] [default: ["*"]]
-o, --time-offset Time offset relative to system time in
milliseconds (e.g. to handle stream
delays) [number] [default: 0]
-s, --schedule-url NHK schedule API url
[string] [default: "https://api.nhk.or.jp"]
-t, --minimum-duration Minimum programme run time to record in
milliseconds [number] [default: 240000]
-T, --trim Attempt to automatically trim video
[boolean] [default: true]
The location of the config file can be specified with the -c option.
{
"assetsUrl": "https://www3.nhk.or.jp",
"crop": true,
"keepOriginal": true,
"logFile": "/logs/nhk-record.log",
"logLevelConsole": "debug",
"logLevelFile": "debug",
"matchPattern": ["*"],
"minimumDuration": 240000,
"safetyBuffer": 40000,
"saveDir": "/recordings/",
"scheduleUrl": "https://nwapi.nhk.jp",
"streamUrl": "https://b-nhkwlive-ojp.nhkworld.jp/hls/live/2003459-b/nhkwlive-ojp-en/index_4M.m3u8",
"threadLimit": 0,
"timeOffset": 0,
"trim": true
}
Match patterns use micromatch. For example:
| Description | Pattern |
|---|---|
| Match everything | ["*"] |
| Japanology and Lunch ON! | ["*japanology*", "*lunch*"] |
| Everything except Newsline | ["!(*newsline*|*nl bridge*)"] |
These CPU-intensive features are enabled by default so be sure to disable them on resource-limited systems.
Additionally, the source materials they use for detection relies on the NHK World stream being in 1080p. Using a lower resolution stream URL will result in crashes upon detection if trim or crop is enabled.
If you desire to use a lower resolution or if NHK discontinues the 1080p stream, disable these features.
Docker images are available on Docker Hub
Example docker-compose.yml:
services:
nhk-record:
image: coordspace/nhk-record:latest
restart: unless-stopped
volumes:
- "/path/to/my/config.json:/config.json:ro"
- "/path/to/my/recordings/:/recordings/"
- "/var/log/nhk-record/:/logs/"
environment:
- UID=1000
- GID=1000