Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

jellyflix-app/jellyfin-api-dart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Please use Tentacle! This project will no longer be supported


openapi (EXPERIMENTAL)

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 10.8.13
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  openapi: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  openapi:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  openapi:
    path: /path/to/openapi

Getting Started

Please follow the installation procedure and then run the following:

import 'package:openapi/openapi.dart';


final api = Openapi().getActivityLogApi();
final int startIndex = 56; // int | Optional. The record index to start at. All items with a lower index will be dropped from the results.
final int limit = 56; // int | Optional. The maximum number of records to return.
final DateTime minDate = 2013-10-20T19:20:30+01:00; // DateTime | Optional. The minimum date. Format = ISO.
final bool hasUserId = true; // bool | Optional. Filter log entries if it has user id, or not.

try {
    final response = await api.getLogEntries(startIndex, limit, minDate, hasUserId);
    print(response);
} catch on DioException (e) {
    print("Exception when calling ActivityLogApi->getLogEntries: $e\n");
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ActivityLogApi getLogEntries GET /System/ActivityLog/Entries Gets activity log entries.
ApiKeyApi createKey POST /Auth/Keys Create a new api key.
ApiKeyApi getKeys GET /Auth/Keys Get all keys.
ApiKeyApi revokeKey DELETE /Auth/Keys/{key} Remove an api key.
ArtistsApi getAlbumArtists GET /Artists/AlbumArtists Gets all album artists from a given item, folder, or the entire library.
ArtistsApi getArtistByName GET /Artists/{name} Gets an artist by name.
ArtistsApi getArtists GET /Artists Gets all artists from a given item, folder, or the entire library.
AudioApi getAudioStream GET /Audio/{itemId}/stream Gets an audio stream.
AudioApi getAudioStreamByContainer GET /Audio/{itemId}/stream.{container} Gets an audio stream.
AudioApi headAudioStream HEAD /Audio/{itemId}/stream Gets an audio stream.
AudioApi headAudioStreamByContainer HEAD /Audio/{itemId}/stream.{container} Gets an audio stream.
BrandingApi getBrandingCss GET /Branding/Css Gets branding css.
BrandingApi getBrandingCss2 GET /Branding/Css.css Gets branding css.
BrandingApi getBrandingOptions GET /Branding/Configuration Gets branding configuration.
ChannelsApi getAllChannelFeatures GET /Channels/Features Get all channel features.
ChannelsApi getChannelFeatures GET /Channels/{channelId}/Features Get channel features.
ChannelsApi getChannelItems GET /Channels/{channelId}/Items Get channel items.
ChannelsApi getChannels GET /Channels Gets available channels.
ChannelsApi getLatestChannelItems GET /Channels/Items/Latest Gets latest channel items.
ClientLogApi logFile POST /ClientLog/Document Upload a document.
CollectionApi addToCollection POST /Collections/{collectionId}/Items Adds items to a collection.
CollectionApi createCollection POST /Collections Creates a new collection.
CollectionApi removeFromCollection DELETE /Collections/{collectionId}/Items Removes items from a collection.
ConfigurationApi getConfiguration GET /System/Configuration Gets application configuration.
ConfigurationApi getDefaultMetadataOptions GET /System/Configuration/MetadataOptions/Default Gets a default MetadataOptions object.
ConfigurationApi getNamedConfiguration GET /System/Configuration/{key} Gets a named configuration.
ConfigurationApi updateConfiguration POST /System/Configuration Updates application configuration.
ConfigurationApi updateMediaEncoderPath POST /System/MediaEncoder/Path Updates the path to the media encoder.
ConfigurationApi updateNamedConfiguration POST /System/Configuration/{key} Updates named configuration.
DashboardApi getConfigurationPages GET /web/ConfigurationPages Gets the configuration pages.
DashboardApi getDashboardConfigurationPage GET /web/ConfigurationPage Gets a dashboard configuration page.
DevicesApi deleteDevice DELETE /Devices Deletes a device.
DevicesApi getDeviceInfo GET /Devices/Info Get info for a device.
DevicesApi getDeviceOptions GET /Devices/Options Get options for a device.
DevicesApi getDevices GET /Devices Get Devices.
DevicesApi updateDeviceOptions POST /Devices/Options Update device options.
DisplayPreferencesApi getDisplayPreferences GET /DisplayPreferences/{displayPreferencesId} Get Display Preferences.
DisplayPreferencesApi updateDisplayPreferences POST /DisplayPreferences/{displayPreferencesId} Update Display Preferences.
DlnaApi createProfile POST /Dlna/Profiles Creates a profile.
DlnaApi deleteProfile DELETE /Dlna/Profiles/{profileId} Deletes a profile.
DlnaApi getDefaultProfile GET /Dlna/Profiles/Default Gets the default profile.
DlnaApi getProfile GET /Dlna/Profiles/{profileId} Gets a single profile.
DlnaApi getProfileInfos GET /Dlna/ProfileInfos Get profile infos.
DlnaApi updateProfile POST /Dlna/Profiles/{profileId} Updates a profile.
DlnaServerApi getConnectionManager GET /Dlna/{serverId}/ConnectionManager Gets Dlna media receiver registrar xml.
DlnaServerApi getConnectionManager2 GET /Dlna/{serverId}/ConnectionManager/ConnectionManager Gets Dlna media receiver registrar xml.
DlnaServerApi getConnectionManager3 GET /Dlna/{serverId}/ConnectionManager/ConnectionManager.xml Gets Dlna media receiver registrar xml.
DlnaServerApi getContentDirectory GET /Dlna/{serverId}/ContentDirectory Gets Dlna content directory xml.
DlnaServerApi getContentDirectory2 GET /Dlna/{serverId}/ContentDirectory/ContentDirectory Gets Dlna content directory xml.
DlnaServerApi getContentDirectory3 GET /Dlna/{serverId}/ContentDirectory/ContentDirectory.xml Gets Dlna content directory xml.
DlnaServerApi getDescriptionXml GET /Dlna/{serverId}/description Get Description Xml.
DlnaServerApi getDescriptionXml2 GET /Dlna/{serverId}/description.xml Get Description Xml.
DlnaServerApi getIcon GET /Dlna/icons/{fileName} Gets a server icon.
DlnaServerApi getIconId GET /Dlna/{serverId}/icons/{fileName} Gets a server icon.
DlnaServerApi getMediaReceiverRegistrar GET /Dlna/{serverId}/MediaReceiverRegistrar Gets Dlna media receiver registrar xml.
DlnaServerApi getMediaReceiverRegistrar2 GET /Dlna/{serverId}/MediaReceiverRegistrar/MediaReceiverRegistrar Gets Dlna media receiver registrar xml.
DlnaServerApi getMediaReceiverRegistrar3 GET /Dlna/{serverId}/MediaReceiverRegistrar/MediaReceiverRegistrar.xml Gets Dlna media receiver registrar xml.
DlnaServerApi processConnectionManagerControlRequest POST /Dlna/{serverId}/ConnectionManager/Control Process a connection manager control request.
DlnaServerApi processContentDirectoryControlRequest POST /Dlna/{serverId}/ContentDirectory/Control Process a content directory control request.
DlnaServerApi processMediaReceiverRegistrarControlRequest POST /Dlna/{serverId}/MediaReceiverRegistrar/Control Process a media receiver registrar control request.
DynamicHlsApi getHlsAudioSegment GET /Audio/{itemId}/hls1/{playlistId}/{segmentId}.{container} Gets a video stream using HTTP live streaming.
DynamicHlsApi getHlsVideoSegment GET /Videos/{itemId}/hls1/{playlistId}/{segmentId}.{container} Gets a video stream using HTTP live streaming.
DynamicHlsApi getLiveHlsStream GET /Videos/{itemId}/live.m3u8 Gets a hls live stream.
DynamicHlsApi getMasterHlsAudioPlaylist GET /Audio/{itemId}/master.m3u8 Gets an audio hls playlist stream.
DynamicHlsApi getMasterHlsVideoPlaylist GET /Videos/{itemId}/master.m3u8 Gets a video hls playlist stream.
DynamicHlsApi getVariantHlsAudioPlaylist GET /Audio/{itemId}/main.m3u8 Gets an audio stream using HTTP live streaming.
DynamicHlsApi getVariantHlsVideoPlaylist GET /Videos/{itemId}/main.m3u8 Gets a video stream using HTTP live streaming.
DynamicHlsApi headMasterHlsAudioPlaylist HEAD /Audio/{itemId}/master.m3u8 Gets an audio hls playlist stream.
DynamicHlsApi headMasterHlsVideoPlaylist HEAD /Videos/{itemId}/master.m3u8 Gets a video hls playlist stream.
EnvironmentApi getDefaultDirectoryBrowser GET /Environment/DefaultDirectoryBrowser Get Default directory browser.
EnvironmentApi getDirectoryContents GET /Environment/DirectoryContents Gets the contents of a given directory in the file system.
EnvironmentApi getDrives GET /Environment/Drives Gets available drives from the server's file system.
EnvironmentApi getNetworkShares GET /Environment/NetworkShares Gets network paths.
EnvironmentApi getParentPath GET /Environment/ParentPath Gets the parent path of a given path.
EnvironmentApi validatePath POST /Environment/ValidatePath Validates path.
FilterApi getQueryFilters GET /Items/Filters2 Gets query filters.
FilterApi getQueryFiltersLegacy GET /Items/Filters Gets legacy query filters.
GenresApi getGenre GET /Genres/{genreName} Gets a genre, by name.
GenresApi getGenres GET /Genres Gets all genres from a given item, folder, or the entire library.
HlsSegmentApi getHlsAudioSegmentLegacyAac GET /Audio/{itemId}/hls/{segmentId}/stream.aac Gets the specified audio segment for an audio item.
HlsSegmentApi getHlsAudioSegmentLegacyMp3 GET /Audio/{itemId}/hls/{segmentId}/stream.mp3 Gets the specified audio segment for an audio item.
HlsSegmentApi getHlsPlaylistLegacy GET /Videos/{itemId}/hls/{playlistId}/stream.m3u8 Gets a hls video playlist.
HlsSegmentApi getHlsVideoSegmentLegacy GET /Videos/{itemId}/hls/{playlistId}/{segmentId}.{segmentContainer} Gets a hls video segment.
HlsSegmentApi stopEncodingProcess DELETE /Videos/ActiveEncodings Stops an active encoding.
ImageApi deleteCustomSplashscreen DELETE /Branding/Splashscreen Delete a custom splashscreen.
ImageApi deleteItemImage DELETE /Items/{itemId}/Images/{imageType} Delete an item's image.
ImageApi deleteItemImageByIndex DELETE /Items/{itemId}/Images/{imageType}/{imageIndex} Delete an item's image.
ImageApi deleteUserImage DELETE /Users/{userId}/Images/{imageType} Delete the user's image.
ImageApi deleteUserImageByIndex DELETE /Users/{userId}/Images/{imageType}/{index} Delete the user's image.
ImageApi getArtistImage GET /Artists/{name}/Images/{imageType}/{imageIndex} Get artist image by name.
ImageApi getGenreImage GET /Genres/{name}/Images/{imageType} Get genre image by name.
ImageApi getGenreImageByIndex GET /Genres/{name}/Images/{imageType}/{imageIndex} Get genre image by name.
ImageApi getItemImage GET /Items/{itemId}/Images/{imageType} Gets the item's image.
ImageApi getItemImage2 GET /Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount} Gets the item's image.
ImageApi getItemImageByIndex GET /Items/{itemId}/Images/{imageType}/{imageIndex} Gets the item's image.
ImageApi getItemImageInfos GET /Items/{itemId}/Images Get item image infos.
ImageApi getMusicGenreImage GET /MusicGenres/{name}/Images/{imageType} Get music genre image by name.
ImageApi getMusicGenreImageByIndex GET /MusicGenres/{name}/Images/{imageType}/{imageIndex} Get music genre image by name.
ImageApi getPersonImage GET /Persons/{name}/Images/{imageType} Get person image by name.
ImageApi getPersonImageByIndex GET /Persons/{name}/Images/{imageType}/{imageIndex} Get person image by name.
ImageApi getSplashscreen GET /Branding/Splashscreen Generates or gets the splashscreen.
ImageApi getStudioImage GET /Studios/{name}/Images/{imageType} Get studio image by name.
ImageApi getStudioImageByIndex GET /Studios/{name}/Images/{imageType}/{imageIndex} Get studio image by name.
ImageApi getUserImage GET /Users/{userId}/Images/{imageType} Get user profile image.
ImageApi getUserImageByIndex GET /Users/{userId}/Images/{imageType}/{imageIndex} Get user profile image.
ImageApi headArtistImage HEAD /Artists/{name}/Images/{imageType}/{imageIndex} Get artist image by name.
ImageApi headGenreImage HEAD /Genres/{name}/Images/{imageType} Get genre image by name.
ImageApi headGenreImageByIndex HEAD /Genres/{name}/Images/{imageType}/{imageIndex} Get genre image by name.
ImageApi headItemImage HEAD /Items/{itemId}/Images/{imageType} Gets the item's image.
ImageApi headItemImage2 HEAD /Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount} Gets the item's image.
ImageApi headItemImageByIndex HEAD /Items/{itemId}/Images/{imageType}/{imageIndex} Gets the item's image.
ImageApi headMusicGenreImage HEAD /MusicGenres/{name}/Images/{imageType} Get music genre image by name.
ImageApi headMusicGenreImageByIndex HEAD /MusicGenres/{name}/Images/{imageType}/{imageIndex} Get music genre image by name.
ImageApi headPersonImage HEAD /Persons/{name}/Images/{imageType} Get person image by name.
ImageApi headPersonImageByIndex HEAD /Persons/{name}/Images/{imageType}/{imageIndex} Get person image by name.
ImageApi headStudioImage HEAD /Studios/{name}/Images/{imageType} Get studio image by name.
ImageApi headStudioImageByIndex HEAD /Studios/{name}/Images/{imageType}/{imageIndex} Get studio image by name.
ImageApi headUserImage HEAD /Users/{userId}/Images/{imageType} Get user profile image.
ImageApi headUserImageByIndex HEAD /Users/{userId}/Images/{imageType}/{imageIndex} Get user profile image.
ImageApi postUserImage POST /Users/{userId}/Images/{imageType} Sets the user image.
ImageApi postUserImageByIndex POST /Users/{userId}/Images/{imageType}/{index} Sets the user image.
ImageApi setItemImage POST /Items/{itemId}/Images/{imageType} Set item image.
ImageApi setItemImageByIndex POST /Items/{itemId}/Images/{imageType}/{imageIndex} Set item image.
ImageApi updateItemImageIndex POST /Items/{itemId}/Images/{imageType}/{imageIndex}/Index Updates the index for an item image.
ImageApi uploadCustomSplashscreen POST /Branding/Splashscreen Uploads a custom splashscreen. The body is expected to the image contents base64 encoded.
ImageByNameApi getGeneralImage GET /Images/General/{name}/{type} Get General Image.
ImageByNameApi getGeneralImages GET /Images/General Get all general images.
ImageByNameApi getMediaInfoImage GET /Images/MediaInfo/{theme}/{name} Get media info image.
ImageByNameApi getMediaInfoImages GET /Images/MediaInfo Get all media info images.
ImageByNameApi getRatingImage GET /Images/Ratings/{theme}/{name} Get rating image.
ImageByNameApi getRatingImages GET /Images/Ratings Get all general images.
InstantMixApi getInstantMixFromAlbum GET /Albums/{id}/InstantMix Creates an instant playlist based on a given album.
InstantMixApi getInstantMixFromArtists GET /Artists/{id}/InstantMix Creates an instant playlist based on a given artist.
InstantMixApi getInstantMixFromArtists2 GET /Artists/InstantMix Creates an instant playlist based on a given artist.
InstantMixApi getInstantMixFromItem GET /Items/{id}/InstantMix Creates an instant playlist based on a given item.
InstantMixApi getInstantMixFromMusicGenreById GET /MusicGenres/InstantMix Creates an instant playlist based on a given genre.
InstantMixApi getInstantMixFromMusicGenreByName GET /MusicGenres/{name}/InstantMix Creates an instant playlist based on a given genre.
InstantMixApi getInstantMixFromPlaylist GET /Playlists/{id}/InstantMix Creates an instant playlist based on a given playlist.
InstantMixApi getInstantMixFromSong GET /Songs/{id}/InstantMix Creates an instant playlist based on a given song.
ItemLookupApi applySearchCriteria POST /Items/RemoteSearch/Apply/{itemId} Applies search criteria to an item and refreshes metadata.
ItemLookupApi getBookRemoteSearchResults POST /Items/RemoteSearch/Book Get book remote search.
ItemLookupApi getBoxSetRemoteSearchResults POST /Items/RemoteSearch/BoxSet Get box set remote search.
ItemLookupApi getExternalIdInfos GET /Items/{itemId}/ExternalIdInfos Get the item's external id info.
ItemLookupApi getMovieRemoteSearchResults POST /Items/RemoteSearch/Movie Get movie remote search.
ItemLookupApi getMusicAlbumRemoteSearchResults POST /Items/RemoteSearch/MusicAlbum Get music album remote search.
ItemLookupApi getMusicArtistRemoteSearchResults POST /Items/RemoteSearch/MusicArtist Get music artist remote search.
ItemLookupApi getMusicVideoRemoteSearchResults POST /Items/RemoteSearch/MusicVideo Get music video remote search.
ItemLookupApi getPersonRemoteSearchResults POST /Items/RemoteSearch/Person Get person remote search.
ItemLookupApi getSeriesRemoteSearchResults POST /Items/RemoteSearch/Series Get series remote search.
ItemLookupApi getTrailerRemoteSearchResults POST /Items/RemoteSearch/Trailer Get trailer remote search.
ItemRefreshApi refreshItem POST /Items/{itemId}/Refresh Refreshes metadata for an item.
ItemUpdateApi getMetadataEditorInfo GET /Items/{itemId}/MetadataEditor Gets metadata editor info for an item.
ItemUpdateApi updateItem POST /Items/{itemId} Updates an item.
ItemUpdateApi updateItemContentType POST /Items/{itemId}/ContentType Updates an item's content type.
ItemsApi getItems GET /Items Gets items based on a query.
ItemsApi getItemsByUserId GET /Users/{userId}/Items Gets items based on a query.
ItemsApi getResumeItems GET /Users/{userId}/Items/Resume Gets items based on a query.
LibraryApi deleteItem DELETE /Items/{itemId} Deletes an item from the library and filesystem.
LibraryApi deleteItems DELETE /Items Deletes items from the library and filesystem.
LibraryApi getAncestors GET /Items/{itemId}/Ancestors Gets all parents of an item.
LibraryApi getCriticReviews GET /Items/{itemId}/CriticReviews Gets critic review for an item.
LibraryApi getDownload GET /Items/{itemId}/Download Downloads item media.
LibraryApi getFile GET /Items/{itemId}/File Get the original file of an item.
LibraryApi getItemCounts GET /Items/Counts Get item counts.
LibraryApi getLibraryOptionsInfo GET /Libraries/AvailableOptions Gets the library options info.
LibraryApi getMediaFolders GET /Library/MediaFolders Gets all user media folders.
LibraryApi getPhysicalPaths GET /Library/PhysicalPaths Gets a list of physical paths from virtual folders.
LibraryApi getSimilarAlbums GET /Albums/{itemId}/Similar Gets similar items.
LibraryApi getSimilarArtists GET /Artists/{itemId}/Similar Gets similar items.
LibraryApi getSimilarItems GET /Items/{itemId}/Similar Gets similar items.
LibraryApi getSimilarMovies GET /Movies/{itemId}/Similar Gets similar items.
LibraryApi getSimilarShows GET /Shows/{itemId}/Similar Gets similar items.
LibraryApi getSimilarTrailers GET /Trailers/{itemId}/Similar Gets similar items.
LibraryApi getThemeMedia GET /Items/{itemId}/ThemeMedia Get theme songs and videos for an item.
LibraryApi getThemeSongs GET /Items/{itemId}/ThemeSongs Get theme songs for an item.
LibraryApi getThemeVideos GET /Items/{itemId}/ThemeVideos Get theme videos for an item.
LibraryApi postAddedMovies POST /Library/Movies/Added Reports that new movies have been added by an external source.
LibraryApi postAddedSeries POST /Library/Series/Added Reports that new episodes of a series have been added by an external source.
LibraryApi postUpdatedMedia POST /Library/Media/Updated Reports that new movies have been added by an external source.
LibraryApi postUpdatedMovies POST /Library/Movies/Updated Reports that new movies have been added by an external source.
LibraryApi postUpdatedSeries POST /Library/Series/Updated Reports that new episodes of a series have been added by an external source.
LibraryApi refreshLibrary POST /Library/Refresh Starts a library scan.
LibraryStructureApi addMediaPath POST /Library/VirtualFolders/Paths Add a media path to a library.
LibraryStructureApi addVirtualFolder POST /Library/VirtualFolders Adds a virtual folder.
LibraryStructureApi getVirtualFolders GET /Library/VirtualFolders Gets all virtual folders.
LibraryStructureApi removeMediaPath DELETE /Library/VirtualFolders/Paths Remove a media path.
LibraryStructureApi removeVirtualFolder DELETE /Library/VirtualFolders Removes a virtual folder.
LibraryStructureApi renameVirtualFolder POST /Library/VirtualFolders/Name Renames a virtual folder.
LibraryStructureApi updateLibraryOptions POST /Library/VirtualFolders/LibraryOptions Update library options.
LibraryStructureApi updateMediaPath POST /Library/VirtualFolders/Paths/Update Updates a media path.
LiveTvApi addListingProvider POST /LiveTv/ListingProviders Adds a listings provider.
LiveTvApi addTunerHost POST /LiveTv/TunerHosts Adds a tuner host.
LiveTvApi cancelSeriesTimer DELETE /LiveTv/SeriesTimers/{timerId} Cancels a live tv series timer.
LiveTvApi cancelTimer DELETE /LiveTv/Timers/{timerId} Cancels a live tv timer.
LiveTvApi createSeriesTimer POST /LiveTv/SeriesTimers Creates a live tv series timer.
LiveTvApi createTimer POST /LiveTv/Timers Creates a live tv timer.
LiveTvApi deleteListingProvider DELETE /LiveTv/ListingProviders Delete listing provider.
LiveTvApi deleteRecording DELETE /LiveTv/Recordings/{recordingId} Deletes a live tv recording.
LiveTvApi deleteTunerHost DELETE /LiveTv/TunerHosts Deletes a tuner host.
LiveTvApi discoverTuners GET /LiveTv/Tuners/Discover Discover tuners.
LiveTvApi discvoverTuners GET /LiveTv/Tuners/Discvover Discover tuners.
LiveTvApi getChannel GET /LiveTv/Channels/{channelId} Gets a live tv channel.
LiveTvApi getChannelMappingOptions GET /LiveTv/ChannelMappingOptions Get channel mapping options.
LiveTvApi getDefaultListingProvider GET /LiveTv/ListingProviders/Default Gets default listings provider info.
LiveTvApi getDefaultTimer GET /LiveTv/Timers/Defaults Gets the default values for a new timer.
LiveTvApi getGuideInfo GET /LiveTv/GuideInfo Get guid info.
LiveTvApi getLineups GET /LiveTv/ListingProviders/Lineups Gets available lineups.
LiveTvApi getLiveRecordingFile GET /LiveTv/LiveRecordings/{recordingId}/stream Gets a live tv recording stream.
LiveTvApi getLiveStreamFile GET /LiveTv/LiveStreamFiles/{streamId}/stream.{container} Gets a live tv channel stream.
LiveTvApi getLiveTvChannels GET /LiveTv/Channels Gets available live tv channels.
LiveTvApi getLiveTvInfo GET /LiveTv/Info Gets available live tv services.
LiveTvApi getLiveTvPrograms GET /LiveTv/Programs Gets available live tv epgs.
LiveTvApi getProgram GET /LiveTv/Programs/{programId} Gets a live tv program.
LiveTvApi getPrograms POST /LiveTv/Programs Gets available live tv epgs.
LiveTvApi getRecommendedPrograms GET /LiveTv/Programs/Recommended Gets recommended live tv epgs.
LiveTvApi getRecording GET /LiveTv/Recordings/{recordingId} Gets a live tv recording.
LiveTvApi getRecordingFolders GET /LiveTv/Recordings/Folders Gets recording folders.
LiveTvApi getRecordingGroup GET /LiveTv/Recordings/Groups/{groupId} Get recording group.
LiveTvApi getRecordingGroups GET /LiveTv/Recordings/Groups Gets live tv recording groups.
LiveTvApi getRecordings GET /LiveTv/Recordings Gets live tv recordings.
LiveTvApi getRecordingsSeries GET /LiveTv/Recordings/Series Gets live tv recording series.
LiveTvApi getSchedulesDirectCountries GET /LiveTv/ListingProviders/SchedulesDirect/Countries Gets available countries.
LiveTvApi getSeriesTimer GET /LiveTv/SeriesTimers/{timerId} Gets a live tv series timer.
LiveTvApi getSeriesTimers GET /LiveTv/SeriesTimers Gets live tv series timers.
LiveTvApi getTimer GET /LiveTv/Timers/{timerId} Gets a timer.
LiveTvApi getTimers GET /LiveTv/Timers Gets the live tv timers.
LiveTvApi getTunerHostTypes GET /LiveTv/TunerHosts/Types Get tuner host types.
LiveTvApi resetTuner POST /LiveTv/Tuners/{tunerId}/Reset Resets a tv tuner.
LiveTvApi setChannelMapping POST /LiveTv/ChannelMappings Set channel mappings.
LiveTvApi updateSeriesTimer POST /LiveTv/SeriesTimers/{timerId} Updates a live tv series timer.
LiveTvApi updateTimer POST /LiveTv/Timers/{timerId} Updates a live tv timer.
LocalizationApi getCountries GET /Localization/Countries Gets known countries.
LocalizationApi getCultures GET /Localization/Cultures Gets known cultures.
LocalizationApi getLocalizationOptions GET /Localization/Options Gets localization options.
LocalizationApi getParentalRatings GET /Localization/ParentalRatings Gets known parental ratings.
MediaInfoApi closeLiveStream POST /LiveStreams/Close Closes a media source.
MediaInfoApi getBitrateTestBytes GET /Playback/BitrateTest Tests the network with a request with the size of the bitrate.
MediaInfoApi getPlaybackInfo GET /Items/{itemId}/PlaybackInfo Gets live playback media info for an item.
MediaInfoApi getPostedPlaybackInfo POST /Items/{itemId}/PlaybackInfo Gets live playback media info for an item.
MediaInfoApi openLiveStream POST /LiveStreams/Open Opens a media source.
MoviesApi getMovieRecommendations GET /Movies/Recommendations Gets movie recommendations.
MusicGenresApi getMusicGenre GET /MusicGenres/{genreName} Gets a music genre, by name.
MusicGenresApi getMusicGenres GET /MusicGenres Gets all music genres from a given item, folder, or the entire library.
NotificationsApi createAdminNotification POST /Notifications/Admin Sends a notification to all admins.
NotificationsApi getNotificationServices GET /Notifications/Services Gets notification services.
NotificationsApi getNotificationTypes GET /Notifications/Types Gets notification types.
NotificationsApi getNotifications GET /Notifications/{userId} Gets a user's notifications.
NotificationsApi getNotificationsSummary GET /Notifications/{userId}/Summary Gets a user's notification summary.
NotificationsApi setRead POST /Notifications/{userId}/Read Sets notifications as read.
NotificationsApi setUnread POST /Notifications/{userId}/Unread Sets notifications as unread.
PackageApi cancelPackageInstallation DELETE /Packages/Installing/{packageId} Cancels a package installation.
PackageApi getPackageInfo GET /Packages/{name} Gets a package by name or assembly GUID.
PackageApi getPackages GET /Packages Gets available packages.
PackageApi getRepositories GET /Repositories Gets all package repositories.
PackageApi installPackage POST /Packages/Installed/{name} Installs a package.
PackageApi setRepositories POST /Repositories Sets the enabled and existing package repositories.
PersonsApi getPerson GET /Persons/{name} Get person by name.
PersonsApi getPersons GET /Persons Gets all persons.
PlaylistsApi addToPlaylist POST /Playlists/{playlistId}/Items Adds items to a playlist.
PlaylistsApi createPlaylist POST /Playlists Creates a new playlist.
PlaylistsApi getPlaylistItems GET /Playlists/{playlistId}/Items Gets the original items of a playlist.
PlaylistsApi moveItem POST /Playlists/{playlistId}/Items/{itemId}/Move/{newIndex} Moves a playlist item.
PlaylistsApi removeFromPlaylist DELETE /Playlists/{playlistId}/Items Removes items from a playlist.
PlaystateApi markPlayedItem POST /Users/{userId}/PlayedItems/{itemId} Marks an item as played for user.
PlaystateApi markUnplayedItem DELETE /Users/{userId}/PlayedItems/{itemId} Marks an item as unplayed for user.
PlaystateApi onPlaybackProgress POST /Users/{userId}/PlayingItems/{itemId}/Progress Reports a user's playback progress.
PlaystateApi onPlaybackStart POST /Users/{userId}/PlayingItems/{itemId} Reports that a user has begun playing an item.
PlaystateApi onPlaybackStopped DELETE /Users/{userId}/PlayingItems/{itemId} Reports that a user has stopped playing an item.
PlaystateApi pingPlaybackSession POST /Sessions/Playing/Ping Pings a playback session.
PlaystateApi reportPlaybackProgress POST /Sessions/Playing/Progress Reports playback progress within a session.
PlaystateApi reportPlaybackStart POST /Sessions/Playing Reports playback has started within a session.
PlaystateApi reportPlaybackStopped POST /Sessions/Playing/Stopped Reports playback has stopped within a session.
PluginsApi disablePlugin POST /Plugins/{pluginId}/{version}/Disable Disable a plugin.
PluginsApi enablePlugin POST /Plugins/{pluginId}/{version}/Enable Enables a disabled plugin.
PluginsApi getPluginConfiguration GET /Plugins/{pluginId}/Configuration Gets plugin configuration.
PluginsApi getPluginImage GET /Plugins/{pluginId}/{version}/Image Gets a plugin's image.
PluginsApi getPluginManifest POST /Plugins/{pluginId}/Manifest Gets a plugin's manifest.
PluginsApi getPlugins GET /Plugins Gets a list of currently installed plugins.
PluginsApi uninstallPlugin DELETE /Plugins/{pluginId} Uninstalls a plugin.
PluginsApi uninstallPluginByVersion DELETE /Plugins/{pluginId}/{version} Uninstalls a plugin by version.
PluginsApi updatePluginConfiguration POST /Plugins/{pluginId}/Configuration Updates plugin configuration.
QuickConnectApi authorize POST /QuickConnect/Authorize Authorizes a pending quick connect request.
QuickConnectApi connect GET /QuickConnect/Connect Attempts to retrieve authentication information.
QuickConnectApi getEnabled GET /QuickConnect/Enabled Gets the current quick connect state.
QuickConnectApi initiate GET /QuickConnect/Initiate Initiate a new quick connect request.
RemoteImageApi downloadRemoteImage POST /Items/{itemId}/RemoteImages/Download Downloads a remote image for an item.
RemoteImageApi getRemoteImageProviders GET /Items/{itemId}/RemoteImages/Providers Gets available remote image providers for an item.
RemoteImageApi getRemoteImages GET /Items/{itemId}/RemoteImages Gets available remote images for an item.
ScheduledTasksApi getTask GET /ScheduledTasks/{taskId} Get task by id.
ScheduledTasksApi getTasks GET /ScheduledTasks Get tasks.
ScheduledTasksApi startTask POST /ScheduledTasks/Running/{taskId} Start specified task.
ScheduledTasksApi stopTask DELETE /ScheduledTasks/Running/{taskId} Stop specified task.
ScheduledTasksApi updateTask POST /ScheduledTasks/{taskId}/Triggers Update specified task triggers.
SearchApi callGet GET /Search/Hints Gets the search hint result.
SessionApi addUserToSession POST /Sessions/{sessionId}/User/{userId} Adds an additional user to a session.
SessionApi displayContent POST /Sessions/{sessionId}/Viewing Instructs a session to browse to an item or view.
SessionApi getAuthProviders GET /Auth/Providers Get all auth providers.
SessionApi getPasswordResetProviders GET /Auth/PasswordResetProviders Get all password reset providers.
SessionApi getSessions GET /Sessions Gets a list of sessions.
SessionApi play POST /Sessions/{sessionId}/Playing Instructs a session to play an item.
SessionApi postCapabilities POST /Sessions/Capabilities Updates capabilities for a device.
SessionApi postFullCapabilities POST /Sessions/Capabilities/Full Updates capabilities for a device.
SessionApi removeUserFromSession DELETE /Sessions/{sessionId}/User/{userId} Removes an additional user from a session.
SessionApi reportSessionEnded POST /Sessions/Logout Reports that a session has ended.
SessionApi reportViewing POST /Sessions/Viewing Reports that a session is viewing an item.
SessionApi sendFullGeneralCommand POST /Sessions/{sessionId}/Command Issues a full general command to a client.
SessionApi sendGeneralCommand POST /Sessions/{sessionId}/Command/{command} Issues a general command to a client.
SessionApi sendMessageCommand POST /Sessions/{sessionId}/Message Issues a command to a client to display a message to the user.
SessionApi sendPlaystateCommand POST /Sessions/{sessionId}/Playing/{command} Issues a playstate command to a client.
SessionApi sendSystemCommand POST /Sessions/{sessionId}/System/{command} Issues a system command to a client.
StartupApi completeWizard POST /Startup/Complete Completes the startup wizard.
StartupApi getFirstUser GET /Startup/User Gets the first user.
StartupApi getFirstUser2 GET /Startup/FirstUser Gets the first user.
StartupApi getStartupConfiguration GET /Startup/Configuration Gets the initial startup wizard configuration.
StartupApi setRemoteAccess POST /Startup/RemoteAccess Sets remote access and UPnP.
StartupApi updateInitialConfiguration POST /Startup/Configuration Sets the initial startup wizard configuration.
StartupApi updateStartupUser POST /Startup/User Sets the user name and password.
StudiosApi getStudio GET /Studios/{name} Gets a studio by name.
StudiosApi getStudios GET /Studios Gets all studios from a given item, folder, or the entire library.
SubtitleApi deleteSubtitle DELETE /Videos/{itemId}/Subtitles/{index} Deletes an external subtitle file.
SubtitleApi downloadRemoteSubtitles POST /Items/{itemId}/RemoteSearch/Subtitles/{subtitleId} Downloads a remote subtitle.
SubtitleApi getFallbackFont GET /FallbackFont/Fonts/{name} Gets a fallback font file.
SubtitleApi getFallbackFontList GET /FallbackFont/Fonts Gets a list of available fallback font files.
SubtitleApi getRemoteSubtitles GET /Providers/Subtitles/Subtitles/{id} Gets the remote subtitles.
SubtitleApi getSubtitle GET /Videos/{routeItemId}/{routeMediaSourceId}/Subtitles/{routeIndex}/Stream.{routeFormat} Gets subtitles in a specified format.
SubtitleApi getSubtitlePlaylist GET /Videos/{itemId}/{mediaSourceId}/Subtitles/{index}/subtitles.m3u8 Gets an HLS subtitle playlist.
SubtitleApi getSubtitleWithTicks GET /Videos/{routeItemId}/{routeMediaSourceId}/Subtitles/{routeIndex}/{routeStartPositionTicks}/Stream.{routeFormat} Gets subtitles in a specified format.
SubtitleApi searchRemoteSubtitles GET /Items/{itemId}/RemoteSearch/Subtitles/{language} Search remote subtitles.
SubtitleApi uploadSubtitle POST /Videos/{itemId}/Subtitles Upload an external subtitle file.
SuggestionsApi getSuggestions GET /Users/{userId}/Suggestions Gets suggestions.
SyncPlayApi syncPlayBuffering POST /SyncPlay/Buffering Notify SyncPlay group that member is buffering.
SyncPlayApi syncPlayCreateGroup POST /SyncPlay/New Create a new SyncPlay group.
SyncPlayApi syncPlayGetGroups GET /SyncPlay/List Gets all SyncPlay groups.
SyncPlayApi syncPlayJoinGroup POST /SyncPlay/Join Join an existing SyncPlay group.
SyncPlayApi syncPlayLeaveGroup POST /SyncPlay/Leave Leave the joined SyncPlay group.
SyncPlayApi syncPlayMovePlaylistItem POST /SyncPlay/MovePlaylistItem Request to move an item in the playlist in SyncPlay group.
SyncPlayApi syncPlayNextItem POST /SyncPlay/NextItem Request next item in SyncPlay group.
SyncPlayApi syncPlayPause POST /SyncPlay/Pause Request pause in SyncPlay group.
SyncPlayApi syncPlayPing POST /SyncPlay/Ping Update session ping.
SyncPlayApi syncPlayPreviousItem POST /SyncPlay/PreviousItem Request previous item in SyncPlay group.
SyncPlayApi syncPlayQueue POST /SyncPlay/Queue Request to queue items to the playlist of a SyncPlay group.
SyncPlayApi syncPlayReady POST /SyncPlay/Ready Notify SyncPlay group that member is ready for playback.
SyncPlayApi syncPlayRemoveFromPlaylist POST /SyncPlay/RemoveFromPlaylist Request to remove items from the playlist in SyncPlay group.
SyncPlayApi syncPlaySeek POST /SyncPlay/Seek Request seek in SyncPlay group.
SyncPlayApi syncPlaySetIgnoreWait POST /SyncPlay/SetIgnoreWait Request SyncPlay group to ignore member during group-wait.
SyncPlayApi syncPlaySetNewQueue POST /SyncPlay/SetNewQueue Request to set new playlist in SyncPlay group.
SyncPlayApi syncPlaySetPlaylistItem POST /SyncPlay/SetPlaylistItem Request to change playlist item in SyncPlay group.
SyncPlayApi syncPlaySetRepeatMode POST /SyncPlay/SetRepeatMode Request to set repeat mode in SyncPlay group.
SyncPlayApi syncPlaySetShuffleMode POST /SyncPlay/SetShuffleMode Request to set shuffle mode in SyncPlay group.
SyncPlayApi syncPlayStop POST /SyncPlay/Stop Request stop in SyncPlay group.
SyncPlayApi syncPlayUnpause POST /SyncPlay/Unpause Request unpause in SyncPlay group.
SystemApi getEndpointInfo GET /System/Endpoint Gets information about the request endpoint.
SystemApi getLogFile GET /System/Logs/Log Gets a log file.
SystemApi getPingSystem GET /System/Ping Pings the system.
SystemApi getPublicSystemInfo GET /System/Info/Public Gets public information about the server.
SystemApi getServerLogs GET /System/Logs Gets a list of available server log files.
SystemApi getSystemInfo GET /System/Info Gets information about the server.
SystemApi getWakeOnLanInfo GET /System/WakeOnLanInfo Gets wake on lan information.
SystemApi postPingSystem POST /System/Ping Pings the system.
SystemApi restartApplication POST /System/Restart Restarts the application.
SystemApi shutdownApplication POST /System/Shutdown Shuts down the application.
TimeSyncApi getUtcTime GET /GetUtcTime Gets the current UTC time.
TmdbApi tmdbClientConfiguration GET /Tmdb/ClientConfiguration Gets the TMDb image configuration options.
TrailersApi getTrailers GET /Trailers Finds movies and trailers similar to a given trailer.
TvShowsApi getEpisodes GET /Shows/{seriesId}/Episodes Gets episodes for a tv season.
TvShowsApi getNextUp GET /Shows/NextUp Gets a list of next up episodes.
TvShowsApi getSeasons GET /Shows/{seriesId}/Seasons Gets seasons for a tv series.
TvShowsApi getUpcomingEpisodes GET /Shows/Upcoming Gets a list of upcoming episodes.
UniversalAudioApi getUniversalAudioStream GET /Audio/{itemId}/universal Gets an audio stream.
UniversalAudioApi headUniversalAudioStream HEAD /Audio/{itemId}/universal Gets an audio stream.
UserApi authenticateUser POST /Users/{userId}/Authenticate Authenticates a user.
UserApi authenticateUserByName POST /Users/AuthenticateByName Authenticates a user by name.
UserApi authenticateWithQuickConnect POST /Users/AuthenticateWithQuickConnect Authenticates a user with quick connect.
UserApi createUserByName POST /Users/New Creates a user.
UserApi deleteUser DELETE /Users/{userId} Deletes a user.
UserApi forgotPassword POST /Users/ForgotPassword Initiates the forgot password process for a local user.
UserApi forgotPasswordPin POST /Users/ForgotPassword/Pin Redeems a forgot password pin.
UserApi getCurrentUser GET /Users/Me Gets the user based on auth token.
UserApi getPublicUsers GET /Users/Public Gets a list of publicly visible users for display on a login screen.
UserApi getUserById GET /Users/{userId} Gets a user by Id.
UserApi getUsers GET /Users Gets a list of users.
UserApi updateUser POST /Users/{userId} Updates a user.
UserApi updateUserConfiguration POST /Users/{userId}/Configuration Updates a user configuration.
UserApi updateUserEasyPassword POST /Users/{userId}/EasyPassword Updates a user's easy password.
UserApi updateUserPassword POST /Users/{userId}/Password Updates a user's password.
UserApi updateUserPolicy POST /Users/{userId}/Policy Updates a user policy.
UserLibraryApi deleteUserItemRating DELETE /Users/{userId}/Items/{itemId}/Rating Deletes a user's saved personal rating for an item.
UserLibraryApi getIntros GET /Users/{userId}/Items/{itemId}/Intros Gets intros to play before the main media item plays.
UserLibraryApi getItem GET /Users/{userId}/Items/{itemId} Gets an item from a user's library.
UserLibraryApi getLatestMedia GET /Users/{userId}/Items/Latest Gets latest media.
UserLibraryApi getLocalTrailers GET /Users/{userId}/Items/{itemId}/LocalTrailers Gets local trailers for an item.
UserLibraryApi getRootFolder GET /Users/{userId}/Items/Root Gets the root folder from a user's library.
UserLibraryApi getSpecialFeatures GET /Users/{userId}/Items/{itemId}/SpecialFeatures Gets special features for an item.
UserLibraryApi markFavoriteItem POST /Users/{userId}/FavoriteItems/{itemId} Marks an item as a favorite.
UserLibraryApi unmarkFavoriteItem DELETE /Users/{userId}/FavoriteItems/{itemId} Unmarks item as a favorite.
UserLibraryApi updateUserItemRating POST /Users/{userId}/Items/{itemId}/Rating Updates a user's rating for an item.
UserViewsApi getGroupingOptions GET /Users/{userId}/GroupingOptions Get user view grouping options.
UserViewsApi getUserViews GET /Users/{userId}/Views Get user views.
VideoAttachmentsApi getAttachment GET /Videos/{videoId}/{mediaSourceId}/Attachments/{index} Get video attachment.
VideosApi deleteAlternateSources DELETE /Videos/{itemId}/AlternateSources Removes alternate video sources.
VideosApi getAdditionalPart GET /Videos/{itemId}/AdditionalParts Gets additional parts for a video.
VideosApi getVideoStream GET /Videos/{itemId}/stream Gets a video stream.
VideosApi getVideoStreamByContainer GET /Videos/{itemId}/stream.{container} Gets a video stream.
VideosApi headVideoStream HEAD /Videos/{itemId}/stream Gets a video stream.
VideosApi headVideoStreamByContainer HEAD /Videos/{itemId}/stream.{container} Gets a video stream.
VideosApi mergeVersions POST /Videos/MergeVersions Merges videos into a single record.
YearsApi getYear GET /Years/{year} Gets a year.
YearsApi getYears GET /Years Get years.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

CustomAuthentication

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages