getLibraryVirtualfoldersQuery

Requires authentication as user

Request
get /Library/VirtualFolders/Query
Parameters
Name In Type Default Notes
StartIndex query

Optional. The record index to start at. All items with a lower index will be dropped from the results.
Limit query

Optional. The maximum number of records to return
Responses
Status Code Type Description Samples
200 QueryResult_VirtualFolderInfo

Operation successful. Returning a QueryResult object.
400

Bad Request. Server cannot process request.
401

Unauthorized. Client needs to authenticate.
403

Forbidden. No permission for the reqested operation.
404

Resource not found or unavailable.
500

Server error.

Definitions

QueryResult_VirtualFolderInfo

QueryResult_VirtualFolderInfo
Name Type Notes
Items VirtualFolderInfo[]
TotalRecordCount integer (int32)

VirtualFolderInfo

Name Type Notes
Name string

The name.
Locations array

The locations.
CollectionType string

The type of the collection.
LibraryOptions LibraryOptions[]
ItemId string

The item identifier.
Id string

ItemId came first, so that is left for compatability purposes
Guid string
PrimaryImageItemId string

The primary image item identifier.
PrimaryImageTag string
RefreshProgress number (double)
RefreshStatus string

LibraryOptions

Name Type Notes
EnableArchiveMediaFiles boolean
EnablePhotos boolean
EnableRealtimeMonitor boolean
EnableMarkerDetection boolean
EnableMarkerDetectionDuringLibraryScan boolean
IntroDetectionFingerprintLength integer (int32)
EnableChapterImageExtraction boolean
ExtractChapterImagesDuringLibraryScan boolean
DownloadImagesInAdvance boolean
CacheImages boolean
PathInfos MediaPathInfo[]
IgnoreHiddenFiles boolean
IgnoreFileExtensions array
SaveLocalMetadata boolean
SaveMetadataHidden boolean
SaveLocalThumbnailSets boolean
ImportPlaylists boolean
EnableAutomaticSeriesGrouping boolean
ShareEmbeddedMusicAlbumImages boolean
EnableEmbeddedTitles boolean
EnableAudioResume boolean
AutoGenerateChapters boolean
AutoGenerateChapterIntervalMinutes integer (int32)
AutomaticRefreshIntervalDays integer (int32)
PlaceholderMetadataRefreshIntervalDays integer (int32)
PreferredMetadataLanguage string

The preferred metadata language.
PreferredImageLanguage string
ContentType string
MetadataCountryCode string

The metadata country code.
MetadataSavers array
DisabledLocalMetadataReaders array
LocalMetadataReaderOrder array
DisabledLyricsFetchers array
SaveLyricsWithMedia boolean
LyricsDownloadMaxAgeDays integer (int32)
LyricsFetcherOrder array
LyricsDownloadLanguages array
DisabledSubtitleFetchers array
SubtitleFetcherOrder array
SkipSubtitlesIfEmbeddedSubtitlesPresent boolean
SkipSubtitlesIfAudioTrackMatches boolean
SubtitleDownloadLanguages array
SubtitleDownloadMaxAgeDays integer (int32)
RequirePerfectSubtitleMatch boolean
SaveSubtitlesWithMedia boolean
ForcedSubtitlesOnly boolean
HearingImpairedSubtitlesOnly boolean
TypeOptions TypeOptions[]
CollapseSingleItemFolders boolean
EnableAdultMetadata boolean
ImportCollections boolean
EnableMultiVersionByFiles boolean
EnableMultiVersionByMetadata boolean
EnableMultiPartItems boolean
MinCollectionItems integer (int32)
MusicFolderStructure string
MinResumePct integer (int32)

The minimum percentage of an item that must be played in order for playstate to be updated.
MaxResumePct integer (int32)

The maximum percentage of an item that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched.
MinResumeDurationSeconds integer (int32)

The minimum duration that an item must have in order to be eligible for playstate updates..
ThumbnailImagesIntervalSeconds integer (int32)
SampleIgnoreSize integer (int32)

MediaPathInfo

Name Type Notes
Path string
NetworkPath string
Username string
Password string

TypeOptions

Name Type Notes
Type string
MetadataFetchers array
MetadataFetcherOrder array
ImageFetchers array
ImageFetcherOrder array
ImageOptions ImageOption[]

ImageOption

Name Type Notes
Type ImageType

Enum ImageType
Limit integer (int32)

The limit.
MinWidth integer (int32)

The minimum width.

ImageType

Enum Values
  • Primary
  • Art
  • Backdrop
  • Banner
  • Logo
  • Thumb
  • Disc
  • Box
  • Screenshot
  • Menu
  • Chapter
  • BoxRear
  • Thumbnail
  • LogoLight
  • LogoLightColor