{"note":"OpenAPI conversion -- returning structured metadata","name":"jellyfin-local","description":"Jellyfin API","version":"v1","base_url":"http://localhost","endpoints":408,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Jellyfin API\n@base http://localhost\n@version v1\n@auth ApiKey X-Emby-Authorization in header\n@endpoints 408\n@hint download_for_search\n@toc System(17), Auth(5), Artists(7), Audio(12), Branding(3), Channels(5), Collections(3), web(2), Devices(5), DisplayPreferences(2), Dlna(22), Videos(21), Environment(6), Items(50), Genres(6), MusicGenres(8), Persons(6), Studios(6), Users(44), Images(7), Albums(2), Playlists(6), Songs(1), Libraries(1), Library(16), Movies(2), Shows(5), Trailers(2), LiveTv(41), Localization(4), LiveStreams(2), Playback(1), Notifications(7), Packages(4), Repositories(2), Sessions(18), Plugins(10), QuickConnect(7), ScheduledTasks(5), Search(1), Startup(7), FallbackFont(2), Providers(1), SyncPlay(21), GetUtcTime(1), Years(2)\n\n@group System\n@endpoint GET /System/ActivityLog/Entries\n@desc Gets activity log entries.\n@optional {startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., minDate: str(date-time) # Optional. The minimum date. Format = ISO., hasUserId: bool # Optional. Filter log entries if it has user id, or not.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Activity log returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Auth\n@endpoint GET /Auth/Keys\n@desc Get all keys.\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Api keys retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Auth/Keys\n@desc Create a new api key.\n@required {app: str # Name of the app using the authentication key.}\n@returns(204) Api key created.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Auth/Keys/{key}\n@desc Remove an api key.\n@required {key: str # The access token to delete.}\n@returns(204) Api key deleted.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Artists\n@endpoint GET /Artists\n@desc Gets all artists from a given item, folder, or the entire library.\n@optional {minCommunityRating: num(double) # Optional filter by minimum community rating., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., searchTerm: str # Optional. Search term., parentId: str(uuid) # Specify this to localize the search to a specific item or folder. Omit to use the root., fields: [str] # Optional. Specify additional fields of information to return in the output., excludeItemTypes: [str] # Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited., includeItemTypes: [str] # Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited., filters: [str] # Optional. Specify additional filters to apply., isFavorite: bool # Optional filter by items that are marked as favorite, or not., mediaTypes: [str] # Optional filter by MediaType. Allows multiple, comma delimited., genres: [str] # Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited., genreIds: [str(uuid)] # Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited., officialRatings: [str] # Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited., tags: [str] # Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited., years: [int(int32)] # Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited., enableUserData: bool # Optional, include user data., imageTypeLimit: int(int32) # Optional, the max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., person: str # Optional. If specified, results will be filtered to include only those containing the specified person., personIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified person ids., personTypes: [str] # Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited., studios: [str] # Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited., studioIds: [str(uuid)] # Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited., userId: str(uuid) # User id., nameStartsWithOrGreater: str # Optional filter by items whose name is sorted equally or greater than a given input string., nameStartsWith: str # Optional filter by items whose name is sorted equally than a given input string., nameLessThan: str # Optional filter by items whose name is equally or lesser than a given input string., enableImages: bool=true # Optional, include image information in output., enableTotalRecordCount: bool=true # Total record count.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Artists returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Artists/{name}\n@desc Gets an artist by name.\n@required {name: str # Studio name.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data.}\n@returns(200) {Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}}} # Artist returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Artists/AlbumArtists\n@desc Gets all album artists from a given item, folder, or the entire library.\n@optional {minCommunityRating: num(double) # Optional filter by minimum community rating., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., searchTerm: str # Optional. Search term., parentId: str(uuid) # Specify this to localize the search to a specific item or folder. Omit to use the root., fields: [str] # Optional. Specify additional fields of information to return in the output., excludeItemTypes: [str] # Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited., includeItemTypes: [str] # Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited., filters: [str] # Optional. Specify additional filters to apply., isFavorite: bool # Optional filter by items that are marked as favorite, or not., mediaTypes: [str] # Optional filter by MediaType. Allows multiple, comma delimited., genres: [str] # Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited., genreIds: [str(uuid)] # Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited., officialRatings: [str] # Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited., tags: [str] # Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited., years: [int(int32)] # Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited., enableUserData: bool # Optional, include user data., imageTypeLimit: int(int32) # Optional, the max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., person: str # Optional. If specified, results will be filtered to include only those containing the specified person., personIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified person ids., personTypes: [str] # Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited., studios: [str] # Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited., studioIds: [str(uuid)] # Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited., userId: str(uuid) # User id., nameStartsWithOrGreater: str # Optional filter by items whose name is sorted equally or greater than a given input string., nameStartsWith: str # Optional filter by items whose name is sorted equally than a given input string., nameLessThan: str # Optional filter by items whose name is equally or lesser than a given input string., enableImages: bool=true # Optional, include image information in output., enableTotalRecordCount: bool=true # Total record count.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Album artists returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Audio\n@endpoint GET /Audio/{itemId}/stream\n@desc Gets an audio stream.\n@required {itemId: str(uuid) # The item id.}\n@optional {container: str # The audio container., static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment length., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options.}\n@returns(200) Audio stream returned.\n\n@endpoint HEAD /Audio/{itemId}/stream\n@desc Gets an audio stream.\n@required {itemId: str(uuid) # The item id.}\n@optional {container: str # The audio container., static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment length., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options.}\n@returns(200) Audio stream returned.\n\n@endpoint GET /Audio/{itemId}/stream.{container}\n@desc Gets an audio stream.\n@required {itemId: str(uuid) # The item id., container: str # The audio container.}\n@optional {static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment lenght., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamporphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options.}\n@returns(200) Audio stream returned.\n\n@endpoint HEAD /Audio/{itemId}/stream.{container}\n@desc Gets an audio stream.\n@required {itemId: str(uuid) # The item id., container: str # The audio container.}\n@optional {static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment lenght., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamporphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options.}\n@returns(200) Audio stream returned.\n\n@endgroup\n\n@group Branding\n@endpoint GET /Branding/Configuration\n@desc Gets branding configuration.\n@returns(200) {LoginDisclaimer: str?, CustomCss: str?} # Branding configuration returned.\n\n@endpoint GET /Branding/Css\n@desc Gets branding css.\n@returns(200) Branding css returned.\n@returns(204) No branding css configured.\n\n@endpoint GET /Branding/Css.css\n@desc Gets branding css.\n@returns(200) Branding css returned.\n@returns(204) No branding css configured.\n\n@endgroup\n\n@group Channels\n@endpoint GET /Channels\n@desc Gets available channels.\n@optional {userId: str(uuid) # User Id to filter by. Use System.Guid.Empty to not filter by user., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., supportsLatestItems: bool # Optional. Filter by channels that support getting latest items., supportsMediaDeletion: bool # Optional. Filter by channels that support media deletion., isFavorite: bool # Optional. Filter by channels that are favorite.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Channels returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Channels/{channelId}/Features\n@desc Get channel features.\n@required {channelId: str(uuid) # Channel id.}\n@returns(200) {Name: str?, Id: str?, CanSearch: bool, MediaTypes: [str]?, ContentTypes: [str]?, MaxPageSize: int(int32)?, AutoRefreshLevels: int(int32)?, DefaultSortFields: [str]?, SupportsSortOrderToggle: bool, SupportsLatestMedia: bool, CanFilter: bool, SupportsContentDownloading: bool} # Channel features returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Channels/{channelId}/Items\n@desc Get channel items.\n@required {channelId: str(uuid) # Channel Id.}\n@optional {folderId: str(uuid) # Optional. Folder Id., userId: str(uuid) # Optional. User Id., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., sortOrder: str # Optional. Sort Order - Ascending,Descending., filters: [str] # Optional. Specify additional filters to apply., sortBy: str # Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime., fields: [str] # Optional. Specify additional fields of information to return in the output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Channel items returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Channels/Features\n@desc Get all channel features.\n@returns(200) All channel features returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Channels/Items/Latest\n@desc Gets latest channel items.\n@optional {userId: str(uuid) # Optional. User Id., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., filters: [str] # Optional. Specify additional filters to apply., fields: [str] # Optional. Specify additional fields of information to return in the output., channelIds: [str(uuid)] # Optional. Specify one or more channel id's, comma delimited.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Latest channel items returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Collections\n@endpoint POST /Collections\n@desc Creates a new collection.\n@optional {name: str # The name of the collection., ids: [str] # Item Ids to add to the collection., parentId: str(uuid) # Optional. Create the collection within a specific folder., isLocked: bool=false # Whether or not to lock the new collection.}\n@returns(200) {Id: str(uuid)} # Collection created.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Collections/{collectionId}/Items\n@desc Adds items to a collection.\n@required {collectionId: str(uuid) # The collection id., ids: [str(uuid)] # Item ids, comma delimited.}\n@returns(204) Items added to collection.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Collections/{collectionId}/Items\n@desc Removes items from a collection.\n@required {collectionId: str(uuid) # The collection id., ids: [str(uuid)] # Item ids, comma delimited.}\n@returns(204) Items removed from collection.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group System\n@endpoint GET /System/Configuration\n@desc Gets application configuration.\n@returns(200) {LogFileRetentionDays: int(int32), IsStartupWizardCompleted: bool, CachePath: str?, PreviousVersion: map{Major: int(int32), Minor: int(int32), Build: int(int32), Revision: int(int32), MajorRevision: int(int32), MinorRevision: int(int32)}, PreviousVersionStr: str?, EnableUPnP: bool, EnableMetrics: bool, PublicPort: int(int32), UPnPCreateHttpPortMap: bool, UDPPortRange: str?, EnableIPV6: bool, EnableIPV4: bool, EnableSSDPTracing: bool, SSDPTracingFilter: str?, UDPSendCount: int(int32), UDPSendDelay: int(int32), IgnoreVirtualInterfaces: bool, VirtualInterfaceNames: str?, GatewayMonitorPeriod: int(int32), EnableMultiSocketBinding: bool, TrustAllIP6Interfaces: bool, HDHomerunPortRange: str?, PublishedServerUriBySubnet: [str]?, AutoDiscoveryTracing: bool, AutoDiscovery: bool, PublicHttpsPort: int(int32), HttpServerPortNumber: int(int32), HttpsPortNumber: int(int32), EnableHttps: bool, EnableNormalizedItemByNameIds: bool, CertificatePath: str?, CertificatePassword: str?, IsPortAuthorized: bool, QuickConnectAvailable: bool, EnableRemoteAccess: bool, EnableCaseSensitiveItemIds: bool, DisableLiveTvChannelUserDataName: bool, MetadataPath: str?, MetadataNetworkPath: str?, PreferredMetadataLanguage: str?, MetadataCountryCode: str?, SortReplaceCharacters: [str]?, SortRemoveCharacters: [str]?, SortRemoveWords: [str]?, MinResumePct: int(int32), MaxResumePct: int(int32), MinResumeDurationSeconds: int(int32), MinAudiobookResume: int(int32), MaxAudiobookResume: int(int32), LibraryMonitorDelay: int(int32), EnableDashboardResponseCaching: bool, ImageSavingConvention: str, MetadataOptions: [map]?, SkipDeserializationForBasicTypes: bool, ServerName: str?, BaseUrl: str?, UICulture: str?, SaveMetadataHidden: bool, ContentTypes: [map]?, RemoteClientBitrateLimit: int(int32), EnableFolderView: bool, EnableGroupingIntoCollections: bool, DisplaySpecialsWithinSeasons: bool, LocalNetworkSubnets: [str]?, LocalNetworkAddresses: [str]?, CodecsUsed: [str]?, PluginRepositories: [map]?, EnableExternalContentInSuggestions: bool, RequireHttps: bool, EnableNewOmdbSupport: bool, RemoteIPFilter: [str]?, IsRemoteIPFilterBlacklist: bool, ImageExtractionTimeoutMs: int(int32), PathSubstitutions: [map]?, EnableSimpleArtistDetection: bool, UninstalledPlugins: [str]?, EnableSlowResponseWarning: bool, SlowResponseThresholdMs: int(int64), CorsHosts: [str]?, KnownProxies: [str]?, ActivityLogRetentionDays: int(int32)?, LibraryScanFanoutConcurrency: int(int32), LibraryMetadataRefreshConcurrency: int(int32), RemoveOldPlugins: bool, DisablePluginImages: bool} # Application configuration returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /System/Configuration\n@desc Updates application configuration.\n@optional {LogFileRetentionDays: int(int32) # Gets or sets the number of days we should retain log files., IsStartupWizardCompleted: bool # Gets or sets a value indicating whether this instance is first run., CachePath: str # Gets or sets the cache path., PreviousVersion: map{Major: int(int32), Minor: int(int32), Build: int(int32), Revision: int(int32), MajorRevision: int(int32), MinorRevision: int(int32)}, PreviousVersionStr: str # Gets or sets the stringified PreviousVersion to be stored/loaded,\r because System.Version itself isn't xml-serializable., EnableUPnP: bool # Gets or sets a value indicating whether to enable automatic port forwarding., EnableMetrics: bool # Gets or sets a value indicating whether to enable prometheus metrics exporting., PublicPort: int(int32) # Gets or sets the public mapped port., UPnPCreateHttpPortMap: bool # Gets or sets a value indicating whether the http port should be mapped as part of UPnP automatic port forwarding., UDPPortRange: str # Gets or sets client udp port range., EnableIPV6: bool # Gets or sets a value indicating whether IPV6 capability is enabled., EnableIPV4: bool # Gets or sets a value indicating whether IPV4 capability is enabled., EnableSSDPTracing: bool # Gets or sets a value indicating whether detailed ssdp logs are sent to the console/log.\r \"Emby.Dlna\": \"Debug\" must be set in logging.default.json for this property to work., SSDPTracingFilter: str # Gets or sets a value indicating whether an IP address is to be used to filter the detailed ssdp logs that are being sent to the console/log.\r If the setting \"Emby.Dlna\": \"Debug\" msut be set in logging.default.json for this property to work., UDPSendCount: int(int32) # Gets or sets the number of times SSDP UDP messages are sent., UDPSendDelay: int(int32) # Gets or sets the delay between each groups of SSDP messages (in ms)., IgnoreVirtualInterfaces: bool # Gets or sets a value indicating whether address names that match MediaBrowser.Model.Configuration.ServerConfiguration.VirtualInterfaceNames should be Ignore for the purposes of binding., VirtualInterfaceNames: str # Gets or sets a value indicating the interfaces that should be ignored. The list can be comma separated. ., GatewayMonitorPeriod: int(int32) # Gets or sets the time (in seconds) between the pings of SSDP gateway monitor., EnableMultiSocketBinding: bool # Gets a value indicating whether multi-socket binding is available., TrustAllIP6Interfaces: bool # Gets or sets a value indicating whether all IPv6 interfaces should be treated as on the internal network.\r Depending on the address range implemented ULA ranges might not be used., HDHomerunPortRange: str # Gets or sets the ports that HDHomerun uses., PublishedServerUriBySubnet: [str] # Gets or sets PublishedServerUri to advertise for specific subnets., AutoDiscoveryTracing: bool # Gets or sets a value indicating whether Autodiscovery tracing is enabled., AutoDiscovery: bool # Gets or sets a value indicating whether Autodiscovery is enabled., PublicHttpsPort: int(int32) # Gets or sets the public HTTPS port., HttpServerPortNumber: int(int32) # Gets or sets the HTTP server port number., HttpsPortNumber: int(int32) # Gets or sets the HTTPS server port number., EnableHttps: bool # Gets or sets a value indicating whether to use HTTPS., EnableNormalizedItemByNameIds: bool, CertificatePath: str # Gets or sets the filesystem path of an X.509 certificate to use for SSL., CertificatePassword: str # Gets or sets the password required to access the X.509 certificate data in the file specified by MediaBrowser.Model.Configuration.ServerConfiguration.CertificatePath., IsPortAuthorized: bool # Gets or sets a value indicating whether this instance is port authorized., QuickConnectAvailable: bool # Gets or sets a value indicating whether quick connect is available for use on this server., EnableRemoteAccess: bool # Gets or sets a value indicating whether access outside of the LAN is permitted., EnableCaseSensitiveItemIds: bool # Gets or sets a value indicating whether [enable case sensitive item ids]., DisableLiveTvChannelUserDataName: bool, MetadataPath: str # Gets or sets the metadata path., MetadataNetworkPath: str, PreferredMetadataLanguage: str # Gets or sets the preferred metadata language., MetadataCountryCode: str # Gets or sets the metadata country code., SortReplaceCharacters: [str] # Gets or sets characters to be replaced with a ' ' in strings to create a sort name., SortRemoveCharacters: [str] # Gets or sets characters to be removed from strings to create a sort name., SortRemoveWords: [str] # Gets or sets words to be removed from strings to create a sort name., MinResumePct: int(int32) # Gets or sets the minimum percentage of an item that must be played in order for playstate to be updated., MaxResumePct: int(int32) # Gets or sets 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: int(int32) # Gets or sets the minimum duration that an item must have in order to be eligible for playstate updates.., MinAudiobookResume: int(int32) # Gets or sets the minimum minutes of a book that must be played in order for playstate to be updated., MaxAudiobookResume: int(int32) # Gets or sets the remaining minutes of a book 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., LibraryMonitorDelay: int(int32) # Gets or sets the delay in seconds that we will wait after a file system change to try and discover what has been added/removed\r Some delay is necessary with some items because their creation is not atomic.  It involves the creation of several\r different directories and files., EnableDashboardResponseCaching: bool # Gets or sets a value indicating whether [enable dashboard response caching].\r Allows potential contributors without visual studio to modify production dashboard code and test changes., ImageSavingConvention: str(Legacy/Compatible), MetadataOptions: [map{ItemType: str, DisabledMetadataSavers: [str], LocalMetadataReaderOrder: [str], DisabledMetadataFetchers: [str], MetadataFetcherOrder: [str], DisabledImageFetchers: [str], ImageFetcherOrder: [str]}], SkipDeserializationForBasicTypes: bool, ServerName: str, BaseUrl: str, UICulture: str, SaveMetadataHidden: bool, ContentTypes: [map{Name: str, Value: str}], RemoteClientBitrateLimit: int(int32), EnableFolderView: bool, EnableGroupingIntoCollections: bool, DisplaySpecialsWithinSeasons: bool, LocalNetworkSubnets: [str] # Gets or sets the subnets that are deemed to make up the LAN., LocalNetworkAddresses: [str] # Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be used., CodecsUsed: [str], PluginRepositories: [map{Name: str, Url: str, Enabled: bool}], EnableExternalContentInSuggestions: bool, RequireHttps: bool # Gets or sets a value indicating whether the server should force connections over HTTPS., EnableNewOmdbSupport: bool, RemoteIPFilter: [str] # Gets or sets the filter for remote IP connectivity. Used in conjuntion with ., IsRemoteIPFilterBlacklist: bool # Gets or sets a value indicating whether  contains a blacklist or a whitelist. Default is a whitelist., ImageExtractionTimeoutMs: int(int32), PathSubstitutions: [map{From: str, To: str}], EnableSimpleArtistDetection: bool, UninstalledPlugins: [str], EnableSlowResponseWarning: bool # Gets or sets a value indicating whether slow server responses should be logged as a warning., SlowResponseThresholdMs: int(int64) # Gets or sets the threshold for the slow response time warning in ms., CorsHosts: [str] # Gets or sets the cors hosts., KnownProxies: [str] # Gets or sets the known proxies., ActivityLogRetentionDays: int(int32) # Gets or sets the number of days we should retain activity logs., LibraryScanFanoutConcurrency: int(int32) # Gets or sets the how the library scan fans out., LibraryMetadataRefreshConcurrency: int(int32) # Gets or sets the how many metadata refreshes can run concurrently., RemoveOldPlugins: bool # Gets or sets a value indicating whether older plugins should automatically be deleted from the plugin folder., DisablePluginImages: bool # Gets or sets a value indicating whether plugin image should be disabled.}\n@returns(204) Configuration updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /System/Configuration/{key}\n@desc Gets a named configuration.\n@required {key: str # Configuration key.}\n@returns(200) Configuration returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /System/Configuration/{key}\n@desc Updates named configuration.\n@required {key: str # Configuration key.}\n@returns(204) Named configuration updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /System/Configuration/MetadataOptions/Default\n@desc Gets a default MetadataOptions object.\n@returns(200) {ItemType: str?, DisabledMetadataSavers: [str]?, LocalMetadataReaderOrder: [str]?, DisabledMetadataFetchers: [str]?, MetadataFetcherOrder: [str]?, DisabledImageFetchers: [str]?, ImageFetcherOrder: [str]?} # Metadata options returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /System/MediaEncoder/Path\n@desc Updates the path to the media encoder.\n@optional {Path: str # Gets or sets media encoder path., PathType: str # Gets or sets media encoder path type.}\n@returns(204) Media encoder path updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group web\n@endpoint GET /web/ConfigurationPage\n@desc Gets a dashboard configuration page.\n@optional {name: str # The name of the page.}\n@returns(200) ConfigurationPage returned.\n@errors {404: Plugin configuration page not found.}\n\n@endpoint GET /web/ConfigurationPages\n@desc Gets the configuration pages.\n@optional {enableInMainMenu: bool # Whether to enable in the main menu., pageType: str # The Jellyfin.Api.Models.ConfigurationPageInfo.}\n@returns(200) ConfigurationPages returned.\n@errors {404: Server still loading.}\n\n@endgroup\n\n@group Devices\n@endpoint GET /Devices\n@desc Get Devices.\n@optional {supportsSync: bool # Gets or sets a value indicating whether [supports synchronize]., userId: str(uuid) # Gets or sets the user identifier.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Devices retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Devices\n@desc Deletes a device.\n@required {id: str # Device Id.}\n@returns(204) Device deleted.\n@errors {401: Unauthorized, 403: Forbidden, 404: Device not found.}\n\n@endpoint GET /Devices/Info\n@desc Get info for a device.\n@required {id: str # Device Id.}\n@returns(200) {Name: str?, Id: str?, LastUserName: str?, AppName: str?, AppVersion: str?, LastUserId: str(uuid), DateLastActivity: str(date-time), Capabilities: map{PlayableMediaTypes: [str]?, SupportedCommands: [str]?, SupportsMediaControl: bool, SupportsContentUploading: bool, MessageCallbackUrl: str?, SupportsPersistentIdentifier: bool, SupportsSync: bool, DeviceProfile: map{Name: str?, Id: str?, Identification: map{FriendlyName: str?, ModelNumber: str?, SerialNumber: str?, ModelName: str?, ModelDescription: str?, ModelUrl: str?, Manufacturer: str?, ManufacturerUrl: str?, Headers: [map]?}, FriendlyName: str?, Manufacturer: str?, ManufacturerUrl: str?, ModelName: str?, ModelDescription: str?, ModelNumber: str?, ModelUrl: str?, SerialNumber: str?, EnableAlbumArtInDidl: bool, EnableSingleAlbumArtLimit: bool, EnableSingleSubtitleLimit: bool, SupportedMediaTypes: str?, UserId: str?, AlbumArtPn: str?, MaxAlbumArtWidth: int(int32), MaxAlbumArtHeight: int(int32), MaxIconWidth: int(int32)?, MaxIconHeight: int(int32)?, MaxStreamingBitrate: int(int32)?, MaxStaticBitrate: int(int32)?, MusicStreamingTranscodingBitrate: int(int32)?, MaxStaticMusicBitrate: int(int32)?, SonyAggregationFlags: str?, ProtocolInfo: str?, TimelineOffsetSeconds: int(int32), RequiresPlainVideoItems: bool, RequiresPlainFolders: bool, EnableMSMediaReceiverRegistrar: bool, IgnoreTranscodeByteRangeRequests: bool, XmlRootAttributes: [map]?, DirectPlayProfiles: [map]?, TranscodingProfiles: [map]?, ContainerProfiles: [map]?, CodecProfiles: [map]?, ResponseProfiles: [map]?, SubtitleProfiles: [map]?}, AppStoreUrl: str?, IconUrl: str?}, IconUrl: str?} # Device info retrieved.\n@errors {401: Unauthorized, 403: Forbidden, 404: Device not found.}\n\n@endpoint GET /Devices/Options\n@desc Get options for a device.\n@required {id: str # Device Id.}\n@returns(200) {CustomName: str?} # Device options retrieved.\n@errors {401: Unauthorized, 403: Forbidden, 404: Device not found.}\n\n@endpoint POST /Devices/Options\n@desc Update device options.\n@required {id: str # Device Id.}\n@optional {CustomName: str}\n@returns(204) Device options updated.\n@errors {401: Unauthorized, 403: Forbidden, 404: Device not found.}\n\n@endgroup\n\n@group DisplayPreferences\n@endpoint GET /DisplayPreferences/{displayPreferencesId}\n@desc Get Display Preferences.\n@required {displayPreferencesId: str # Display preferences id., userId: str(uuid) # User id., client: str # Client.}\n@returns(200) {Id: str?, ViewType: str?, SortBy: str?, IndexBy: str?, RememberIndexing: bool, PrimaryImageHeight: int(int32), PrimaryImageWidth: int(int32), CustomPrefs: map?, ScrollDirection: str, ShowBackdrop: bool, RememberSorting: bool, SortOrder: str, ShowSidebar: bool, Client: str?} # Display preferences retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /DisplayPreferences/{displayPreferencesId}\n@desc Update Display Preferences.\n@required {displayPreferencesId: str # Display preferences id., userId: str(uuid) # User Id., client: str # Client.}\n@optional {Id: str # Gets or sets the user id., ViewType: str # Gets or sets the type of the view., SortBy: str # Gets or sets the sort by., IndexBy: str # Gets or sets the index by., RememberIndexing: bool # Gets or sets a value indicating whether [remember indexing]., PrimaryImageHeight: int(int32) # Gets or sets the height of the primary image., PrimaryImageWidth: int(int32) # Gets or sets the width of the primary image., CustomPrefs: map # Gets or sets the custom prefs., ScrollDirection: str(Horizontal/Vertical) # An enum representing the axis that should be scrolled., ShowBackdrop: bool # Gets or sets a value indicating whether to show backdrops on this item., RememberSorting: bool # Gets or sets a value indicating whether [remember sorting]., SortOrder: str(Ascending/Descending) # An enum representing the sorting order., ShowSidebar: bool # Gets or sets a value indicating whether [show sidebar]., Client: str # Gets or sets the client.}\n@returns(204) Display preferences updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Dlna\n@endpoint GET /Dlna/ProfileInfos\n@desc Get profile infos.\n@returns(200) Device profile infos returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Dlna/Profiles\n@desc Creates a profile.\n@optional {Name: str # Gets or sets the Name., Id: str # Gets or sets the Id., Identification: map{FriendlyName: str, ModelNumber: str, SerialNumber: str, ModelName: str, ModelDescription: str, ModelUrl: str, Manufacturer: str, ManufacturerUrl: str, Headers: [map]}, FriendlyName: str # Gets or sets the FriendlyName., Manufacturer: str # Gets or sets the Manufacturer., ManufacturerUrl: str # Gets or sets the ManufacturerUrl., ModelName: str # Gets or sets the ModelName., ModelDescription: str # Gets or sets the ModelDescription., ModelNumber: str # Gets or sets the ModelNumber., ModelUrl: str # Gets or sets the ModelUrl., SerialNumber: str # Gets or sets the SerialNumber., EnableAlbumArtInDidl: bool # Gets or sets a value indicating whether EnableAlbumArtInDidl., EnableSingleAlbumArtLimit: bool # Gets or sets a value indicating whether EnableSingleAlbumArtLimit., EnableSingleSubtitleLimit: bool # Gets or sets a value indicating whether EnableSingleSubtitleLimit., SupportedMediaTypes: str # Gets or sets the SupportedMediaTypes., UserId: str # Gets or sets the UserId., AlbumArtPn: str # Gets or sets the AlbumArtPn., MaxAlbumArtWidth: int(int32) # Gets or sets the MaxAlbumArtWidth., MaxAlbumArtHeight: int(int32) # Gets or sets the MaxAlbumArtHeight., MaxIconWidth: int(int32) # Gets or sets the MaxIconWidth., MaxIconHeight: int(int32) # Gets or sets the MaxIconHeight., MaxStreamingBitrate: int(int32) # Gets or sets the MaxStreamingBitrate., MaxStaticBitrate: int(int32) # Gets or sets the MaxStaticBitrate., MusicStreamingTranscodingBitrate: int(int32) # Gets or sets the MusicStreamingTranscodingBitrate., MaxStaticMusicBitrate: int(int32) # Gets or sets the MaxStaticMusicBitrate., SonyAggregationFlags: str # Gets or sets the content of the aggregationFlags element in the urn:schemas-sonycom:av namespace., ProtocolInfo: str # Gets or sets the ProtocolInfo., TimelineOffsetSeconds: int(int32) # Gets or sets the TimelineOffsetSeconds., RequiresPlainVideoItems: bool # Gets or sets a value indicating whether RequiresPlainVideoItems., RequiresPlainFolders: bool # Gets or sets a value indicating whether RequiresPlainFolders., EnableMSMediaReceiverRegistrar: bool # Gets or sets a value indicating whether EnableMSMediaReceiverRegistrar., IgnoreTranscodeByteRangeRequests: bool # Gets or sets a value indicating whether IgnoreTranscodeByteRangeRequests., XmlRootAttributes: [map{Name: str, Value: str}] # Gets or sets the XmlRootAttributes., DirectPlayProfiles: [map{Container: str, AudioCodec: str, VideoCodec: str, Type: str}] # Gets or sets the direct play profiles., TranscodingProfiles: [map{Container: str, Type: str, VideoCodec: str, AudioCodec: str, Protocol: str, EstimateContentLength: bool, EnableMpegtsM2TsMode: bool, TranscodeSeekInfo: str, CopyTimestamps: bool, Context: str, EnableSubtitlesInManifest: bool, MaxAudioChannels: str, MinSegments: int(int32), SegmentLength: int(int32), BreakOnNonKeyFrames: bool}] # Gets or sets the transcoding profiles., ContainerProfiles: [map{Type: str, Conditions: [map], Container: str}] # Gets or sets the ContainerProfiles., CodecProfiles: [map{Type: str, Conditions: [map], ApplyConditions: [map], Codec: str, Container: str}] # Gets or sets the CodecProfiles., ResponseProfiles: [map{Container: str, AudioCodec: str, VideoCodec: str, Type: str, OrgPn: str, MimeType: str, Conditions: [map]}] # Gets or sets the ResponseProfiles., SubtitleProfiles: [map{Format: str, Method: str, DidlMode: str, Language: str, Container: str}] # Gets or sets the SubtitleProfiles.}\n@returns(204) Device profile created.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Dlna/Profiles/{profileId}\n@desc Gets a single profile.\n@required {profileId: str # Profile Id.}\n@returns(200) {Name: str?, Id: str?, Identification: map{FriendlyName: str?, ModelNumber: str?, SerialNumber: str?, ModelName: str?, ModelDescription: str?, ModelUrl: str?, Manufacturer: str?, ManufacturerUrl: str?, Headers: [map]?}, FriendlyName: str?, Manufacturer: str?, ManufacturerUrl: str?, ModelName: str?, ModelDescription: str?, ModelNumber: str?, ModelUrl: str?, SerialNumber: str?, EnableAlbumArtInDidl: bool, EnableSingleAlbumArtLimit: bool, EnableSingleSubtitleLimit: bool, SupportedMediaTypes: str?, UserId: str?, AlbumArtPn: str?, MaxAlbumArtWidth: int(int32), MaxAlbumArtHeight: int(int32), MaxIconWidth: int(int32)?, MaxIconHeight: int(int32)?, MaxStreamingBitrate: int(int32)?, MaxStaticBitrate: int(int32)?, MusicStreamingTranscodingBitrate: int(int32)?, MaxStaticMusicBitrate: int(int32)?, SonyAggregationFlags: str?, ProtocolInfo: str?, TimelineOffsetSeconds: int(int32), RequiresPlainVideoItems: bool, RequiresPlainFolders: bool, EnableMSMediaReceiverRegistrar: bool, IgnoreTranscodeByteRangeRequests: bool, XmlRootAttributes: [map]?, DirectPlayProfiles: [map]?, TranscodingProfiles: [map]?, ContainerProfiles: [map]?, CodecProfiles: [map]?, ResponseProfiles: [map]?, SubtitleProfiles: [map]?} # Device profile returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Device profile not found.}\n\n@endpoint DELETE /Dlna/Profiles/{profileId}\n@desc Deletes a profile.\n@required {profileId: str # Profile id.}\n@returns(204) Device profile deleted.\n@errors {401: Unauthorized, 403: Forbidden, 404: Device profile not found.}\n\n@endpoint POST /Dlna/Profiles/{profileId}\n@desc Updates a profile.\n@required {profileId: str # Profile id.}\n@optional {Name: str # Gets or sets the Name., Id: str # Gets or sets the Id., Identification: map{FriendlyName: str, ModelNumber: str, SerialNumber: str, ModelName: str, ModelDescription: str, ModelUrl: str, Manufacturer: str, ManufacturerUrl: str, Headers: [map]}, FriendlyName: str # Gets or sets the FriendlyName., Manufacturer: str # Gets or sets the Manufacturer., ManufacturerUrl: str # Gets or sets the ManufacturerUrl., ModelName: str # Gets or sets the ModelName., ModelDescription: str # Gets or sets the ModelDescription., ModelNumber: str # Gets or sets the ModelNumber., ModelUrl: str # Gets or sets the ModelUrl., SerialNumber: str # Gets or sets the SerialNumber., EnableAlbumArtInDidl: bool # Gets or sets a value indicating whether EnableAlbumArtInDidl., EnableSingleAlbumArtLimit: bool # Gets or sets a value indicating whether EnableSingleAlbumArtLimit., EnableSingleSubtitleLimit: bool # Gets or sets a value indicating whether EnableSingleSubtitleLimit., SupportedMediaTypes: str # Gets or sets the SupportedMediaTypes., UserId: str # Gets or sets the UserId., AlbumArtPn: str # Gets or sets the AlbumArtPn., MaxAlbumArtWidth: int(int32) # Gets or sets the MaxAlbumArtWidth., MaxAlbumArtHeight: int(int32) # Gets or sets the MaxAlbumArtHeight., MaxIconWidth: int(int32) # Gets or sets the MaxIconWidth., MaxIconHeight: int(int32) # Gets or sets the MaxIconHeight., MaxStreamingBitrate: int(int32) # Gets or sets the MaxStreamingBitrate., MaxStaticBitrate: int(int32) # Gets or sets the MaxStaticBitrate., MusicStreamingTranscodingBitrate: int(int32) # Gets or sets the MusicStreamingTranscodingBitrate., MaxStaticMusicBitrate: int(int32) # Gets or sets the MaxStaticMusicBitrate., SonyAggregationFlags: str # Gets or sets the content of the aggregationFlags element in the urn:schemas-sonycom:av namespace., ProtocolInfo: str # Gets or sets the ProtocolInfo., TimelineOffsetSeconds: int(int32) # Gets or sets the TimelineOffsetSeconds., RequiresPlainVideoItems: bool # Gets or sets a value indicating whether RequiresPlainVideoItems., RequiresPlainFolders: bool # Gets or sets a value indicating whether RequiresPlainFolders., EnableMSMediaReceiverRegistrar: bool # Gets or sets a value indicating whether EnableMSMediaReceiverRegistrar., IgnoreTranscodeByteRangeRequests: bool # Gets or sets a value indicating whether IgnoreTranscodeByteRangeRequests., XmlRootAttributes: [map{Name: str, Value: str}] # Gets or sets the XmlRootAttributes., DirectPlayProfiles: [map{Container: str, AudioCodec: str, VideoCodec: str, Type: str}] # Gets or sets the direct play profiles., TranscodingProfiles: [map{Container: str, Type: str, VideoCodec: str, AudioCodec: str, Protocol: str, EstimateContentLength: bool, EnableMpegtsM2TsMode: bool, TranscodeSeekInfo: str, CopyTimestamps: bool, Context: str, EnableSubtitlesInManifest: bool, MaxAudioChannels: str, MinSegments: int(int32), SegmentLength: int(int32), BreakOnNonKeyFrames: bool}] # Gets or sets the transcoding profiles., ContainerProfiles: [map{Type: str, Conditions: [map], Container: str}] # Gets or sets the ContainerProfiles., CodecProfiles: [map{Type: str, Conditions: [map], ApplyConditions: [map], Codec: str, Container: str}] # Gets or sets the CodecProfiles., ResponseProfiles: [map{Container: str, AudioCodec: str, VideoCodec: str, Type: str, OrgPn: str, MimeType: str, Conditions: [map]}] # Gets or sets the ResponseProfiles., SubtitleProfiles: [map{Format: str, Method: str, DidlMode: str, Language: str, Container: str}] # Gets or sets the SubtitleProfiles.}\n@returns(204) Device profile updated.\n@errors {401: Unauthorized, 403: Forbidden, 404: Device profile not found.}\n\n@endpoint GET /Dlna/Profiles/Default\n@desc Gets the default profile.\n@returns(200) {Name: str?, Id: str?, Identification: map{FriendlyName: str?, ModelNumber: str?, SerialNumber: str?, ModelName: str?, ModelDescription: str?, ModelUrl: str?, Manufacturer: str?, ManufacturerUrl: str?, Headers: [map]?}, FriendlyName: str?, Manufacturer: str?, ManufacturerUrl: str?, ModelName: str?, ModelDescription: str?, ModelNumber: str?, ModelUrl: str?, SerialNumber: str?, EnableAlbumArtInDidl: bool, EnableSingleAlbumArtLimit: bool, EnableSingleSubtitleLimit: bool, SupportedMediaTypes: str?, UserId: str?, AlbumArtPn: str?, MaxAlbumArtWidth: int(int32), MaxAlbumArtHeight: int(int32), MaxIconWidth: int(int32)?, MaxIconHeight: int(int32)?, MaxStreamingBitrate: int(int32)?, MaxStaticBitrate: int(int32)?, MusicStreamingTranscodingBitrate: int(int32)?, MaxStaticMusicBitrate: int(int32)?, SonyAggregationFlags: str?, ProtocolInfo: str?, TimelineOffsetSeconds: int(int32), RequiresPlainVideoItems: bool, RequiresPlainFolders: bool, EnableMSMediaReceiverRegistrar: bool, IgnoreTranscodeByteRangeRequests: bool, XmlRootAttributes: [map]?, DirectPlayProfiles: [map]?, TranscodingProfiles: [map]?, ContainerProfiles: [map]?, CodecProfiles: [map]?, ResponseProfiles: [map]?, SubtitleProfiles: [map]?} # Default device profile returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Dlna/{serverId}/ConnectionManager\n@desc Gets Dlna media receiver registrar xml.\n@required {serverId: str # Server UUID.}\n@returns(200) Dlna media receiver registrar xml returned.\n@errors {503: DLNA is disabled.}\n\n@endpoint GET /Dlna/{serverId}/ConnectionManager/ConnectionManager\n@desc Gets Dlna media receiver registrar xml.\n@required {serverId: str # Server UUID.}\n@returns(200) Dlna media receiver registrar xml returned.\n@errors {503: DLNA is disabled.}\n\n@endpoint GET /Dlna/{serverId}/ConnectionManager/ConnectionManager.xml\n@desc Gets Dlna media receiver registrar xml.\n@required {serverId: str # Server UUID.}\n@returns(200) Dlna media receiver registrar xml returned.\n@errors {503: DLNA is disabled.}\n\n@endpoint POST /Dlna/{serverId}/ConnectionManager/Control\n@desc Process a connection manager control request.\n@required {serverId: str # Server UUID.}\n@returns(200) Request processed.\n@errors {503: DLNA is disabled.}\n\n@endpoint GET /Dlna/{serverId}/ContentDirectory\n@desc Gets Dlna content directory xml.\n@required {serverId: str # Server UUID.}\n@returns(200) Dlna content directory returned.\n@errors {503: DLNA is disabled.}\n\n@endpoint GET /Dlna/{serverId}/ContentDirectory/ContentDirectory\n@desc Gets Dlna content directory xml.\n@required {serverId: str # Server UUID.}\n@returns(200) Dlna content directory returned.\n@errors {503: DLNA is disabled.}\n\n@endpoint GET /Dlna/{serverId}/ContentDirectory/ContentDirectory.xml\n@desc Gets Dlna content directory xml.\n@required {serverId: str # Server UUID.}\n@returns(200) Dlna content directory returned.\n@errors {503: DLNA is disabled.}\n\n@endpoint POST /Dlna/{serverId}/ContentDirectory/Control\n@desc Process a content directory control request.\n@required {serverId: str # Server UUID.}\n@returns(200) Request processed.\n@errors {503: DLNA is disabled.}\n\n@endpoint GET /Dlna/{serverId}/description\n@desc Get Description Xml.\n@required {serverId: str # Server UUID.}\n@returns(200) Description xml returned.\n@errors {503: DLNA is disabled.}\n\n@endpoint GET /Dlna/{serverId}/description.xml\n@desc Get Description Xml.\n@required {serverId: str # Server UUID.}\n@returns(200) Description xml returned.\n@errors {503: DLNA is disabled.}\n\n@endpoint GET /Dlna/{serverId}/icons/{fileName}\n@desc Gets a server icon.\n@required {serverId: str # Server UUID., fileName: str # The icon filename.}\n@returns(200) Request processed.\n@errors {404: Not Found., 503: DLNA is disabled.}\n\n@endpoint GET /Dlna/{serverId}/MediaReceiverRegistrar\n@desc Gets Dlna media receiver registrar xml.\n@required {serverId: str # Server UUID.}\n@returns(200) Dlna media receiver registrar xml returned.\n@errors {503: DLNA is disabled.}\n\n@endpoint POST /Dlna/{serverId}/MediaReceiverRegistrar/Control\n@desc Process a media receiver registrar control request.\n@required {serverId: str # Server UUID.}\n@returns(200) Request processed.\n@errors {503: DLNA is disabled.}\n\n@endpoint GET /Dlna/{serverId}/MediaReceiverRegistrar/MediaReceiverRegistrar\n@desc Gets Dlna media receiver registrar xml.\n@required {serverId: str # Server UUID.}\n@returns(200) Dlna media receiver registrar xml returned.\n@errors {503: DLNA is disabled.}\n\n@endpoint GET /Dlna/{serverId}/MediaReceiverRegistrar/MediaReceiverRegistrar.xml\n@desc Gets Dlna media receiver registrar xml.\n@required {serverId: str # Server UUID.}\n@returns(200) Dlna media receiver registrar xml returned.\n@errors {503: DLNA is disabled.}\n\n@endpoint GET /Dlna/icons/{fileName}\n@desc Gets a server icon.\n@required {fileName: str # The icon filename.}\n@returns(200) Request processed.\n@errors {404: Not Found., 503: DLNA is disabled.}\n\n@endgroup\n\n@group Audio\n@endpoint GET /Audio/{itemId}/hls1/{playlistId}/{segmentId}.{container}\n@desc Gets a video stream using HTTP live streaming.\n@required {itemId: str(uuid) # The item id., playlistId: str # The playlist id., segmentId: int(int32) # The segment id., container: str # The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.}\n@optional {static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment length., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., maxStreamingBitrate: int(int32) # Optional. The maximum streaming bitrate., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options.}\n@returns(200) Video stream returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Audio/{itemId}/main.m3u8\n@desc Gets an audio stream using HTTP live streaming.\n@required {itemId: str(uuid) # The item id.}\n@optional {static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment length., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., maxStreamingBitrate: int(int32) # Optional. The maximum streaming bitrate., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options.}\n@returns(200) Audio stream returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Audio/{itemId}/master.m3u8\n@desc Gets an audio hls playlist stream.\n@required {itemId: str(uuid) # The item id., mediaSourceId: str # The media version id, if playing an alternate version.}\n@optional {static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment length., minSegments: int(int32) # The minimum number of segments., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., maxStreamingBitrate: int(int32) # Optional. The maximum streaming bitrate., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options., enableAdaptiveBitrateStreaming: bool=true # Enable adaptive bitrate streaming.}\n@returns(200) Audio stream returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint HEAD /Audio/{itemId}/master.m3u8\n@desc Gets an audio hls playlist stream.\n@required {itemId: str(uuid) # The item id., mediaSourceId: str # The media version id, if playing an alternate version.}\n@optional {static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment length., minSegments: int(int32) # The minimum number of segments., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., maxStreamingBitrate: int(int32) # Optional. The maximum streaming bitrate., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options., enableAdaptiveBitrateStreaming: bool=true # Enable adaptive bitrate streaming.}\n@returns(200) Audio stream returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Videos\n@endpoint GET /Videos/{itemId}/hls1/{playlistId}/{segmentId}.{container}\n@desc Gets a video stream using HTTP live streaming.\n@required {itemId: str(uuid) # The item id., playlistId: str # The playlist id., segmentId: int(int32) # The segment id., container: str # The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.}\n@optional {static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment lenght., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options.}\n@returns(200) Video stream returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Videos/{itemId}/main.m3u8\n@desc Gets a video stream using HTTP live streaming.\n@required {itemId: str(uuid) # The item id.}\n@optional {static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment length., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options.}\n@returns(200) Video stream returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Videos/{itemId}/master.m3u8\n@desc Gets a video hls playlist stream.\n@required {itemId: str(uuid) # The item id., mediaSourceId: str # The media version id, if playing an alternate version.}\n@optional {static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment length., minSegments: int(int32) # The minimum number of segments., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options., enableAdaptiveBitrateStreaming: bool=true # Enable adaptive bitrate streaming.}\n@returns(200) Video stream returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint HEAD /Videos/{itemId}/master.m3u8\n@desc Gets a video hls playlist stream.\n@required {itemId: str(uuid) # The item id., mediaSourceId: str # The media version id, if playing an alternate version.}\n@optional {static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment length., minSegments: int(int32) # The minimum number of segments., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options., enableAdaptiveBitrateStreaming: bool=true # Enable adaptive bitrate streaming.}\n@returns(200) Video stream returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Environment\n@endpoint GET /Environment/DefaultDirectoryBrowser\n@desc Get Default directory browser.\n@returns(200) {Path: str?} # Default directory browser returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Environment/DirectoryContents\n@desc Gets the contents of a given directory in the file system.\n@required {path: str # The path.}\n@optional {includeFiles: bool=false # An optional filter to include or exclude files from the results. true/false., includeDirectories: bool=false # An optional filter to include or exclude folders from the results. true/false.}\n@returns(200) Directory contents returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Environment/Drives\n@desc Gets available drives from the server's file system.\n@returns(200) List of entries returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Environment/NetworkShares\n@desc Gets network paths.\n@returns(200) Empty array returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Environment/ParentPath\n@desc Gets the parent path of a given path.\n@required {path: str # The path.}\n@returns(200) Success\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Environment/ValidatePath\n@desc Validates path.\n@optional {ValidateWritable: bool # Gets or sets a value indicating whether validate if path is writable., Path: str # Gets or sets the path., IsFile: bool # Gets or sets is path file.}\n@returns(204) Path validated.\n@errors {401: Unauthorized, 403: Forbidden, 404: Path not found.}\n\n@endgroup\n\n@group Items\n@endpoint GET /Items/Filters\n@desc Gets legacy query filters.\n@optional {userId: str(uuid) # Optional. User id., parentId: str(uuid) # Optional. Parent id., includeItemTypes: [str] # Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited., mediaTypes: [str] # Optional. Filter by MediaType. Allows multiple, comma delimited.}\n@returns(200) {Genres: [str]?, Tags: [str]?, OfficialRatings: [str]?, Years: [int(int32)]?} # Legacy filters retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Items/Filters2\n@desc Gets query filters.\n@optional {userId: str(uuid) # Optional. User id., parentId: str(uuid) # Optional. Specify this to localize the search to a specific item or folder. Omit to use the root., includeItemTypes: [str] # Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited., isAiring: bool # Optional. Is item airing., isMovie: bool # Optional. Is item movie., isSports: bool # Optional. Is item sports., isKids: bool # Optional. Is item kids., isNews: bool # Optional. Is item news., isSeries: bool # Optional. Is item series., recursive: bool # Optional. Search recursive.}\n@returns(200) {Genres: [map]?, Tags: [str]?} # Filters retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Genres\n@endpoint GET /Genres\n@desc Gets all genres from a given item, folder, or the entire library.\n@optional {startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., searchTerm: str # The search term., parentId: str(uuid) # Specify this to localize the search to a specific item or folder. Omit to use the root., fields: [str] # Optional. Specify additional fields of information to return in the output., excludeItemTypes: [str] # Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited., includeItemTypes: [str] # Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited., isFavorite: bool # Optional filter by items that are marked as favorite, or not., imageTypeLimit: int(int32) # Optional, the max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., userId: str(uuid) # User id., nameStartsWithOrGreater: str # Optional filter by items whose name is sorted equally or greater than a given input string., nameStartsWith: str # Optional filter by items whose name is sorted equally than a given input string., nameLessThan: str # Optional filter by items whose name is equally or lesser than a given input string., enableImages: bool=true # Optional, include image information in output., enableTotalRecordCount: bool=true # Optional. Include total record count.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Genres returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Genres/{genreName}\n@desc Gets a genre, by name.\n@required {genreName: str # The genre name.}\n@optional {userId: str(uuid) # The user id.}\n@returns(200) {Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}}} # Genres returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Audio\n@endpoint GET /Audio/{itemId}/hls/{segmentId}/stream.aac\n@desc Gets the specified audio segment for an audio item.\n@required {itemId: str # The item id., segmentId: str # The segment id.}\n@returns(200) Hls audio segment returned.\n\n@endpoint GET /Audio/{itemId}/hls/{segmentId}/stream.mp3\n@desc Gets the specified audio segment for an audio item.\n@required {itemId: str # The item id., segmentId: str # The segment id.}\n@returns(200) Hls audio segment returned.\n\n@endgroup\n\n@group Videos\n@endpoint GET /Videos/{itemId}/hls/{playlistId}/{segmentId}.{segmentContainer}\n@desc Gets a hls video segment.\n@required {itemId: str # The item id., playlistId: str # The playlist id., segmentId: str # The segment id., segmentContainer: str # The segment container.}\n@returns(200) Hls video segment returned.\n@errors {404: Hls segment not found.}\n\n@endpoint GET /Videos/{itemId}/hls/{playlistId}/stream.m3u8\n@desc Gets a hls video playlist.\n@required {itemId: str # The video id., playlistId: str # The playlist id.}\n@returns(200) Hls video playlist returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Videos/ActiveEncodings\n@desc Stops an active encoding.\n@optional {deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., playSessionId: str # The play session id.}\n@returns(204) Encoding stopped successfully.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Artists\n@endpoint GET /Artists/{name}/Images/{imageType}/{imageIndex}\n@desc Get artist image by name.\n@required {name: str # Artist name., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /Artists/{name}/Images/{imageType}/{imageIndex}\n@desc Get artist image by name.\n@required {name: str # Artist name., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endgroup\n\n@group Genres\n@endpoint GET /Genres/{name}/Images/{imageType}\n@desc Get genre image by name.\n@required {name: str # Genre name., imageType: str # Image type.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image., imageIndex: int(int32) # Image index.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /Genres/{name}/Images/{imageType}\n@desc Get genre image by name.\n@required {name: str # Genre name., imageType: str # Image type.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image., imageIndex: int(int32) # Image index.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint GET /Genres/{name}/Images/{imageType}/{imageIndex}\n@desc Get genre image by name.\n@required {name: str # Genre name., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /Genres/{name}/Images/{imageType}/{imageIndex}\n@desc Get genre image by name.\n@required {name: str # Genre name., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endgroup\n\n@group Items\n@endpoint GET /Items/{itemId}/Images\n@desc Get item image infos.\n@required {itemId: str(uuid) # Item id.}\n@returns(200) Item images returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint DELETE /Items/{itemId}/Images/{imageType}\n@desc Delete an item's image.\n@required {itemId: str(uuid) # Item id., imageType: str # Image type.}\n@optional {imageIndex: int(int32) # The image index.}\n@returns(204) Image deleted.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint POST /Items/{itemId}/Images/{imageType}\n@desc Set item image.\n@required {itemId: str(uuid) # Item id., imageType: str # Image type.}\n@returns(204) Image saved.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint GET /Items/{itemId}/Images/{imageType}\n@desc Gets the item's image.\n@required {itemId: str(uuid) # Item id., imageType: str # Image type.}\n@optional {maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., format: str # Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image., addPlayedIndicator: bool # Optional. Add a played indicator., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image., imageIndex: int(int32) # Image index.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /Items/{itemId}/Images/{imageType}\n@desc Gets the item's image.\n@required {itemId: str(uuid) # Item id., imageType: str # Image type.}\n@optional {maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., format: str # Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image., addPlayedIndicator: bool # Optional. Add a played indicator., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image., imageIndex: int(int32) # Image index.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint DELETE /Items/{itemId}/Images/{imageType}/{imageIndex}\n@desc Delete an item's image.\n@required {itemId: str(uuid) # Item id., imageType: str # Image type., imageIndex: int(int32) # The image index.}\n@returns(204) Image deleted.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint POST /Items/{itemId}/Images/{imageType}/{imageIndex}\n@desc Set item image.\n@required {itemId: str(uuid) # Item id., imageType: str # Image type., imageIndex: int(int32) # (Unused) Image index.}\n@returns(204) Image saved.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint GET /Items/{itemId}/Images/{imageType}/{imageIndex}\n@desc Gets the item's image.\n@required {itemId: str(uuid) # Item id., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., format: str # Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image., addPlayedIndicator: bool # Optional. Add a played indicator., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /Items/{itemId}/Images/{imageType}/{imageIndex}\n@desc Gets the item's image.\n@required {itemId: str(uuid) # Item id., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., format: str # Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image., addPlayedIndicator: bool # Optional. Add a played indicator., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint GET /Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}\n@desc Gets the item's image.\n@required {itemId: str(uuid) # Item id., imageType: str # Image type., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., imageIndex: int(int32) # Image index.}\n@optional {width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}\n@desc Gets the item's image.\n@required {itemId: str(uuid) # Item id., imageType: str # Image type., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., imageIndex: int(int32) # Image index.}\n@optional {width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint POST /Items/{itemId}/Images/{imageType}/{imageIndex}/Index\n@desc Updates the index for an item image.\n@required {itemId: str(uuid) # Item id., imageType: str # Image type., imageIndex: int(int32) # Old image index.}\n@optional {newIndex: int(int32) # New image index.}\n@returns(204) Image index updated.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endgroup\n\n@group MusicGenres\n@endpoint GET /MusicGenres/{name}/Images/{imageType}\n@desc Get music genre image by name.\n@required {name: str # Music genre name., imageType: str # Image type.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image., imageIndex: int(int32) # Image index.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /MusicGenres/{name}/Images/{imageType}\n@desc Get music genre image by name.\n@required {name: str # Music genre name., imageType: str # Image type.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image., imageIndex: int(int32) # Image index.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint GET /MusicGenres/{name}/Images/{imageType}/{imageIndex}\n@desc Get music genre image by name.\n@required {name: str # Music genre name., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /MusicGenres/{name}/Images/{imageType}/{imageIndex}\n@desc Get music genre image by name.\n@required {name: str # Music genre name., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endgroup\n\n@group Persons\n@endpoint GET /Persons/{name}/Images/{imageType}\n@desc Get person image by name.\n@required {name: str # Person name., imageType: str # Image type.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image., imageIndex: int(int32) # Image index.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /Persons/{name}/Images/{imageType}\n@desc Get person image by name.\n@required {name: str # Person name., imageType: str # Image type.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image., imageIndex: int(int32) # Image index.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint GET /Persons/{name}/Images/{imageType}/{imageIndex}\n@desc Get person image by name.\n@required {name: str # Person name., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /Persons/{name}/Images/{imageType}/{imageIndex}\n@desc Get person image by name.\n@required {name: str # Person name., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endgroup\n\n@group Studios\n@endpoint GET /Studios/{name}/Images/{imageType}\n@desc Get studio image by name.\n@required {name: str # Studio name., imageType: str # Image type.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image., imageIndex: int(int32) # Image index.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /Studios/{name}/Images/{imageType}\n@desc Get studio image by name.\n@required {name: str # Studio name., imageType: str # Image type.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image., imageIndex: int(int32) # Image index.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint GET /Studios/{name}/Images/{imageType}/{imageIndex}\n@desc Get studio image by name.\n@required {name: str # Studio name., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /Studios/{name}/Images/{imageType}/{imageIndex}\n@desc Get studio image by name.\n@required {name: str # Studio name., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endgroup\n\n@group Users\n@endpoint POST /Users/{userId}/Images/{imageType}\n@desc Sets the user image.\n@required {userId: str(uuid) # User Id., imageType: str # (Unused) Image type.}\n@optional {index: int(int32) # (Unused) Image index.}\n@returns(204) Image updated.\n@errors {401: Unauthorized, 403: User does not have permission to delete the image.}\n\n@endpoint DELETE /Users/{userId}/Images/{imageType}\n@desc Delete the user's image.\n@required {userId: str(uuid) # User Id., imageType: str # (Unused) Image type.}\n@optional {index: int(int32) # (Unused) Image index.}\n@returns(204) Image deleted.\n@errors {401: Unauthorized, 403: User does not have permission to delete the image.}\n\n@endpoint GET /Users/{userId}/Images/{imageType}\n@desc Get user profile image.\n@required {userId: str(uuid) # User id., imageType: str # Image type.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image., imageIndex: int(int32) # Image index.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /Users/{userId}/Images/{imageType}\n@desc Get user profile image.\n@required {userId: str(uuid) # User id., imageType: str # Image type.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image., imageIndex: int(int32) # Image index.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint GET /Users/{userId}/Images/{imageType}/{imageIndex}\n@desc Get user profile image.\n@required {userId: str(uuid) # User id., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint HEAD /Users/{userId}/Images/{imageType}/{imageIndex}\n@desc Get user profile image.\n@required {userId: str(uuid) # User id., imageType: str # Image type., imageIndex: int(int32) # Image index.}\n@optional {tag: str # Optional. Supply the cache tag from the item object to receive strong caching headers., format: str # Determines the output format of the image - original,gif,jpg,png., maxWidth: int(int32) # The maximum image width to return., maxHeight: int(int32) # The maximum image height to return., percentPlayed: num(double) # Optional. Percent to render for the percent played overlay., unplayedCount: int(int32) # Optional. Unplayed count overlay to render., width: int(int32) # The fixed image width to return., height: int(int32) # The fixed image height to return., quality: int(int32) # Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases., cropWhitespace: bool # Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art., addPlayedIndicator: bool # Optional. Add a played indicator., blur: int(int32) # Optional. Blur image., backgroundColor: str # Optional. Apply a background color for transparent images., foregroundLayer: str # Optional. Apply a foreground layer on top of the image.}\n@returns(200) Image stream returned.\n@errors {404: Item not found.}\n\n@endpoint POST /Users/{userId}/Images/{imageType}/{index}\n@desc Sets the user image.\n@required {userId: str(uuid) # User Id., imageType: str # (Unused) Image type., index: int(int32) # (Unused) Image index.}\n@returns(204) Image updated.\n@errors {401: Unauthorized, 403: User does not have permission to delete the image.}\n\n@endpoint DELETE /Users/{userId}/Images/{imageType}/{index}\n@desc Delete the user's image.\n@required {userId: str(uuid) # User Id., imageType: str # (Unused) Image type., index: int(int32) # (Unused) Image index.}\n@returns(204) Image deleted.\n@errors {401: Unauthorized, 403: User does not have permission to delete the image.}\n\n@endgroup\n\n@group Images\n@endpoint GET /Images/General\n@desc Get all general images.\n@returns(200) Retrieved list of images.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Images/General/{name}/{type}\n@desc Get General Image.\n@required {name: str # The name of the image., type: str # Image Type (primary, backdrop, logo, etc).}\n@returns(200) Image stream retrieved.\n@errors {404: Image not found.}\n\n@endpoint GET /Images/MediaInfo\n@desc Get all media info images.\n@returns(200) Image list retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Images/MediaInfo/{theme}/{name}\n@desc Get media info image.\n@required {theme: str # The theme to get the image from., name: str # The name of the image.}\n@returns(200) Image stream retrieved.\n@errors {404: Image not found.}\n\n@endpoint GET /Images/Ratings\n@desc Get all general images.\n@returns(200) Retrieved list of images.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Images/Ratings/{theme}/{name}\n@desc Get rating image.\n@required {theme: str # The theme to get the image from., name: str # The name of the image.}\n@returns(200) Image stream retrieved.\n@errors {404: Image not found.}\n\n@endgroup\n\n@group Albums\n@endpoint GET /Albums/{id}/InstantMix\n@desc Creates an instant playlist based on a given song.\n@required {id: str(uuid) # The item id.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output., enableImages: bool # Optional. Include image information in output., enableUserData: bool # Optional. Include user data., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Instant playlist returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Artists\n@endpoint GET /Artists/{id}/InstantMix\n@desc Creates an instant playlist based on a given song.\n@required {id: str(uuid) # The item id.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output., enableImages: bool # Optional. Include image information in output., enableUserData: bool # Optional. Include user data., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Instant playlist returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Items\n@endpoint GET /Items/{id}/InstantMix\n@desc Creates an instant playlist based on a given song.\n@required {id: str(uuid) # The item id.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output., enableImages: bool # Optional. Include image information in output., enableUserData: bool # Optional. Include user data., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Instant playlist returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group MusicGenres\n@endpoint GET /MusicGenres/{id}/InstantMix\n@desc Creates an instant playlist based on a given song.\n@required {id: str(uuid) # The item id.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output., enableImages: bool # Optional. Include image information in output., enableUserData: bool # Optional. Include user data., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Instant playlist returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /MusicGenres/{name}/InstantMix\n@desc Creates an instant playlist based on a given song.\n@required {name: str # The genre name.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output., enableImages: bool # Optional. Include image information in output., enableUserData: bool # Optional. Include user data., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Instant playlist returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Playlists\n@endpoint GET /Playlists/{id}/InstantMix\n@desc Creates an instant playlist based on a given song.\n@required {id: str(uuid) # The item id.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output., enableImages: bool # Optional. Include image information in output., enableUserData: bool # Optional. Include user data., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Instant playlist returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Songs\n@endpoint GET /Songs/{id}/InstantMix\n@desc Creates an instant playlist based on a given song.\n@required {id: str(uuid) # The item id.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output., enableImages: bool # Optional. Include image information in output., enableUserData: bool # Optional. Include user data., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Instant playlist returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Items\n@endpoint GET /Items/{itemId}/ExternalIdInfos\n@desc Get the item's external id info.\n@required {itemId: str(uuid) # Item id.}\n@returns(200) External id info retrieved.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint POST /Items/RemoteSearch/Apply/{itemId}\n@desc Applies search criteria to an item and refreshes metadata.\n@required {itemId: str(uuid) # Item id.}\n@optional {replaceAllImages: bool=true # Optional. Whether or not to replace all images. Default: True., Name: str # Gets or sets the name., ProviderIds: map # Gets or sets the provider ids., ProductionYear: int(int32) # Gets or sets the year., IndexNumber: int(int32), IndexNumberEnd: int(int32), ParentIndexNumber: int(int32), PremiereDate: str(date-time), ImageUrl: str, SearchProviderName: str, Overview: str, AlbumArtist: map{Name: str, ProviderIds: map, ProductionYear: int(int32), IndexNumber: int(int32), IndexNumberEnd: int(int32), ParentIndexNumber: int(int32), PremiereDate: str(date-time), ImageUrl: str, SearchProviderName: str, Overview: str, AlbumArtist: map, Artists: [map]}, Artists: [map{Name: str, ProviderIds: map, ProductionYear: int(int32), IndexNumber: int(int32), IndexNumberEnd: int(int32), ParentIndexNumber: int(int32), PremiereDate: str(date-time), ImageUrl: str, SearchProviderName: str, Overview: str, AlbumArtist: map, Artists: [map]}]}\n@returns(204) Item metadata refreshed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Items/RemoteSearch/Book\n@desc Get book remote search.\n@optional {SearchInfo: map{Name: str, Path: str, MetadataLanguage: str, MetadataCountryCode: str, ProviderIds: map, Year: int(int32), IndexNumber: int(int32), ParentIndexNumber: int(int32), PremiereDate: str(date-time), IsAutomated: bool, SeriesName: str}, ItemId: str(uuid), SearchProviderName: str # Will only search within the given provider when set., IncludeDisabledProviders: bool # Gets or sets a value indicating whether disabled providers should be included.}\n@returns(200) Book remote search executed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Items/RemoteSearch/BoxSet\n@desc Get box set remote search.\n@optional {SearchInfo: map{Name: str, Path: str, MetadataLanguage: str, MetadataCountryCode: str, ProviderIds: map, Year: int(int32), IndexNumber: int(int32), ParentIndexNumber: int(int32), PremiereDate: str(date-time), IsAutomated: bool}, ItemId: str(uuid), SearchProviderName: str # Will only search within the given provider when set., IncludeDisabledProviders: bool # Gets or sets a value indicating whether disabled providers should be included.}\n@returns(200) Box set remote search executed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Items/RemoteSearch/Image\n@desc Gets a remote image.\n@required {imageUrl: str # The image url., providerName: str # The provider name.}\n@returns(200) Remote image retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Items/RemoteSearch/Movie\n@desc Get movie remote search.\n@optional {SearchInfo: map{Name: str, Path: str, MetadataLanguage: str, MetadataCountryCode: str, ProviderIds: map, Year: int(int32), IndexNumber: int(int32), ParentIndexNumber: int(int32), PremiereDate: str(date-time), IsAutomated: bool}, ItemId: str(uuid), SearchProviderName: str # Will only search within the given provider when set., IncludeDisabledProviders: bool # Gets or sets a value indicating whether disabled providers should be included.}\n@returns(200) Movie remote search executed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Items/RemoteSearch/MusicAlbum\n@desc Get music album remote search.\n@optional {SearchInfo: map{Name: str, Path: str, MetadataLanguage: str, MetadataCountryCode: str, ProviderIds: map, Year: int(int32), IndexNumber: int(int32), ParentIndexNumber: int(int32), PremiereDate: str(date-time), IsAutomated: bool, AlbumArtists: [str], ArtistProviderIds: map, SongInfos: [map]}, ItemId: str(uuid), SearchProviderName: str # Will only search within the given provider when set., IncludeDisabledProviders: bool # Gets or sets a value indicating whether disabled providers should be included.}\n@returns(200) Music album remote search executed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Items/RemoteSearch/MusicArtist\n@desc Get music artist remote search.\n@optional {SearchInfo: map{Name: str, Path: str, MetadataLanguage: str, MetadataCountryCode: str, ProviderIds: map, Year: int(int32), IndexNumber: int(int32), ParentIndexNumber: int(int32), PremiereDate: str(date-time), IsAutomated: bool, SongInfos: [map]}, ItemId: str(uuid), SearchProviderName: str # Will only search within the given provider when set., IncludeDisabledProviders: bool # Gets or sets a value indicating whether disabled providers should be included.}\n@returns(200) Music artist remote search executed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Items/RemoteSearch/MusicVideo\n@desc Get music video remote search.\n@optional {SearchInfo: map{Name: str, Path: str, MetadataLanguage: str, MetadataCountryCode: str, ProviderIds: map, Year: int(int32), IndexNumber: int(int32), ParentIndexNumber: int(int32), PremiereDate: str(date-time), IsAutomated: bool, Artists: [str]}, ItemId: str(uuid), SearchProviderName: str # Will only search within the given provider when set., IncludeDisabledProviders: bool # Gets or sets a value indicating whether disabled providers should be included.}\n@returns(200) Music video remote search executed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Items/RemoteSearch/Person\n@desc Get person remote search.\n@optional {SearchInfo: map{Name: str, Path: str, MetadataLanguage: str, MetadataCountryCode: str, ProviderIds: map, Year: int(int32), IndexNumber: int(int32), ParentIndexNumber: int(int32), PremiereDate: str(date-time), IsAutomated: bool}, ItemId: str(uuid), SearchProviderName: str # Will only search within the given provider when set., IncludeDisabledProviders: bool # Gets or sets a value indicating whether disabled providers should be included.}\n@returns(200) Person remote search executed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Items/RemoteSearch/Series\n@desc Get series remote search.\n@optional {SearchInfo: map{Name: str, Path: str, MetadataLanguage: str, MetadataCountryCode: str, ProviderIds: map, Year: int(int32), IndexNumber: int(int32), ParentIndexNumber: int(int32), PremiereDate: str(date-time), IsAutomated: bool}, ItemId: str(uuid), SearchProviderName: str # Will only search within the given provider when set., IncludeDisabledProviders: bool # Gets or sets a value indicating whether disabled providers should be included.}\n@returns(200) Series remote search executed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Items/RemoteSearch/Trailer\n@desc Get trailer remote search.\n@optional {SearchInfo: map{Name: str, Path: str, MetadataLanguage: str, MetadataCountryCode: str, ProviderIds: map, Year: int(int32), IndexNumber: int(int32), ParentIndexNumber: int(int32), PremiereDate: str(date-time), IsAutomated: bool}, ItemId: str(uuid), SearchProviderName: str # Will only search within the given provider when set., IncludeDisabledProviders: bool # Gets or sets a value indicating whether disabled providers should be included.}\n@returns(200) Trailer remote search executed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Items/{itemId}/Refresh\n@desc Refreshes metadata for an item.\n@required {itemId: str(uuid) # Item id.}\n@optional {metadataRefreshMode: str # (Optional) Specifies the metadata refresh mode., imageRefreshMode: str # (Optional) Specifies the image refresh mode., replaceAllMetadata: bool=false # (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh., replaceAllImages: bool=false # (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.}\n@returns(204) Item metadata refresh queued.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item to refresh not found.}\n\n@endpoint GET /Items\n@desc Gets items based on a query.\n@optional {userId: str(uuid) # The user id supplied as query parameter., maxOfficialRating: str # Optional filter by maximum official rating (PG, PG-13, TV-MA, etc)., hasThemeSong: bool # Optional filter by items with theme songs., hasThemeVideo: bool # Optional filter by items with theme videos., hasSubtitles: bool # Optional filter by items with subtitles., hasSpecialFeature: bool # Optional filter by items with special features., hasTrailer: bool # Optional filter by items with trailers., adjacentTo: str # Optional. Return items that are siblings of a supplied item., parentIndexNumber: int(int32) # Optional filter by parent index number., hasParentalRating: bool # Optional filter by items that have or do not have a parental rating., isHd: bool # Optional filter by items that are HD or not., is4K: bool # Optional filter by items that are 4K or not., locationTypes: [str] # Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited., excludeLocationTypes: [str] # Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited., isMissing: bool # Optional filter by items that are missing episodes or not., isUnaired: bool # Optional filter by items that are unaired episodes or not., minCommunityRating: num(double) # Optional filter by minimum community rating., minCriticRating: num(double) # Optional filter by minimum critic rating., minPremiereDate: str(date-time) # Optional. The minimum premiere date. Format = ISO., minDateLastSaved: str(date-time) # Optional. The minimum last saved date. Format = ISO., minDateLastSavedForUser: str(date-time) # Optional. The minimum last saved date for the current user. Format = ISO., maxPremiereDate: str(date-time) # Optional. The maximum premiere date. Format = ISO., hasOverview: bool # Optional filter by items that have an overview or not., hasImdbId: bool # Optional filter by items that have an imdb id or not., hasTmdbId: bool # Optional filter by items that have a tmdb id or not., hasTvdbId: bool # Optional filter by items that have a tvdb id or not., excludeItemIds: [str(uuid)] # Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., recursive: bool # When searching within folders, this determines whether or not the search will be recursive. true/false., searchTerm: str # Optional. Filter based on a search term., sortOrder: str # Sort Order - Ascending,Descending., parentId: str(uuid) # Specify this to localize the search to a specific item or folder. Omit to use the root., fields: [str] # Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines., excludeItemTypes: [str] # Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited., includeItemTypes: [str] # Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited., filters: [str] # Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes., isFavorite: bool # Optional filter by items that are marked as favorite, or not., mediaTypes: [str] # Optional filter by MediaType. Allows multiple, comma delimited., imageTypes: [str] # Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited., sortBy: str # Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime., isPlayed: bool # Optional filter by items that are played, or not., genres: [str] # Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited., officialRatings: [str] # Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited., tags: [str] # Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited., years: [int(int32)] # Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited., enableUserData: bool # Optional, include user data., imageTypeLimit: int(int32) # Optional, the max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., person: str # Optional. If specified, results will be filtered to include only those containing the specified person., personIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified person id., personTypes: [str] # Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited., studios: [str] # Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited., artists: [str] # Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited., excludeArtistIds: [str(uuid)] # Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited., artistIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified artist id., albumArtistIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified album artist id., contributingArtistIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified contributing artist id., albums: [str] # Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited., albumIds: [str(uuid)] # Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited., ids: [str(uuid)] # Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited., videoTypes: [str] # Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited., minOfficialRating: str # Optional filter by minimum official rating (PG, PG-13, TV-MA, etc)., isLocked: bool # Optional filter by items that are locked., isPlaceHolder: bool # Optional filter by items that are placeholders., hasOfficialRating: bool # Optional filter by items that have official ratings., collapseBoxSetItems: bool # Whether or not to hide items behind their boxsets., minWidth: int(int32) # Optional. Filter by the minimum width of the item., minHeight: int(int32) # Optional. Filter by the minimum height of the item., maxWidth: int(int32) # Optional. Filter by the maximum width of the item., maxHeight: int(int32) # Optional. Filter by the maximum height of the item., is3D: bool # Optional filter by items that are 3D, or not., seriesStatus: [str] # Optional filter by Series Status. Allows multiple, comma delimited., nameStartsWithOrGreater: str # Optional filter by items whose name is sorted equally or greater than a given input string., nameStartsWith: str # Optional filter by items whose name is sorted equally than a given input string., nameLessThan: str # Optional filter by items whose name is equally or lesser than a given input string., studioIds: [str(uuid)] # Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited., genreIds: [str(uuid)] # Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited., enableTotalRecordCount: bool=true # Optional. Enable the total record count., enableImages: bool=true # Optional, include image information in output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Success\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Items\n@desc Deletes items from the library and filesystem.\n@optional {ids: [str(uuid)] # The item ids.}\n@returns(204) Items deleted.\n@errors {401: Unauthorized access., 403: Forbidden}\n\n@endgroup\n\n@group Users\n@endpoint GET /Users/{userId}/Items\n@desc Gets items based on a query.\n@required {userId: str(uuid) # The user id supplied as query parameter.}\n@optional {maxOfficialRating: str # Optional filter by maximum official rating (PG, PG-13, TV-MA, etc)., hasThemeSong: bool # Optional filter by items with theme songs., hasThemeVideo: bool # Optional filter by items with theme videos., hasSubtitles: bool # Optional filter by items with subtitles., hasSpecialFeature: bool # Optional filter by items with special features., hasTrailer: bool # Optional filter by items with trailers., adjacentTo: str # Optional. Return items that are siblings of a supplied item., parentIndexNumber: int(int32) # Optional filter by parent index number., hasParentalRating: bool # Optional filter by items that have or do not have a parental rating., isHd: bool # Optional filter by items that are HD or not., is4K: bool # Optional filter by items that are 4K or not., locationTypes: [str] # Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimeted., excludeLocationTypes: [str] # Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimeted., isMissing: bool # Optional filter by items that are missing episodes or not., isUnaired: bool # Optional filter by items that are unaired episodes or not., minCommunityRating: num(double) # Optional filter by minimum community rating., minCriticRating: num(double) # Optional filter by minimum critic rating., minPremiereDate: str(date-time) # Optional. The minimum premiere date. Format = ISO., minDateLastSaved: str(date-time) # Optional. The minimum last saved date. Format = ISO., minDateLastSavedForUser: str(date-time) # Optional. The minimum last saved date for the current user. Format = ISO., maxPremiereDate: str(date-time) # Optional. The maximum premiere date. Format = ISO., hasOverview: bool # Optional filter by items that have an overview or not., hasImdbId: bool # Optional filter by items that have an imdb id or not., hasTmdbId: bool # Optional filter by items that have a tmdb id or not., hasTvdbId: bool # Optional filter by items that have a tvdb id or not., excludeItemIds: [str(uuid)] # Optional. If specified, results will be filtered by exxcluding item ids. This allows multiple, comma delimeted., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., recursive: bool # When searching within folders, this determines whether or not the search will be recursive. true/false., searchTerm: str # Optional. Filter based on a search term., sortOrder: str # Sort Order - Ascending,Descending., parentId: str(uuid) # Specify this to localize the search to a specific item or folder. Omit to use the root., fields: [str] # Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines., excludeItemTypes: [str] # Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted., includeItemTypes: [str] # Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimeted., filters: [str] # Optional. Specify additional filters to apply. This allows multiple, comma delimeted. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes., isFavorite: bool # Optional filter by items that are marked as favorite, or not., mediaTypes: [str] # Optional filter by MediaType. Allows multiple, comma delimited., imageTypes: [str] # Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited., sortBy: str # Optional. Specify one or more sort orders, comma delimeted. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime., isPlayed: bool # Optional filter by items that are played, or not., genres: [str] # Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimeted., officialRatings: [str] # Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimeted., tags: [str] # Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimeted., years: [int(int32)] # Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimeted., enableUserData: bool # Optional, include user data., imageTypeLimit: int(int32) # Optional, the max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., person: str # Optional. If specified, results will be filtered to include only those containing the specified person., personIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified person id., personTypes: [str] # Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited., studios: [str] # Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimeted., artists: [str] # Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimeted., excludeArtistIds: [str(uuid)] # Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimeted., artistIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified artist id., albumArtistIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified album artist id., contributingArtistIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified contributing artist id., albums: [str] # Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimeted., albumIds: [str(uuid)] # Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimeted., ids: [str(uuid)] # Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited., videoTypes: [str] # Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimeted., minOfficialRating: str # Optional filter by minimum official rating (PG, PG-13, TV-MA, etc)., isLocked: bool # Optional filter by items that are locked., isPlaceHolder: bool # Optional filter by items that are placeholders., hasOfficialRating: bool # Optional filter by items that have official ratings., collapseBoxSetItems: bool # Whether or not to hide items behind their boxsets., minWidth: int(int32) # Optional. Filter by the minimum width of the item., minHeight: int(int32) # Optional. Filter by the minimum height of the item., maxWidth: int(int32) # Optional. Filter by the maximum width of the item., maxHeight: int(int32) # Optional. Filter by the maximum height of the item., is3D: bool # Optional filter by items that are 3D, or not., seriesStatus: [str] # Optional filter by Series Status. Allows multiple, comma delimeted., nameStartsWithOrGreater: str # Optional filter by items whose name is sorted equally or greater than a given input string., nameStartsWith: str # Optional filter by items whose name is sorted equally than a given input string., nameLessThan: str # Optional filter by items whose name is equally or lesser than a given input string., studioIds: [str(uuid)] # Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimeted., genreIds: [str(uuid)] # Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimeted., enableTotalRecordCount: bool=true # Optional. Enable the total record count., enableImages: bool=true # Optional, include image information in output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Success\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Users/{userId}/Items/Resume\n@desc Gets items based on a query.\n@required {userId: str(uuid) # The user id.}\n@optional {startIndex: int(int32) # The start index., limit: int(int32) # The item limit., searchTerm: str # The search term., parentId: str(uuid) # Specify this to localize the search to a specific item or folder. Omit to use the root., fields: [str] # Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines., mediaTypes: [str] # Optional. Filter by MediaType. Allows multiple, comma delimited., enableUserData: bool # Optional. Include user data., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., excludeItemTypes: [str] # Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited., includeItemTypes: [str] # Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited., enableTotalRecordCount: bool=true # Optional. Enable the total record count., enableImages: bool=true # Optional. Include image information in output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Items returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Items\n@endpoint POST /Items/{itemId}\n@desc Updates an item.\n@required {itemId: str(uuid) # The item id.}\n@optional {Name: str # Gets or sets the name., OriginalTitle: str, ServerId: str # Gets or sets the server identifier., Id: str(uuid) # Gets or sets the id., Etag: str # Gets or sets the etag., SourceType: str # Gets or sets the type of the source., PlaylistItemId: str # Gets or sets the playlist item identifier., DateCreated: str(date-time) # Gets or sets the date created., DateLastMediaAdded: str(date-time), ExtraType: str, AirsBeforeSeasonNumber: int(int32), AirsAfterSeasonNumber: int(int32), AirsBeforeEpisodeNumber: int(int32), CanDelete: bool, CanDownload: bool, HasSubtitles: bool, PreferredMetadataLanguage: str, PreferredMetadataCountryCode: str, SupportsSync: bool # Gets or sets a value indicating whether [supports synchronize]., Container: str, SortName: str # Gets or sets the name of the sort., ForcedSortName: str, Video3DFormat: str(HalfSideBySide/FullSideBySide/FullTopAndBottom/HalfTopAndBottom/MVC), PremiereDate: str(date-time) # Gets or sets the premiere date., ExternalUrls: [map{Name: str, Url: str}] # Gets or sets the external urls., MediaSources: [map{Protocol: str, Id: str, Path: str, EncoderPath: str, EncoderProtocol: str, Type: str, Container: str, Size: int(int64), Name: str, IsRemote: bool, ETag: str, RunTimeTicks: int(int64), ReadAtNativeFramerate: bool, IgnoreDts: bool, IgnoreIndex: bool, GenPtsInput: bool, SupportsTranscoding: bool, SupportsDirectStream: bool, SupportsDirectPlay: bool, IsInfiniteStream: bool, RequiresOpening: bool, OpenToken: str, RequiresClosing: bool, LiveStreamId: str, BufferMs: int(int32), RequiresLooping: bool, SupportsProbing: bool, VideoType: str, IsoType: str, Video3DFormat: str, MediaStreams: [map], MediaAttachments: [map], Formats: [str], Bitrate: int(int32), Timestamp: str, RequiredHttpHeaders: map, TranscodingUrl: str, TranscodingSubProtocol: str, TranscodingContainer: str, AnalyzeDurationMs: int(int32), DefaultAudioStreamIndex: int(int32), DefaultSubtitleStreamIndex: int(int32)}] # Gets or sets the media versions., CriticRating: num(float) # Gets or sets the critic rating., ProductionLocations: [str], Path: str # Gets or sets the path., EnableMediaSourceDisplay: bool, OfficialRating: str # Gets or sets the official rating., CustomRating: str # Gets or sets the custom rating., ChannelId: str(uuid) # Gets or sets the channel identifier., ChannelName: str, Overview: str # Gets or sets the overview., Taglines: [str] # Gets or sets the taglines., Genres: [str] # Gets or sets the genres., CommunityRating: num(float) # Gets or sets the community rating., CumulativeRunTimeTicks: int(int64) # Gets or sets the cumulative run time ticks., RunTimeTicks: int(int64) # Gets or sets the run time ticks., PlayAccess: str(Full/None), AspectRatio: str # Gets or sets the aspect ratio., ProductionYear: int(int32) # Gets or sets the production year., IsPlaceHolder: bool # Gets or sets a value indicating whether this instance is place holder., Number: str # Gets or sets the number., ChannelNumber: str, IndexNumber: int(int32) # Gets or sets the index number., IndexNumberEnd: int(int32) # Gets or sets the index number end., ParentIndexNumber: int(int32) # Gets or sets the parent index number., RemoteTrailers: [map{Url: str, Name: str}] # Gets or sets the trailer urls., ProviderIds: map # Gets or sets the provider ids., IsHD: bool # Gets or sets a value indicating whether this instance is HD., IsFolder: bool # Gets or sets a value indicating whether this instance is folder., ParentId: str(uuid) # Gets or sets the parent id., Type: str # Gets or sets the type., People: [map{Name: str, Id: str, Role: str, Type: str, PrimaryImageTag: str, ImageBlurHashes: map}] # Gets or sets the people., Studios: [map{Name: str, Id: str(uuid)}] # Gets or sets the studios., GenreItems: [map{Name: str, Id: str(uuid)}], ParentLogoItemId: str # If the item does not have a logo, this will hold the Id of the Parent that has one., ParentBackdropItemId: str # If the item does not have any backdrops, this will hold the Id of the Parent that has one., ParentBackdropImageTags: [str] # Gets or sets the parent backdrop image tags., LocalTrailerCount: int(int32) # Gets or sets the local trailer count., UserData: map{Rating: num(double), PlayedPercentage: num(double), UnplayedItemCount: int(int32), PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool, LastPlayedDate: str(date-time), Played: bool, Key: str, ItemId: str} # Class UserItemDataDto., RecursiveItemCount: int(int32) # Gets or sets the recursive item count., ChildCount: int(int32) # Gets or sets the child count., SeriesName: str # Gets or sets the name of the series., SeriesId: str(uuid) # Gets or sets the series id., SeasonId: str(uuid) # Gets or sets the season identifier., SpecialFeatureCount: int(int32) # Gets or sets the special feature count., DisplayPreferencesId: str # Gets or sets the display preferences id., Status: str # Gets or sets the status., AirTime: str # Gets or sets the air time., AirDays: [str] # Gets or sets the air days., Tags: [str] # Gets or sets the tags., PrimaryImageAspectRatio: num(double) # Gets or sets the primary image aspect ratio, after image enhancements., Artists: [str] # Gets or sets the artists., ArtistItems: [map{Name: str, Id: str(uuid)}] # Gets or sets the artist items., Album: str # Gets or sets the album., CollectionType: str # Gets or sets the type of the collection., DisplayOrder: str # Gets or sets the display order., AlbumId: str(uuid) # Gets or sets the album id., AlbumPrimaryImageTag: str # Gets or sets the album image tag., SeriesPrimaryImageTag: str # Gets or sets the series primary image tag., AlbumArtist: str # Gets or sets the album artist., AlbumArtists: [map{Name: str, Id: str(uuid)}] # Gets or sets the album artists., SeasonName: str # Gets or sets the name of the season., MediaStreams: [map{Codec: str, CodecTag: str, Language: str, ColorRange: str, ColorSpace: str, ColorTransfer: str, ColorPrimaries: str, Comment: str, TimeBase: str, CodecTimeBase: str, Title: str, VideoRange: str, localizedUndefined: str, localizedDefault: str, localizedForced: str, DisplayTitle: str, NalLengthSize: str, IsInterlaced: bool, IsAVC: bool, ChannelLayout: str, BitRate: int(int32), BitDepth: int(int32), RefFrames: int(int32), PacketLength: int(int32), Channels: int(int32), SampleRate: int(int32), IsDefault: bool, IsForced: bool, Height: int(int32), Width: int(int32), AverageFrameRate: num(float), RealFrameRate: num(float), Profile: str, Type: str, AspectRatio: str, Index: int(int32), Score: int(int32), IsExternal: bool, DeliveryMethod: str, DeliveryUrl: str, IsExternalUrl: bool, IsTextSubtitleStream: bool, SupportsExternalStream: bool, Path: str, PixelFormat: str, Level: num(double), IsAnamorphic: bool}] # Gets or sets the media streams., VideoType: str(VideoFile/Iso/Dvd/BluRay) # Enum VideoType., PartCount: int(int32) # Gets or sets the part count., MediaSourceCount: int(int32), ImageTags: map # Gets or sets the image tags., BackdropImageTags: [str] # Gets or sets the backdrop image tags., ScreenshotImageTags: [str] # Gets or sets the screenshot image tags., ParentLogoImageTag: str # Gets or sets the parent logo image tag., ParentArtItemId: str # If the item does not have a art, this will hold the Id of the Parent that has one., ParentArtImageTag: str # Gets or sets the parent art image tag., SeriesThumbImageTag: str # Gets or sets the series thumb image tag., ImageBlurHashes: map{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map} # Gets or sets the blurhashes for the image tags.\r Maps image type to dictionary mapping image tag to blurhash value., SeriesStudio: str # Gets or sets the series studio., ParentThumbItemId: str # Gets or sets the parent thumb item id., ParentThumbImageTag: str # Gets or sets the parent thumb image tag., ParentPrimaryImageItemId: str # Gets or sets the parent primary image item identifier., ParentPrimaryImageTag: str # Gets or sets the parent primary image tag., Chapters: [map{StartPositionTicks: int(int64), Name: str, ImagePath: str, ImageDateModified: str(date-time), ImageTag: str}] # Gets or sets the chapters., LocationType: str(FileSystem/Remote/Virtual/Offline) # Enum LocationType., IsoType: str(Dvd/BluRay) # Enum IsoType., MediaType: str # Gets or sets the type of the media., EndDate: str(date-time) # Gets or sets the end date., LockedFields: [str] # Gets or sets the locked fields., TrailerCount: int(int32) # Gets or sets the trailer count., MovieCount: int(int32) # Gets or sets the movie count., SeriesCount: int(int32) # Gets or sets the series count., ProgramCount: int(int32), EpisodeCount: int(int32) # Gets or sets the episode count., SongCount: int(int32) # Gets or sets the song count., AlbumCount: int(int32) # Gets or sets the album count., ArtistCount: int(int32), MusicVideoCount: int(int32) # Gets or sets the music video count., LockData: bool # Gets or sets a value indicating whether [enable internet providers]., Width: int(int32), Height: int(int32), CameraMake: str, CameraModel: str, Software: str, ExposureTime: num(double), FocalLength: num(double), ImageOrientation: str(TopLeft/TopRight/BottomRight/BottomLeft/LeftTop/RightTop/RightBottom/LeftBottom), Aperture: num(double), ShutterSpeed: num(double), Latitude: num(double), Longitude: num(double), Altitude: num(double), IsoSpeedRating: int(int32), SeriesTimerId: str # Gets or sets the series timer identifier., ProgramId: str # Gets or sets the program identifier., ChannelPrimaryImageTag: str # Gets or sets the channel primary image tag., StartDate: str(date-time) # The start date of the recording, in UTC., CompletionPercentage: num(double) # Gets or sets the completion percentage., IsRepeat: bool # Gets or sets a value indicating whether this instance is repeat., EpisodeTitle: str # Gets or sets the episode title., ChannelType: str(TV/Radio) # Enum ChannelType., Audio: str(Mono/Stereo/Dolby/DolbyDigital/Thx/Atmos), IsMovie: bool # Gets or sets a value indicating whether this instance is movie., IsSports: bool # Gets or sets a value indicating whether this instance is sports., IsSeries: bool # Gets or sets a value indicating whether this instance is series., IsLive: bool # Gets or sets a value indicating whether this instance is live., IsNews: bool # Gets or sets a value indicating whether this instance is news., IsKids: bool # Gets or sets a value indicating whether this instance is kids., IsPremiere: bool # Gets or sets a value indicating whether this instance is premiere., TimerId: str # Gets or sets the timer identifier., CurrentProgram: map{Name: str, OriginalTitle: str, ServerId: str, Id: str(uuid), Etag: str, SourceType: str, PlaylistItemId: str, DateCreated: str(date-time), DateLastMediaAdded: str(date-time), ExtraType: str, AirsBeforeSeasonNumber: int(int32), AirsAfterSeasonNumber: int(int32), AirsBeforeEpisodeNumber: int(int32), CanDelete: bool, CanDownload: bool, HasSubtitles: bool, PreferredMetadataLanguage: str, PreferredMetadataCountryCode: str, SupportsSync: bool, Container: str, SortName: str, ForcedSortName: str, Video3DFormat: str, PremiereDate: str(date-time), ExternalUrls: [map], MediaSources: [map], CriticRating: num(float), ProductionLocations: [str], Path: str, EnableMediaSourceDisplay: bool, OfficialRating: str, CustomRating: str, ChannelId: str(uuid), ChannelName: str, Overview: str, Taglines: [str], Genres: [str], CommunityRating: num(float), CumulativeRunTimeTicks: int(int64), RunTimeTicks: int(int64), PlayAccess: str, AspectRatio: str, ProductionYear: int(int32), IsPlaceHolder: bool, Number: str, ChannelNumber: str, IndexNumber: int(int32), IndexNumberEnd: int(int32), ParentIndexNumber: int(int32), RemoteTrailers: [map], ProviderIds: map, IsHD: bool, IsFolder: bool, ParentId: str(uuid), Type: str, People: [map], Studios: [map], GenreItems: [map], ParentLogoItemId: str, ParentBackdropItemId: str, ParentBackdropImageTags: [str], LocalTrailerCount: int(int32), UserData: map, RecursiveItemCount: int(int32), ChildCount: int(int32), SeriesName: str, SeriesId: str(uuid), SeasonId: str(uuid), SpecialFeatureCount: int(int32), DisplayPreferencesId: str, Status: str, AirTime: str, AirDays: [str], Tags: [str], PrimaryImageAspectRatio: num(double), Artists: [str], ArtistItems: [map], Album: str, CollectionType: str, DisplayOrder: str, AlbumId: str(uuid), AlbumPrimaryImageTag: str, SeriesPrimaryImageTag: str, AlbumArtist: str, AlbumArtists: [map], SeasonName: str, MediaStreams: [map], VideoType: str, PartCount: int(int32), MediaSourceCount: int(int32), ImageTags: map, BackdropImageTags: [str], ScreenshotImageTags: [str], ParentLogoImageTag: str, ParentArtItemId: str, ParentArtImageTag: str, SeriesThumbImageTag: str, ImageBlurHashes: map, SeriesStudio: str, ParentThumbItemId: str, ParentThumbImageTag: str, ParentPrimaryImageItemId: str, ParentPrimaryImageTag: str, Chapters: [map], LocationType: str, IsoType: str, MediaType: str, EndDate: str(date-time), LockedFields: [str], TrailerCount: int(int32), MovieCount: int(int32), SeriesCount: int(int32), ProgramCount: int(int32), EpisodeCount: int(int32), SongCount: int(int32), AlbumCount: int(int32), ArtistCount: int(int32), MusicVideoCount: int(int32), LockData: bool, Width: int(int32), Height: int(int32), CameraMake: str, CameraModel: str, Software: str, ExposureTime: num(double), FocalLength: num(double), ImageOrientation: str, Aperture: num(double), ShutterSpeed: num(double), Latitude: num(double), Longitude: num(double), Altitude: num(double), IsoSpeedRating: int(int32), SeriesTimerId: str, ProgramId: str, ChannelPrimaryImageTag: str, StartDate: str(date-time), CompletionPercentage: num(double), IsRepeat: bool, EpisodeTitle: str, ChannelType: str, Audio: str, IsMovie: bool, IsSports: bool, IsSeries: bool, IsLive: bool, IsNews: bool, IsKids: bool, IsPremiere: bool, TimerId: str, CurrentProgram: map} # This is strictly used as a data transfer object from the api layer.\r This holds information about a BaseItem in a format that is convenient for the client.}\n@returns(204) Item updated.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint DELETE /Items/{itemId}\n@desc Deletes an item from the library and filesystem.\n@required {itemId: str(uuid) # The item id.}\n@returns(204) Item deleted.\n@errors {401: Unauthorized access., 403: Forbidden}\n\n@endpoint POST /Items/{itemId}/ContentType\n@desc Updates an item's content type.\n@required {itemId: str(uuid) # The item id.}\n@optional {contentType: str # The content type of the item.}\n@returns(204) Item content type updated.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint GET /Items/{itemId}/MetadataEditor\n@desc Gets metadata editor info for an item.\n@required {itemId: str(uuid) # The item id.}\n@returns(200) {ParentalRatingOptions: [map]?, Countries: [map]?, Cultures: [map]?, ExternalIdInfos: [map]?, ContentType: str?, ContentTypeOptions: [map]?} # Item metadata editor returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endgroup\n\n@group Albums\n@endpoint GET /Albums/{itemId}/Similar\n@desc Gets similar items.\n@required {itemId: str(uuid) # The item id.}\n@optional {excludeArtistIds: [str(uuid)] # Exclude artist ids., userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Similar items returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Artists\n@endpoint GET /Artists/{itemId}/Similar\n@desc Gets similar items.\n@required {itemId: str(uuid) # The item id.}\n@optional {excludeArtistIds: [str(uuid)] # Exclude artist ids., userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Similar items returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Items\n@endpoint GET /Items/{itemId}/Ancestors\n@desc Gets all parents of an item.\n@required {itemId: str(uuid) # The item id.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data.}\n@returns(200) Item parents returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint GET /Items/{itemId}/CriticReviews\n@desc Gets critic review for an item.\n@required {itemId: str}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Critic reviews returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Items/{itemId}/Download\n@desc Downloads item media.\n@required {itemId: str(uuid) # The item id.}\n@returns(200) Media downloaded.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint GET /Items/{itemId}/File\n@desc Get the original file of an item.\n@required {itemId: str(uuid) # The item id.}\n@returns(200) File stream returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint GET /Items/{itemId}/Similar\n@desc Gets similar items.\n@required {itemId: str(uuid) # The item id.}\n@optional {excludeArtistIds: [str(uuid)] # Exclude artist ids., userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Similar items returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Items/{itemId}/ThemeMedia\n@desc Get theme songs and videos for an item.\n@required {itemId: str(uuid) # The item id.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data., inheritFromParent: bool=false # Optional. Determines whether or not parent items should be searched for theme media.}\n@returns(200) {ThemeVideosResult: map{Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32), OwnerId: str(uuid)}, ThemeSongsResult: map{Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32), OwnerId: str(uuid)}, SoundtrackSongsResult: map{Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32), OwnerId: str(uuid)}} # Theme songs and videos returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint GET /Items/{itemId}/ThemeSongs\n@desc Get theme songs for an item.\n@required {itemId: str(uuid) # The item id.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data., inheritFromParent: bool=false # Optional. Determines whether or not parent items should be searched for theme media.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32), OwnerId: str(uuid)} # Theme songs returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint GET /Items/{itemId}/ThemeVideos\n@desc Get theme videos for an item.\n@required {itemId: str(uuid) # The item id.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data., inheritFromParent: bool=false # Optional. Determines whether or not parent items should be searched for theme media.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32), OwnerId: str(uuid)} # Theme videos returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint GET /Items/Counts\n@desc Get item counts.\n@optional {userId: str(uuid) # Optional. Get counts from a specific user's library., isFavorite: bool # Optional. Get counts of favorite items.}\n@returns(200) {MovieCount: int(int32), SeriesCount: int(int32), EpisodeCount: int(int32), ArtistCount: int(int32), ProgramCount: int(int32), TrailerCount: int(int32), SongCount: int(int32), AlbumCount: int(int32), MusicVideoCount: int(int32), BoxSetCount: int(int32), BookCount: int(int32), ItemCount: int(int32)} # Item counts returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Libraries\n@endpoint GET /Libraries/AvailableOptions\n@desc Gets the library options info.\n@optional {libraryContentType: str # Library content type., isNewLibrary: bool # Whether this is a new library.}\n@returns(200) {MetadataSavers: [map]?, MetadataReaders: [map]?, SubtitleFetchers: [map]?, TypeOptions: [map]?} # Library options info returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Library\n@endpoint POST /Library/Media/Updated\n@desc Reports that new movies have been added by an external source.\n@returns(204) Report success.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Library/MediaFolders\n@desc Gets all user media folders.\n@optional {isHidden: bool # Optional. Filter by folders that are marked hidden, or not.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Media folders returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Library/Movies/Added\n@desc Reports that new movies have been added by an external source.\n@optional {tmdbId: str # The tmdbId., imdbId: str # The imdbId.}\n@returns(204) Report success.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Library/Movies/Updated\n@desc Reports that new movies have been added by an external source.\n@optional {tmdbId: str # The tmdbId., imdbId: str # The imdbId.}\n@returns(204) Report success.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Library/PhysicalPaths\n@desc Gets a list of physical paths from virtual folders.\n@returns(200) Physical paths returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Library/Refresh\n@desc Starts a library scan.\n@returns(204) Library scan started.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Library/Series/Added\n@desc Reports that new episodes of a series have been added by an external source.\n@optional {tvdbId: str # The tvdbId.}\n@returns(204) Report success.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Library/Series/Updated\n@desc Reports that new episodes of a series have been added by an external source.\n@optional {tvdbId: str # The tvdbId.}\n@returns(204) Report success.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Movies\n@endpoint GET /Movies/{itemId}/Similar\n@desc Gets similar items.\n@required {itemId: str(uuid) # The item id.}\n@optional {excludeArtistIds: [str(uuid)] # Exclude artist ids., userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Similar items returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Shows\n@endpoint GET /Shows/{itemId}/Similar\n@desc Gets similar items.\n@required {itemId: str(uuid) # The item id.}\n@optional {excludeArtistIds: [str(uuid)] # Exclude artist ids., userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Similar items returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Trailers\n@endpoint GET /Trailers/{itemId}/Similar\n@desc Gets similar items.\n@required {itemId: str(uuid) # The item id.}\n@optional {excludeArtistIds: [str(uuid)] # Exclude artist ids., userId: str(uuid) # Optional. Filter by user id, and attach user data., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Similar items returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Library\n@endpoint GET /Library/VirtualFolders\n@desc Gets all virtual folders.\n@returns(200) Virtual folders retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Library/VirtualFolders\n@desc Adds a virtual folder.\n@optional {name: str # The name of the virtual folder., collectionType: str # The type of the collection., paths: [str] # The paths of the virtual folder., refreshLibrary: bool=false # Whether to refresh the library., LibraryOptions: map{EnablePhotos: bool, EnableRealtimeMonitor: bool, EnableChapterImageExtraction: bool, ExtractChapterImagesDuringLibraryScan: bool, PathInfos: [map], SaveLocalMetadata: bool, EnableInternetProviders: bool, EnableAutomaticSeriesGrouping: bool, EnableEmbeddedTitles: bool, EnableEmbeddedEpisodeInfos: bool, AutomaticRefreshIntervalDays: int(int32), PreferredMetadataLanguage: str, MetadataCountryCode: str, SeasonZeroDisplayName: str, MetadataSavers: [str], DisabledLocalMetadataReaders: [str], LocalMetadataReaderOrder: [str], DisabledSubtitleFetchers: [str], SubtitleFetcherOrder: [str], SkipSubtitlesIfEmbeddedSubtitlesPresent: bool, SkipSubtitlesIfAudioTrackMatches: bool, SubtitleDownloadLanguages: [str], RequirePerfectSubtitleMatch: bool, SaveSubtitlesWithMedia: bool, TypeOptions: [map]}}\n@returns(204) Folder added.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Library/VirtualFolders\n@desc Removes a virtual folder.\n@optional {name: str # The name of the folder., refreshLibrary: bool=false # Whether to refresh the library.}\n@returns(204) Folder removed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Library/VirtualFolders/LibraryOptions\n@desc Update library options.\n@optional {Id: str(uuid) # Gets or sets the library item id., LibraryOptions: map{EnablePhotos: bool, EnableRealtimeMonitor: bool, EnableChapterImageExtraction: bool, ExtractChapterImagesDuringLibraryScan: bool, PathInfos: [map], SaveLocalMetadata: bool, EnableInternetProviders: bool, EnableAutomaticSeriesGrouping: bool, EnableEmbeddedTitles: bool, EnableEmbeddedEpisodeInfos: bool, AutomaticRefreshIntervalDays: int(int32), PreferredMetadataLanguage: str, MetadataCountryCode: str, SeasonZeroDisplayName: str, MetadataSavers: [str], DisabledLocalMetadataReaders: [str], LocalMetadataReaderOrder: [str], DisabledSubtitleFetchers: [str], SubtitleFetcherOrder: [str], SkipSubtitlesIfEmbeddedSubtitlesPresent: bool, SkipSubtitlesIfAudioTrackMatches: bool, SubtitleDownloadLanguages: [str], RequirePerfectSubtitleMatch: bool, SaveSubtitlesWithMedia: bool, TypeOptions: [map]}}\n@returns(204) Library updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Library/VirtualFolders/Name\n@desc Renames a virtual folder.\n@optional {name: str # The name of the virtual folder., newName: str # The new name., refreshLibrary: bool=false # Whether to refresh the library.}\n@returns(204) Folder renamed.\n@errors {401: Unauthorized, 403: Forbidden, 404: Library doesn't exist., 409: Library already exists.}\n\n@endpoint POST /Library/VirtualFolders/Paths\n@desc Add a media path to a library.\n@required {Name: str # Gets or sets the name of the library.}\n@optional {refreshLibrary: bool=false # Whether to refresh the library., Path: str # Gets or sets the path to add., PathInfo: map{Path: str, NetworkPath: str}}\n@returns(204) Media path added.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Library/VirtualFolders/Paths\n@desc Remove a media path.\n@optional {name: str # The name of the library., path: str # The path to remove., refreshLibrary: bool=false # Whether to refresh the library.}\n@returns(204) Media path removed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Library/VirtualFolders/Paths/Update\n@desc Updates a media path.\n@optional {name: str # The name of the library., Path: str, NetworkPath: str}\n@returns(204) Media path updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group LiveTv\n@endpoint GET /LiveTv/ChannelMappingOptions\n@desc Get channel mapping options.\n@optional {providerId: str # Provider id.}\n@returns(200) {TunerChannels: [map]?, ProviderChannels: [map]?, Mappings: [map]?, ProviderName: str?} # Channel mapping options returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /LiveTv/ChannelMappings\n@desc Set channel mappings.\n@required {ProviderId: str # Gets or sets the provider id., TunerChannelId: str # Gets or sets the tuner channel id., ProviderChannelId: str # Gets or sets the provider channel id.}\n@returns(200) {Name: str?, ProviderChannelName: str?, ProviderChannelId: str?, Id: str?} # Created channel mapping returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Channels\n@desc Gets available live tv channels.\n@optional {type: str # Optional. Filter by channel type., userId: str(uuid) # Optional. Filter by user and attach user data., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., isMovie: bool # Optional. Filter for movies., isSeries: bool # Optional. Filter for series., isNews: bool # Optional. Filter for news., isKids: bool # Optional. Filter for kids., isSports: bool # Optional. Filter for sports., limit: int(int32) # Optional. The maximum number of records to return., isFavorite: bool # Optional. Filter by channels that are favorites, or not., isLiked: bool # Optional. Filter by channels that are liked, or not., isDisliked: bool # Optional. Filter by channels that are disliked, or not., enableImages: bool # Optional. Include image information in output., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # \"Optional. The image types to include in the output., fields: [str] # Optional. Specify additional fields of information to return in the output., enableUserData: bool # Optional. Include user data., sortBy: [str] # Optional. Key to sort by., sortOrder: str # Optional. Sort order., enableFavoriteSorting: bool=false # Optional. Incorporate favorite and like status into channel sorting., addCurrentProgram: bool=true # Optional. Adds current program info to each channel.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Available live tv channels returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Channels/{channelId}\n@desc Gets a live tv channel.\n@required {channelId: str(uuid) # Channel id.}\n@optional {userId: str(uuid) # Optional. Attach user data.}\n@returns(200) {Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}}} # Live tv channel returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/GuideInfo\n@desc Get guid info.\n@returns(200) {StartDate: str(date-time), EndDate: str(date-time)} # Guid info returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Info\n@desc Gets available live tv services.\n@returns(200) {Services: [map]?, IsEnabled: bool, EnabledUsers: [str]?} # Available live tv services returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /LiveTv/ListingProviders\n@desc Adds a listings provider.\n@optional {pw: str # Password., validateListings: bool=false # Validate listings., validateLogin: bool=false # Validate login., Id: str, Type: str, Username: str, Password: str, ListingsId: str, ZipCode: str, Country: str, Path: str, EnabledTuners: [str], EnableAllTuners: bool, NewsCategories: [str], SportsCategories: [str], KidsCategories: [str], MovieCategories: [str], ChannelMappings: [map{Name: str, Value: str}], MoviePrefix: str, PreferredLanguage: str, UserAgent: str}\n@returns(200) {Id: str?, Type: str?, Username: str?, Password: str?, ListingsId: str?, ZipCode: str?, Country: str?, Path: str?, EnabledTuners: [str]?, EnableAllTuners: bool, NewsCategories: [str]?, SportsCategories: [str]?, KidsCategories: [str]?, MovieCategories: [str]?, ChannelMappings: [map]?, MoviePrefix: str?, PreferredLanguage: str?, UserAgent: str?} # Created listings provider returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /LiveTv/ListingProviders\n@desc Delete listing provider.\n@optional {id: str # Listing provider id.}\n@returns(204) Listing provider deleted.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/ListingProviders/Default\n@desc Gets default listings provider info.\n@returns(200) {Id: str?, Type: str?, Username: str?, Password: str?, ListingsId: str?, ZipCode: str?, Country: str?, Path: str?, EnabledTuners: [str]?, EnableAllTuners: bool, NewsCategories: [str]?, SportsCategories: [str]?, KidsCategories: [str]?, MovieCategories: [str]?, ChannelMappings: [map]?, MoviePrefix: str?, PreferredLanguage: str?, UserAgent: str?} # Default listings provider info returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/ListingProviders/Lineups\n@desc Gets available lineups.\n@optional {id: str # Provider id., type: str # Provider type., location: str # Location., country: str # Country.}\n@returns(200) Available lineups returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/ListingProviders/SchedulesDirect/Countries\n@desc Gets available countries.\n@returns(200) Available countries returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/LiveRecordings/{recordingId}/stream\n@desc Gets a live tv recording stream.\n@required {recordingId: str # Recording id.}\n@returns(200) Recording stream returned.\n@errors {404: Recording not found.}\n\n@endpoint GET /LiveTv/LiveStreamFiles/{streamId}/stream.{container}\n@desc Gets a live tv channel stream.\n@required {streamId: str # Stream id., container: str # Container type.}\n@returns(200) Stream returned.\n@errors {404: Stream not found.}\n\n@endpoint GET /LiveTv/Programs\n@desc Gets available live tv epgs.\n@optional {channelIds: [str(uuid)] # The channels to return guide information for., userId: str(uuid) # Optional. Filter by user id., minStartDate: str(date-time) # Optional. The minimum premiere start date., hasAired: bool # Optional. Filter by programs that have completed airing, or not., isAiring: bool # Optional. Filter by programs that are currently airing, or not., maxStartDate: str(date-time) # Optional. The maximum premiere start date., minEndDate: str(date-time) # Optional. The minimum premiere end date., maxEndDate: str(date-time) # Optional. The maximum premiere end date., isMovie: bool # Optional. Filter for movies., isSeries: bool # Optional. Filter for series., isNews: bool # Optional. Filter for news., isKids: bool # Optional. Filter for kids., isSports: bool # Optional. Filter for sports., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., sortBy: str # Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate., sortOrder: str # Sort Order - Ascending,Descending., genres: [str] # The genres to return guide information for., genreIds: [str(uuid)] # The genre ids to return guide information for., enableImages: bool # Optional. Include image information in output., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., enableUserData: bool # Optional. Include user data., seriesTimerId: str # Optional. Filter by series timer id., librarySeriesId: str(uuid) # Optional. Filter by library series id., fields: [str] # Optional. Specify additional fields of information to return in the output., enableTotalRecordCount: bool=true # Retrieve total record count.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Live tv epgs returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /LiveTv/Programs\n@desc Gets available live tv epgs.\n@optional {ChannelIds: [str(uuid)] # Gets or sets the channels to return guide information for., UserId: str(uuid) # Gets or sets optional. Filter by user id., MinStartDate: str(date-time) # Gets or sets the minimum premiere start date.\r Optional., HasAired: bool # Gets or sets filter by programs that have completed airing, or not.\r Optional., IsAiring: bool # Gets or sets filter by programs that are currently airing, or not.\r Optional., MaxStartDate: str(date-time) # Gets or sets the maximum premiere start date.\r Optional., MinEndDate: str(date-time) # Gets or sets the minimum premiere end date.\r Optional., MaxEndDate: str(date-time) # Gets or sets the maximum premiere end date.\r Optional., IsMovie: bool # Gets or sets filter for movies.\r Optional., IsSeries: bool # Gets or sets filter for series.\r Optional., IsNews: bool # Gets or sets filter for news.\r Optional., IsKids: bool # Gets or sets filter for kids.\r Optional., IsSports: bool # Gets or sets filter for sports.\r Optional., StartIndex: int(int32) # Gets or sets the record index to start at. All items with a lower index will be dropped from the results.\r Optional., Limit: int(int32) # Gets or sets the maximum number of records to return.\r Optional., SortBy: str # Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate.\r Optional., SortOrder: str # Gets or sets sort Order - Ascending,Descending., Genres: [str] # Gets or sets the genres to return guide information for., GenreIds: [str(uuid)] # Gets or sets the genre ids to return guide information for., EnableImages: bool # Gets or sets include image information in output.\r Optional., EnableTotalRecordCount: bool # Gets or sets a value indicating whether retrieve total record count., ImageTypeLimit: int(int32) # Gets or sets the max number of images to return, per image type.\r Optional., EnableImageTypes: [str] # Gets or sets the image types to include in the output.\r Optional., EnableUserData: bool # Gets or sets include user data.\r Optional., SeriesTimerId: str # Gets or sets filter by series timer id.\r Optional., LibrarySeriesId: str(uuid) # Gets or sets filter by library series id.\r Optional., Fields: [str] # Gets or sets specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.\r Optional.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Live tv epgs returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Programs/{programId}\n@desc Gets a live tv program.\n@required {programId: str # Program id.}\n@optional {userId: str(uuid) # Optional. Attach user data.}\n@returns(200) {Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}}} # Program returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Programs/Recommended\n@desc Gets recommended live tv epgs.\n@optional {userId: str(uuid) # Optional. filter by user id., limit: int(int32) # Optional. The maximum number of records to return., isAiring: bool # Optional. Filter by programs that are currently airing, or not., hasAired: bool # Optional. Filter by programs that have completed airing, or not., isSeries: bool # Optional. Filter for series., isMovie: bool # Optional. Filter for movies., isNews: bool # Optional. Filter for news., isKids: bool # Optional. Filter for kids., isSports: bool # Optional. Filter for sports., enableImages: bool # Optional. Include image information in output., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., genreIds: [str(uuid)] # The genres to return guide information for., fields: [str] # Optional. Specify additional fields of information to return in the output., enableUserData: bool # Optional. include user data., enableTotalRecordCount: bool=true # Retrieve total record count.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Recommended epgs returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Recordings\n@desc Gets live tv recordings.\n@optional {channelId: str # Optional. Filter by channel id., userId: str(uuid) # Optional. Filter by user and attach user data., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., status: str # Optional. Filter by recording status., isInProgress: bool # Optional. Filter by recordings that are in progress, or not., seriesTimerId: str # Optional. Filter by recordings belonging to a series timer., enableImages: bool # Optional. Include image information in output., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., fields: [str] # Optional. Specify additional fields of information to return in the output., enableUserData: bool # Optional. Include user data., isMovie: bool # Optional. Filter for movies., isSeries: bool # Optional. Filter for series., isKids: bool # Optional. Filter for kids., isSports: bool # Optional. Filter for sports., isNews: bool # Optional. Filter for news., isLibraryItem: bool # Optional. Filter for is library item., enableTotalRecordCount: bool=true # Optional. Return total record count.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Live tv recordings returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Recordings/{recordingId}\n@desc Gets a live tv recording.\n@required {recordingId: str(uuid) # Recording id.}\n@optional {userId: str(uuid) # Optional. Attach user data.}\n@returns(200) {Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}}} # Recording returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /LiveTv/Recordings/{recordingId}\n@desc Deletes a live tv recording.\n@required {recordingId: str(uuid) # Recording id.}\n@returns(204) Recording deleted.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint GET /LiveTv/Recordings/Folders\n@desc Gets recording folders.\n@optional {userId: str(uuid) # Optional. Filter by user and attach user data.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Recording folders returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Recordings/Groups\n@desc Gets live tv recording groups.\n@optional {userId: str(uuid) # Optional. Filter by user and attach user data.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Recording groups returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Recordings/Groups/{groupId}\n@desc Get recording group.\n@required {groupId: str(uuid) # Group id.}\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found}\n\n@endpoint GET /LiveTv/Recordings/Series\n@desc Gets live tv recording series.\n@optional {channelId: str # Optional. Filter by channel id., userId: str(uuid) # Optional. Filter by user and attach user data., groupId: str # Optional. Filter by recording group., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., status: str # Optional. Filter by recording status., isInProgress: bool # Optional. Filter by recordings that are in progress, or not., seriesTimerId: str # Optional. Filter by recordings belonging to a series timer., enableImages: bool # Optional. Include image information in output., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., fields: [str] # Optional. Specify additional fields of information to return in the output., enableUserData: bool # Optional. Include user data., enableTotalRecordCount: bool=true # Optional. Return total record count.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Live tv recordings returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/SeriesTimers\n@desc Gets live tv series timers.\n@optional {sortBy: str # Optional. Sort by SortName or Priority., sortOrder: str # Optional. Sort in Ascending or Descending order.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Timers returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /LiveTv/SeriesTimers\n@desc Creates a live tv series timer.\n@optional {Id: str # Id of the recording., Type: str, ServerId: str # Gets or sets the server identifier., ExternalId: str # Gets or sets the external identifier., ChannelId: str(uuid) # ChannelId of the recording., ExternalChannelId: str # Gets or sets the external channel identifier., ChannelName: str # ChannelName of the recording., ChannelPrimaryImageTag: str, ProgramId: str # Gets or sets the program identifier., ExternalProgramId: str # Gets or sets the external program identifier., Name: str # Name of the recording., Overview: str # Description of the recording., StartDate: str(date-time) # The start date of the recording, in UTC., EndDate: str(date-time) # The end date of the recording, in UTC., ServiceName: str # Gets or sets the name of the service., Priority: int(int32) # Gets or sets the priority., PrePaddingSeconds: int(int32) # Gets or sets the pre padding seconds., PostPaddingSeconds: int(int32) # Gets or sets the post padding seconds., IsPrePaddingRequired: bool # Gets or sets a value indicating whether this instance is pre padding required., ParentBackdropItemId: str # If the item does not have any backdrops, this will hold the Id of the Parent that has one., ParentBackdropImageTags: [str] # Gets or sets the parent backdrop image tags., IsPostPaddingRequired: bool # Gets or sets a value indicating whether this instance is post padding required., KeepUntil: str(UntilDeleted/UntilSpaceNeeded/UntilWatched/UntilDate), RecordAnyTime: bool # Gets or sets a value indicating whether [record any time]., SkipEpisodesInLibrary: bool, RecordAnyChannel: bool # Gets or sets a value indicating whether [record any channel]., KeepUpTo: int(int32), RecordNewOnly: bool # Gets or sets a value indicating whether [record new only]., Days: [str] # Gets or sets the days., DayPattern: str(Daily/Weekdays/Weekends), ImageTags: map # Gets or sets the image tags., ParentThumbItemId: str # Gets or sets the parent thumb item id., ParentThumbImageTag: str # Gets or sets the parent thumb image tag., ParentPrimaryImageItemId: str # Gets or sets the parent primary image item identifier., ParentPrimaryImageTag: str # Gets or sets the parent primary image tag.}\n@returns(204) Series timer info created.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/SeriesTimers/{timerId}\n@desc Gets a live tv series timer.\n@required {timerId: str # Timer id.}\n@returns(200) {Id: str?, Type: str?, ServerId: str?, ExternalId: str?, ChannelId: str(uuid), ExternalChannelId: str?, ChannelName: str?, ChannelPrimaryImageTag: str?, ProgramId: str?, ExternalProgramId: str?, Name: str?, Overview: str?, StartDate: str(date-time), EndDate: str(date-time), ServiceName: str?, Priority: int(int32), PrePaddingSeconds: int(int32), PostPaddingSeconds: int(int32), IsPrePaddingRequired: bool, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, IsPostPaddingRequired: bool, KeepUntil: str, RecordAnyTime: bool, SkipEpisodesInLibrary: bool, RecordAnyChannel: bool, KeepUpTo: int(int32), RecordNewOnly: bool, Days: [str]?, DayPattern: str, ImageTags: map?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?} # Series timer returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Series timer not found.}\n\n@endpoint DELETE /LiveTv/SeriesTimers/{timerId}\n@desc Cancels a live tv series timer.\n@required {timerId: str # Timer id.}\n@returns(204) Timer cancelled.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /LiveTv/SeriesTimers/{timerId}\n@desc Updates a live tv series timer.\n@required {timerId: str # Timer id.}\n@optional {Id: str # Id of the recording., Type: str, ServerId: str # Gets or sets the server identifier., ExternalId: str # Gets or sets the external identifier., ChannelId: str(uuid) # ChannelId of the recording., ExternalChannelId: str # Gets or sets the external channel identifier., ChannelName: str # ChannelName of the recording., ChannelPrimaryImageTag: str, ProgramId: str # Gets or sets the program identifier., ExternalProgramId: str # Gets or sets the external program identifier., Name: str # Name of the recording., Overview: str # Description of the recording., StartDate: str(date-time) # The start date of the recording, in UTC., EndDate: str(date-time) # The end date of the recording, in UTC., ServiceName: str # Gets or sets the name of the service., Priority: int(int32) # Gets or sets the priority., PrePaddingSeconds: int(int32) # Gets or sets the pre padding seconds., PostPaddingSeconds: int(int32) # Gets or sets the post padding seconds., IsPrePaddingRequired: bool # Gets or sets a value indicating whether this instance is pre padding required., ParentBackdropItemId: str # If the item does not have any backdrops, this will hold the Id of the Parent that has one., ParentBackdropImageTags: [str] # Gets or sets the parent backdrop image tags., IsPostPaddingRequired: bool # Gets or sets a value indicating whether this instance is post padding required., KeepUntil: str(UntilDeleted/UntilSpaceNeeded/UntilWatched/UntilDate), RecordAnyTime: bool # Gets or sets a value indicating whether [record any time]., SkipEpisodesInLibrary: bool, RecordAnyChannel: bool # Gets or sets a value indicating whether [record any channel]., KeepUpTo: int(int32), RecordNewOnly: bool # Gets or sets a value indicating whether [record new only]., Days: [str] # Gets or sets the days., DayPattern: str(Daily/Weekdays/Weekends), ImageTags: map # Gets or sets the image tags., ParentThumbItemId: str # Gets or sets the parent thumb item id., ParentThumbImageTag: str # Gets or sets the parent thumb image tag., ParentPrimaryImageItemId: str # Gets or sets the parent primary image item identifier., ParentPrimaryImageTag: str # Gets or sets the parent primary image tag.}\n@returns(204) Series timer updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Timers\n@desc Gets the live tv timers.\n@optional {channelId: str # Optional. Filter by channel id., seriesTimerId: str # Optional. Filter by timers belonging to a series timer., isActive: bool # Optional. Filter by timers that are active., isScheduled: bool # Optional. Filter by timers that are scheduled.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Success\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /LiveTv/Timers\n@desc Creates a live tv timer.\n@optional {Id: str # Id of the recording., Type: str, ServerId: str # Gets or sets the server identifier., ExternalId: str # Gets or sets the external identifier., ChannelId: str(uuid) # ChannelId of the recording., ExternalChannelId: str # Gets or sets the external channel identifier., ChannelName: str # ChannelName of the recording., ChannelPrimaryImageTag: str, ProgramId: str # Gets or sets the program identifier., ExternalProgramId: str # Gets or sets the external program identifier., Name: str # Name of the recording., Overview: str # Description of the recording., StartDate: str(date-time) # The start date of the recording, in UTC., EndDate: str(date-time) # The end date of the recording, in UTC., ServiceName: str # Gets or sets the name of the service., Priority: int(int32) # Gets or sets the priority., PrePaddingSeconds: int(int32) # Gets or sets the pre padding seconds., PostPaddingSeconds: int(int32) # Gets or sets the post padding seconds., IsPrePaddingRequired: bool # Gets or sets a value indicating whether this instance is pre padding required., ParentBackdropItemId: str # If the item does not have any backdrops, this will hold the Id of the Parent that has one., ParentBackdropImageTags: [str] # Gets or sets the parent backdrop image tags., IsPostPaddingRequired: bool # Gets or sets a value indicating whether this instance is post padding required., KeepUntil: str(UntilDeleted/UntilSpaceNeeded/UntilWatched/UntilDate), Status: str(New/InProgress/Completed/Cancelled/ConflictedOk/ConflictedNotOk/Error), SeriesTimerId: str # Gets or sets the series timer identifier., ExternalSeriesTimerId: str # Gets or sets the external series timer identifier., RunTimeTicks: int(int64) # Gets or sets the run time ticks., ProgramInfo: map{Name: str, OriginalTitle: str, ServerId: str, Id: str(uuid), Etag: str, SourceType: str, PlaylistItemId: str, DateCreated: str(date-time), DateLastMediaAdded: str(date-time), ExtraType: str, AirsBeforeSeasonNumber: int(int32), AirsAfterSeasonNumber: int(int32), AirsBeforeEpisodeNumber: int(int32), CanDelete: bool, CanDownload: bool, HasSubtitles: bool, PreferredMetadataLanguage: str, PreferredMetadataCountryCode: str, SupportsSync: bool, Container: str, SortName: str, ForcedSortName: str, Video3DFormat: str, PremiereDate: str(date-time), ExternalUrls: [map], MediaSources: [map], CriticRating: num(float), ProductionLocations: [str], Path: str, EnableMediaSourceDisplay: bool, OfficialRating: str, CustomRating: str, ChannelId: str(uuid), ChannelName: str, Overview: str, Taglines: [str], Genres: [str], CommunityRating: num(float), CumulativeRunTimeTicks: int(int64), RunTimeTicks: int(int64), PlayAccess: str, AspectRatio: str, ProductionYear: int(int32), IsPlaceHolder: bool, Number: str, ChannelNumber: str, IndexNumber: int(int32), IndexNumberEnd: int(int32), ParentIndexNumber: int(int32), RemoteTrailers: [map], ProviderIds: map, IsHD: bool, IsFolder: bool, ParentId: str(uuid), Type: str, People: [map], Studios: [map], GenreItems: [map], ParentLogoItemId: str, ParentBackdropItemId: str, ParentBackdropImageTags: [str], LocalTrailerCount: int(int32), UserData: map, RecursiveItemCount: int(int32), ChildCount: int(int32), SeriesName: str, SeriesId: str(uuid), SeasonId: str(uuid), SpecialFeatureCount: int(int32), DisplayPreferencesId: str, Status: str, AirTime: str, AirDays: [str], Tags: [str], PrimaryImageAspectRatio: num(double), Artists: [str], ArtistItems: [map], Album: str, CollectionType: str, DisplayOrder: str, AlbumId: str(uuid), AlbumPrimaryImageTag: str, SeriesPrimaryImageTag: str, AlbumArtist: str, AlbumArtists: [map], SeasonName: str, MediaStreams: [map], VideoType: str, PartCount: int(int32), MediaSourceCount: int(int32), ImageTags: map, BackdropImageTags: [str], ScreenshotImageTags: [str], ParentLogoImageTag: str, ParentArtItemId: str, ParentArtImageTag: str, SeriesThumbImageTag: str, ImageBlurHashes: map, SeriesStudio: str, ParentThumbItemId: str, ParentThumbImageTag: str, ParentPrimaryImageItemId: str, ParentPrimaryImageTag: str, Chapters: [map], LocationType: str, IsoType: str, MediaType: str, EndDate: str(date-time), LockedFields: [str], TrailerCount: int(int32), MovieCount: int(int32), SeriesCount: int(int32), ProgramCount: int(int32), EpisodeCount: int(int32), SongCount: int(int32), AlbumCount: int(int32), ArtistCount: int(int32), MusicVideoCount: int(int32), LockData: bool, Width: int(int32), Height: int(int32), CameraMake: str, CameraModel: str, Software: str, ExposureTime: num(double), FocalLength: num(double), ImageOrientation: str, Aperture: num(double), ShutterSpeed: num(double), Latitude: num(double), Longitude: num(double), Altitude: num(double), IsoSpeedRating: int(int32), SeriesTimerId: str, ProgramId: str, ChannelPrimaryImageTag: str, StartDate: str(date-time), CompletionPercentage: num(double), IsRepeat: bool, EpisodeTitle: str, ChannelType: str, Audio: str, IsMovie: bool, IsSports: bool, IsSeries: bool, IsLive: bool, IsNews: bool, IsKids: bool, IsPremiere: bool, TimerId: str, CurrentProgram: map} # This is strictly used as a data transfer object from the api layer.\r This holds information about a BaseItem in a format that is convenient for the client.}\n@returns(204) Timer created.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Timers/{timerId}\n@desc Gets a timer.\n@required {timerId: str # Timer id.}\n@returns(200) {Id: str?, Type: str?, ServerId: str?, ExternalId: str?, ChannelId: str(uuid), ExternalChannelId: str?, ChannelName: str?, ChannelPrimaryImageTag: str?, ProgramId: str?, ExternalProgramId: str?, Name: str?, Overview: str?, StartDate: str(date-time), EndDate: str(date-time), ServiceName: str?, Priority: int(int32), PrePaddingSeconds: int(int32), PostPaddingSeconds: int(int32), IsPrePaddingRequired: bool, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, IsPostPaddingRequired: bool, KeepUntil: str, Status: str, SeriesTimerId: str?, ExternalSeriesTimerId: str?, RunTimeTicks: int(int64)?, ProgramInfo: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}}} # Timer returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /LiveTv/Timers/{timerId}\n@desc Cancels a live tv timer.\n@required {timerId: str # Timer id.}\n@returns(204) Timer deleted.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /LiveTv/Timers/{timerId}\n@desc Updates a live tv timer.\n@required {timerId: str # Timer id.}\n@optional {Id: str # Id of the recording., Type: str, ServerId: str # Gets or sets the server identifier., ExternalId: str # Gets or sets the external identifier., ChannelId: str(uuid) # ChannelId of the recording., ExternalChannelId: str # Gets or sets the external channel identifier., ChannelName: str # ChannelName of the recording., ChannelPrimaryImageTag: str, ProgramId: str # Gets or sets the program identifier., ExternalProgramId: str # Gets or sets the external program identifier., Name: str # Name of the recording., Overview: str # Description of the recording., StartDate: str(date-time) # The start date of the recording, in UTC., EndDate: str(date-time) # The end date of the recording, in UTC., ServiceName: str # Gets or sets the name of the service., Priority: int(int32) # Gets or sets the priority., PrePaddingSeconds: int(int32) # Gets or sets the pre padding seconds., PostPaddingSeconds: int(int32) # Gets or sets the post padding seconds., IsPrePaddingRequired: bool # Gets or sets a value indicating whether this instance is pre padding required., ParentBackdropItemId: str # If the item does not have any backdrops, this will hold the Id of the Parent that has one., ParentBackdropImageTags: [str] # Gets or sets the parent backdrop image tags., IsPostPaddingRequired: bool # Gets or sets a value indicating whether this instance is post padding required., KeepUntil: str(UntilDeleted/UntilSpaceNeeded/UntilWatched/UntilDate), Status: str(New/InProgress/Completed/Cancelled/ConflictedOk/ConflictedNotOk/Error), SeriesTimerId: str # Gets or sets the series timer identifier., ExternalSeriesTimerId: str # Gets or sets the external series timer identifier., RunTimeTicks: int(int64) # Gets or sets the run time ticks., ProgramInfo: map{Name: str, OriginalTitle: str, ServerId: str, Id: str(uuid), Etag: str, SourceType: str, PlaylistItemId: str, DateCreated: str(date-time), DateLastMediaAdded: str(date-time), ExtraType: str, AirsBeforeSeasonNumber: int(int32), AirsAfterSeasonNumber: int(int32), AirsBeforeEpisodeNumber: int(int32), CanDelete: bool, CanDownload: bool, HasSubtitles: bool, PreferredMetadataLanguage: str, PreferredMetadataCountryCode: str, SupportsSync: bool, Container: str, SortName: str, ForcedSortName: str, Video3DFormat: str, PremiereDate: str(date-time), ExternalUrls: [map], MediaSources: [map], CriticRating: num(float), ProductionLocations: [str], Path: str, EnableMediaSourceDisplay: bool, OfficialRating: str, CustomRating: str, ChannelId: str(uuid), ChannelName: str, Overview: str, Taglines: [str], Genres: [str], CommunityRating: num(float), CumulativeRunTimeTicks: int(int64), RunTimeTicks: int(int64), PlayAccess: str, AspectRatio: str, ProductionYear: int(int32), IsPlaceHolder: bool, Number: str, ChannelNumber: str, IndexNumber: int(int32), IndexNumberEnd: int(int32), ParentIndexNumber: int(int32), RemoteTrailers: [map], ProviderIds: map, IsHD: bool, IsFolder: bool, ParentId: str(uuid), Type: str, People: [map], Studios: [map], GenreItems: [map], ParentLogoItemId: str, ParentBackdropItemId: str, ParentBackdropImageTags: [str], LocalTrailerCount: int(int32), UserData: map, RecursiveItemCount: int(int32), ChildCount: int(int32), SeriesName: str, SeriesId: str(uuid), SeasonId: str(uuid), SpecialFeatureCount: int(int32), DisplayPreferencesId: str, Status: str, AirTime: str, AirDays: [str], Tags: [str], PrimaryImageAspectRatio: num(double), Artists: [str], ArtistItems: [map], Album: str, CollectionType: str, DisplayOrder: str, AlbumId: str(uuid), AlbumPrimaryImageTag: str, SeriesPrimaryImageTag: str, AlbumArtist: str, AlbumArtists: [map], SeasonName: str, MediaStreams: [map], VideoType: str, PartCount: int(int32), MediaSourceCount: int(int32), ImageTags: map, BackdropImageTags: [str], ScreenshotImageTags: [str], ParentLogoImageTag: str, ParentArtItemId: str, ParentArtImageTag: str, SeriesThumbImageTag: str, ImageBlurHashes: map, SeriesStudio: str, ParentThumbItemId: str, ParentThumbImageTag: str, ParentPrimaryImageItemId: str, ParentPrimaryImageTag: str, Chapters: [map], LocationType: str, IsoType: str, MediaType: str, EndDate: str(date-time), LockedFields: [str], TrailerCount: int(int32), MovieCount: int(int32), SeriesCount: int(int32), ProgramCount: int(int32), EpisodeCount: int(int32), SongCount: int(int32), AlbumCount: int(int32), ArtistCount: int(int32), MusicVideoCount: int(int32), LockData: bool, Width: int(int32), Height: int(int32), CameraMake: str, CameraModel: str, Software: str, ExposureTime: num(double), FocalLength: num(double), ImageOrientation: str, Aperture: num(double), ShutterSpeed: num(double), Latitude: num(double), Longitude: num(double), Altitude: num(double), IsoSpeedRating: int(int32), SeriesTimerId: str, ProgramId: str, ChannelPrimaryImageTag: str, StartDate: str(date-time), CompletionPercentage: num(double), IsRepeat: bool, EpisodeTitle: str, ChannelType: str, Audio: str, IsMovie: bool, IsSports: bool, IsSeries: bool, IsLive: bool, IsNews: bool, IsKids: bool, IsPremiere: bool, TimerId: str, CurrentProgram: map} # This is strictly used as a data transfer object from the api layer.\r This holds information about a BaseItem in a format that is convenient for the client.}\n@returns(204) Timer updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Timers/Defaults\n@desc Gets the default values for a new timer.\n@optional {programId: str # Optional. To attach default values based on a program.}\n@returns(200) {Id: str?, Type: str?, ServerId: str?, ExternalId: str?, ChannelId: str(uuid), ExternalChannelId: str?, ChannelName: str?, ChannelPrimaryImageTag: str?, ProgramId: str?, ExternalProgramId: str?, Name: str?, Overview: str?, StartDate: str(date-time), EndDate: str(date-time), ServiceName: str?, Priority: int(int32), PrePaddingSeconds: int(int32), PostPaddingSeconds: int(int32), IsPrePaddingRequired: bool, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, IsPostPaddingRequired: bool, KeepUntil: str, RecordAnyTime: bool, SkipEpisodesInLibrary: bool, RecordAnyChannel: bool, KeepUpTo: int(int32), RecordNewOnly: bool, Days: [str]?, DayPattern: str, ImageTags: map?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?} # Default values returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /LiveTv/TunerHosts\n@desc Adds a tuner host.\n@optional {Id: str, Url: str, Type: str, DeviceId: str, FriendlyName: str, ImportFavoritesOnly: bool, AllowHWTranscoding: bool, EnableStreamLooping: bool, Source: str, TunerCount: int(int32), UserAgent: str}\n@returns(200) {Id: str?, Url: str?, Type: str?, DeviceId: str?, FriendlyName: str?, ImportFavoritesOnly: bool, AllowHWTranscoding: bool, EnableStreamLooping: bool, Source: str?, TunerCount: int(int32), UserAgent: str?} # Created tuner host returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /LiveTv/TunerHosts\n@desc Deletes a tuner host.\n@optional {id: str # Tuner host id.}\n@returns(204) Tuner host deleted.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/TunerHosts/Types\n@desc Get tuner host types.\n@returns(200) Tuner host types returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /LiveTv/Tuners/{tunerId}/Reset\n@desc Resets a tv tuner.\n@required {tunerId: str # Tuner id.}\n@returns(204) Tuner reset.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Tuners/Discover\n@desc Discover tuners.\n@optional {newDevicesOnly: bool=false # Only discover new tuners.}\n@returns(200) Tuners returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /LiveTv/Tuners/Discvover\n@desc Discover tuners.\n@optional {newDevicesOnly: bool=false # Only discover new tuners.}\n@returns(200) Tuners returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Localization\n@endpoint GET /Localization/Countries\n@desc Gets known countries.\n@returns(200) Known countries returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Localization/Cultures\n@desc Gets known cultures.\n@returns(200) Known cultures returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Localization/Options\n@desc Gets localization options.\n@returns(200) Localization options returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Localization/ParentalRatings\n@desc Gets known parental ratings.\n@returns(200) Known parental ratings returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Items\n@endpoint GET /Items/{itemId}/PlaybackInfo\n@desc Gets live playback media info for an item.\n@required {itemId: str(uuid) # The item id., userId: str(uuid) # The user id.}\n@returns(200) {MediaSources: [map]?, PlaySessionId: str?, ErrorCode: str} # Playback info returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Items/{itemId}/PlaybackInfo\n@desc Gets live playback media info for an item.\n@required {itemId: str(uuid) # The item id.}\n@optional {userId: str(uuid) # The user id., maxStreamingBitrate: int(int32) # The maximum streaming bitrate., startTimeTicks: int(int64) # The start time in ticks., audioStreamIndex: int(int32) # The audio stream index., subtitleStreamIndex: int(int32) # The subtitle stream index., maxAudioChannels: int(int32) # The maximum number of audio channels., mediaSourceId: str # The media source id., liveStreamId: str # The livestream id., autoOpenLiveStream: bool # Whether to auto open the livestream., enableDirectPlay: bool # Whether to enable direct play. Default: true., enableDirectStream: bool # Whether to enable direct stream. Default: true., enableTranscoding: bool # Whether to enable transcoding. Default: true., allowVideoStreamCopy: bool # Whether to allow to copy the video stream. Default: true., allowAudioStreamCopy: bool # Whether to allow to copy the audio stream. Default: true., UserId: str(uuid) # Gets or sets the playback userId., MaxStreamingBitrate: int(int32) # Gets or sets the max streaming bitrate., StartTimeTicks: int(int64) # Gets or sets the start time in ticks., AudioStreamIndex: int(int32) # Gets or sets the audio stream index., SubtitleStreamIndex: int(int32) # Gets or sets the subtitle stream index., MaxAudioChannels: int(int32) # Gets or sets the max audio channels., MediaSourceId: str # Gets or sets the media source id., LiveStreamId: str # Gets or sets the live stream id., DeviceProfile: map{Name: str, Id: str, Identification: map, FriendlyName: str, Manufacturer: str, ManufacturerUrl: str, ModelName: str, ModelDescription: str, ModelNumber: str, ModelUrl: str, SerialNumber: str, EnableAlbumArtInDidl: bool, EnableSingleAlbumArtLimit: bool, EnableSingleSubtitleLimit: bool, SupportedMediaTypes: str, UserId: str, AlbumArtPn: str, MaxAlbumArtWidth: int(int32), MaxAlbumArtHeight: int(int32), MaxIconWidth: int(int32), MaxIconHeight: int(int32), MaxStreamingBitrate: int(int32), MaxStaticBitrate: int(int32), MusicStreamingTranscodingBitrate: int(int32), MaxStaticMusicBitrate: int(int32), SonyAggregationFlags: str, ProtocolInfo: str, TimelineOffsetSeconds: int(int32), RequiresPlainVideoItems: bool, RequiresPlainFolders: bool, EnableMSMediaReceiverRegistrar: bool, IgnoreTranscodeByteRangeRequests: bool, XmlRootAttributes: [map], DirectPlayProfiles: [map], TranscodingProfiles: [map], ContainerProfiles: [map], CodecProfiles: [map], ResponseProfiles: [map], SubtitleProfiles: [map]} # Defines the MediaBrowser.Model.Dlna.DeviceProfile., EnableDirectPlay: bool # Gets or sets a value indicating whether to enable direct play., EnableDirectStream: bool # Gets or sets a value indicating whether to enable direct stream., EnableTranscoding: bool # Gets or sets a value indicating whether to enable transcoding., AllowVideoStreamCopy: bool # Gets or sets a value indicating whether to enable video stream copy., AllowAudioStreamCopy: bool # Gets or sets a value indicating whether to allow audio stream copy., AutoOpenLiveStream: bool # Gets or sets a value indicating whether to auto open the live stream.}\n@returns(200) {MediaSources: [map]?, PlaySessionId: str?, ErrorCode: str} # Playback info returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group LiveStreams\n@endpoint POST /LiveStreams/Close\n@desc Closes a media source.\n@required {liveStreamId: str # The livestream id.}\n@returns(204) Livestream closed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /LiveStreams/Open\n@desc Opens a media source.\n@optional {openToken: str # The open token., userId: str(uuid) # The user id., playSessionId: str # The play session id., maxStreamingBitrate: int(int32) # The maximum streaming bitrate., startTimeTicks: int(int64) # The start time in ticks., audioStreamIndex: int(int32) # The audio stream index., subtitleStreamIndex: int(int32) # The subtitle stream index., maxAudioChannels: int(int32) # The maximum number of audio channels., itemId: str(uuid) # The item id., enableDirectPlay: bool # Whether to enable direct play. Default: true., enableDirectStream: bool # Whether to enable direct stream. Default: true., OpenToken: str # Gets or sets the open token., UserId: str(uuid) # Gets or sets the user id., PlaySessionId: str # Gets or sets the play session id., MaxStreamingBitrate: int(int32) # Gets or sets the max streaming bitrate., StartTimeTicks: int(int64) # Gets or sets the start time in ticks., AudioStreamIndex: int(int32) # Gets or sets the audio stream index., SubtitleStreamIndex: int(int32) # Gets or sets the subtitle stream index., MaxAudioChannels: int(int32) # Gets or sets the max audio channels., ItemId: str(uuid) # Gets or sets the item id., EnableDirectPlay: bool # Gets or sets a value indicating whether to enable direct play., EnableDirectStream: bool # Gets or sets a value indicating whether to enale direct stream., DeviceProfile: map{Name: str, Id: str, Identification: map, FriendlyName: str, Manufacturer: str, ManufacturerUrl: str, ModelName: str, ModelDescription: str, ModelNumber: str, ModelUrl: str, SerialNumber: str, EnableAlbumArtInDidl: bool, EnableSingleAlbumArtLimit: bool, EnableSingleSubtitleLimit: bool, SupportedMediaTypes: str, UserId: str, AlbumArtPn: str, MaxAlbumArtWidth: int(int32), MaxAlbumArtHeight: int(int32), MaxIconWidth: int(int32), MaxIconHeight: int(int32), MaxStreamingBitrate: int(int32), MaxStaticBitrate: int(int32), MusicStreamingTranscodingBitrate: int(int32), MaxStaticMusicBitrate: int(int32), SonyAggregationFlags: str, ProtocolInfo: str, TimelineOffsetSeconds: int(int32), RequiresPlainVideoItems: bool, RequiresPlainFolders: bool, EnableMSMediaReceiverRegistrar: bool, IgnoreTranscodeByteRangeRequests: bool, XmlRootAttributes: [map], DirectPlayProfiles: [map], TranscodingProfiles: [map], ContainerProfiles: [map], CodecProfiles: [map], ResponseProfiles: [map], SubtitleProfiles: [map]} # Defines the MediaBrowser.Model.Dlna.DeviceProfile., DirectPlayProtocols: [str] # Gets or sets the device play protocols.}\n@returns(200) {MediaSource: map{Protocol: str, Id: str?, Path: str?, EncoderPath: str?, EncoderProtocol: str, Type: str, Container: str?, Size: int(int64)?, Name: str?, IsRemote: bool, ETag: str?, RunTimeTicks: int(int64)?, ReadAtNativeFramerate: bool, IgnoreDts: bool, IgnoreIndex: bool, GenPtsInput: bool, SupportsTranscoding: bool, SupportsDirectStream: bool, SupportsDirectPlay: bool, IsInfiniteStream: bool, RequiresOpening: bool, OpenToken: str?, RequiresClosing: bool, LiveStreamId: str?, BufferMs: int(int32)?, RequiresLooping: bool, SupportsProbing: bool, VideoType: str, IsoType: str, Video3DFormat: str, MediaStreams: [map]?, MediaAttachments: [map]?, Formats: [str]?, Bitrate: int(int32)?, Timestamp: str, RequiredHttpHeaders: map?, TranscodingUrl: str?, TranscodingSubProtocol: str?, TranscodingContainer: str?, AnalyzeDurationMs: int(int32)?, DefaultAudioStreamIndex: int(int32)?, DefaultSubtitleStreamIndex: int(int32)?}} # Media source opened.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Playback\n@endpoint GET /Playback/BitrateTest\n@desc Tests the network with a request with the size of the bitrate.\n@optional {size: int(int32)=102400 # The bitrate. Defaults to 102400.}\n@returns(200) Test buffer returned.\n@errors {400: Size has to be a numer between 0 and 10,000,000., 401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Movies\n@endpoint GET /Movies/Recommendations\n@desc Gets movie recommendations.\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data., parentId: str(uuid) # Specify this to localize the search to a specific item or folder. Omit to use the root., fields: [str] # Optional. The fields to return., categoryLimit: int(int32)=5 # The max number of categories to return., itemLimit: int(int32)=8 # The max number of items to return per category.}\n@returns(200) Movie recommendations returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group MusicGenres\n@endpoint GET /MusicGenres\n@desc Gets all music genres from a given item, folder, or the entire library.\n@optional {startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., searchTerm: str # The search term., parentId: str(uuid) # Specify this to localize the search to a specific item or folder. Omit to use the root., fields: [str] # Optional. Specify additional fields of information to return in the output., excludeItemTypes: [str] # Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited., includeItemTypes: [str] # Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited., isFavorite: bool # Optional filter by items that are marked as favorite, or not., imageTypeLimit: int(int32) # Optional, the max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., userId: str(uuid) # User id., nameStartsWithOrGreater: str # Optional filter by items whose name is sorted equally or greater than a given input string., nameStartsWith: str # Optional filter by items whose name is sorted equally than a given input string., nameLessThan: str # Optional filter by items whose name is equally or lesser than a given input string., enableImages: bool=true # Optional, include image information in output., enableTotalRecordCount: bool=true # Optional. Include total record count.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Music genres returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /MusicGenres/{genreName}\n@desc Gets a music genre, by name.\n@required {genreName: str # The genre name.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data.}\n@returns(200) {Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}}} # Success\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Notifications\n@endpoint GET /Notifications/{userId}\n@desc Gets a user's notifications.\n@required {userId: str}\n@returns(200) {Notifications: [map]?, TotalRecordCount: int(int32)} # Notifications returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Notifications/{userId}/Read\n@desc Sets notifications as read.\n@required {userId: str}\n@returns(204) Notifications set as read.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Notifications/{userId}/Summary\n@desc Gets a user's notification summary.\n@required {userId: str}\n@returns(200) {UnreadCount: int(int32), MaxUnreadNotificationLevel: str} # Summary of user's notifications returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Notifications/{userId}/Unread\n@desc Sets notifications as unread.\n@required {userId: str}\n@returns(204) Notifications set as unread.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Notifications/Admin\n@desc Sends a notification to all admins.\n@optional {url: str # The URL of the notification., level: str # The level of the notification., name: str= # The name of the notification., description: str= # The description of the notification.}\n@returns(204) Notification sent.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Notifications/Services\n@desc Gets notification services.\n@returns(200) All notification services returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Notifications/Types\n@desc Gets notification types.\n@returns(200) All notification types returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Packages\n@endpoint GET /Packages\n@desc Gets available packages.\n@returns(200) Available packages returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Packages/{name}\n@desc Gets a package by name or assembly GUID.\n@required {name: str # The name of the package.}\n@optional {assemblyGuid: str(uuid) # The GUID of the associated assembly.}\n@returns(200) {name: str?, description: str?, overview: str?, owner: str?, category: str?, guid: str?, versions: [map]?, imageUrl: str?} # Package retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Packages/Installed/{name}\n@desc Installs a package.\n@required {name: str # Package name.}\n@optional {assemblyGuid: str(uuid) # GUID of the associated assembly., version: str # Optional version. Defaults to latest version., repositoryUrl: str # Optional. Specify the repository to install from.}\n@returns(204) Package found.\n@errors {401: Unauthorized, 403: Forbidden, 404: Package not found.}\n\n@endpoint DELETE /Packages/Installing/{packageId}\n@desc Cancels a package installation.\n@required {packageId: str(uuid) # Installation Id.}\n@returns(204) Installation cancelled.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Repositories\n@endpoint GET /Repositories\n@desc Gets all package repositories.\n@returns(200) Package repositories returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Repositories\n@desc Sets the enabled and existing package repositories.\n@returns(204) Package repositories saved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Persons\n@endpoint GET /Persons\n@desc Gets all persons.\n@optional {limit: int(int32) # Optional. The maximum number of records to return., searchTerm: str # The search term., fields: [str] # Optional. Specify additional fields of information to return in the output., filters: [str] # Optional. Specify additional filters to apply., isFavorite: bool # Optional filter by items that are marked as favorite, or not. userId is required., enableUserData: bool # Optional, include user data., imageTypeLimit: int(int32) # Optional, the max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., excludePersonTypes: [str] # Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited., personTypes: [str] # Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited., appearsInItemId: str(uuid) # Optional. If specified, person results will be filtered on items related to said persons., userId: str(uuid) # User id., enableImages: bool=true # Optional, include image information in output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Persons returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Persons/{name}\n@desc Get person by name.\n@required {name: str # Person name.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data.}\n@returns(200) {Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}}} # Person returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Person not found.}\n\n@endgroup\n\n@group Playlists\n@endpoint POST /Playlists\n@desc Creates a new playlist.\n@optional {name: str # The playlist name., ids: [str(uuid)] # The item ids., userId: str(uuid) # The user id., mediaType: str # The media type., Name: str # Gets or sets the name of the new playlist., Ids: [str(uuid)] # Gets or sets item ids to add to the playlist., UserId: str(uuid) # Gets or sets the user id., MediaType: str # Gets or sets the media type.}\n@returns(200) {Id: str?} # Success\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Playlists/{playlistId}/Items\n@desc Adds items to a playlist.\n@required {playlistId: str(uuid) # The playlist id.}\n@optional {ids: [str(uuid)] # Item id, comma delimited., userId: str(uuid) # The userId.}\n@returns(204) Items added to playlist.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Playlists/{playlistId}/Items\n@desc Removes items from a playlist.\n@required {playlistId: str # The playlist id.}\n@optional {entryIds: [str] # The item ids, comma delimited.}\n@returns(204) Items removed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Playlists/{playlistId}/Items\n@desc Gets the original items of a playlist.\n@required {playlistId: str(uuid) # The playlist id., userId: str(uuid) # User id.}\n@optional {startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output., enableImages: bool # Optional. Include image information in output., enableUserData: bool # Optional. Include user data., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Original playlist returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Playlist not found.}\n\n@endpoint POST /Playlists/{playlistId}/Items/{itemId}/Move/{newIndex}\n@desc Moves a playlist item.\n@required {playlistId: str # The playlist id., itemId: str # The item id., newIndex: int(int32) # The new index.}\n@returns(204) Item moved to new index.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Sessions\n@endpoint POST /Sessions/Playing\n@desc Reports playback has started within a session.\n@optional {CanSeek: bool # Gets or sets a value indicating whether this instance can seek., Item: map{Name: str, OriginalTitle: str, ServerId: str, Id: str(uuid), Etag: str, SourceType: str, PlaylistItemId: str, DateCreated: str(date-time), DateLastMediaAdded: str(date-time), ExtraType: str, AirsBeforeSeasonNumber: int(int32), AirsAfterSeasonNumber: int(int32), AirsBeforeEpisodeNumber: int(int32), CanDelete: bool, CanDownload: bool, HasSubtitles: bool, PreferredMetadataLanguage: str, PreferredMetadataCountryCode: str, SupportsSync: bool, Container: str, SortName: str, ForcedSortName: str, Video3DFormat: str, PremiereDate: str(date-time), ExternalUrls: [map], MediaSources: [map], CriticRating: num(float), ProductionLocations: [str], Path: str, EnableMediaSourceDisplay: bool, OfficialRating: str, CustomRating: str, ChannelId: str(uuid), ChannelName: str, Overview: str, Taglines: [str], Genres: [str], CommunityRating: num(float), CumulativeRunTimeTicks: int(int64), RunTimeTicks: int(int64), PlayAccess: str, AspectRatio: str, ProductionYear: int(int32), IsPlaceHolder: bool, Number: str, ChannelNumber: str, IndexNumber: int(int32), IndexNumberEnd: int(int32), ParentIndexNumber: int(int32), RemoteTrailers: [map], ProviderIds: map, IsHD: bool, IsFolder: bool, ParentId: str(uuid), Type: str, People: [map], Studios: [map], GenreItems: [map], ParentLogoItemId: str, ParentBackdropItemId: str, ParentBackdropImageTags: [str], LocalTrailerCount: int(int32), UserData: map, RecursiveItemCount: int(int32), ChildCount: int(int32), SeriesName: str, SeriesId: str(uuid), SeasonId: str(uuid), SpecialFeatureCount: int(int32), DisplayPreferencesId: str, Status: str, AirTime: str, AirDays: [str], Tags: [str], PrimaryImageAspectRatio: num(double), Artists: [str], ArtistItems: [map], Album: str, CollectionType: str, DisplayOrder: str, AlbumId: str(uuid), AlbumPrimaryImageTag: str, SeriesPrimaryImageTag: str, AlbumArtist: str, AlbumArtists: [map], SeasonName: str, MediaStreams: [map], VideoType: str, PartCount: int(int32), MediaSourceCount: int(int32), ImageTags: map, BackdropImageTags: [str], ScreenshotImageTags: [str], ParentLogoImageTag: str, ParentArtItemId: str, ParentArtImageTag: str, SeriesThumbImageTag: str, ImageBlurHashes: map, SeriesStudio: str, ParentThumbItemId: str, ParentThumbImageTag: str, ParentPrimaryImageItemId: str, ParentPrimaryImageTag: str, Chapters: [map], LocationType: str, IsoType: str, MediaType: str, EndDate: str(date-time), LockedFields: [str], TrailerCount: int(int32), MovieCount: int(int32), SeriesCount: int(int32), ProgramCount: int(int32), EpisodeCount: int(int32), SongCount: int(int32), AlbumCount: int(int32), ArtistCount: int(int32), MusicVideoCount: int(int32), LockData: bool, Width: int(int32), Height: int(int32), CameraMake: str, CameraModel: str, Software: str, ExposureTime: num(double), FocalLength: num(double), ImageOrientation: str, Aperture: num(double), ShutterSpeed: num(double), Latitude: num(double), Longitude: num(double), Altitude: num(double), IsoSpeedRating: int(int32), SeriesTimerId: str, ProgramId: str, ChannelPrimaryImageTag: str, StartDate: str(date-time), CompletionPercentage: num(double), IsRepeat: bool, EpisodeTitle: str, ChannelType: str, Audio: str, IsMovie: bool, IsSports: bool, IsSeries: bool, IsLive: bool, IsNews: bool, IsKids: bool, IsPremiere: bool, TimerId: str, CurrentProgram: map} # This is strictly used as a data transfer object from the api layer.\r This holds information about a BaseItem in a format that is convenient for the client., ItemId: str(uuid) # Gets or sets the item identifier., SessionId: str # Gets or sets the session id., MediaSourceId: str # Gets or sets the media version identifier., AudioStreamIndex: int(int32) # Gets or sets the index of the audio stream., SubtitleStreamIndex: int(int32) # Gets or sets the index of the subtitle stream., IsPaused: bool # Gets or sets a value indicating whether this instance is paused., IsMuted: bool # Gets or sets a value indicating whether this instance is muted., PositionTicks: int(int64) # Gets or sets the position ticks., PlaybackStartTimeTicks: int(int64), VolumeLevel: int(int32) # Gets or sets the volume level., Brightness: int(int32), AspectRatio: str, PlayMethod: str(Transcode/DirectStream/DirectPlay), LiveStreamId: str # Gets or sets the live stream identifier., PlaySessionId: str # Gets or sets the play session identifier., RepeatMode: str(RepeatNone/RepeatAll/RepeatOne), NowPlayingQueue: [map{Id: str(uuid), PlaylistItemId: str}], PlaylistItemId: str}\n@returns(204) Playback start recorded.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/Playing/Ping\n@desc Pings a playback session.\n@optional {playSessionId: str # Playback session id.}\n@returns(204) Playback session pinged.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/Playing/Progress\n@desc Reports playback progress within a session.\n@optional {CanSeek: bool # Gets or sets a value indicating whether this instance can seek., Item: map{Name: str, OriginalTitle: str, ServerId: str, Id: str(uuid), Etag: str, SourceType: str, PlaylistItemId: str, DateCreated: str(date-time), DateLastMediaAdded: str(date-time), ExtraType: str, AirsBeforeSeasonNumber: int(int32), AirsAfterSeasonNumber: int(int32), AirsBeforeEpisodeNumber: int(int32), CanDelete: bool, CanDownload: bool, HasSubtitles: bool, PreferredMetadataLanguage: str, PreferredMetadataCountryCode: str, SupportsSync: bool, Container: str, SortName: str, ForcedSortName: str, Video3DFormat: str, PremiereDate: str(date-time), ExternalUrls: [map], MediaSources: [map], CriticRating: num(float), ProductionLocations: [str], Path: str, EnableMediaSourceDisplay: bool, OfficialRating: str, CustomRating: str, ChannelId: str(uuid), ChannelName: str, Overview: str, Taglines: [str], Genres: [str], CommunityRating: num(float), CumulativeRunTimeTicks: int(int64), RunTimeTicks: int(int64), PlayAccess: str, AspectRatio: str, ProductionYear: int(int32), IsPlaceHolder: bool, Number: str, ChannelNumber: str, IndexNumber: int(int32), IndexNumberEnd: int(int32), ParentIndexNumber: int(int32), RemoteTrailers: [map], ProviderIds: map, IsHD: bool, IsFolder: bool, ParentId: str(uuid), Type: str, People: [map], Studios: [map], GenreItems: [map], ParentLogoItemId: str, ParentBackdropItemId: str, ParentBackdropImageTags: [str], LocalTrailerCount: int(int32), UserData: map, RecursiveItemCount: int(int32), ChildCount: int(int32), SeriesName: str, SeriesId: str(uuid), SeasonId: str(uuid), SpecialFeatureCount: int(int32), DisplayPreferencesId: str, Status: str, AirTime: str, AirDays: [str], Tags: [str], PrimaryImageAspectRatio: num(double), Artists: [str], ArtistItems: [map], Album: str, CollectionType: str, DisplayOrder: str, AlbumId: str(uuid), AlbumPrimaryImageTag: str, SeriesPrimaryImageTag: str, AlbumArtist: str, AlbumArtists: [map], SeasonName: str, MediaStreams: [map], VideoType: str, PartCount: int(int32), MediaSourceCount: int(int32), ImageTags: map, BackdropImageTags: [str], ScreenshotImageTags: [str], ParentLogoImageTag: str, ParentArtItemId: str, ParentArtImageTag: str, SeriesThumbImageTag: str, ImageBlurHashes: map, SeriesStudio: str, ParentThumbItemId: str, ParentThumbImageTag: str, ParentPrimaryImageItemId: str, ParentPrimaryImageTag: str, Chapters: [map], LocationType: str, IsoType: str, MediaType: str, EndDate: str(date-time), LockedFields: [str], TrailerCount: int(int32), MovieCount: int(int32), SeriesCount: int(int32), ProgramCount: int(int32), EpisodeCount: int(int32), SongCount: int(int32), AlbumCount: int(int32), ArtistCount: int(int32), MusicVideoCount: int(int32), LockData: bool, Width: int(int32), Height: int(int32), CameraMake: str, CameraModel: str, Software: str, ExposureTime: num(double), FocalLength: num(double), ImageOrientation: str, Aperture: num(double), ShutterSpeed: num(double), Latitude: num(double), Longitude: num(double), Altitude: num(double), IsoSpeedRating: int(int32), SeriesTimerId: str, ProgramId: str, ChannelPrimaryImageTag: str, StartDate: str(date-time), CompletionPercentage: num(double), IsRepeat: bool, EpisodeTitle: str, ChannelType: str, Audio: str, IsMovie: bool, IsSports: bool, IsSeries: bool, IsLive: bool, IsNews: bool, IsKids: bool, IsPremiere: bool, TimerId: str, CurrentProgram: map} # This is strictly used as a data transfer object from the api layer.\r This holds information about a BaseItem in a format that is convenient for the client., ItemId: str(uuid) # Gets or sets the item identifier., SessionId: str # Gets or sets the session id., MediaSourceId: str # Gets or sets the media version identifier., AudioStreamIndex: int(int32) # Gets or sets the index of the audio stream., SubtitleStreamIndex: int(int32) # Gets or sets the index of the subtitle stream., IsPaused: bool # Gets or sets a value indicating whether this instance is paused., IsMuted: bool # Gets or sets a value indicating whether this instance is muted., PositionTicks: int(int64) # Gets or sets the position ticks., PlaybackStartTimeTicks: int(int64), VolumeLevel: int(int32) # Gets or sets the volume level., Brightness: int(int32), AspectRatio: str, PlayMethod: str(Transcode/DirectStream/DirectPlay), LiveStreamId: str # Gets or sets the live stream identifier., PlaySessionId: str # Gets or sets the play session identifier., RepeatMode: str(RepeatNone/RepeatAll/RepeatOne), NowPlayingQueue: [map{Id: str(uuid), PlaylistItemId: str}], PlaylistItemId: str}\n@returns(204) Playback progress recorded.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/Playing/Stopped\n@desc Reports playback has stopped within a session.\n@optional {Item: map{Name: str, OriginalTitle: str, ServerId: str, Id: str(uuid), Etag: str, SourceType: str, PlaylistItemId: str, DateCreated: str(date-time), DateLastMediaAdded: str(date-time), ExtraType: str, AirsBeforeSeasonNumber: int(int32), AirsAfterSeasonNumber: int(int32), AirsBeforeEpisodeNumber: int(int32), CanDelete: bool, CanDownload: bool, HasSubtitles: bool, PreferredMetadataLanguage: str, PreferredMetadataCountryCode: str, SupportsSync: bool, Container: str, SortName: str, ForcedSortName: str, Video3DFormat: str, PremiereDate: str(date-time), ExternalUrls: [map], MediaSources: [map], CriticRating: num(float), ProductionLocations: [str], Path: str, EnableMediaSourceDisplay: bool, OfficialRating: str, CustomRating: str, ChannelId: str(uuid), ChannelName: str, Overview: str, Taglines: [str], Genres: [str], CommunityRating: num(float), CumulativeRunTimeTicks: int(int64), RunTimeTicks: int(int64), PlayAccess: str, AspectRatio: str, ProductionYear: int(int32), IsPlaceHolder: bool, Number: str, ChannelNumber: str, IndexNumber: int(int32), IndexNumberEnd: int(int32), ParentIndexNumber: int(int32), RemoteTrailers: [map], ProviderIds: map, IsHD: bool, IsFolder: bool, ParentId: str(uuid), Type: str, People: [map], Studios: [map], GenreItems: [map], ParentLogoItemId: str, ParentBackdropItemId: str, ParentBackdropImageTags: [str], LocalTrailerCount: int(int32), UserData: map, RecursiveItemCount: int(int32), ChildCount: int(int32), SeriesName: str, SeriesId: str(uuid), SeasonId: str(uuid), SpecialFeatureCount: int(int32), DisplayPreferencesId: str, Status: str, AirTime: str, AirDays: [str], Tags: [str], PrimaryImageAspectRatio: num(double), Artists: [str], ArtistItems: [map], Album: str, CollectionType: str, DisplayOrder: str, AlbumId: str(uuid), AlbumPrimaryImageTag: str, SeriesPrimaryImageTag: str, AlbumArtist: str, AlbumArtists: [map], SeasonName: str, MediaStreams: [map], VideoType: str, PartCount: int(int32), MediaSourceCount: int(int32), ImageTags: map, BackdropImageTags: [str], ScreenshotImageTags: [str], ParentLogoImageTag: str, ParentArtItemId: str, ParentArtImageTag: str, SeriesThumbImageTag: str, ImageBlurHashes: map, SeriesStudio: str, ParentThumbItemId: str, ParentThumbImageTag: str, ParentPrimaryImageItemId: str, ParentPrimaryImageTag: str, Chapters: [map], LocationType: str, IsoType: str, MediaType: str, EndDate: str(date-time), LockedFields: [str], TrailerCount: int(int32), MovieCount: int(int32), SeriesCount: int(int32), ProgramCount: int(int32), EpisodeCount: int(int32), SongCount: int(int32), AlbumCount: int(int32), ArtistCount: int(int32), MusicVideoCount: int(int32), LockData: bool, Width: int(int32), Height: int(int32), CameraMake: str, CameraModel: str, Software: str, ExposureTime: num(double), FocalLength: num(double), ImageOrientation: str, Aperture: num(double), ShutterSpeed: num(double), Latitude: num(double), Longitude: num(double), Altitude: num(double), IsoSpeedRating: int(int32), SeriesTimerId: str, ProgramId: str, ChannelPrimaryImageTag: str, StartDate: str(date-time), CompletionPercentage: num(double), IsRepeat: bool, EpisodeTitle: str, ChannelType: str, Audio: str, IsMovie: bool, IsSports: bool, IsSeries: bool, IsLive: bool, IsNews: bool, IsKids: bool, IsPremiere: bool, TimerId: str, CurrentProgram: map} # This is strictly used as a data transfer object from the api layer.\r This holds information about a BaseItem in a format that is convenient for the client., ItemId: str(uuid) # Gets or sets the item identifier., SessionId: str # Gets or sets the session id., MediaSourceId: str # Gets or sets the media version identifier., PositionTicks: int(int64) # Gets or sets the position ticks., LiveStreamId: str # Gets or sets the live stream identifier., PlaySessionId: str # Gets or sets the play session identifier., Failed: bool # Gets or sets a value indicating whether this MediaBrowser.Model.Session.PlaybackStopInfo is failed., NextMediaType: str, PlaylistItemId: str, NowPlayingQueue: [map{Id: str(uuid), PlaylistItemId: str}]}\n@returns(204) Playback stop recorded.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Users\n@endpoint POST /Users/{userId}/PlayedItems/{itemId}\n@desc Marks an item as played for user.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@optional {datePlayed: str(date-time) # Optional. The date the item was played.}\n@returns(200) {Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?} # Item marked as played.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Users/{userId}/PlayedItems/{itemId}\n@desc Marks an item as unplayed for user.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@returns(200) {Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?} # Item marked as unplayed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Users/{userId}/PlayingItems/{itemId}\n@desc Reports that a user has begun playing an item.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@optional {mediaSourceId: str # The id of the MediaSource., audioStreamIndex: int(int32) # The audio stream index., subtitleStreamIndex: int(int32) # The subtitle stream index., playMethod: str # The play method., liveStreamId: str # The live stream id., playSessionId: str # The play session id., canSeek: bool=false # Indicates if the client can seek.}\n@returns(204) Play start recorded.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Users/{userId}/PlayingItems/{itemId}\n@desc Reports that a user has stopped playing an item.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@optional {mediaSourceId: str # The id of the MediaSource., nextMediaType: str # The next media type that will play., positionTicks: int(int64) # Optional. The position, in ticks, where playback stopped. 1 tick = 10000 ms., liveStreamId: str # The live stream id., playSessionId: str # The play session id.}\n@returns(204) Playback stop recorded.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Users/{userId}/PlayingItems/{itemId}/Progress\n@desc Reports a user's playback progress.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@optional {mediaSourceId: str # The id of the MediaSource., positionTicks: int(int64) # Optional. The current position, in ticks. 1 tick = 10000 ms., audioStreamIndex: int(int32) # The audio stream index., subtitleStreamIndex: int(int32) # The subtitle stream index., volumeLevel: int(int32) # Scale of 0-100., playMethod: str # The play method., liveStreamId: str # The live stream id., playSessionId: str # The play session id., repeatMode: str # The repeat mode., isPaused: bool=false # Indicates if the player is paused., isMuted: bool=false # Indicates if the player is muted.}\n@returns(204) Play progress recorded.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Plugins\n@endpoint GET /Plugins\n@desc Gets a list of currently installed plugins.\n@returns(200) Installed plugins returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Plugins/{pluginId}\n@desc Uninstalls a plugin.\n@required {pluginId: str(uuid) # Plugin id.}\n@returns(204) Plugin uninstalled.\n@errors {401: Unauthorized, 403: Forbidden, 404: Plugin not found.}\n\n@endpoint DELETE /Plugins/{pluginId}/{version}\n@desc Uninstalls a plugin by version.\n@required {pluginId: str(uuid) # Plugin id., version: map # Plugin version.}\n@returns(204) Plugin uninstalled.\n@errors {401: Unauthorized, 403: Forbidden, 404: Plugin not found.}\n\n@endpoint POST /Plugins/{pluginId}/{version}/Disable\n@desc Disable a plugin.\n@required {pluginId: str(uuid) # Plugin id., version: map # Plugin version.}\n@returns(204) Plugin disabled.\n@errors {401: Unauthorized, 403: Forbidden, 404: Plugin not found.}\n\n@endpoint POST /Plugins/{pluginId}/{version}/Enable\n@desc Enables a disabled plugin.\n@required {pluginId: str(uuid) # Plugin id., version: map # Plugin version.}\n@returns(204) Plugin enabled.\n@errors {401: Unauthorized, 403: Forbidden, 404: Plugin not found.}\n\n@endpoint GET /Plugins/{pluginId}/{version}/Image\n@desc Gets a plugin's image.\n@required {pluginId: str(uuid) # Plugin id., version: map # Plugin version.}\n@returns(200) Plugin image returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found}\n\n@endpoint GET /Plugins/{pluginId}/Configuration\n@desc Gets plugin configuration.\n@required {pluginId: str(uuid) # Plugin id.}\n@returns(200) Plugin configuration returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Plugin not found or plugin configuration not found.}\n\n@endpoint POST /Plugins/{pluginId}/Configuration\n@desc Updates plugin configuration.\n@required {pluginId: str(uuid) # Plugin id.}\n@returns(204) Plugin configuration updated.\n@errors {401: Unauthorized, 403: Forbidden, 404: Plugin not found or plugin does not have configuration.}\n\n@endpoint POST /Plugins/{pluginId}/Manifest\n@desc Gets a plugin's manifest.\n@required {pluginId: str(uuid) # Plugin id.}\n@returns(204) Plugin manifest returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Plugin not found.}\n\n@endpoint POST /Plugins/SecurityInfo\n@desc Updates plugin security info.\n@optional {SupporterKey: str # Gets or sets the supporter key., IsMbSupporter: bool # Gets or sets a value indicating whether is mb supporter.}\n@returns(204) Plugin security info updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group QuickConnect\n@endpoint POST /QuickConnect/Activate\n@desc Temporarily activates quick connect for five minutes.\n@returns(204) Quick connect has been temporarily activated.\n@errors {401: Unauthorized, 403: Quick connect is unavailable on this server.}\n\n@endpoint POST /QuickConnect/Authorize\n@desc Authorizes a pending quick connect request.\n@required {code: str # Quick connect code to authorize.}\n@returns(200) Quick connect result authorized successfully.\n@errors {401: Unauthorized, 403: Unknown user id.}\n\n@endpoint POST /QuickConnect/Available\n@desc Enables or disables quick connect.\n@optional {status: str # New MediaBrowser.Model.QuickConnect.QuickConnectState.}\n@returns(204) Quick connect state set successfully.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /QuickConnect/Connect\n@desc Attempts to retrieve authentication information.\n@required {secret: str # Secret previously returned from the Initiate endpoint.}\n@returns(200) {Authenticated: bool, Secret: str?, Code: str?, Authentication: str?, Error: str?, DateAdded: str(date-time)?} # Quick connect result returned.\n@errors {404: Unknown quick connect secret.}\n\n@endpoint POST /QuickConnect/Deauthorize\n@desc Deauthorize all quick connect devices for the current user.\n@returns(200) All quick connect devices were deleted.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /QuickConnect/Initiate\n@desc Initiate a new quick connect request.\n@returns(200) {Authenticated: bool, Secret: str?, Code: str?, Authentication: str?, Error: str?, DateAdded: str(date-time)?} # Quick connect request successfully created.\n@errors {401: Quick connect is not active on this server.}\n\n@endpoint GET /QuickConnect/Status\n@desc Gets the current quick connect state.\n@returns(200) Quick connect state returned.\n\n@endgroup\n\n@group Images\n@endpoint GET /Images/Remote\n@desc Gets a remote image.\n@required {imageUrl: str(uri) # The image url.}\n@returns(200) Remote image returned.\n@errors {404: Remote image not found.}\n\n@endgroup\n\n@group Items\n@endpoint GET /Items/{itemId}/RemoteImages\n@desc Gets available remote images for an item.\n@required {itemId: str(uuid) # Item Id.}\n@optional {type: str # The image type., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., providerName: str # Optional. The image provider to use., includeAllLanguages: bool=false # Optional. Include all languages.}\n@returns(200) {Images: [map]?, TotalRecordCount: int(int32), Providers: [str]?} # Remote Images returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endpoint POST /Items/{itemId}/RemoteImages/Download\n@desc Downloads a remote image for an item.\n@required {itemId: str(uuid) # Item Id., type: str # The image type.}\n@optional {imageUrl: str # The image url.}\n@returns(204) Remote image downloaded.\n@errors {401: Unauthorized, 403: Forbidden, 404: Remote image not found.}\n\n@endpoint GET /Items/{itemId}/RemoteImages/Providers\n@desc Gets available remote image providers for an item.\n@required {itemId: str(uuid) # Item Id.}\n@returns(200) Returned remote image providers.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endgroup\n\n@group ScheduledTasks\n@endpoint GET /ScheduledTasks\n@desc Get tasks.\n@optional {isHidden: bool # Optional filter tasks that are hidden, or not., isEnabled: bool # Optional filter tasks that are enabled, or not.}\n@returns(200) Scheduled tasks retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /ScheduledTasks/{taskId}\n@desc Get task by id.\n@required {taskId: str # Task Id.}\n@returns(200) {Name: str?, State: str, CurrentProgressPercentage: num(double)?, Id: str?, LastExecutionResult: map{StartTimeUtc: str(date-time), EndTimeUtc: str(date-time), Status: str, Name: str?, Key: str?, Id: str?, ErrorMessage: str?, LongErrorMessage: str?}, Triggers: [map]?, Description: str?, Category: str?, IsHidden: bool, Key: str?} # Task retrieved.\n@errors {401: Unauthorized, 403: Forbidden, 404: Task not found.}\n\n@endpoint POST /ScheduledTasks/{taskId}/Triggers\n@desc Update specified task triggers.\n@required {taskId: str # Task Id.}\n@returns(204) Task triggers updated.\n@errors {401: Unauthorized, 403: Forbidden, 404: Task not found.}\n\n@endpoint POST /ScheduledTasks/Running/{taskId}\n@desc Start specified task.\n@required {taskId: str # Task Id.}\n@returns(204) Task started.\n@errors {401: Unauthorized, 403: Forbidden, 404: Task not found.}\n\n@endpoint DELETE /ScheduledTasks/Running/{taskId}\n@desc Stop specified task.\n@required {taskId: str # Task Id.}\n@returns(204) Task stopped.\n@errors {401: Unauthorized, 403: Forbidden, 404: Task not found.}\n\n@endgroup\n\n@group Search\n@endpoint GET /Search/Hints\n@desc Gets the search hint result.\n@required {searchTerm: str # The search term to filter on.}\n@optional {startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., userId: str(uuid) # Optional. Supply a user id to search within a user's library or omit to search all., includeItemTypes: [str] # If specified, only results with the specified item types are returned. This allows multiple, comma delimeted., excludeItemTypes: [str] # If specified, results with these item types are filtered out. This allows multiple, comma delimeted., mediaTypes: [str] # If specified, only results with the specified media types are returned. This allows multiple, comma delimeted., parentId: str(uuid) # If specified, only children of the parent are returned., isMovie: bool # Optional filter for movies., isSeries: bool # Optional filter for series., isNews: bool # Optional filter for news., isKids: bool # Optional filter for kids., isSports: bool # Optional filter for sports., includePeople: bool=true # Optional filter whether to include people., includeMedia: bool=true # Optional filter whether to include media., includeGenres: bool=true # Optional filter whether to include genres., includeStudios: bool=true # Optional filter whether to include studios., includeArtists: bool=true # Optional filter whether to include artists.}\n@returns(200) {SearchHints: [map]?, TotalRecordCount: int(int32)} # Search hint returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Auth\n@endpoint GET /Auth/PasswordResetProviders\n@desc Get all password reset providers.\n@returns(200) Password reset providers retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Auth/Providers\n@desc Get all auth providers.\n@returns(200) Auth providers retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Sessions\n@endpoint GET /Sessions\n@desc Gets a list of sessions.\n@optional {controllableByUserId: str(uuid) # Filter by sessions that a given user is allowed to remote control., deviceId: str # Filter by device Id., activeWithinSeconds: int(int32) # Optional. Filter by sessions that were active in the last n seconds.}\n@returns(200) List of sessions returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/{sessionId}/Command\n@desc Issues a full general command to a client.\n@required {sessionId: str # The session id.}\n@optional {Name: str(MoveUp/MoveDown/MoveLeft/MoveRight/PageUp/PageDown/PreviousLetter/NextLetter/ToggleOsd/ToggleContextMenu/Select/Back/TakeScreenshot/SendKey/SendString/GoHome/GoToSettings/VolumeUp/VolumeDown/Mute/Unmute/ToggleMute/SetVolume/SetAudioStreamIndex/SetSubtitleStreamIndex/ToggleFullscreen/DisplayContent/GoToSearch/DisplayMessage/SetRepeatMode/ChannelUp/ChannelDown/Guide/ToggleStats/PlayMediaSource/PlayTrailers/SetShuffleQueue/PlayState/PlayNext/ToggleOsdMenu/Play) # This exists simply to identify a set of known commands., ControllingUserId: str(uuid), Arguments: map}\n@returns(204) Full general command sent to session.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/{sessionId}/Command/{command}\n@desc Issues a general command to a client.\n@required {sessionId: str # The session id., command: str # The command to send.}\n@returns(204) General command sent to session.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/{sessionId}/Message\n@desc Issues a command to a client to display a message to the user.\n@required {sessionId: str # The session id., text: str # The message test.}\n@optional {header: str # The message header., timeoutMs: int(int64) # The message timeout. If omitted the user will have to confirm viewing the message.}\n@returns(204) Message sent.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/{sessionId}/Playing\n@desc Instructs a session to play an item.\n@required {sessionId: str # The session id., playCommand: str # The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now., itemIds: [str(uuid)] # The ids of the items to play, comma delimited.}\n@optional {startPositionTicks: int(int64) # The starting position of the first item.}\n@returns(204) Instruction sent to session.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/{sessionId}/Playing/{command}\n@desc Issues a playstate command to a client.\n@required {sessionId: str # The session id., command: str # The MediaBrowser.Model.Session.PlaystateCommand.}\n@optional {seekPositionTicks: int(int64) # The optional position ticks., controllingUserId: str # The optional controlling user id.}\n@returns(204) Playstate command sent to session.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/{sessionId}/System/{command}\n@desc Issues a system command to a client.\n@required {sessionId: str # The session id., command: str # The command to send.}\n@returns(204) System command sent to session.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/{sessionId}/User/{userId}\n@desc Adds an additional user to a session.\n@required {sessionId: str # The session id., userId: str(uuid) # The user id.}\n@returns(204) User added to session.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Sessions/{sessionId}/User/{userId}\n@desc Removes an additional user from a session.\n@required {sessionId: str # The session id., userId: str(uuid) # The user id.}\n@returns(204) User removed from session.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/{sessionId}/Viewing\n@desc Instructs a session to browse to an item or view.\n@required {sessionId: str # The session Id., itemType: str # The type of item to browse to., itemId: str # The Id of the item., itemName: str # The name of the item.}\n@returns(204) Instruction sent to session.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/Capabilities\n@desc Updates capabilities for a device.\n@optional {id: str # The session id., playableMediaTypes: [str] # A list of playable media types, comma delimited. Audio, Video, Book, Photo., supportedCommands: [str] # A list of supported remote control commands, comma delimited., supportsMediaControl: bool=false # Determines whether media can be played remotely.., supportsSync: bool=false # Determines whether sync is supported., supportsPersistentIdentifier: bool=true # Determines whether the device supports a unique identifier.}\n@returns(204) Capabilities posted.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/Capabilities/Full\n@desc Updates capabilities for a device.\n@optional {id: str # The session id., PlayableMediaTypes: [str] # Gets or sets the list of playable media types., SupportedCommands: [str] # Gets or sets the list of supported commands., SupportsMediaControl: bool # Gets or sets a value indicating whether session supports media control., SupportsContentUploading: bool # Gets or sets a value indicating whether session supports content uploading., MessageCallbackUrl: str # Gets or sets the message callback url., SupportsPersistentIdentifier: bool # Gets or sets a value indicating whether session supports a persistent identifier., SupportsSync: bool # Gets or sets a value indicating whether session supports sync., DeviceProfile: map{Name: str, Id: str, Identification: map, FriendlyName: str, Manufacturer: str, ManufacturerUrl: str, ModelName: str, ModelDescription: str, ModelNumber: str, ModelUrl: str, SerialNumber: str, EnableAlbumArtInDidl: bool, EnableSingleAlbumArtLimit: bool, EnableSingleSubtitleLimit: bool, SupportedMediaTypes: str, UserId: str, AlbumArtPn: str, MaxAlbumArtWidth: int(int32), MaxAlbumArtHeight: int(int32), MaxIconWidth: int(int32), MaxIconHeight: int(int32), MaxStreamingBitrate: int(int32), MaxStaticBitrate: int(int32), MusicStreamingTranscodingBitrate: int(int32), MaxStaticMusicBitrate: int(int32), SonyAggregationFlags: str, ProtocolInfo: str, TimelineOffsetSeconds: int(int32), RequiresPlainVideoItems: bool, RequiresPlainFolders: bool, EnableMSMediaReceiverRegistrar: bool, IgnoreTranscodeByteRangeRequests: bool, XmlRootAttributes: [map], DirectPlayProfiles: [map], TranscodingProfiles: [map], ContainerProfiles: [map], CodecProfiles: [map], ResponseProfiles: [map], SubtitleProfiles: [map]} # Defines the MediaBrowser.Model.Dlna.DeviceProfile., AppStoreUrl: str # Gets or sets the app store url., IconUrl: str # Gets or sets the icon url.}\n@returns(204) Capabilities updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/Logout\n@desc Reports that a session has ended.\n@returns(204) Session end reported to server.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Sessions/Viewing\n@desc Reports that a session is viewing an item.\n@required {itemId: str # The item id.}\n@optional {sessionId: str # The session id.}\n@returns(204) Session reported to server.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Startup\n@endpoint POST /Startup/Complete\n@desc Completes the startup wizard.\n@returns(204) Startup wizard completed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Startup/Configuration\n@desc Gets the initial startup wizard configuration.\n@returns(200) {UICulture: str?, MetadataCountryCode: str?, PreferredMetadataLanguage: str?} # Initial startup wizard configuration retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Startup/Configuration\n@desc Sets the initial startup wizard configuration.\n@optional {UICulture: str # Gets or sets UI language culture., MetadataCountryCode: str # Gets or sets the metadata country code., PreferredMetadataLanguage: str # Gets or sets the preferred language for the metadata.}\n@returns(204) Configuration saved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Startup/FirstUser\n@desc Gets the first user.\n@returns(200) {Name: str?, Password: str?} # Initial user retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Startup/RemoteAccess\n@desc Sets remote access and UPnP.\n@required {EnableRemoteAccess: bool # Gets or sets a value indicating whether enable remote access., EnableAutomaticPortMapping: bool # Gets or sets a value indicating whether enable automatic port mapping.}\n@returns(204) Configuration saved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Startup/User\n@desc Gets the first user.\n@returns(200) {Name: str?, Password: str?} # Initial user retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Startup/User\n@desc Sets the user name and password.\n@optional {Name: str # Gets or sets the username., Password: str # Gets or sets the user's password.}\n@returns(204) Updated user name and password.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Studios\n@endpoint GET /Studios\n@desc Gets all studios from a given item, folder, or the entire library.\n@optional {startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., searchTerm: str # Optional. Search term., parentId: str(uuid) # Specify this to localize the search to a specific item or folder. Omit to use the root., fields: [str] # Optional. Specify additional fields of information to return in the output., excludeItemTypes: [str] # Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited., includeItemTypes: [str] # Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited., isFavorite: bool # Optional filter by items that are marked as favorite, or not., enableUserData: bool # Optional, include user data., imageTypeLimit: int(int32) # Optional, the max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., userId: str(uuid) # User id., nameStartsWithOrGreater: str # Optional filter by items whose name is sorted equally or greater than a given input string., nameStartsWith: str # Optional filter by items whose name is sorted equally than a given input string., nameLessThan: str # Optional filter by items whose name is equally or lesser than a given input string., enableImages: bool=true # Optional, include image information in output., enableTotalRecordCount: bool=true # Total record count.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Studios returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Studios/{name}\n@desc Gets a studio by name.\n@required {name: str # Studio name.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data.}\n@returns(200) {Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}}} # Studio returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group FallbackFont\n@endpoint GET /FallbackFont/Fonts\n@desc Gets a list of available fallback font files.\n@returns(200) Information retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /FallbackFont/Fonts/{name}\n@desc Gets a fallback font file.\n@required {name: str # The name of the fallback font file to get.}\n@returns(200) Fallback font file retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Items\n@endpoint GET /Items/{itemId}/RemoteSearch/Subtitles/{language}\n@desc Search remote subtitles.\n@required {itemId: str(uuid) # The item id., language: str # The language of the subtitles.}\n@optional {isPerfectMatch: bool # Optional. Only show subtitles which are a perfect match.}\n@returns(200) Subtitles retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Items/{itemId}/RemoteSearch/Subtitles/{subtitleId}\n@desc Downloads a remote subtitle.\n@required {itemId: str(uuid) # The item id., subtitleId: str # The subtitle id.}\n@returns(204) Subtitle downloaded.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Providers\n@endpoint GET /Providers/Subtitles/Subtitles/{id}\n@desc Gets the remote subtitles.\n@required {id: str # The item id.}\n@returns(200) File returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Videos\n@endpoint GET /Videos/{itemId}/{mediaSourceId}/Subtitles/{index}/{startPositionTicks}/Stream.{format}\n@desc Gets subtitles in a specified format.\n@required {itemId: str(uuid) # The item id., mediaSourceId: str # The media source id., index: int(int32) # The subtitle stream index., startPositionTicks: int(int64) # Optional. The start position of the subtitle in ticks., format: str # The format of the returned subtitle.}\n@optional {endPositionTicks: int(int64) # Optional. The end position of the subtitle in ticks., copyTimestamps: bool=false # Optional. Whether to copy the timestamps., addVttTimeMap: bool=false # Optional. Whether to add a VTT time map.}\n@returns(200) File returned.\n\n@endpoint GET /Videos/{itemId}/{mediaSourceId}/Subtitles/{index}/Stream.{format}\n@desc Gets subtitles in a specified format.\n@required {itemId: str(uuid) # The item id., mediaSourceId: str # The media source id., index: int(int32) # The subtitle stream index., format: str # The format of the returned subtitle.}\n@optional {endPositionTicks: int(int64) # Optional. The end position of the subtitle in ticks., copyTimestamps: bool=false # Optional. Whether to copy the timestamps., addVttTimeMap: bool=false # Optional. Whether to add a VTT time map., startPositionTicks: int(int64)=0 # Optional. The start position of the subtitle in ticks.}\n@returns(200) File returned.\n\n@endpoint GET /Videos/{itemId}/{mediaSourceId}/Subtitles/{index}/subtitles.m3u8\n@desc Gets an HLS subtitle playlist.\n@required {itemId: str(uuid) # The item id., index: int(int32) # The subtitle stream index., mediaSourceId: str # The media source id., segmentLength: int(int32) # The subtitle segment length.}\n@returns(200) Subtitle playlist retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Videos/{itemId}/Subtitles\n@desc Upload an external subtitle file.\n@required {itemId: str(uuid) # The item the subtitle belongs to., Language: str # Gets or sets the subtitle language., Format: str # Gets or sets the subtitle format., IsForced: bool # Gets or sets a value indicating whether the subtitle is forced., Data: str # Gets or sets the subtitle data.}\n@returns(204) Subtitle uploaded.\n\n@endpoint DELETE /Videos/{itemId}/Subtitles/{index}\n@desc Deletes an external subtitle file.\n@required {itemId: str(uuid) # The item id., index: int(int32) # The index of the subtitle file.}\n@returns(204) Subtitle deleted.\n@errors {401: Unauthorized, 403: Forbidden, 404: Item not found.}\n\n@endgroup\n\n@group Users\n@endpoint GET /Users/{userId}/Suggestions\n@desc Gets suggestions.\n@required {userId: str(uuid) # The user id.}\n@optional {mediaType: [str] # The media types., type: [str] # The type., startIndex: int(int32) # Optional. The start index., limit: int(int32) # Optional. The limit., enableTotalRecordCount: bool=false # Whether to enable the total record count.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Suggestions returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group SyncPlay\n@endpoint POST /SyncPlay/Buffering\n@desc Notify SyncPlay group that member is buffering.\n@optional {When: str(date-time) # Gets or sets when the request has been made by the client., PositionTicks: int(int64) # Gets or sets the position ticks., IsPlaying: bool # Gets or sets a value indicating whether the client playback is unpaused., PlaylistItemId: str(uuid) # Gets or sets the playlist item identifier of the playing item.}\n@returns(204) Group state update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/Join\n@desc Join an existing SyncPlay group.\n@optional {GroupId: str(uuid) # Gets or sets the group identifier.}\n@returns(204) Group join successful.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/Leave\n@desc Leave the joined SyncPlay group.\n@returns(204) Group leave successful.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /SyncPlay/List\n@desc Gets all SyncPlay groups.\n@returns(200) Groups returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/MovePlaylistItem\n@desc Request to move an item in the playlist in SyncPlay group.\n@optional {PlaylistItemId: str(uuid) # Gets or sets the playlist identifier of the item., NewIndex: int(int32) # Gets or sets the new position.}\n@returns(204) Queue update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/New\n@desc Create a new SyncPlay group.\n@optional {GroupName: str # Gets or sets the group name.}\n@returns(204) New group created.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/NextItem\n@desc Request next item in SyncPlay group.\n@optional {PlaylistItemId: str(uuid) # Gets or sets the playing item identifier.}\n@returns(204) Next item update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/Pause\n@desc Request pause in SyncPlay group.\n@returns(204) Pause update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/Ping\n@desc Update session ping.\n@optional {Ping: int(int64) # Gets or sets the ping time.}\n@returns(204) Ping updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/PreviousItem\n@desc Request previous item in SyncPlay group.\n@optional {PlaylistItemId: str(uuid) # Gets or sets the playing item identifier.}\n@returns(204) Previous item update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/Queue\n@desc Request to queue items to the playlist of a SyncPlay group.\n@optional {ItemIds: [str(uuid)] # Gets or sets the items to enqueue., Mode: str(Queue/QueueNext) # Enum GroupQueueMode.}\n@returns(204) Queue update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/Ready\n@desc Notify SyncPlay group that member is ready for playback.\n@optional {When: str(date-time) # Gets or sets when the request has been made by the client., PositionTicks: int(int64) # Gets or sets the position ticks., IsPlaying: bool # Gets or sets a value indicating whether the client playback is unpaused., PlaylistItemId: str(uuid) # Gets or sets the playlist item identifier of the playing item.}\n@returns(204) Group state update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/RemoveFromPlaylist\n@desc Request to remove items from the playlist in SyncPlay group.\n@optional {PlaylistItemIds: [str(uuid)] # Gets or sets the playlist identifiers ot the items.}\n@returns(204) Queue update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/Seek\n@desc Request seek in SyncPlay group.\n@optional {PositionTicks: int(int64) # Gets or sets the position ticks.}\n@returns(204) Seek update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/SetIgnoreWait\n@desc Request SyncPlay group to ignore member during group-wait.\n@optional {IgnoreWait: bool # Gets or sets a value indicating whether the client should be ignored.}\n@returns(204) Member state updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/SetNewQueue\n@desc Request to set new playlist in SyncPlay group.\n@optional {PlayingQueue: [str(uuid)] # Gets or sets the playing queue., PlayingItemPosition: int(int32) # Gets or sets the position of the playing item in the queue., StartPositionTicks: int(int64) # Gets or sets the start position ticks.}\n@returns(204) Queue update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/SetPlaylistItem\n@desc Request to change playlist item in SyncPlay group.\n@optional {PlaylistItemId: str(uuid) # Gets or sets the playlist identifier of the playing item.}\n@returns(204) Queue update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/SetRepeatMode\n@desc Request to set repeat mode in SyncPlay group.\n@optional {Mode: str(RepeatOne/RepeatAll/RepeatNone) # Enum GroupRepeatMode.}\n@returns(204) Play queue update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/SetShuffleMode\n@desc Request to set shuffle mode in SyncPlay group.\n@optional {Mode: str(Sorted/Shuffle) # Enum GroupShuffleMode.}\n@returns(204) Play queue update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/Stop\n@desc Request stop in SyncPlay group.\n@returns(204) Stop update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /SyncPlay/Unpause\n@desc Request unpause in SyncPlay group.\n@returns(204) Unpause update sent to all group members.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group System\n@endpoint GET /System/Endpoint\n@desc Gets information about the request endpoint.\n@returns(200) {IsLocal: bool, IsInNetwork: bool} # Information retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /System/Info\n@desc Gets information about the server.\n@returns(200) {LocalAddress: str?, ServerName: str?, Version: str?, ProductName: str?, OperatingSystem: str?, Id: str?, StartupWizardCompleted: bool?, OperatingSystemDisplayName: str?, PackageName: str?, HasPendingRestart: bool, IsShuttingDown: bool, SupportsLibraryMonitor: bool, WebSocketPortNumber: int(int32), CompletedInstallations: [map]?, CanSelfRestart: bool, CanLaunchWebBrowser: bool, ProgramDataPath: str?, WebPath: str?, ItemsByNamePath: str?, CachePath: str?, LogPath: str?, InternalMetadataPath: str?, TranscodingTempPath: str?, HasUpdateAvailable: bool, EncoderLocation: str, SystemArchitecture: str} # Information retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /System/Info/Public\n@desc Gets public information about the server.\n@returns(200) {LocalAddress: str?, ServerName: str?, Version: str?, ProductName: str?, OperatingSystem: str?, Id: str?, StartupWizardCompleted: bool?} # Information retrieved.\n\n@endpoint GET /System/Logs\n@desc Gets a list of available server log files.\n@returns(200) Information retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /System/Logs/Log\n@desc Gets a log file.\n@required {name: str # The name of the log file to get.}\n@returns(200) Log file retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /System/Ping\n@desc Pings the system.\n@returns(200) Information retrieved.\n\n@endpoint POST /System/Ping\n@desc Pings the system.\n@returns(200) Information retrieved.\n\n@endpoint POST /System/Restart\n@desc Restarts the application.\n@returns(204) Server restarted.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /System/Shutdown\n@desc Shuts down the application.\n@returns(204) Server shut down.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /System/WakeOnLanInfo\n@desc Gets wake on lan information.\n@returns(200) Information retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group GetUtcTime\n@endpoint GET /GetUtcTime\n@desc Gets the current UTC time.\n@returns(200) {RequestReceptionTime: str(date-time), ResponseTransmissionTime: str(date-time)} # Time returned.\n\n@endgroup\n\n@group Trailers\n@endpoint GET /Trailers\n@desc Finds movies and trailers similar to a given trailer.\n@optional {userId: str(uuid) # The user id., maxOfficialRating: str # Optional filter by maximum official rating (PG, PG-13, TV-MA, etc)., hasThemeSong: bool # Optional filter by items with theme songs., hasThemeVideo: bool # Optional filter by items with theme videos., hasSubtitles: bool # Optional filter by items with subtitles., hasSpecialFeature: bool # Optional filter by items with special features., hasTrailer: bool # Optional filter by items with trailers., adjacentTo: str # Optional. Return items that are siblings of a supplied item., parentIndexNumber: int(int32) # Optional filter by parent index number., hasParentalRating: bool # Optional filter by items that have or do not have a parental rating., isHd: bool # Optional filter by items that are HD or not., is4K: bool # Optional filter by items that are 4K or not., locationTypes: [str] # Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited., excludeLocationTypes: [str] # Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited., isMissing: bool # Optional filter by items that are missing episodes or not., isUnaired: bool # Optional filter by items that are unaired episodes or not., minCommunityRating: num(double) # Optional filter by minimum community rating., minCriticRating: num(double) # Optional filter by minimum critic rating., minPremiereDate: str(date-time) # Optional. The minimum premiere date. Format = ISO., minDateLastSaved: str(date-time) # Optional. The minimum last saved date. Format = ISO., minDateLastSavedForUser: str(date-time) # Optional. The minimum last saved date for the current user. Format = ISO., maxPremiereDate: str(date-time) # Optional. The maximum premiere date. Format = ISO., hasOverview: bool # Optional filter by items that have an overview or not., hasImdbId: bool # Optional filter by items that have an imdb id or not., hasTmdbId: bool # Optional filter by items that have a tmdb id or not., hasTvdbId: bool # Optional filter by items that have a tvdb id or not., excludeItemIds: [str(uuid)] # Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., recursive: bool # When searching within folders, this determines whether or not the search will be recursive. true/false., searchTerm: str # Optional. Filter based on a search term., sortOrder: str # Sort Order - Ascending,Descending., parentId: str(uuid) # Specify this to localize the search to a specific item or folder. Omit to use the root., fields: [str] # Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines., excludeItemTypes: [str] # Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited., filters: [str] # Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes., isFavorite: bool # Optional filter by items that are marked as favorite, or not., mediaTypes: [str] # Optional filter by MediaType. Allows multiple, comma delimited., imageTypes: [str] # Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited., sortBy: str # Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime., isPlayed: bool # Optional filter by items that are played, or not., genres: [str] # Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited., officialRatings: [str] # Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited., tags: [str] # Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited., years: [int(int32)] # Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited., enableUserData: bool # Optional, include user data., imageTypeLimit: int(int32) # Optional, the max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., person: str # Optional. If specified, results will be filtered to include only those containing the specified person., personIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified person id., personTypes: [str] # Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited., studios: [str] # Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited., artists: [str] # Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited., excludeArtistIds: [str(uuid)] # Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited., artistIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified artist id., albumArtistIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified album artist id., contributingArtistIds: [str(uuid)] # Optional. If specified, results will be filtered to include only those containing the specified contributing artist id., albums: [str] # Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited., albumIds: [str(uuid)] # Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited., ids: [str(uuid)] # Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited., videoTypes: [str] # Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited., minOfficialRating: str # Optional filter by minimum official rating (PG, PG-13, TV-MA, etc)., isLocked: bool # Optional filter by items that are locked., isPlaceHolder: bool # Optional filter by items that are placeholders., hasOfficialRating: bool # Optional filter by items that have official ratings., collapseBoxSetItems: bool # Whether or not to hide items behind their boxsets., minWidth: int(int32) # Optional. Filter by the minimum width of the item., minHeight: int(int32) # Optional. Filter by the minimum height of the item., maxWidth: int(int32) # Optional. Filter by the maximum width of the item., maxHeight: int(int32) # Optional. Filter by the maximum height of the item., is3D: bool # Optional filter by items that are 3D, or not., seriesStatus: [str] # Optional filter by Series Status. Allows multiple, comma delimited., nameStartsWithOrGreater: str # Optional filter by items whose name is sorted equally or greater than a given input string., nameStartsWith: str # Optional filter by items whose name is sorted equally than a given input string., nameLessThan: str # Optional filter by items whose name is equally or lesser than a given input string., studioIds: [str(uuid)] # Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited., genreIds: [str(uuid)] # Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited., enableTotalRecordCount: bool=true # Optional. Enable the total record count., enableImages: bool=true # Optional, include image information in output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Success\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Shows\n@endpoint GET /Shows/{seriesId}/Episodes\n@desc Gets episodes for a tv season.\n@required {seriesId: str(uuid) # The series id.}\n@optional {userId: str(uuid) # The user id., fields: [str] # Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls., season: int(int32) # Optional filter by season number., seasonId: str(uuid) # Optional. Filter by season id., isMissing: bool # Optional. Filter by items that are missing episodes or not., adjacentTo: str # Optional. Return items that are siblings of a supplied item., startItemId: str(uuid) # Optional. Skip through the list until a given item is found., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., enableImages: bool # Optional, include image information in output., imageTypeLimit: int(int32) # Optional, the max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., enableUserData: bool # Optional. Include user data., sortBy: str # Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Success\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found}\n\n@endpoint GET /Shows/{seriesId}/Seasons\n@desc Gets seasons for a tv series.\n@required {seriesId: str(uuid) # The series id.}\n@optional {userId: str(uuid) # The user id., fields: [str] # Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls., isSpecialSeason: bool # Optional. Filter by special season., isMissing: bool # Optional. Filter by items that are missing episodes or not., adjacentTo: str # Optional. Return items that are siblings of a supplied item., enableImages: bool # Optional. Include image information in output., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., enableUserData: bool # Optional. Include user data.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Success\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found}\n\n@endpoint GET /Shows/NextUp\n@desc Gets a list of next up episodes.\n@optional {userId: str(uuid) # The user id of the user to get the next up episodes for., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output., seriesId: str # Optional. Filter by series id., parentId: str(uuid) # Optional. Specify this to localize the search to a specific item or folder. Omit to use the root., enableImges: bool # Optional. Include image information in output., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., enableUserData: bool # Optional. Include user data., enableTotalRecordCount: bool=true # Whether to enable the total records count. Defaults to true.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Success\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Shows/Upcoming\n@desc Gets a list of upcoming episodes.\n@optional {userId: str(uuid) # The user id of the user to get the upcoming episodes for., startIndex: int(int32) # Optional. The record index to start at. All items with a lower index will be dropped from the results., limit: int(int32) # Optional. The maximum number of records to return., fields: [str] # Optional. Specify additional fields of information to return in the output., parentId: str(uuid) # Optional. Specify this to localize the search to a specific item or folder. Omit to use the root., enableImges: bool # Optional. Include image information in output., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., enableUserData: bool # Optional. Include user data.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Success\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Audio\n@endpoint GET /Audio/{itemId}/universal\n@desc Gets an audio stream.\n@required {itemId: str(uuid) # The item id.}\n@optional {container: [str] # Optional. The audio container., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., userId: str(uuid) # Optional. The user id., audioCodec: str # Optional. The audio codec to transcode to., maxAudioChannels: int(int32) # Optional. The maximum number of audio channels., transcodingAudioChannels: int(int32) # Optional. The number of how many audio channels to transcode to., maxStreamingBitrate: int(int32) # Optional. The maximum streaming bitrate., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., transcodingContainer: str # Optional. The container to transcode to., transcodingProtocol: str # Optional. The transcoding protocol., maxAudioSampleRate: int(int32) # Optional. The maximum audio sample rate., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., enableRemoteMedia: bool # Optional. Whether to enable remote media., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., enableRedirection: bool=true # Whether to enable redirection. Defaults to true.}\n@returns(200) Audio stream returned.\n@errors {302: Redirected to remote audio stream., 401: Unauthorized, 403: Forbidden}\n\n@endpoint HEAD /Audio/{itemId}/universal\n@desc Gets an audio stream.\n@required {itemId: str(uuid) # The item id.}\n@optional {container: [str] # Optional. The audio container., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., userId: str(uuid) # Optional. The user id., audioCodec: str # Optional. The audio codec to transcode to., maxAudioChannels: int(int32) # Optional. The maximum number of audio channels., transcodingAudioChannels: int(int32) # Optional. The number of how many audio channels to transcode to., maxStreamingBitrate: int(int32) # Optional. The maximum streaming bitrate., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., transcodingContainer: str # Optional. The container to transcode to., transcodingProtocol: str # Optional. The transcoding protocol., maxAudioSampleRate: int(int32) # Optional. The maximum audio sample rate., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., enableRemoteMedia: bool # Optional. Whether to enable remote media., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., enableRedirection: bool=true # Whether to enable redirection. Defaults to true.}\n@returns(200) Audio stream returned.\n@errors {302: Redirected to remote audio stream., 401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Users\n@endpoint GET /Users\n@desc Gets a list of users.\n@optional {isHidden: bool # Optional filter by IsHidden=true or false., isDisabled: bool # Optional filter by IsDisabled=true or false.}\n@returns(200) Users returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Users/{userId}\n@desc Gets a user by Id.\n@required {userId: str(uuid) # The user id.}\n@returns(200) {Name: str?, ServerId: str?, ServerName: str?, Id: str(uuid), PrimaryImageTag: str?, HasPassword: bool, HasConfiguredPassword: bool, HasConfiguredEasyPassword: bool, EnableAutoLogin: bool?, LastLoginDate: str(date-time)?, LastActivityDate: str(date-time)?, Configuration: map{AudioLanguagePreference: str?, PlayDefaultAudioTrack: bool, SubtitleLanguagePreference: str?, DisplayMissingEpisodes: bool, GroupedFolders: [str]?, SubtitleMode: str, DisplayCollectionsView: bool, EnableLocalPassword: bool, OrderedViews: [str]?, LatestItemsExcludes: [str]?, MyMediaExcludes: [str]?, HidePlayedInLatest: bool, RememberAudioSelections: bool, RememberSubtitleSelections: bool, EnableNextEpisodeAutoPlay: bool}, Policy: map{IsAdministrator: bool, IsHidden: bool, IsDisabled: bool, MaxParentalRating: int(int32)?, BlockedTags: [str]?, EnableUserPreferenceAccess: bool, AccessSchedules: [map]?, BlockUnratedItems: [str]?, EnableRemoteControlOfOtherUsers: bool, EnableSharedDeviceControl: bool, EnableRemoteAccess: bool, EnableLiveTvManagement: bool, EnableLiveTvAccess: bool, EnableMediaPlayback: bool, EnableAudioPlaybackTranscoding: bool, EnableVideoPlaybackTranscoding: bool, EnablePlaybackRemuxing: bool, ForceRemoteSourceTranscoding: bool, EnableContentDeletion: bool, EnableContentDeletionFromFolders: [str]?, EnableContentDownloading: bool, EnableSyncTranscoding: bool, EnableMediaConversion: bool, EnabledDevices: [str]?, EnableAllDevices: bool, EnabledChannels: [str(uuid)]?, EnableAllChannels: bool, EnabledFolders: [str(uuid)]?, EnableAllFolders: bool, InvalidLoginAttemptCount: int(int32), LoginAttemptsBeforeLockout: int(int32), MaxActiveSessions: int(int32), EnablePublicSharing: bool, BlockedMediaFolders: [str(uuid)]?, BlockedChannels: [str(uuid)]?, RemoteClientBitrateLimit: int(int32), AuthenticationProviderId: str?, PasswordResetProviderId: str?, SyncPlayAccess: str}, PrimaryImageAspectRatio: num(double)?} # User returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: User not found.}\n\n@endpoint DELETE /Users/{userId}\n@desc Deletes a user.\n@required {userId: str(uuid) # The user id.}\n@returns(204) User deleted.\n@errors {401: Unauthorized, 403: Forbidden, 404: User not found.}\n\n@endpoint POST /Users/{userId}\n@desc Updates a user.\n@required {userId: str(uuid) # The user id.}\n@optional {Name: str # Gets or sets the name., ServerId: str # Gets or sets the server identifier., ServerName: str # Gets or sets the name of the server.\r This is not used by the server and is for client-side usage only., Id: str(uuid) # Gets or sets the id., PrimaryImageTag: str # Gets or sets the primary image tag., HasPassword: bool # Gets or sets a value indicating whether this instance has password., HasConfiguredPassword: bool # Gets or sets a value indicating whether this instance has configured password., HasConfiguredEasyPassword: bool # Gets or sets a value indicating whether this instance has configured easy password., EnableAutoLogin: bool # Gets or sets whether async login is enabled or not., LastLoginDate: str(date-time) # Gets or sets the last login date., LastActivityDate: str(date-time) # Gets or sets the last activity date., Configuration: map{AudioLanguagePreference: str, PlayDefaultAudioTrack: bool, SubtitleLanguagePreference: str, DisplayMissingEpisodes: bool, GroupedFolders: [str], SubtitleMode: str, DisplayCollectionsView: bool, EnableLocalPassword: bool, OrderedViews: [str], LatestItemsExcludes: [str], MyMediaExcludes: [str], HidePlayedInLatest: bool, RememberAudioSelections: bool, RememberSubtitleSelections: bool, EnableNextEpisodeAutoPlay: bool} # Class UserConfiguration., Policy: map{IsAdministrator: bool, IsHidden: bool, IsDisabled: bool, MaxParentalRating: int(int32), BlockedTags: [str], EnableUserPreferenceAccess: bool, AccessSchedules: [map], BlockUnratedItems: [str], EnableRemoteControlOfOtherUsers: bool, EnableSharedDeviceControl: bool, EnableRemoteAccess: bool, EnableLiveTvManagement: bool, EnableLiveTvAccess: bool, EnableMediaPlayback: bool, EnableAudioPlaybackTranscoding: bool, EnableVideoPlaybackTranscoding: bool, EnablePlaybackRemuxing: bool, ForceRemoteSourceTranscoding: bool, EnableContentDeletion: bool, EnableContentDeletionFromFolders: [str], EnableContentDownloading: bool, EnableSyncTranscoding: bool, EnableMediaConversion: bool, EnabledDevices: [str], EnableAllDevices: bool, EnabledChannels: [str(uuid)], EnableAllChannels: bool, EnabledFolders: [str(uuid)], EnableAllFolders: bool, InvalidLoginAttemptCount: int(int32), LoginAttemptsBeforeLockout: int(int32), MaxActiveSessions: int(int32), EnablePublicSharing: bool, BlockedMediaFolders: [str(uuid)], BlockedChannels: [str(uuid)], RemoteClientBitrateLimit: int(int32), AuthenticationProviderId: str, PasswordResetProviderId: str, SyncPlayAccess: str}, PrimaryImageAspectRatio: num(double) # Gets or sets the primary image aspect ratio.}\n@returns(204) User updated.\n@errors {400: User information was not supplied., 401: Unauthorized, 403: User update forbidden.}\n\n@endpoint POST /Users/{userId}/Authenticate\n@desc Authenticates a user.\n@required {userId: str(uuid) # The user id., pw: str # The password as plain text.}\n@optional {password: str # The password sha1-hash.}\n@returns(200) {User: map{Name: str?, ServerId: str?, ServerName: str?, Id: str(uuid), PrimaryImageTag: str?, HasPassword: bool, HasConfiguredPassword: bool, HasConfiguredEasyPassword: bool, EnableAutoLogin: bool?, LastLoginDate: str(date-time)?, LastActivityDate: str(date-time)?, Configuration: map{AudioLanguagePreference: str?, PlayDefaultAudioTrack: bool, SubtitleLanguagePreference: str?, DisplayMissingEpisodes: bool, GroupedFolders: [str]?, SubtitleMode: str, DisplayCollectionsView: bool, EnableLocalPassword: bool, OrderedViews: [str]?, LatestItemsExcludes: [str]?, MyMediaExcludes: [str]?, HidePlayedInLatest: bool, RememberAudioSelections: bool, RememberSubtitleSelections: bool, EnableNextEpisodeAutoPlay: bool}, Policy: map{IsAdministrator: bool, IsHidden: bool, IsDisabled: bool, MaxParentalRating: int(int32)?, BlockedTags: [str]?, EnableUserPreferenceAccess: bool, AccessSchedules: [map]?, BlockUnratedItems: [str]?, EnableRemoteControlOfOtherUsers: bool, EnableSharedDeviceControl: bool, EnableRemoteAccess: bool, EnableLiveTvManagement: bool, EnableLiveTvAccess: bool, EnableMediaPlayback: bool, EnableAudioPlaybackTranscoding: bool, EnableVideoPlaybackTranscoding: bool, EnablePlaybackRemuxing: bool, ForceRemoteSourceTranscoding: bool, EnableContentDeletion: bool, EnableContentDeletionFromFolders: [str]?, EnableContentDownloading: bool, EnableSyncTranscoding: bool, EnableMediaConversion: bool, EnabledDevices: [str]?, EnableAllDevices: bool, EnabledChannels: [str(uuid)]?, EnableAllChannels: bool, EnabledFolders: [str(uuid)]?, EnableAllFolders: bool, InvalidLoginAttemptCount: int(int32), LoginAttemptsBeforeLockout: int(int32), MaxActiveSessions: int(int32), EnablePublicSharing: bool, BlockedMediaFolders: [str(uuid)]?, BlockedChannels: [str(uuid)]?, RemoteClientBitrateLimit: int(int32), AuthenticationProviderId: str?, PasswordResetProviderId: str?, SyncPlayAccess: str}, PrimaryImageAspectRatio: num(double)?}, SessionInfo: map{PlayState: map{PositionTicks: int(int64)?, CanSeek: bool, IsPaused: bool, IsMuted: bool, VolumeLevel: int(int32)?, AudioStreamIndex: int(int32)?, SubtitleStreamIndex: int(int32)?, MediaSourceId: str?, PlayMethod: str, RepeatMode: str}, AdditionalUsers: [map]?, Capabilities: map{PlayableMediaTypes: [str]?, SupportedCommands: [str]?, SupportsMediaControl: bool, SupportsContentUploading: bool, MessageCallbackUrl: str?, SupportsPersistentIdentifier: bool, SupportsSync: bool, DeviceProfile: map{Name: str?, Id: str?, Identification: map, FriendlyName: str?, Manufacturer: str?, ManufacturerUrl: str?, ModelName: str?, ModelDescription: str?, ModelNumber: str?, ModelUrl: str?, SerialNumber: str?, EnableAlbumArtInDidl: bool, EnableSingleAlbumArtLimit: bool, EnableSingleSubtitleLimit: bool, SupportedMediaTypes: str?, UserId: str?, AlbumArtPn: str?, MaxAlbumArtWidth: int(int32), MaxAlbumArtHeight: int(int32), MaxIconWidth: int(int32)?, MaxIconHeight: int(int32)?, MaxStreamingBitrate: int(int32)?, MaxStaticBitrate: int(int32)?, MusicStreamingTranscodingBitrate: int(int32)?, MaxStaticMusicBitrate: int(int32)?, SonyAggregationFlags: str?, ProtocolInfo: str?, TimelineOffsetSeconds: int(int32), RequiresPlainVideoItems: bool, RequiresPlainFolders: bool, EnableMSMediaReceiverRegistrar: bool, IgnoreTranscodeByteRangeRequests: bool, XmlRootAttributes: [map]?, DirectPlayProfiles: [map]?, TranscodingProfiles: [map]?, ContainerProfiles: [map]?, CodecProfiles: [map]?, ResponseProfiles: [map]?, SubtitleProfiles: [map]?}, AppStoreUrl: str?, IconUrl: str?}, RemoteEndPoint: str?, PlayableMediaTypes: [str]?, Id: str?, UserId: str(uuid), UserName: str?, Client: str?, LastActivityDate: str(date-time), LastPlaybackCheckIn: str(date-time), DeviceName: str?, DeviceType: str?, NowPlayingItem: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}, FullNowPlayingItem: map{Size: int(int64)?, Container: str?, DateLastSaved: str(date-time), RemoteTrailers: [map]?, IsHD: bool, IsShortcut: bool, ShortcutPath: str?, Width: int(int32), Height: int(int32), ExtraIds: [str(uuid)]?, SupportsExternalTransfer: bool}, NowViewingItem: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}, DeviceId: str?, ApplicationVersion: str?, TranscodingInfo: map{AudioCodec: str?, VideoCodec: str?, Container: str?, IsVideoDirect: bool, IsAudioDirect: bool, Bitrate: int(int32)?, Framerate: num(float)?, CompletionPercentage: num(double)?, Width: int(int32)?, Height: int(int32)?, AudioChannels: int(int32)?, TranscodeReasons: [str]?}, IsActive: bool, SupportsMediaControl: bool, SupportsRemoteControl: bool, NowPlayingQueue: [map]?, HasCustomDeviceName: bool, PlaylistItemId: str?, ServerId: str?, UserPrimaryImageTag: str?, SupportedCommands: [str]?}, AccessToken: str?, ServerId: str?} # User authenticated.\n@errors {403: Sha1-hashed password only is not allowed., 404: User not found.}\n\n@endpoint POST /Users/{userId}/Configuration\n@desc Updates a user configuration.\n@required {userId: str(uuid) # The user id.}\n@optional {AudioLanguagePreference: str # Gets or sets the audio language preference., PlayDefaultAudioTrack: bool # Gets or sets a value indicating whether [play default audio track]., SubtitleLanguagePreference: str # Gets or sets the subtitle language preference., DisplayMissingEpisodes: bool, GroupedFolders: [str], SubtitleMode: str(Default/Always/OnlyForced/None/Smart) # An enum representing a subtitle playback mode., DisplayCollectionsView: bool, EnableLocalPassword: bool, OrderedViews: [str], LatestItemsExcludes: [str], MyMediaExcludes: [str], HidePlayedInLatest: bool, RememberAudioSelections: bool, RememberSubtitleSelections: bool, EnableNextEpisodeAutoPlay: bool}\n@returns(204) User configuration updated.\n@errors {401: Unauthorized, 403: User configuration update forbidden.}\n\n@endpoint POST /Users/{userId}/EasyPassword\n@desc Updates a user's easy password.\n@required {userId: str(uuid) # The user id.}\n@optional {NewPassword: str # Gets or sets the new sha1-hashed password., NewPw: str # Gets or sets the new password., ResetPassword: bool # Gets or sets a value indicating whether to reset the password.}\n@returns(204) Password successfully reset.\n@errors {401: Unauthorized, 403: User is not allowed to update the password., 404: User not found.}\n\n@endpoint POST /Users/{userId}/Password\n@desc Updates a user's password.\n@required {userId: str(uuid) # The user id.}\n@optional {CurrentPassword: str # Gets or sets the current sha1-hashed password., CurrentPw: str # Gets or sets the current plain text password., NewPw: str # Gets or sets the new plain text password., ResetPassword: bool # Gets or sets a value indicating whether to reset the password.}\n@returns(204) Password successfully reset.\n@errors {401: Unauthorized, 403: User is not allowed to update the password., 404: User not found.}\n\n@endpoint POST /Users/{userId}/Policy\n@desc Updates a user policy.\n@required {userId: str(uuid) # The user id.}\n@optional {IsAdministrator: bool # Gets or sets a value indicating whether this instance is administrator., IsHidden: bool # Gets or sets a value indicating whether this instance is hidden., IsDisabled: bool # Gets or sets a value indicating whether this instance is disabled., MaxParentalRating: int(int32) # Gets or sets the max parental rating., BlockedTags: [str], EnableUserPreferenceAccess: bool, AccessSchedules: [map{Id!: int(int32), UserId!: str(uuid), DayOfWeek!: str, StartHour!: num(double), EndHour!: num(double)}], BlockUnratedItems: [str], EnableRemoteControlOfOtherUsers: bool, EnableSharedDeviceControl: bool, EnableRemoteAccess: bool, EnableLiveTvManagement: bool, EnableLiveTvAccess: bool, EnableMediaPlayback: bool, EnableAudioPlaybackTranscoding: bool, EnableVideoPlaybackTranscoding: bool, EnablePlaybackRemuxing: bool, ForceRemoteSourceTranscoding: bool, EnableContentDeletion: bool, EnableContentDeletionFromFolders: [str], EnableContentDownloading: bool, EnableSyncTranscoding: bool # Gets or sets a value indicating whether [enable synchronize]., EnableMediaConversion: bool, EnabledDevices: [str], EnableAllDevices: bool, EnabledChannels: [str(uuid)], EnableAllChannels: bool, EnabledFolders: [str(uuid)], EnableAllFolders: bool, InvalidLoginAttemptCount: int(int32), LoginAttemptsBeforeLockout: int(int32), MaxActiveSessions: int(int32), EnablePublicSharing: bool, BlockedMediaFolders: [str(uuid)], BlockedChannels: [str(uuid)], RemoteClientBitrateLimit: int(int32), AuthenticationProviderId: str, PasswordResetProviderId: str, SyncPlayAccess: str(CreateAndJoinGroups/JoinGroups/None) # Enum SyncPlayUserAccessType.}\n@returns(204) User policy updated.\n@errors {400: User policy was not supplied., 401: Unauthorized, 403: User policy update forbidden.}\n\n@endpoint POST /Users/AuthenticateByName\n@desc Authenticates a user by name.\n@optional {Username: str # Gets or sets the username., Pw: str # Gets or sets the plain text password., Password: str # Gets or sets the sha1-hashed password.}\n@returns(200) {User: map{Name: str?, ServerId: str?, ServerName: str?, Id: str(uuid), PrimaryImageTag: str?, HasPassword: bool, HasConfiguredPassword: bool, HasConfiguredEasyPassword: bool, EnableAutoLogin: bool?, LastLoginDate: str(date-time)?, LastActivityDate: str(date-time)?, Configuration: map{AudioLanguagePreference: str?, PlayDefaultAudioTrack: bool, SubtitleLanguagePreference: str?, DisplayMissingEpisodes: bool, GroupedFolders: [str]?, SubtitleMode: str, DisplayCollectionsView: bool, EnableLocalPassword: bool, OrderedViews: [str]?, LatestItemsExcludes: [str]?, MyMediaExcludes: [str]?, HidePlayedInLatest: bool, RememberAudioSelections: bool, RememberSubtitleSelections: bool, EnableNextEpisodeAutoPlay: bool}, Policy: map{IsAdministrator: bool, IsHidden: bool, IsDisabled: bool, MaxParentalRating: int(int32)?, BlockedTags: [str]?, EnableUserPreferenceAccess: bool, AccessSchedules: [map]?, BlockUnratedItems: [str]?, EnableRemoteControlOfOtherUsers: bool, EnableSharedDeviceControl: bool, EnableRemoteAccess: bool, EnableLiveTvManagement: bool, EnableLiveTvAccess: bool, EnableMediaPlayback: bool, EnableAudioPlaybackTranscoding: bool, EnableVideoPlaybackTranscoding: bool, EnablePlaybackRemuxing: bool, ForceRemoteSourceTranscoding: bool, EnableContentDeletion: bool, EnableContentDeletionFromFolders: [str]?, EnableContentDownloading: bool, EnableSyncTranscoding: bool, EnableMediaConversion: bool, EnabledDevices: [str]?, EnableAllDevices: bool, EnabledChannels: [str(uuid)]?, EnableAllChannels: bool, EnabledFolders: [str(uuid)]?, EnableAllFolders: bool, InvalidLoginAttemptCount: int(int32), LoginAttemptsBeforeLockout: int(int32), MaxActiveSessions: int(int32), EnablePublicSharing: bool, BlockedMediaFolders: [str(uuid)]?, BlockedChannels: [str(uuid)]?, RemoteClientBitrateLimit: int(int32), AuthenticationProviderId: str?, PasswordResetProviderId: str?, SyncPlayAccess: str}, PrimaryImageAspectRatio: num(double)?}, SessionInfo: map{PlayState: map{PositionTicks: int(int64)?, CanSeek: bool, IsPaused: bool, IsMuted: bool, VolumeLevel: int(int32)?, AudioStreamIndex: int(int32)?, SubtitleStreamIndex: int(int32)?, MediaSourceId: str?, PlayMethod: str, RepeatMode: str}, AdditionalUsers: [map]?, Capabilities: map{PlayableMediaTypes: [str]?, SupportedCommands: [str]?, SupportsMediaControl: bool, SupportsContentUploading: bool, MessageCallbackUrl: str?, SupportsPersistentIdentifier: bool, SupportsSync: bool, DeviceProfile: map{Name: str?, Id: str?, Identification: map, FriendlyName: str?, Manufacturer: str?, ManufacturerUrl: str?, ModelName: str?, ModelDescription: str?, ModelNumber: str?, ModelUrl: str?, SerialNumber: str?, EnableAlbumArtInDidl: bool, EnableSingleAlbumArtLimit: bool, EnableSingleSubtitleLimit: bool, SupportedMediaTypes: str?, UserId: str?, AlbumArtPn: str?, MaxAlbumArtWidth: int(int32), MaxAlbumArtHeight: int(int32), MaxIconWidth: int(int32)?, MaxIconHeight: int(int32)?, MaxStreamingBitrate: int(int32)?, MaxStaticBitrate: int(int32)?, MusicStreamingTranscodingBitrate: int(int32)?, MaxStaticMusicBitrate: int(int32)?, SonyAggregationFlags: str?, ProtocolInfo: str?, TimelineOffsetSeconds: int(int32), RequiresPlainVideoItems: bool, RequiresPlainFolders: bool, EnableMSMediaReceiverRegistrar: bool, IgnoreTranscodeByteRangeRequests: bool, XmlRootAttributes: [map]?, DirectPlayProfiles: [map]?, TranscodingProfiles: [map]?, ContainerProfiles: [map]?, CodecProfiles: [map]?, ResponseProfiles: [map]?, SubtitleProfiles: [map]?}, AppStoreUrl: str?, IconUrl: str?}, RemoteEndPoint: str?, PlayableMediaTypes: [str]?, Id: str?, UserId: str(uuid), UserName: str?, Client: str?, LastActivityDate: str(date-time), LastPlaybackCheckIn: str(date-time), DeviceName: str?, DeviceType: str?, NowPlayingItem: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}, FullNowPlayingItem: map{Size: int(int64)?, Container: str?, DateLastSaved: str(date-time), RemoteTrailers: [map]?, IsHD: bool, IsShortcut: bool, ShortcutPath: str?, Width: int(int32), Height: int(int32), ExtraIds: [str(uuid)]?, SupportsExternalTransfer: bool}, NowViewingItem: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}, DeviceId: str?, ApplicationVersion: str?, TranscodingInfo: map{AudioCodec: str?, VideoCodec: str?, Container: str?, IsVideoDirect: bool, IsAudioDirect: bool, Bitrate: int(int32)?, Framerate: num(float)?, CompletionPercentage: num(double)?, Width: int(int32)?, Height: int(int32)?, AudioChannels: int(int32)?, TranscodeReasons: [str]?}, IsActive: bool, SupportsMediaControl: bool, SupportsRemoteControl: bool, NowPlayingQueue: [map]?, HasCustomDeviceName: bool, PlaylistItemId: str?, ServerId: str?, UserPrimaryImageTag: str?, SupportedCommands: [str]?}, AccessToken: str?, ServerId: str?} # User authenticated.\n\n@endpoint POST /Users/AuthenticateWithQuickConnect\n@desc Authenticates a user with quick connect.\n@required {Token: str # Gets or sets the quick connect token.}\n@returns(200) {User: map{Name: str?, ServerId: str?, ServerName: str?, Id: str(uuid), PrimaryImageTag: str?, HasPassword: bool, HasConfiguredPassword: bool, HasConfiguredEasyPassword: bool, EnableAutoLogin: bool?, LastLoginDate: str(date-time)?, LastActivityDate: str(date-time)?, Configuration: map{AudioLanguagePreference: str?, PlayDefaultAudioTrack: bool, SubtitleLanguagePreference: str?, DisplayMissingEpisodes: bool, GroupedFolders: [str]?, SubtitleMode: str, DisplayCollectionsView: bool, EnableLocalPassword: bool, OrderedViews: [str]?, LatestItemsExcludes: [str]?, MyMediaExcludes: [str]?, HidePlayedInLatest: bool, RememberAudioSelections: bool, RememberSubtitleSelections: bool, EnableNextEpisodeAutoPlay: bool}, Policy: map{IsAdministrator: bool, IsHidden: bool, IsDisabled: bool, MaxParentalRating: int(int32)?, BlockedTags: [str]?, EnableUserPreferenceAccess: bool, AccessSchedules: [map]?, BlockUnratedItems: [str]?, EnableRemoteControlOfOtherUsers: bool, EnableSharedDeviceControl: bool, EnableRemoteAccess: bool, EnableLiveTvManagement: bool, EnableLiveTvAccess: bool, EnableMediaPlayback: bool, EnableAudioPlaybackTranscoding: bool, EnableVideoPlaybackTranscoding: bool, EnablePlaybackRemuxing: bool, ForceRemoteSourceTranscoding: bool, EnableContentDeletion: bool, EnableContentDeletionFromFolders: [str]?, EnableContentDownloading: bool, EnableSyncTranscoding: bool, EnableMediaConversion: bool, EnabledDevices: [str]?, EnableAllDevices: bool, EnabledChannels: [str(uuid)]?, EnableAllChannels: bool, EnabledFolders: [str(uuid)]?, EnableAllFolders: bool, InvalidLoginAttemptCount: int(int32), LoginAttemptsBeforeLockout: int(int32), MaxActiveSessions: int(int32), EnablePublicSharing: bool, BlockedMediaFolders: [str(uuid)]?, BlockedChannels: [str(uuid)]?, RemoteClientBitrateLimit: int(int32), AuthenticationProviderId: str?, PasswordResetProviderId: str?, SyncPlayAccess: str}, PrimaryImageAspectRatio: num(double)?}, SessionInfo: map{PlayState: map{PositionTicks: int(int64)?, CanSeek: bool, IsPaused: bool, IsMuted: bool, VolumeLevel: int(int32)?, AudioStreamIndex: int(int32)?, SubtitleStreamIndex: int(int32)?, MediaSourceId: str?, PlayMethod: str, RepeatMode: str}, AdditionalUsers: [map]?, Capabilities: map{PlayableMediaTypes: [str]?, SupportedCommands: [str]?, SupportsMediaControl: bool, SupportsContentUploading: bool, MessageCallbackUrl: str?, SupportsPersistentIdentifier: bool, SupportsSync: bool, DeviceProfile: map{Name: str?, Id: str?, Identification: map, FriendlyName: str?, Manufacturer: str?, ManufacturerUrl: str?, ModelName: str?, ModelDescription: str?, ModelNumber: str?, ModelUrl: str?, SerialNumber: str?, EnableAlbumArtInDidl: bool, EnableSingleAlbumArtLimit: bool, EnableSingleSubtitleLimit: bool, SupportedMediaTypes: str?, UserId: str?, AlbumArtPn: str?, MaxAlbumArtWidth: int(int32), MaxAlbumArtHeight: int(int32), MaxIconWidth: int(int32)?, MaxIconHeight: int(int32)?, MaxStreamingBitrate: int(int32)?, MaxStaticBitrate: int(int32)?, MusicStreamingTranscodingBitrate: int(int32)?, MaxStaticMusicBitrate: int(int32)?, SonyAggregationFlags: str?, ProtocolInfo: str?, TimelineOffsetSeconds: int(int32), RequiresPlainVideoItems: bool, RequiresPlainFolders: bool, EnableMSMediaReceiverRegistrar: bool, IgnoreTranscodeByteRangeRequests: bool, XmlRootAttributes: [map]?, DirectPlayProfiles: [map]?, TranscodingProfiles: [map]?, ContainerProfiles: [map]?, CodecProfiles: [map]?, ResponseProfiles: [map]?, SubtitleProfiles: [map]?}, AppStoreUrl: str?, IconUrl: str?}, RemoteEndPoint: str?, PlayableMediaTypes: [str]?, Id: str?, UserId: str(uuid), UserName: str?, Client: str?, LastActivityDate: str(date-time), LastPlaybackCheckIn: str(date-time), DeviceName: str?, DeviceType: str?, NowPlayingItem: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}, FullNowPlayingItem: map{Size: int(int64)?, Container: str?, DateLastSaved: str(date-time), RemoteTrailers: [map]?, IsHD: bool, IsShortcut: bool, ShortcutPath: str?, Width: int(int32), Height: int(int32), ExtraIds: [str(uuid)]?, SupportsExternalTransfer: bool}, NowViewingItem: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}, DeviceId: str?, ApplicationVersion: str?, TranscodingInfo: map{AudioCodec: str?, VideoCodec: str?, Container: str?, IsVideoDirect: bool, IsAudioDirect: bool, Bitrate: int(int32)?, Framerate: num(float)?, CompletionPercentage: num(double)?, Width: int(int32)?, Height: int(int32)?, AudioChannels: int(int32)?, TranscodeReasons: [str]?}, IsActive: bool, SupportsMediaControl: bool, SupportsRemoteControl: bool, NowPlayingQueue: [map]?, HasCustomDeviceName: bool, PlaylistItemId: str?, ServerId: str?, UserPrimaryImageTag: str?, SupportedCommands: [str]?}, AccessToken: str?, ServerId: str?} # User authenticated.\n@errors {400: Missing token.}\n\n@endpoint POST /Users/ForgotPassword\n@desc Initiates the forgot password process for a local user.\n@required {EnteredUsername: str # Gets or sets the entered username to have its password reset.}\n@returns(200) {Action: str, PinFile: str?, PinExpirationDate: str(date-time)?} # Password reset process started.\n\n@endpoint POST /Users/ForgotPassword/Pin\n@desc Redeems a forgot password pin.\n@returns(200) {Success: bool, UsersReset: [str]?} # Pin reset process started.\n\n@endpoint GET /Users/Me\n@desc Gets the user based on auth token.\n@returns(200) {Name: str?, ServerId: str?, ServerName: str?, Id: str(uuid), PrimaryImageTag: str?, HasPassword: bool, HasConfiguredPassword: bool, HasConfiguredEasyPassword: bool, EnableAutoLogin: bool?, LastLoginDate: str(date-time)?, LastActivityDate: str(date-time)?, Configuration: map{AudioLanguagePreference: str?, PlayDefaultAudioTrack: bool, SubtitleLanguagePreference: str?, DisplayMissingEpisodes: bool, GroupedFolders: [str]?, SubtitleMode: str, DisplayCollectionsView: bool, EnableLocalPassword: bool, OrderedViews: [str]?, LatestItemsExcludes: [str]?, MyMediaExcludes: [str]?, HidePlayedInLatest: bool, RememberAudioSelections: bool, RememberSubtitleSelections: bool, EnableNextEpisodeAutoPlay: bool}, Policy: map{IsAdministrator: bool, IsHidden: bool, IsDisabled: bool, MaxParentalRating: int(int32)?, BlockedTags: [str]?, EnableUserPreferenceAccess: bool, AccessSchedules: [map]?, BlockUnratedItems: [str]?, EnableRemoteControlOfOtherUsers: bool, EnableSharedDeviceControl: bool, EnableRemoteAccess: bool, EnableLiveTvManagement: bool, EnableLiveTvAccess: bool, EnableMediaPlayback: bool, EnableAudioPlaybackTranscoding: bool, EnableVideoPlaybackTranscoding: bool, EnablePlaybackRemuxing: bool, ForceRemoteSourceTranscoding: bool, EnableContentDeletion: bool, EnableContentDeletionFromFolders: [str]?, EnableContentDownloading: bool, EnableSyncTranscoding: bool, EnableMediaConversion: bool, EnabledDevices: [str]?, EnableAllDevices: bool, EnabledChannels: [str(uuid)]?, EnableAllChannels: bool, EnabledFolders: [str(uuid)]?, EnableAllFolders: bool, InvalidLoginAttemptCount: int(int32), LoginAttemptsBeforeLockout: int(int32), MaxActiveSessions: int(int32), EnablePublicSharing: bool, BlockedMediaFolders: [str(uuid)]?, BlockedChannels: [str(uuid)]?, RemoteClientBitrateLimit: int(int32), AuthenticationProviderId: str?, PasswordResetProviderId: str?, SyncPlayAccess: str}, PrimaryImageAspectRatio: num(double)?} # User returned.\n@errors {400: Token is not owned by a user., 401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Users/New\n@desc Creates a user.\n@optional {Name: str # Gets or sets the username., Password: str # Gets or sets the password.}\n@returns(200) {Name: str?, ServerId: str?, ServerName: str?, Id: str(uuid), PrimaryImageTag: str?, HasPassword: bool, HasConfiguredPassword: bool, HasConfiguredEasyPassword: bool, EnableAutoLogin: bool?, LastLoginDate: str(date-time)?, LastActivityDate: str(date-time)?, Configuration: map{AudioLanguagePreference: str?, PlayDefaultAudioTrack: bool, SubtitleLanguagePreference: str?, DisplayMissingEpisodes: bool, GroupedFolders: [str]?, SubtitleMode: str, DisplayCollectionsView: bool, EnableLocalPassword: bool, OrderedViews: [str]?, LatestItemsExcludes: [str]?, MyMediaExcludes: [str]?, HidePlayedInLatest: bool, RememberAudioSelections: bool, RememberSubtitleSelections: bool, EnableNextEpisodeAutoPlay: bool}, Policy: map{IsAdministrator: bool, IsHidden: bool, IsDisabled: bool, MaxParentalRating: int(int32)?, BlockedTags: [str]?, EnableUserPreferenceAccess: bool, AccessSchedules: [map]?, BlockUnratedItems: [str]?, EnableRemoteControlOfOtherUsers: bool, EnableSharedDeviceControl: bool, EnableRemoteAccess: bool, EnableLiveTvManagement: bool, EnableLiveTvAccess: bool, EnableMediaPlayback: bool, EnableAudioPlaybackTranscoding: bool, EnableVideoPlaybackTranscoding: bool, EnablePlaybackRemuxing: bool, ForceRemoteSourceTranscoding: bool, EnableContentDeletion: bool, EnableContentDeletionFromFolders: [str]?, EnableContentDownloading: bool, EnableSyncTranscoding: bool, EnableMediaConversion: bool, EnabledDevices: [str]?, EnableAllDevices: bool, EnabledChannels: [str(uuid)]?, EnableAllChannels: bool, EnabledFolders: [str(uuid)]?, EnableAllFolders: bool, InvalidLoginAttemptCount: int(int32), LoginAttemptsBeforeLockout: int(int32), MaxActiveSessions: int(int32), EnablePublicSharing: bool, BlockedMediaFolders: [str(uuid)]?, BlockedChannels: [str(uuid)]?, RemoteClientBitrateLimit: int(int32), AuthenticationProviderId: str?, PasswordResetProviderId: str?, SyncPlayAccess: str}, PrimaryImageAspectRatio: num(double)?} # User created.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Users/Public\n@desc Gets a list of publicly visible users for display on a login screen.\n@returns(200) Public users returned.\n\n@endpoint POST /Users/{userId}/FavoriteItems/{itemId}\n@desc Marks an item as a favorite.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@returns(200) {Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?} # Item marked as favorite.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Users/{userId}/FavoriteItems/{itemId}\n@desc Unmarks item as a favorite.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@returns(200) {Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?} # Item unmarked as favorite.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Users/{userId}/Items/{itemId}\n@desc Gets an item from a user's library.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@returns(200) {Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}}} # Item returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Users/{userId}/Items/{itemId}/Intros\n@desc Gets intros to play before the main media item plays.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Intros returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Users/{userId}/Items/{itemId}/LocalTrailers\n@desc Gets local trailers for an item.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@returns(200) An Microsoft.AspNetCore.Mvc.OkResult containing the item's local trailers.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Users/{userId}/Items/{itemId}/Rating\n@desc Deletes a user's saved personal rating for an item.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@returns(200) {Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?} # Personal rating removed.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint POST /Users/{userId}/Items/{itemId}/Rating\n@desc Updates a user's rating for an item.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@optional {likes: bool # Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Guid,System.Guid,System.Nullable{System.Boolean}) is likes.}\n@returns(200) {Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?} # Item rating updated.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Users/{userId}/Items/{itemId}/SpecialFeatures\n@desc Gets special features for an item.\n@required {userId: str(uuid) # User id., itemId: str(uuid) # Item id.}\n@returns(200) Special features returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Users/{userId}/Items/Latest\n@desc Gets latest media.\n@required {userId: str(uuid) # User id.}\n@optional {parentId: str(uuid) # Specify this to localize the search to a specific item or folder. Omit to use the root., fields: [str] # Optional. Specify additional fields of information to return in the output., includeItemTypes: [str] # Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited., isPlayed: bool # Filter by items that are played, or not., enableImages: bool # Optional. include image information in output., imageTypeLimit: int(int32) # Optional. the max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., enableUserData: bool # Optional. include user data., limit: int(int32)=20 # Return item limit., groupItems: bool=true # Whether or not to group items into a parent container.}\n@returns(200) Latest media returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Users/{userId}/Items/Root\n@desc Gets the root folder from a user's library.\n@required {userId: str(uuid) # User id.}\n@returns(200) {Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}}} # Root folder returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Users/{userId}/GroupingOptions\n@desc Get user view grouping options.\n@required {userId: str(uuid) # User id.}\n@returns(200) User view grouping options returned.\n@errors {404: User not found.}\n\n@endpoint GET /Users/{userId}/Views\n@desc Get user views.\n@required {userId: str(uuid) # User id.}\n@optional {includeExternalContent: bool # Whether or not to include external views such as channels or live tv., presetViews: [str] # Preset views., includeHidden: bool=false # Whether or not to include hidden content.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # User views returned.\n\n@endgroup\n\n@group Videos\n@endpoint GET /Videos/{videoId}/{mediaSourceId}/Attachments/{index}\n@desc Get video attachment.\n@required {videoId: str(uuid) # Video ID., mediaSourceId: str # Media Source ID., index: int(int32) # Attachment Index.}\n@returns(200) Attachment retrieved.\n@errors {404: Video or attachment not found.}\n\n@endpoint GET /Videos/{itemId}/live.m3u8\n@desc Gets a hls live stream.\n@required {itemId: str(uuid) # The item id.}\n@optional {container: str # The audio container., static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment lenght., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options., maxWidth: int(int32) # Optional. The max width., maxHeight: int(int32) # Optional. The max height., enableSubtitlesInManifest: bool # Optional. Whether to enable subtitles in the manifest.}\n@returns(200) Hls live stream retrieved.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Videos/{itemId}/{stream}.{container}\n@desc Gets a video stream.\n@required {itemId: str(uuid) # The item id., container: str # The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv., stream: str}\n@optional {static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment lenght., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamporphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options.}\n@returns(200) Video stream returned.\n\n@endpoint HEAD /Videos/{itemId}/{stream}.{container}\n@desc Gets a video stream.\n@required {itemId: str(uuid) # The item id., container: str # The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv., stream: str}\n@optional {static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment lenght., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamporphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options.}\n@returns(200) Video stream returned.\n\n@endpoint GET /Videos/{itemId}/AdditionalParts\n@desc Gets additional parts for a video.\n@required {itemId: str(uuid) # The item id.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Additional parts returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint DELETE /Videos/{itemId}/AlternateSources\n@desc Removes alternate video sources.\n@required {itemId: str(uuid) # The item id.}\n@returns(204) Alternate sources deleted.\n@errors {401: Unauthorized, 403: Forbidden, 404: Video not found.}\n\n@endpoint GET /Videos/{itemId}/stream\n@desc Gets a video stream.\n@required {itemId: str(uuid) # The item id.}\n@optional {container: str # The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv., static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment length., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options.}\n@returns(200) Video stream returned.\n\n@endpoint HEAD /Videos/{itemId}/stream\n@desc Gets a video stream.\n@required {itemId: str(uuid) # The item id.}\n@optional {container: str # The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv., static: bool # Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false., params: str # The streaming parameters., tag: str # The tag., deviceProfileId: str # Optional. The dlna device profile id to utilize., playSessionId: str # The play session id., segmentContainer: str # The segment container., segmentLength: int(int32) # The segment length., minSegments: int(int32) # The minimum number of segments., mediaSourceId: str # The media version id, if playing an alternate version., deviceId: str # The device id of the client requesting. Used to stop encoding processes when needed., audioCodec: str # Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma., enableAutoStreamCopy: bool # Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true., allowVideoStreamCopy: bool # Whether or not to allow copying of the video stream url., allowAudioStreamCopy: bool # Whether or not to allow copying of the audio stream url., breakOnNonKeyFrames: bool # Optional. Whether to break on non key frames., audioSampleRate: int(int32) # Optional. Specify a specific audio sample rate, e.g. 44100., maxAudioBitDepth: int(int32) # Optional. The maximum audio bit depth., audioBitRate: int(int32) # Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults., audioChannels: int(int32) # Optional. Specify a specific number of audio channels to encode to, e.g. 2., maxAudioChannels: int(int32) # Optional. Specify a maximum number of audio channels to encode to, e.g. 2., profile: str # Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high., level: str # Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1., framerate: num(float) # Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., maxFramerate: num(float) # Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements., copyTimestamps: bool # Whether or not to copy timestamps when transcoding with an offset. Defaults to false., startTimeTicks: int(int64) # Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms., width: int(int32) # Optional. The fixed horizontal resolution of the encoded video., height: int(int32) # Optional. The fixed vertical resolution of the encoded video., videoBitRate: int(int32) # Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults., subtitleStreamIndex: int(int32) # Optional. The index of the subtitle stream to use. If omitted no subtitles will be used., subtitleMethod: str # Optional. Specify the subtitle delivery method., maxRefFrames: int(int32) # Optional., maxVideoBitDepth: int(int32) # Optional. The maximum video bit depth., requireAvc: bool # Optional. Whether to require avc., deInterlace: bool # Optional. Whether to deinterlace the video., requireNonAnamorphic: bool # Optional. Whether to require a non anamorphic stream., transcodingMaxAudioChannels: int(int32) # Optional. The maximum number of audio channels to transcode., cpuCoreLimit: int(int32) # Optional. The limit of how many cpu cores to use., liveStreamId: str # The live stream id., enableMpegtsM2TsMode: bool # Optional. Whether to enable the MpegtsM2Ts mode., videoCodec: str # Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv., subtitleCodec: str # Optional. Specify a subtitle codec to encode to., transcodeReasons: str # Optional. The transcoding reason., audioStreamIndex: int(int32) # Optional. The index of the audio stream to use. If omitted the first audio stream will be used., videoStreamIndex: int(int32) # Optional. The index of the video stream to use. If omitted the first video stream will be used., context: str # Optional. The MediaBrowser.Model.Dlna.EncodingContext., streamOptions: map # Optional. The streaming options.}\n@returns(200) Video stream returned.\n\n@endpoint POST /Videos/MergeVersions\n@desc Merges videos into a single record.\n@required {ids: [str(uuid)] # Item id list. This allows multiple, comma delimited.}\n@returns(204) Videos merged.\n@errors {400: Supply at least 2 video ids., 401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group Years\n@endpoint GET /Years\n@desc Get years.\n@optional {startIndex: int(int32) # Skips over a given number of items within the results. Use for paging., limit: int(int32) # Optional. The maximum number of records to return., sortOrder: str # Sort Order - Ascending,Descending., parentId: str(uuid) # Specify this to localize the search to a specific item or folder. Omit to use the root., fields: [str] # Optional. Specify additional fields of information to return in the output., excludeItemTypes: [str] # Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited., includeItemTypes: [str] # Optional. If specified, results will be included based on item type. This allows multiple, comma delimited., mediaTypes: [str] # Optional. Filter by MediaType. Allows multiple, comma delimited., sortBy: str # Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime., enableUserData: bool # Optional. Include user data., imageTypeLimit: int(int32) # Optional. The max number of images to return, per image type., enableImageTypes: [str] # Optional. The image types to include in the output., userId: str(uuid) # User Id., recursive: bool=true # Search recursively., enableImages: bool=true # Optional. Include image information in output.}\n@returns(200) {Items: [map]?, TotalRecordCount: int(int32), StartIndex: int(int32)} # Year query returned.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endpoint GET /Years/{year}\n@desc Gets a year.\n@required {year: int(int32) # The year.}\n@optional {userId: str(uuid) # Optional. Filter by user id, and attach user data.}\n@returns(200) {Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map{Rating: num(double)?, PlayedPercentage: num(double)?, UnplayedItemCount: int(int32)?, PlaybackPositionTicks: int(int64), PlayCount: int(int32), IsFavorite: bool, Likes: bool?, LastPlayedDate: str(date-time)?, Played: bool, Key: str?, ItemId: str?}, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?{Primary: map, Art: map, Backdrop: map, Banner: map, Logo: map, Thumb: map, Disc: map, Box: map, Screenshot: map, Menu: map, Chapter: map, BoxRear: map, Profile: map}, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map{Name: str?, OriginalTitle: str?, ServerId: str?, Id: str(uuid), Etag: str?, SourceType: str?, PlaylistItemId: str?, DateCreated: str(date-time)?, DateLastMediaAdded: str(date-time)?, ExtraType: str?, AirsBeforeSeasonNumber: int(int32)?, AirsAfterSeasonNumber: int(int32)?, AirsBeforeEpisodeNumber: int(int32)?, CanDelete: bool?, CanDownload: bool?, HasSubtitles: bool?, PreferredMetadataLanguage: str?, PreferredMetadataCountryCode: str?, SupportsSync: bool?, Container: str?, SortName: str?, ForcedSortName: str?, Video3DFormat: str, PremiereDate: str(date-time)?, ExternalUrls: [map]?, MediaSources: [map]?, CriticRating: num(float)?, ProductionLocations: [str]?, Path: str?, EnableMediaSourceDisplay: bool?, OfficialRating: str?, CustomRating: str?, ChannelId: str(uuid)?, ChannelName: str?, Overview: str?, Taglines: [str]?, Genres: [str]?, CommunityRating: num(float)?, CumulativeRunTimeTicks: int(int64)?, RunTimeTicks: int(int64)?, PlayAccess: str, AspectRatio: str?, ProductionYear: int(int32)?, IsPlaceHolder: bool?, Number: str?, ChannelNumber: str?, IndexNumber: int(int32)?, IndexNumberEnd: int(int32)?, ParentIndexNumber: int(int32)?, RemoteTrailers: [map]?, ProviderIds: map?, IsHD: bool?, IsFolder: bool?, ParentId: str(uuid)?, Type: str?, People: [map]?, Studios: [map]?, GenreItems: [map]?, ParentLogoItemId: str?, ParentBackdropItemId: str?, ParentBackdropImageTags: [str]?, LocalTrailerCount: int(int32)?, UserData: map, RecursiveItemCount: int(int32)?, ChildCount: int(int32)?, SeriesName: str?, SeriesId: str(uuid)?, SeasonId: str(uuid)?, SpecialFeatureCount: int(int32)?, DisplayPreferencesId: str?, Status: str?, AirTime: str?, AirDays: [str]?, Tags: [str]?, PrimaryImageAspectRatio: num(double)?, Artists: [str]?, ArtistItems: [map]?, Album: str?, CollectionType: str?, DisplayOrder: str?, AlbumId: str(uuid)?, AlbumPrimaryImageTag: str?, SeriesPrimaryImageTag: str?, AlbumArtist: str?, AlbumArtists: [map]?, SeasonName: str?, MediaStreams: [map]?, VideoType: str, PartCount: int(int32)?, MediaSourceCount: int(int32)?, ImageTags: map?, BackdropImageTags: [str]?, ScreenshotImageTags: [str]?, ParentLogoImageTag: str?, ParentArtItemId: str?, ParentArtImageTag: str?, SeriesThumbImageTag: str?, ImageBlurHashes: map?, SeriesStudio: str?, ParentThumbItemId: str?, ParentThumbImageTag: str?, ParentPrimaryImageItemId: str?, ParentPrimaryImageTag: str?, Chapters: [map]?, LocationType: str, IsoType: str, MediaType: str?, EndDate: str(date-time)?, LockedFields: [str]?, TrailerCount: int(int32)?, MovieCount: int(int32)?, SeriesCount: int(int32)?, ProgramCount: int(int32)?, EpisodeCount: int(int32)?, SongCount: int(int32)?, AlbumCount: int(int32)?, ArtistCount: int(int32)?, MusicVideoCount: int(int32)?, LockData: bool?, Width: int(int32)?, Height: int(int32)?, CameraMake: str?, CameraModel: str?, Software: str?, ExposureTime: num(double)?, FocalLength: num(double)?, ImageOrientation: str, Aperture: num(double)?, ShutterSpeed: num(double)?, Latitude: num(double)?, Longitude: num(double)?, Altitude: num(double)?, IsoSpeedRating: int(int32)?, SeriesTimerId: str?, ProgramId: str?, ChannelPrimaryImageTag: str?, StartDate: str(date-time)?, CompletionPercentage: num(double)?, IsRepeat: bool?, EpisodeTitle: str?, ChannelType: str, Audio: str, IsMovie: bool?, IsSports: bool?, IsSeries: bool?, IsLive: bool?, IsNews: bool?, IsKids: bool?, IsPremiere: bool?, TimerId: str?, CurrentProgram: map}}}} # Year returned.\n@errors {401: Unauthorized, 403: Forbidden, 404: Year not found.}\n\n@endgroup\n\n@end\n"}