Ranking configuration settings
AudioRanks
Object containing the following properties:
| Property | Type |
|---|---|
aac | CustomRank |
atmos | CustomRank |
dolbyDigital | CustomRank |
dolbyDigitalPlus | CustomRank |
dtsLossy | CustomRank |
dtsLossless | CustomRank |
flac | CustomRank |
mono | CustomRank |
mp3 | CustomRank |
stereo | CustomRank |
surround | CustomRank |
truehd | CustomRank |
All properties are optional.
CustomRank
Object containing the following properties:
| Property | Type | Default |
|---|---|---|
fetch | boolean | true |
rank | number |
All properties are optional.
CustomRanksConfig
Object containing the following properties:
| Property | Type |
|---|---|
quality | QualityRanks |
rips | RipsRanks |
hdr | HdrRanks |
audio | AudioRanks |
extras | ExtrasRanks |
trash | TrashRanks |
All properties are optional.
ExtrasRanks
Object containing the following properties:
| Property | Type |
|---|---|
threeD | CustomRank |
converted | CustomRank |
documentary | CustomRank |
dubbed | CustomRank |
edition | CustomRank |
hardcoded | CustomRank |
network | CustomRank |
proper | CustomRank |
repack | CustomRank |
retail | CustomRank |
site | CustomRank |
subbed | CustomRank |
upscaled | CustomRank |
scene | CustomRank |
uncensored | CustomRank |
All properties are optional.
HdrRanks
Object containing the following properties:
| Property | Type |
|---|---|
bit10 | CustomRank |
dolbyVision | CustomRank |
hdr | CustomRank |
hdr10plus | CustomRank |
sdr | CustomRank |
All properties are optional.
LanguagesConfig
Object containing the following properties:
| Property | Type | Default |
|---|---|---|
required | Array<string> | [] |
allowed | Array<string> | [] |
exclude | Array<string> | [] |
preferred | Array<string> | [] |
All properties are optional.
OptionsConfig
Object containing the following properties:
| Property | Type | Default |
|---|---|---|
removeAllTrash | boolean | true |
removeRanksUnder | number | -10000 |
removeUnknownLanguages | boolean | false |
allowEnglishInLanguages | boolean | true |
removeAdultContent | boolean | true |
titleSimilarity | number (≥0, ≤1) | 0.85 |
All properties are optional.
QualityRanks
Object containing the following properties:
| Property | Type |
|---|---|
av1 | CustomRank |
avc | CustomRank |
bluray | CustomRank |
dvd | CustomRank |
hdtv | CustomRank |
hevc | CustomRank |
mpeg | CustomRank |
remux | CustomRank |
vhs | CustomRank |
web | CustomRank |
webdl | CustomRank |
webmux | CustomRank |
xvid | CustomRank |
All properties are optional.
RankingModel
Object containing the following properties:
| Property | Type | Default |
|---|---|---|
av1 | number | 0 |
avc | number | 0 |
bluray | number | 0 |
dvd | number | 0 |
hdtv | number | 0 |
hevc | number | 0 |
mpeg | number | 0 |
remux | number | 0 |
vhs | number | 0 |
web | number | 0 |
webdl | number | 0 |
webmux | number | 0 |
xvid | number | 0 |
bdrip | number | 0 |
brrip | number | 0 |
dvdrip | number | 0 |
hdrip | number | 0 |
ppvrip | number | 0 |
tvrip | number | 0 |
uhdrip | number | 0 |
vhsrip | number | 0 |
webdlrip | number | 0 |
webrip | number | 0 |
bit10 | number | 0 |
dolbyVision | number | 0 |
hdr | number | 0 |
hdr10plus | number | 0 |
sdr | number | 0 |
aac | number | 0 |
atmos | number | 0 |
dolbyDigital | number | 0 |
dolbyDigitalPlus | number | 0 |
dtsLossy | number | 0 |
dtsLossless | number | 0 |
flac | number | 0 |
mono | number | 0 |
mp3 | number | 0 |
stereo | number | 0 |
surround | number | 0 |
truehd | number | 0 |
threeD | number | 0 |
converted | number | 0 |
documentary | number | 0 |
commentary | number | 0 |
uncensored | number | 0 |
dubbed | number | 0 |
edition | number | 0 |
hardcoded | number | 0 |
network | number | 0 |
proper | number | 0 |
repack | number | 0 |
retail | number | 0 |
subbed | number | 0 |
upscaled | number | 0 |
scene | number | 0 |
cam | number | 0 |
cleanAudio | number | 0 |
r5 | number | 0 |
pdtv | number | 0 |
satrip | number | 0 |
screener | number | 0 |
site | number | 0 |
size | number | 0 |
telecine | number | 0 |
telesync | number | 0 |
All properties are optional.
ResolutionConfig
Object containing the following properties:
| Property | Type | Default |
|---|---|---|
r2160p | boolean | false |
r1080p | boolean | true |
r720p | boolean | true |
r480p | boolean | false |
r360p | boolean | false |
unknown | boolean | true |
All properties are optional.
RipsRanks
Object containing the following properties:
| Property | Type |
|---|---|
bdrip | CustomRank |
brrip | CustomRank |
dvdrip | CustomRank |
hdrip | CustomRank |
ppvrip | CustomRank |
satrip | CustomRank |
tvrip | CustomRank |
uhdrip | CustomRank |
vhsrip | CustomRank |
webdlrip | CustomRank |
webrip | CustomRank |
All properties are optional.
Settings
Object containing the following properties:
| Property | Type | Default |
|---|---|---|
require | Array<string> | [] |
exclude | Array<string> | [] |
preferred | Array<string> | [] |
resolutions | ResolutionConfig | |
options | OptionsConfig | |
languages | LanguagesConfig | |
customRanks | CustomRanksConfig |
All properties are optional.
Settings
Object containing the following properties:
| Property | Type | Default |
|---|---|---|
require | Array<string> | [] |
exclude | Array<string> | [] |
preferred | Array<string> | [] |
resolutions | ResolutionConfig | |
options | OptionsConfig | |
languages | LanguagesConfig | |
customRanks | CustomRanksConfig |
All properties are optional.
TrashRanks
Object containing the following properties:
| Property | Type |
|---|---|
cam | CustomRank |
cleanAudio | CustomRank |
pdtv | CustomRank |
r5 | CustomRank |
screener | CustomRank |
size | CustomRank |
telecine | CustomRank |
telesync | CustomRank |
All properties are optional.