Jellyfin API
Project description
openapi-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 10.11.0
- Package version: 1.0.0
- Generator version: 7.14.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.9+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import openapi_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import openapi_client
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "http://localhost"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CustomAuthentication'] = 'Bearer'
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.ActivityLogApi(api_client)
start_index = 56 # int | Optional. The record index to start at. All items with a lower index will be dropped from the results. (optional)
limit = 56 # int | Optional. The maximum number of records to return. (optional)
min_date = '2013-10-20T19:20:30+01:00' # datetime | Optional. The minimum date. Format = ISO. (optional)
has_user_id = True # bool | Optional. Filter log entries if it has user id, or not. (optional)
try:
# Gets activity log entries.
api_response = api_instance.get_log_entries(start_index=start_index, limit=limit, min_date=min_date, has_user_id=has_user_id)
print("The response of ActivityLogApi->get_log_entries:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ActivityLogApi->get_log_entries: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ActivityLogApi | get_log_entries | GET /System/ActivityLog/Entries | Gets activity log entries. |
| ApiKeyApi | create_key | POST /Auth/Keys | Create a new api key. |
| ApiKeyApi | get_keys | GET /Auth/Keys | Get all keys. |
| ApiKeyApi | revoke_key | DELETE /Auth/Keys/{key} | Remove an api key. |
| ArtistsApi | get_album_artists | GET /Artists/AlbumArtists | Gets all album artists from a given item, folder, or the entire library. |
| ArtistsApi | get_artist_by_name | GET /Artists/{name} | Gets an artist by name. |
| ArtistsApi | get_artists | GET /Artists | Gets all artists from a given item, folder, or the entire library. |
| AudioApi | get_audio_stream | GET /Audio/{itemId}/stream | Gets an audio stream. |
| AudioApi | get_audio_stream_by_container | GET /Audio/{itemId}/stream.{container} | Gets an audio stream. |
| AudioApi | head_audio_stream | HEAD /Audio/{itemId}/stream | Gets an audio stream. |
| AudioApi | head_audio_stream_by_container | HEAD /Audio/{itemId}/stream.{container} | Gets an audio stream. |
| BackupApi | create_backup | POST /Backup/Create | Creates a new Backup. |
| BackupApi | get_backup | GET /Backup/Manifest | Gets the descriptor from an existing archive is present. |
| BackupApi | list_backups | GET /Backup | Gets a list of all currently present backups in the backup directory. |
| BackupApi | start_restore_backup | POST /Backup/Restore | Restores to a backup by restarting the server and applying the backup. |
| BrandingApi | get_branding_css | GET /Branding/Css | Gets branding css. |
| BrandingApi | get_branding_css2 | GET /Branding/Css.css | Gets branding css. |
| BrandingApi | get_branding_options | GET /Branding/Configuration | Gets branding configuration. |
| ChannelsApi | get_all_channel_features | GET /Channels/Features | Get all channel features. |
| ChannelsApi | get_channel_features | GET /Channels/{channelId}/Features | Get channel features. |
| ChannelsApi | get_channel_items | GET /Channels/{channelId}/Items | Get channel items. |
| ChannelsApi | get_channels | GET /Channels | Gets available channels. |
| ChannelsApi | get_latest_channel_items | GET /Channels/Items/Latest | Gets latest channel items. |
| ClientLogApi | log_file | POST /ClientLog/Document | Upload a document. |
| CollectionApi | add_to_collection | POST /Collections/{collectionId}/Items | Adds items to a collection. |
| CollectionApi | create_collection | POST /Collections | Creates a new collection. |
| CollectionApi | remove_from_collection | DELETE /Collections/{collectionId}/Items | Removes items from a collection. |
| ConfigurationApi | get_configuration | GET /System/Configuration | Gets application configuration. |
| ConfigurationApi | get_default_metadata_options | GET /System/Configuration/MetadataOptions/Default | Gets a default MetadataOptions object. |
| ConfigurationApi | get_named_configuration | GET /System/Configuration/{key} | Gets a named configuration. |
| ConfigurationApi | update_branding_configuration | POST /System/Configuration/Branding | Updates branding configuration. |
| ConfigurationApi | update_configuration | POST /System/Configuration | Updates application configuration. |
| ConfigurationApi | update_named_configuration | POST /System/Configuration/{key} | Updates named configuration. |
| DashboardApi | get_configuration_pages | GET /web/ConfigurationPages | Gets the configuration pages. |
| DashboardApi | get_dashboard_configuration_page | GET /web/ConfigurationPage | Gets a dashboard configuration page. |
| DevicesApi | delete_device | DELETE /Devices | Deletes a device. |
| DevicesApi | get_device_info | GET /Devices/Info | Get info for a device. |
| DevicesApi | get_device_options | GET /Devices/Options | Get options for a device. |
| DevicesApi | get_devices | GET /Devices | Get Devices. |
| DevicesApi | update_device_options | POST /Devices/Options | Update device options. |
| DisplayPreferencesApi | get_display_preferences | GET /DisplayPreferences/{displayPreferencesId} | Get Display Preferences. |
| DisplayPreferencesApi | update_display_preferences | POST /DisplayPreferences/{displayPreferencesId} | Update Display Preferences. |
| DynamicHlsApi | get_hls_audio_segment | GET /Audio/{itemId}/hls1/{playlistId}/{segmentId}.{container} | Gets a video stream using HTTP live streaming. |
| DynamicHlsApi | get_hls_video_segment | GET /Videos/{itemId}/hls1/{playlistId}/{segmentId}.{container} | Gets a video stream using HTTP live streaming. |
| DynamicHlsApi | get_live_hls_stream | GET /Videos/{itemId}/live.m3u8 | Gets a hls live stream. |
| DynamicHlsApi | get_master_hls_audio_playlist | GET /Audio/{itemId}/master.m3u8 | Gets an audio hls playlist stream. |
| DynamicHlsApi | get_master_hls_video_playlist | GET /Videos/{itemId}/master.m3u8 | Gets a video hls playlist stream. |
| DynamicHlsApi | get_variant_hls_audio_playlist | GET /Audio/{itemId}/main.m3u8 | Gets an audio stream using HTTP live streaming. |
| DynamicHlsApi | get_variant_hls_video_playlist | GET /Videos/{itemId}/main.m3u8 | Gets a video stream using HTTP live streaming. |
| DynamicHlsApi | head_master_hls_audio_playlist | HEAD /Audio/{itemId}/master.m3u8 | Gets an audio hls playlist stream. |
| DynamicHlsApi | head_master_hls_video_playlist | HEAD /Videos/{itemId}/master.m3u8 | Gets a video hls playlist stream. |
| EnvironmentApi | get_default_directory_browser | GET /Environment/DefaultDirectoryBrowser | Get Default directory browser. |
| EnvironmentApi | get_directory_contents | GET /Environment/DirectoryContents | Gets the contents of a given directory in the file system. |
| EnvironmentApi | get_drives | GET /Environment/Drives | Gets available drives from the server's file system. |
| EnvironmentApi | get_network_shares | GET /Environment/NetworkShares | Gets network paths. |
| EnvironmentApi | get_parent_path | GET /Environment/ParentPath | Gets the parent path of a given path. |
| EnvironmentApi | validate_path | POST /Environment/ValidatePath | Validates path. |
| FilterApi | get_query_filters | GET /Items/Filters2 | Gets query filters. |
| FilterApi | get_query_filters_legacy | GET /Items/Filters | Gets legacy query filters. |
| GenresApi | get_genre | GET /Genres/{genreName} | Gets a genre, by name. |
| GenresApi | get_genres | GET /Genres | Gets all genres from a given item, folder, or the entire library. |
| HlsSegmentApi | get_hls_audio_segment_legacy_aac | GET /Audio/{itemId}/hls/{segmentId}/stream.aac | Gets the specified audio segment for an audio item. |
| HlsSegmentApi | get_hls_audio_segment_legacy_mp3 | GET /Audio/{itemId}/hls/{segmentId}/stream.mp3 | Gets the specified audio segment for an audio item. |
| HlsSegmentApi | get_hls_playlist_legacy | GET /Videos/{itemId}/hls/{playlistId}/stream.m3u8 | Gets a hls video playlist. |
| HlsSegmentApi | get_hls_video_segment_legacy | GET /Videos/{itemId}/hls/{playlistId}/{segmentId}.{segmentContainer} | Gets a hls video segment. |
| HlsSegmentApi | stop_encoding_process | DELETE /Videos/ActiveEncodings | Stops an active encoding. |
| ImageApi | delete_custom_splashscreen | DELETE /Branding/Splashscreen | Delete a custom splashscreen. |
| ImageApi | delete_item_image | DELETE /Items/{itemId}/Images/{imageType} | Delete an item's image. |
| ImageApi | delete_item_image_by_index | DELETE /Items/{itemId}/Images/{imageType}/{imageIndex} | Delete an item's image. |
| ImageApi | delete_user_image | DELETE /UserImage | Delete the user's image. |
| ImageApi | get_artist_image | GET /Artists/{name}/Images/{imageType}/{imageIndex} | Get artist image by name. |
| ImageApi | get_genre_image | GET /Genres/{name}/Images/{imageType} | Get genre image by name. |
| ImageApi | get_genre_image_by_index | GET /Genres/{name}/Images/{imageType}/{imageIndex} | Get genre image by name. |
| ImageApi | get_item_image | GET /Items/{itemId}/Images/{imageType} | Gets the item's image. |
| ImageApi | get_item_image2 | GET /Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount} | Gets the item's image. |
| ImageApi | get_item_image_by_index | GET /Items/{itemId}/Images/{imageType}/{imageIndex} | Gets the item's image. |
| ImageApi | get_item_image_infos | GET /Items/{itemId}/Images | Get item image infos. |
| ImageApi | get_music_genre_image | GET /MusicGenres/{name}/Images/{imageType} | Get music genre image by name. |
| ImageApi | get_music_genre_image_by_index | GET /MusicGenres/{name}/Images/{imageType}/{imageIndex} | Get music genre image by name. |
| ImageApi | get_person_image | GET /Persons/{name}/Images/{imageType} | Get person image by name. |
| ImageApi | get_person_image_by_index | GET /Persons/{name}/Images/{imageType}/{imageIndex} | Get person image by name. |
| ImageApi | get_splashscreen | GET /Branding/Splashscreen | Generates or gets the splashscreen. |
| ImageApi | get_studio_image | GET /Studios/{name}/Images/{imageType} | Get studio image by name. |
| ImageApi | get_studio_image_by_index | GET /Studios/{name}/Images/{imageType}/{imageIndex} | Get studio image by name. |
| ImageApi | get_user_image | GET /UserImage | Get user profile image. |
| ImageApi | head_artist_image | HEAD /Artists/{name}/Images/{imageType}/{imageIndex} | Get artist image by name. |
| ImageApi | head_genre_image | HEAD /Genres/{name}/Images/{imageType} | Get genre image by name. |
| ImageApi | head_genre_image_by_index | HEAD /Genres/{name}/Images/{imageType}/{imageIndex} | Get genre image by name. |
| ImageApi | head_item_image | HEAD /Items/{itemId}/Images/{imageType} | Gets the item's image. |
| ImageApi | head_item_image2 | HEAD /Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount} | Gets the item's image. |
| ImageApi | head_item_image_by_index | HEAD /Items/{itemId}/Images/{imageType}/{imageIndex} | Gets the item's image. |
| ImageApi | head_music_genre_image | HEAD /MusicGenres/{name}/Images/{imageType} | Get music genre image by name. |
| ImageApi | head_music_genre_image_by_index | HEAD /MusicGenres/{name}/Images/{imageType}/{imageIndex} | Get music genre image by name. |
| ImageApi | head_person_image | HEAD /Persons/{name}/Images/{imageType} | Get person image by name. |
| ImageApi | head_person_image_by_index | HEAD /Persons/{name}/Images/{imageType}/{imageIndex} | Get person image by name. |
| ImageApi | head_studio_image | HEAD /Studios/{name}/Images/{imageType} | Get studio image by name. |
| ImageApi | head_studio_image_by_index | HEAD /Studios/{name}/Images/{imageType}/{imageIndex} | Get studio image by name. |
| ImageApi | head_user_image | HEAD /UserImage | Get user profile image. |
| ImageApi | post_user_image | POST /UserImage | Sets the user image. |
| ImageApi | set_item_image | POST /Items/{itemId}/Images/{imageType} | Set item image. |
| ImageApi | set_item_image_by_index | POST /Items/{itemId}/Images/{imageType}/{imageIndex} | Set item image. |
| ImageApi | update_item_image_index | POST /Items/{itemId}/Images/{imageType}/{imageIndex}/Index | Updates the index for an item image. |
| ImageApi | upload_custom_splashscreen | POST /Branding/Splashscreen | Uploads a custom splashscreen. The body is expected to the image contents base64 encoded. |
| InstantMixApi | get_instant_mix_from_album | GET /Albums/{itemId}/InstantMix | Creates an instant playlist based on a given album. |
| InstantMixApi | get_instant_mix_from_artists | GET /Artists/{itemId}/InstantMix | Creates an instant playlist based on a given artist. |
| InstantMixApi | get_instant_mix_from_artists2 | GET /Artists/InstantMix | Creates an instant playlist based on a given artist. |
| InstantMixApi | get_instant_mix_from_item | GET /Items/{itemId}/InstantMix | Creates an instant playlist based on a given item. |
| InstantMixApi | get_instant_mix_from_music_genre_by_id | GET /MusicGenres/InstantMix | Creates an instant playlist based on a given genre. |
| InstantMixApi | get_instant_mix_from_music_genre_by_name | GET /MusicGenres/{name}/InstantMix | Creates an instant playlist based on a given genre. |
| InstantMixApi | get_instant_mix_from_playlist | GET /Playlists/{itemId}/InstantMix | Creates an instant playlist based on a given playlist. |
| InstantMixApi | get_instant_mix_from_song | GET /Songs/{itemId}/InstantMix | Creates an instant playlist based on a given song. |
| ItemLookupApi | apply_search_criteria | POST /Items/RemoteSearch/Apply/{itemId} | Applies search criteria to an item and refreshes metadata. |
| ItemLookupApi | get_book_remote_search_results | POST /Items/RemoteSearch/Book | Get book remote search. |
| ItemLookupApi | get_box_set_remote_search_results | POST /Items/RemoteSearch/BoxSet | Get box set remote search. |
| ItemLookupApi | get_external_id_infos | GET /Items/{itemId}/ExternalIdInfos | Get the item's external id info. |
| ItemLookupApi | get_movie_remote_search_results | POST /Items/RemoteSearch/Movie | Get movie remote search. |
| ItemLookupApi | get_music_album_remote_search_results | POST /Items/RemoteSearch/MusicAlbum | Get music album remote search. |
| ItemLookupApi | get_music_artist_remote_search_results | POST /Items/RemoteSearch/MusicArtist | Get music artist remote search. |
| ItemLookupApi | get_music_video_remote_search_results | POST /Items/RemoteSearch/MusicVideo | Get music video remote search. |
| ItemLookupApi | get_person_remote_search_results | POST /Items/RemoteSearch/Person | Get person remote search. |
| ItemLookupApi | get_series_remote_search_results | POST /Items/RemoteSearch/Series | Get series remote search. |
| ItemLookupApi | get_trailer_remote_search_results | POST /Items/RemoteSearch/Trailer | Get trailer remote search. |
| ItemRefreshApi | refresh_item | POST /Items/{itemId}/Refresh | Refreshes metadata for an item. |
| ItemUpdateApi | get_metadata_editor_info | GET /Items/{itemId}/MetadataEditor | Gets metadata editor info for an item. |
| ItemUpdateApi | update_item | POST /Items/{itemId} | Updates an item. |
| ItemUpdateApi | update_item_content_type | POST /Items/{itemId}/ContentType | Updates an item's content type. |
| ItemsApi | get_item_user_data | GET /UserItems/{itemId}/UserData | Get Item User Data. |
| ItemsApi | get_items | GET /Items | Gets items based on a query. |
| ItemsApi | get_resume_items | GET /UserItems/Resume | Gets items based on a query. |
| ItemsApi | update_item_user_data | POST /UserItems/{itemId}/UserData | Update Item User Data. |
| LibraryApi | delete_item | DELETE /Items/{itemId} | Deletes an item from the library and filesystem. |
| LibraryApi | delete_items | DELETE /Items | Deletes items from the library and filesystem. |
| LibraryApi | get_ancestors | GET /Items/{itemId}/Ancestors | Gets all parents of an item. |
| LibraryApi | get_critic_reviews | GET /Items/{itemId}/CriticReviews | Gets critic review for an item. |
| LibraryApi | get_download | GET /Items/{itemId}/Download | Downloads item media. |
| LibraryApi | get_file | GET /Items/{itemId}/File | Get the original file of an item. |
| LibraryApi | get_item_counts | GET /Items/Counts | Get item counts. |
| LibraryApi | get_library_options_info | GET /Libraries/AvailableOptions | Gets the library options info. |
| LibraryApi | get_media_folders | GET /Library/MediaFolders | Gets all user media folders. |
| LibraryApi | get_physical_paths | GET /Library/PhysicalPaths | Gets a list of physical paths from virtual folders. |
| LibraryApi | get_similar_albums | GET /Albums/{itemId}/Similar | Gets similar items. |
| LibraryApi | get_similar_artists | GET /Artists/{itemId}/Similar | Gets similar items. |
| LibraryApi | get_similar_items | GET /Items/{itemId}/Similar | Gets similar items. |
| LibraryApi | get_similar_movies | GET /Movies/{itemId}/Similar | Gets similar items. |
| LibraryApi | get_similar_shows | GET /Shows/{itemId}/Similar | Gets similar items. |
| LibraryApi | get_similar_trailers | GET /Trailers/{itemId}/Similar | Gets similar items. |
| LibraryApi | get_theme_media | GET /Items/{itemId}/ThemeMedia | Get theme songs and videos for an item. |
| LibraryApi | get_theme_songs | GET /Items/{itemId}/ThemeSongs | Get theme songs for an item. |
| LibraryApi | get_theme_videos | GET /Items/{itemId}/ThemeVideos | Get theme videos for an item. |
| LibraryApi | post_added_movies | POST /Library/Movies/Added | Reports that new movies have been added by an external source. |
| LibraryApi | post_added_series | POST /Library/Series/Added | Reports that new episodes of a series have been added by an external source. |
| LibraryApi | post_updated_media | POST /Library/Media/Updated | Reports that new movies have been added by an external source. |
| LibraryApi | post_updated_movies | POST /Library/Movies/Updated | Reports that new movies have been added by an external source. |
| LibraryApi | post_updated_series | POST /Library/Series/Updated | Reports that new episodes of a series have been added by an external source. |
| LibraryApi | refresh_library | POST /Library/Refresh | Starts a library scan. |
| LibraryStructureApi | add_media_path | POST /Library/VirtualFolders/Paths | Add a media path to a library. |
| LibraryStructureApi | add_virtual_folder | POST /Library/VirtualFolders | Adds a virtual folder. |
| LibraryStructureApi | get_virtual_folders | GET /Library/VirtualFolders | Gets all virtual folders. |
| LibraryStructureApi | remove_media_path | DELETE /Library/VirtualFolders/Paths | Remove a media path. |
| LibraryStructureApi | remove_virtual_folder | DELETE /Library/VirtualFolders | Removes a virtual folder. |
| LibraryStructureApi | rename_virtual_folder | POST /Library/VirtualFolders/Name | Renames a virtual folder. |
| LibraryStructureApi | update_library_options | POST /Library/VirtualFolders/LibraryOptions | Update library options. |
| LibraryStructureApi | update_media_path | POST /Library/VirtualFolders/Paths/Update | Updates a media path. |
| LiveTvApi | add_listing_provider | POST /LiveTv/ListingProviders | Adds a listings provider. |
| LiveTvApi | add_tuner_host | POST /LiveTv/TunerHosts | Adds a tuner host. |
| LiveTvApi | cancel_series_timer | DELETE /LiveTv/SeriesTimers/{timerId} | Cancels a live tv series timer. |
| LiveTvApi | cancel_timer | DELETE /LiveTv/Timers/{timerId} | Cancels a live tv timer. |
| LiveTvApi | create_series_timer | POST /LiveTv/SeriesTimers | Creates a live tv series timer. |
| LiveTvApi | create_timer | POST /LiveTv/Timers | Creates a live tv timer. |
| LiveTvApi | delete_listing_provider | DELETE /LiveTv/ListingProviders | Delete listing provider. |
| LiveTvApi | delete_recording | DELETE /LiveTv/Recordings/{recordingId} | Deletes a live tv recording. |
| LiveTvApi | delete_tuner_host | DELETE /LiveTv/TunerHosts | Deletes a tuner host. |
| LiveTvApi | discover_tuners | GET /LiveTv/Tuners/Discover | Discover tuners. |
| LiveTvApi | discvover_tuners | GET /LiveTv/Tuners/Discvover | Discover tuners. |
| LiveTvApi | get_channel | GET /LiveTv/Channels/{channelId} | Gets a live tv channel. |
| LiveTvApi | get_channel_mapping_options | GET /LiveTv/ChannelMappingOptions | Get channel mapping options. |
| LiveTvApi | get_default_listing_provider | GET /LiveTv/ListingProviders/Default | Gets default listings provider info. |
| LiveTvApi | get_default_timer | GET /LiveTv/Timers/Defaults | Gets the default values for a new timer. |
| LiveTvApi | get_guide_info | GET /LiveTv/GuideInfo | Get guide info. |
| LiveTvApi | get_lineups | GET /LiveTv/ListingProviders/Lineups | Gets available lineups. |
| LiveTvApi | get_live_recording_file | GET /LiveTv/LiveRecordings/{recordingId}/stream | Gets a live tv recording stream. |
| LiveTvApi | get_live_stream_file | GET /LiveTv/LiveStreamFiles/{streamId}/stream.{container} | Gets a live tv channel stream. |
| LiveTvApi | get_live_tv_channels | GET /LiveTv/Channels | Gets available live tv channels. |
| LiveTvApi | get_live_tv_info | GET /LiveTv/Info | Gets available live tv services. |
| LiveTvApi | get_live_tv_programs | GET /LiveTv/Programs | Gets available live tv epgs. |
| LiveTvApi | get_program | GET /LiveTv/Programs/{programId} | Gets a live tv program. |
| LiveTvApi | get_programs | POST /LiveTv/Programs | Gets available live tv epgs. |
| LiveTvApi | get_recommended_programs | GET /LiveTv/Programs/Recommended | Gets recommended live tv epgs. |
| LiveTvApi | get_recording | GET /LiveTv/Recordings/{recordingId} | Gets a live tv recording. |
| LiveTvApi | get_recording_folders | GET /LiveTv/Recordings/Folders | Gets recording folders. |
| LiveTvApi | get_recording_group | GET /LiveTv/Recordings/Groups/{groupId} | Get recording group. |
| LiveTvApi | get_recording_groups | GET /LiveTv/Recordings/Groups | Gets live tv recording groups. |
| LiveTvApi | get_recordings | GET /LiveTv/Recordings | Gets live tv recordings. |
| LiveTvApi | get_recordings_series | GET /LiveTv/Recordings/Series | Gets live tv recording series. |
| LiveTvApi | get_schedules_direct_countries | GET /LiveTv/ListingProviders/SchedulesDirect/Countries | Gets available countries. |
| LiveTvApi | get_series_timer | GET /LiveTv/SeriesTimers/{timerId} | Gets a live tv series timer. |
| LiveTvApi | get_series_timers | GET /LiveTv/SeriesTimers | Gets live tv series timers. |
| LiveTvApi | get_timer | GET /LiveTv/Timers/{timerId} | Gets a timer. |
| LiveTvApi | get_timers | GET /LiveTv/Timers | Gets the live tv timers. |
| LiveTvApi | get_tuner_host_types | GET /LiveTv/TunerHosts/Types | Get tuner host types. |
| LiveTvApi | reset_tuner | POST /LiveTv/Tuners/{tunerId}/Reset | Resets a tv tuner. |
| LiveTvApi | set_channel_mapping | POST /LiveTv/ChannelMappings | Set channel mappings. |
| LiveTvApi | update_series_timer | POST /LiveTv/SeriesTimers/{timerId} | Updates a live tv series timer. |
| LiveTvApi | update_timer | POST /LiveTv/Timers/{timerId} | Updates a live tv timer. |
| LocalizationApi | get_countries | GET /Localization/Countries | Gets known countries. |
| LocalizationApi | get_cultures | GET /Localization/Cultures | Gets known cultures. |
| LocalizationApi | get_localization_options | GET /Localization/Options | Gets localization options. |
| LocalizationApi | get_parental_ratings | GET /Localization/ParentalRatings | Gets known parental ratings. |
| LyricsApi | delete_lyrics | DELETE /Audio/{itemId}/Lyrics | Deletes an external lyric file. |
| LyricsApi | download_remote_lyrics | POST /Audio/{itemId}/RemoteSearch/Lyrics/{lyricId} | Downloads a remote lyric. |
| LyricsApi | get_lyrics | GET /Audio/{itemId}/Lyrics | Gets an item's lyrics. |
| LyricsApi | get_remote_lyrics | GET /Providers/Lyrics/{lyricId} | Gets the remote lyrics. |
| LyricsApi | search_remote_lyrics | GET /Audio/{itemId}/RemoteSearch/Lyrics | Search remote lyrics. |
| LyricsApi | upload_lyrics | POST /Audio/{itemId}/Lyrics | Upload an external lyric file. |
| MediaInfoApi | close_live_stream | POST /LiveStreams/Close | Closes a media source. |
| MediaInfoApi | get_bitrate_test_bytes | GET /Playback/BitrateTest | Tests the network with a request with the size of the bitrate. |
| MediaInfoApi | get_playback_info | GET /Items/{itemId}/PlaybackInfo | Gets live playback media info for an item. |
| MediaInfoApi | get_posted_playback_info | POST /Items/{itemId}/PlaybackInfo | Gets live playback media info for an item. |
| MediaInfoApi | open_live_stream | POST /LiveStreams/Open | Opens a media source. |
| MediaSegmentsApi | get_item_segments | GET /MediaSegments/{itemId} | Gets all media segments based on an itemId. |
| MoviesApi | get_movie_recommendations | GET /Movies/Recommendations | Gets movie recommendations. |
| MusicGenresApi | get_music_genre | GET /MusicGenres/{genreName} | Gets a music genre, by name. |
| MusicGenresApi | get_music_genres | GET /MusicGenres | Gets all music genres from a given item, folder, or the entire library. |
| PackageApi | cancel_package_installation | DELETE /Packages/Installing/{packageId} | Cancels a package installation. |
| PackageApi | get_package_info | GET /Packages/{name} | Gets a package by name or assembly GUID. |
| PackageApi | get_packages | GET /Packages | Gets available packages. |
| PackageApi | get_repositories | GET /Repositories | Gets all package repositories. |
| PackageApi | install_package | POST /Packages/Installed/{name} | Installs a package. |
| PackageApi | set_repositories | POST /Repositories | Sets the enabled and existing package repositories. |
| PersonsApi | get_person | GET /Persons/{name} | Get person by name. |
| PersonsApi | get_persons | GET /Persons | Gets all persons. |
| PlaylistsApi | add_item_to_playlist | POST /Playlists/{playlistId}/Items | Adds items to a playlist. |
| PlaylistsApi | create_playlist | POST /Playlists | Creates a new playlist. |
| PlaylistsApi | get_playlist | GET /Playlists/{playlistId} | Get a playlist. |
| PlaylistsApi | get_playlist_items | GET /Playlists/{playlistId}/Items | Gets the original items of a playlist. |
| PlaylistsApi | get_playlist_user | GET /Playlists/{playlistId}/Users/{userId} | Get a playlist user. |
| PlaylistsApi | get_playlist_users | GET /Playlists/{playlistId}/Users | Get a playlist's users. |
| PlaylistsApi | move_item | POST /Playlists/{playlistId}/Items/{itemId}/Move/{newIndex} | Moves a playlist item. |
| PlaylistsApi | remove_item_from_playlist | DELETE /Playlists/{playlistId}/Items | Removes items from a playlist. |
| PlaylistsApi | remove_user_from_playlist | DELETE /Playlists/{playlistId}/Users/{userId} | Remove a user from a playlist's users. |
| PlaylistsApi | update_playlist | POST /Playlists/{playlistId} | Updates a playlist. |
| PlaylistsApi | update_playlist_user | POST /Playlists/{playlistId}/Users/{userId} | Modify a user of a playlist's users. |
| PlaystateApi | mark_played_item | POST /UserPlayedItems/{itemId} | Marks an item as played for user. |
| PlaystateApi | mark_unplayed_item | DELETE /UserPlayedItems/{itemId} | Marks an item as unplayed for user. |
| PlaystateApi | on_playback_progress | POST /PlayingItems/{itemId}/Progress | Reports a session's playback progress. |
| PlaystateApi | on_playback_start | POST /PlayingItems/{itemId} | Reports that a session has begun playing an item. |
| PlaystateApi | on_playback_stopped | DELETE /PlayingItems/{itemId} | Reports that a session has stopped playing an item. |
| PlaystateApi | ping_playback_session | POST /Sessions/Playing/Ping | Pings a playback session. |
| PlaystateApi | report_playback_progress | POST /Sessions/Playing/Progress | Reports playback progress within a session. |
| PlaystateApi | report_playback_start | POST /Sessions/Playing | Reports playback has started within a session. |
| PlaystateApi | report_playback_stopped | POST /Sessions/Playing/Stopped | Reports playback has stopped within a session. |
| PluginsApi | disable_plugin | POST /Plugins/{pluginId}/{version}/Disable | Disable a plugin. |
| PluginsApi | enable_plugin | POST /Plugins/{pluginId}/{version}/Enable | Enables a disabled plugin. |
| PluginsApi | get_plugin_configuration | GET /Plugins/{pluginId}/Configuration | Gets plugin configuration. |
| PluginsApi | get_plugin_image | GET /Plugins/{pluginId}/{version}/Image | Gets a plugin's image. |
| PluginsApi | get_plugin_manifest | POST /Plugins/{pluginId}/Manifest | Gets a plugin's manifest. |
| PluginsApi | get_plugins | GET /Plugins | Gets a list of currently installed plugins. |
| PluginsApi | uninstall_plugin | DELETE /Plugins/{pluginId} | Uninstalls a plugin. |
| PluginsApi | uninstall_plugin_by_version | DELETE /Plugins/{pluginId}/{version} | Uninstalls a plugin by version. |
| PluginsApi | update_plugin_configuration | POST /Plugins/{pluginId}/Configuration | Updates plugin configuration. |
| QuickConnectApi | authorize_quick_connect | POST /QuickConnect/Authorize | Authorizes a pending quick connect request. |
| QuickConnectApi | get_quick_connect_enabled | GET /QuickConnect/Enabled | Gets the current quick connect state. |
| QuickConnectApi | get_quick_connect_state | GET /QuickConnect/Connect | Attempts to retrieve authentication information. |
| QuickConnectApi | initiate_quick_connect | POST /QuickConnect/Initiate | Initiate a new quick connect request. |
| RemoteImageApi | download_remote_image | POST /Items/{itemId}/RemoteImages/Download | Downloads a remote image for an item. |
| RemoteImageApi | get_remote_image_providers | GET /Items/{itemId}/RemoteImages/Providers | Gets available remote image providers for an item. |
| RemoteImageApi | get_remote_images | GET /Items/{itemId}/RemoteImages | Gets available remote images for an item. |
| ScheduledTasksApi | get_task | GET /ScheduledTasks/{taskId} | Get task by id. |
| ScheduledTasksApi | get_tasks | GET /ScheduledTasks | Get tasks. |
| ScheduledTasksApi | start_task | POST /ScheduledTasks/Running/{taskId} | Start specified task. |
| ScheduledTasksApi | stop_task | DELETE /ScheduledTasks/Running/{taskId} | Stop specified task. |
| ScheduledTasksApi | update_task | POST /ScheduledTasks/{taskId}/Triggers | Update specified task triggers. |
| SearchApi | get_search_hints | GET /Search/Hints | Gets the search hint result. |
| SessionApi | add_user_to_session | POST /Sessions/{sessionId}/User/{userId} | Adds an additional user to a session. |
| SessionApi | display_content | POST /Sessions/{sessionId}/Viewing | Instructs a session to browse to an item or view. |
| SessionApi | get_auth_providers | GET /Auth/Providers | Get all auth providers. |
| SessionApi | get_password_reset_providers | GET /Auth/PasswordResetProviders | Get all password reset providers. |
| SessionApi | get_sessions | GET /Sessions | Gets a list of sessions. |
| SessionApi | play | POST /Sessions/{sessionId}/Playing | Instructs a session to play an item. |
| SessionApi | post_capabilities | POST /Sessions/Capabilities | Updates capabilities for a device. |
| SessionApi | post_full_capabilities | POST /Sessions/Capabilities/Full | Updates capabilities for a device. |
| SessionApi | remove_user_from_session | DELETE /Sessions/{sessionId}/User/{userId} | Removes an additional user from a session. |
| SessionApi | report_session_ended | POST /Sessions/Logout | Reports that a session has ended. |
| SessionApi | report_viewing | POST /Sessions/Viewing | Reports that a session is viewing an item. |
| SessionApi | send_full_general_command | POST /Sessions/{sessionId}/Command | Issues a full general command to a client. |
| SessionApi | send_general_command | POST /Sessions/{sessionId}/Command/{command} | Issues a general command to a client. |
| SessionApi | send_message_command | POST /Sessions/{sessionId}/Message | Issues a command to a client to display a message to the user. |
| SessionApi | send_playstate_command | POST /Sessions/{sessionId}/Playing/{command} | Issues a playstate command to a client. |
| SessionApi | send_system_command | POST /Sessions/{sessionId}/System/{command} | Issues a system command to a client. |
| StartupApi | complete_wizard | POST /Startup/Complete | Completes the startup wizard. |
| StartupApi | get_first_user | GET /Startup/User | Gets the first user. |
| StartupApi | get_first_user2 | GET /Startup/FirstUser | Gets the first user. |
| StartupApi | get_startup_configuration | GET /Startup/Configuration | Gets the initial startup wizard configuration. |
| StartupApi | set_remote_access | POST /Startup/RemoteAccess | Sets remote access and UPnP. |
| StartupApi | update_initial_configuration | POST /Startup/Configuration | Sets the initial startup wizard configuration. |
| StartupApi | update_startup_user | POST /Startup/User | Sets the user name and password. |
| StudiosApi | get_studio | GET /Studios/{name} | Gets a studio by name. |
| StudiosApi | get_studios | GET /Studios | Gets all studios from a given item, folder, or the entire library. |
| SubtitleApi | delete_subtitle | DELETE /Videos/{itemId}/Subtitles/{index} | Deletes an external subtitle file. |
| SubtitleApi | download_remote_subtitles | POST /Items/{itemId}/RemoteSearch/Subtitles/{subtitleId} | Downloads a remote subtitle. |
| SubtitleApi | get_fallback_font | GET /FallbackFont/Fonts/{name} | Gets a fallback font file. |
| SubtitleApi | get_fallback_font_list | GET /FallbackFont/Fonts | Gets a list of available fallback font files. |
| SubtitleApi | get_remote_subtitles | GET /Providers/Subtitles/Subtitles/{subtitleId} | Gets the remote subtitles. |
| SubtitleApi | get_subtitle | GET /Videos/{routeItemId}/{routeMediaSourceId}/Subtitles/{routeIndex}/Stream.{routeFormat} | Gets subtitles in a specified format. |
| SubtitleApi | get_subtitle_playlist | GET /Videos/{itemId}/{mediaSourceId}/Subtitles/{index}/subtitles.m3u8 | Gets an HLS subtitle playlist. |
| SubtitleApi | get_subtitle_with_ticks | GET /Videos/{routeItemId}/{routeMediaSourceId}/Subtitles/{routeIndex}/{routeStartPositionTicks}/Stream.{routeFormat} | Gets subtitles in a specified format. |
| SubtitleApi | search_remote_subtitles | GET /Items/{itemId}/RemoteSearch/Subtitles/{language} | Search remote subtitles. |
| SubtitleApi | upload_subtitle | POST /Videos/{itemId}/Subtitles | Upload an external subtitle file. |
| SuggestionsApi | get_suggestions | GET /Items/Suggestions | Gets suggestions. |
| SyncPlayApi | sync_play_buffering | POST /SyncPlay/Buffering | Notify SyncPlay group that member is buffering. |
| SyncPlayApi | sync_play_create_group | POST /SyncPlay/New | Create a new SyncPlay group. |
| SyncPlayApi | sync_play_get_group | GET /SyncPlay/{id} | Gets a SyncPlay group by id. |
| SyncPlayApi | sync_play_get_groups | GET /SyncPlay/List | Gets all SyncPlay groups. |
| SyncPlayApi | sync_play_join_group | POST /SyncPlay/Join | Join an existing SyncPlay group. |
| SyncPlayApi | sync_play_leave_group | POST /SyncPlay/Leave | Leave the joined SyncPlay group. |
| SyncPlayApi | sync_play_move_playlist_item | POST /SyncPlay/MovePlaylistItem | Request to move an item in the playlist in SyncPlay group. |
| SyncPlayApi | sync_play_next_item | POST /SyncPlay/NextItem | Request next item in SyncPlay group. |
| SyncPlayApi | sync_play_pause | POST /SyncPlay/Pause | Request pause in SyncPlay group. |
| SyncPlayApi | sync_play_ping | POST /SyncPlay/Ping | Update session ping. |
| SyncPlayApi | sync_play_previous_item | POST /SyncPlay/PreviousItem | Request previous item in SyncPlay group. |
| SyncPlayApi | sync_play_queue | POST /SyncPlay/Queue | Request to queue items to the playlist of a SyncPlay group. |
| SyncPlayApi | sync_play_ready | POST /SyncPlay/Ready | Notify SyncPlay group that member is ready for playback. |
| SyncPlayApi | sync_play_remove_from_playlist | POST /SyncPlay/RemoveFromPlaylist | Request to remove items from the playlist in SyncPlay group. |
| SyncPlayApi | sync_play_seek | POST /SyncPlay/Seek | Request seek in SyncPlay group. |
| SyncPlayApi | sync_play_set_ignore_wait | POST /SyncPlay/SetIgnoreWait | Request SyncPlay group to ignore member during group-wait. |
| SyncPlayApi | sync_play_set_new_queue | POST /SyncPlay/SetNewQueue | Request to set new playlist in SyncPlay group. |
| SyncPlayApi | sync_play_set_playlist_item | POST /SyncPlay/SetPlaylistItem | Request to change playlist item in SyncPlay group. |
| SyncPlayApi | sync_play_set_repeat_mode | POST /SyncPlay/SetRepeatMode | Request to set repeat mode in SyncPlay group. |
| SyncPlayApi | sync_play_set_shuffle_mode | POST /SyncPlay/SetShuffleMode | Request to set shuffle mode in SyncPlay group. |
| SyncPlayApi | sync_play_stop | POST /SyncPlay/Stop | Request stop in SyncPlay group. |
| SyncPlayApi | sync_play_unpause | POST /SyncPlay/Unpause | Request unpause in SyncPlay group. |
| SystemApi | get_endpoint_info | GET /System/Endpoint | Gets information about the request endpoint. |
| SystemApi | get_log_file | GET /System/Logs/Log | Gets a log file. |
| SystemApi | get_ping_system | GET /System/Ping | Pings the system. |
| SystemApi | get_public_system_info | GET /System/Info/Public | Gets public information about the server. |
| SystemApi | get_server_logs | GET /System/Logs | Gets a list of available server log files. |
| SystemApi | get_system_info | GET /System/Info | Gets information about the server. |
| SystemApi | get_system_storage | GET /System/Info/Storage | Gets information about the server. |
| SystemApi | post_ping_system | POST /System/Ping | Pings the system. |
| SystemApi | restart_application | POST /System/Restart | Restarts the application. |
| SystemApi | shutdown_application | POST /System/Shutdown | Shuts down the application. |
| TimeSyncApi | get_utc_time | GET /GetUtcTime | Gets the current UTC time. |
| TmdbApi | tmdb_client_configuration | GET /Tmdb/ClientConfiguration | Gets the TMDb image configuration options. |
| TrailersApi | get_trailers | GET /Trailers | Finds movies and trailers similar to a given trailer. |
| TrickplayApi | get_trickplay_hls_playlist | GET /Videos/{itemId}/Trickplay/{width}/tiles.m3u8 | Gets an image tiles playlist for trickplay. |
| TrickplayApi | get_trickplay_tile_image | GET /Videos/{itemId}/Trickplay/{width}/{index}.jpg | Gets a trickplay tile image. |
| TvShowsApi | get_episodes | GET /Shows/{seriesId}/Episodes | Gets episodes for a tv season. |
| TvShowsApi | get_next_up | GET /Shows/NextUp | Gets a list of next up episodes. |
| TvShowsApi | get_seasons | GET /Shows/{seriesId}/Seasons | Gets seasons for a tv series. |
| TvShowsApi | get_upcoming_episodes | GET /Shows/Upcoming | Gets a list of upcoming episodes. |
| UniversalAudioApi | get_universal_audio_stream | GET /Audio/{itemId}/universal | Gets an audio stream. |
| UniversalAudioApi | head_universal_audio_stream | HEAD /Audio/{itemId}/universal | Gets an audio stream. |
| UserApi | authenticate_user_by_name | POST /Users/AuthenticateByName | Authenticates a user by name. |
| UserApi | authenticate_with_quick_connect | POST /Users/AuthenticateWithQuickConnect | Authenticates a user with quick connect. |
| UserApi | create_user_by_name | POST /Users/New | Creates a user. |
| UserApi | delete_user | DELETE /Users/{userId} | Deletes a user. |
| UserApi | forgot_password | POST /Users/ForgotPassword | Initiates the forgot password process for a local user. |
| UserApi | forgot_password_pin | POST /Users/ForgotPassword/Pin | Redeems a forgot password pin. |
| UserApi | get_current_user | GET /Users/Me | Gets the user based on auth token. |
| UserApi | get_public_users | GET /Users/Public | Gets a list of publicly visible users for display on a login screen. |
| UserApi | get_user_by_id | GET /Users/{userId} | Gets a user by Id. |
| UserApi | get_users | GET /Users | Gets a list of users. |
| UserApi | update_user | POST /Users | Updates a user. |
| UserApi | update_user_configuration | POST /Users/Configuration | Updates a user configuration. |
| UserApi | update_user_password | POST /Users/Password | Updates a user's password. |
| UserApi | update_user_policy | POST /Users/{userId}/Policy | Updates a user policy. |
| UserLibraryApi | delete_user_item_rating | DELETE /UserItems/{itemId}/Rating | Deletes a user's saved personal rating for an item. |
| UserLibraryApi | get_intros | GET /Items/{itemId}/Intros | Gets intros to play before the main media item plays. |
| UserLibraryApi | get_item | GET /Items/{itemId} | Gets an item from a user's library. |
| UserLibraryApi | get_latest_media | GET /Items/Latest | Gets latest media. |
| UserLibraryApi | get_local_trailers | GET /Items/{itemId}/LocalTrailers | Gets local trailers for an item. |
| UserLibraryApi | get_root_folder | GET /Items/Root | Gets the root folder from a user's library. |
| UserLibraryApi | get_special_features | GET /Items/{itemId}/SpecialFeatures | Gets special features for an item. |
| UserLibraryApi | mark_favorite_item | POST /UserFavoriteItems/{itemId} | Marks an item as a favorite. |
| UserLibraryApi | unmark_favorite_item | DELETE /UserFavoriteItems/{itemId} | Unmarks item as a favorite. |
| UserLibraryApi | update_user_item_rating | POST /UserItems/{itemId}/Rating | Updates a user's rating for an item. |
| UserViewsApi | get_grouping_options | GET /UserViews/GroupingOptions | Get user view grouping options. |
| UserViewsApi | get_user_views | GET /UserViews | Get user views. |
| VideoAttachmentsApi | get_attachment | GET /Videos/{videoId}/{mediaSourceId}/Attachments/{index} | Get video attachment. |
| VideosApi | delete_alternate_sources | DELETE /Videos/{itemId}/AlternateSources | Removes alternate video sources. |
| VideosApi | get_additional_part | GET /Videos/{itemId}/AdditionalParts | Gets additional parts for a video. |
| VideosApi | get_video_stream | GET /Videos/{itemId}/stream | Gets a video stream. |
| VideosApi | get_video_stream_by_container | GET /Videos/{itemId}/stream.{container} | Gets a video stream. |
| VideosApi | head_video_stream | HEAD /Videos/{itemId}/stream | Gets a video stream. |
| VideosApi | head_video_stream_by_container | HEAD /Videos/{itemId}/stream.{container} | Gets a video stream. |
| VideosApi | merge_versions | POST /Videos/MergeVersions | Merges videos into a single record. |
| YearsApi | get_year | GET /Years/{year} | Gets a year. |
| YearsApi | get_years | GET /Years | Get years. |
Documentation For Models
- AccessSchedule
- ActivityLogEntry
- ActivityLogEntryMessage
- ActivityLogEntryQueryResult
- ActivityLogEntryStartMessage
- ActivityLogEntryStopMessage
- AddVirtualFolderDto
- AlbumInfo
- AlbumInfoRemoteSearchQuery
- AllThemeMediaResult
- ArtistInfo
- ArtistInfoRemoteSearchQuery
- AudioSpatialFormat
- AuthenticateUserByName
- AuthenticationInfo
- AuthenticationInfoQueryResult
- AuthenticationResult
- BackupManifestDto
- BackupOptionsDto
- BackupRestoreRequestDto
- BaseItemDto
- BaseItemDtoImageBlurHashes
- BaseItemDtoQueryResult
- BaseItemKind
- BaseItemPerson
- BaseItemPersonImageBlurHashes
- BookInfo
- BookInfoRemoteSearchQuery
- BoxSetInfo
- BoxSetInfoRemoteSearchQuery
- BrandingOptionsDto
- BufferRequestDto
- CastReceiverApplication
- ChannelFeatures
- ChannelItemSortField
- ChannelMappingOptionsDto
- ChannelMediaContentType
- ChannelMediaType
- ChannelType
- ChapterInfo
- ClientCapabilitiesDto
- ClientLogDocumentResponseDto
- CodecProfile
- CodecType
- CollectionCreationResult
- CollectionType
- CollectionTypeOptions
- ConfigImageTypes
- ConfigurationPageInfo
- ContainerProfile
- CountryInfo
- CreatePlaylistDto
- CreateUserByName
- CultureDto
- CustomDatabaseOption
- CustomDatabaseOptions
- DatabaseConfigurationOptions
- DatabaseLockingBehaviorTypes
- DayOfWeek
- DayPattern
- DefaultDirectoryBrowserInfoDto
- DeinterlaceMethod
- DeviceInfoDto
- DeviceInfoDtoQueryResult
- DeviceOptionsDto
- DeviceProfile
- DirectPlayProfile
- DisplayPreferencesDto
- DlnaProfileType
- DownMixStereoAlgorithms
- DynamicDayOfWeek
- EmbeddedSubtitleOptions
- EncoderPreset
- EncodingContext
- EncodingOptions
- EndPointInfo
- ExternalIdInfo
- ExternalIdMediaType
- ExternalUrl
- ExtraType
- FileSystemEntryInfo
- FileSystemEntryType
- FolderStorageDto
- FontFile
- ForceKeepAliveMessage
- ForgotPasswordAction
- ForgotPasswordDto
- ForgotPasswordPinDto
- ForgotPasswordResult
- GeneralCommand
- GeneralCommandMessage
- GeneralCommandType
- GetProgramsDto
- GroupInfoDto
- GroupQueueMode
- GroupRepeatMode
- GroupShuffleMode
- GroupStateType
- GroupStateUpdate
- GroupUpdate
- GroupUpdateType
- GuideInfo
- HardwareAccelerationType
- IPlugin
- IgnoreWaitRequestDto
- ImageFormat
- ImageInfo
- ImageOption
- ImageOrientation
- ImageProviderInfo
- ImageResolution
- ImageSavingConvention
- ImageType
- InboundKeepAliveMessage
- InboundWebSocketMessage
- InstallationInfo
- IsoType
- ItemCounts
- ItemFields
- ItemFilter
- ItemSortBy
- JoinGroupRequestDto
- KeepUntil
- LibraryChangedMessage
- LibraryOptionInfoDto
- LibraryOptions
- LibraryOptionsResultDto
- LibraryStorageDto
- LibraryTypeOptionsDto
- LibraryUpdateInfo
- ListingsProviderInfo
- LiveStreamResponse
- LiveTvInfo
- LiveTvOptions
- LiveTvServiceInfo
- LiveTvServiceStatus
- LocalizationOption
- LocationType
- LogFile
- LogLevel
- LyricDto
- LyricLine
- LyricLineCue
- LyricMetadata
- MediaAttachment
- MediaPathDto
- MediaPathInfo
- MediaProtocol
- MediaSegmentDto
- MediaSegmentDtoQueryResult
- MediaSegmentType
- MediaSourceInfo
- MediaSourceType
- MediaStream
- MediaStreamProtocol
- MediaStreamType
- MediaType
- MediaUpdateInfoDto
- MediaUpdateInfoPathDto
- MediaUrl
- MessageCommand
- MetadataConfiguration
- MetadataEditorInfo
- MetadataField
- MetadataOptions
- MetadataRefreshMode
- MovePlaylistItemRequestDto
- MovieInfo
- MovieInfoRemoteSearchQuery
- MusicVideoInfo
- MusicVideoInfoRemoteSearchQuery
- NameGuidPair
- NameIdPair
- NameValuePair
- NetworkConfiguration
- NewGroupRequestDto
- NextItemRequestDto
- OpenLiveStreamDto
- OutboundKeepAliveMessage
- OutboundWebSocketMessage
- PackageInfo
- ParentalRating
- ParentalRatingScore
- PathSubstitution
- PersonKind
- PersonLookupInfo
- PersonLookupInfoRemoteSearchQuery
- PinRedeemResult
- PingRequestDto
- PlayAccess
- PlayCommand
- PlayMessage
- PlayMethod
- PlayQueueUpdate
- PlayQueueUpdateReason
- PlayRequest
- PlayRequestDto
- PlaybackErrorCode
- PlaybackInfoDto
- PlaybackInfoResponse
- PlaybackOrder
- PlaybackProgressInfo
- PlaybackRequestType
- PlaybackStartInfo
- PlaybackStopInfo
- PlayerStateInfo
- PlaylistCreationResult
- PlaylistDto
- PlaylistUserPermissions
- PlaystateCommand
- PlaystateMessage
- PlaystateRequest
- PluginInfo
- PluginInstallationCancelledMessage
- PluginInstallationCompletedMessage
- PluginInstallationFailedMessage
- PluginInstallingMessage
- PluginStatus
- PluginUninstalledMessage
- PreviousItemRequestDto
- ProblemDetails
- ProcessPriorityClass
- ProfileCondition
- ProfileConditionType
- ProfileConditionValue
- ProgramAudio
- PublicSystemInfo
- QueryFilters
- QueryFiltersLegacy
- QueueItem
- QueueRequestDto
- QuickConnectDto
- QuickConnectResult
- RatingType
- ReadyRequestDto
- RecommendationDto
- RecommendationType
- RecordingStatus
- RefreshProgressMessage
- RemoteImageInfo
- RemoteImageResult
- RemoteLyricInfoDto
- RemoteSearchResult
- RemoteSubtitleInfo
- RemoveFromPlaylistRequestDto
- RepeatMode
- RepositoryInfo
- RestartRequiredMessage
- ScheduledTaskEndedMessage
- ScheduledTasksInfoMessage
- ScheduledTasksInfoStartMessage
- ScheduledTasksInfoStopMessage
- ScrollDirection
- SearchHint
- SearchHintResult
- SeekRequestDto
- SendCommand
- SendCommandType
- SeriesInfo
- SeriesInfoRemoteSearchQuery
- SeriesStatus
- SeriesTimerCancelledMessage
- SeriesTimerCreatedMessage
- SeriesTimerInfoDto
- SeriesTimerInfoDtoQueryResult
- ServerConfiguration
- ServerDiscoveryInfo
- ServerRestartingMessage
- ServerShuttingDownMessage
- SessionInfoDto
- SessionMessageType
- SessionUserInfo
- SessionsMessage
- SessionsStartMessage
- SessionsStopMessage
- SetChannelMappingDto
- SetPlaylistItemRequestDto
- SetRepeatModeRequestDto
- SetShuffleModeRequestDto
- SongInfo
- SortOrder
- SpecialViewOptionDto
- StartupConfigurationDto
- StartupRemoteAccessDto
- StartupUserDto
- SubtitleDeliveryMethod
- SubtitleOptions
- SubtitlePlaybackMode
- SubtitleProfile
- SyncPlayCommandMessage
- SyncPlayGroupDoesNotExistUpdate
- SyncPlayGroupJoinedUpdate
- SyncPlayGroupLeftUpdate
- SyncPlayGroupUpdateMessage
- SyncPlayLibraryAccessDeniedUpdate
- SyncPlayNotInGroupUpdate
- SyncPlayPlayQueueUpdate
- SyncPlayQueueItem
- SyncPlayStateUpdate
- SyncPlayUserAccessType
- SyncPlayUserJoinedUpdate
- SyncPlayUserLeftUpdate
- SystemInfo
- SystemStorageDto
- TaskCompletionStatus
- TaskInfo
- TaskResult
- TaskState
- TaskTriggerInfo
- TaskTriggerInfoType
- ThemeMediaResult
- TimerCancelledMessage
- TimerCreatedMessage
- TimerEventInfo
- TimerInfoDto
- TimerInfoDtoQueryResult
- TonemappingAlgorithm
- TonemappingMode
- TonemappingRange
- TrailerInfo
- TrailerInfoRemoteSearchQuery
- TranscodeReason
- TranscodeSeekInfo
- TranscodingInfo
- TranscodingProfile
- TransportStreamTimestamp
- TrickplayInfo
- TrickplayOptions
- TrickplayScanBehavior
- TunerChannelMapping
- TunerHostInfo
- TypeOptions
- UnratedItem
- UpdateLibraryOptionsDto
- UpdateMediaPathRequestDto
- UpdatePlaylistDto
- UpdatePlaylistUserDto
- UpdateUserItemDataDto
- UpdateUserPassword
- UploadSubtitleDto
- UserConfiguration
- UserDataChangeInfo
- UserDataChangedMessage
- UserDeletedMessage
- UserDto
- UserItemDataDto
- UserPolicy
- UserUpdatedMessage
- UtcTimeResponse
- ValidatePathDto
- VersionInfo
- Video3DFormat
- VideoRange
- VideoRangeType
- VideoType
- VirtualFolderInfo
- WebSocketMessage
- XbmcMetadataOptions
Documentation For Authorization
Authentication schemes defined for the API:
CustomAuthentication
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file jellfyin_openapi_client-1.0.0.tar.gz.
File metadata
- Download URL: jellfyin_openapi_client-1.0.0.tar.gz
- Upload date:
- Size: 546.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ecec59b9e63762e720b83ee3343e27682e375e86d4459abc403588902cdf7a9e
|
|
| MD5 |
4330edd7dd3e97f2ac0e3610d30a5697
|
|
| BLAKE2b-256 |
d54d8848cd97a99b0f5bfc3f9c7c574b835cec0f4cf8c9fa6c7f22c01a96c4f7
|
Provenance
The following attestation bundles were made for jellfyin_openapi_client-1.0.0.tar.gz:
Publisher:
publish.yml on Thundernerd/jellyfin-openapi-client
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
jellfyin_openapi_client-1.0.0.tar.gz -
Subject digest:
ecec59b9e63762e720b83ee3343e27682e375e86d4459abc403588902cdf7a9e - Sigstore transparency entry: 245668925
- Sigstore integration time:
-
Permalink:
Thundernerd/jellyfin-openapi-client@1a41a109d838eb63e69ac987e2978e0b47b3ff3b -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/Thundernerd
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@1a41a109d838eb63e69ac987e2978e0b47b3ff3b -
Trigger Event:
release
-
Statement type:
File details
Details for the file jellfyin_openapi_client-1.0.0-py3-none-any.whl.
File metadata
- Download URL: jellfyin_openapi_client-1.0.0-py3-none-any.whl
- Upload date:
- Size: 877.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d8685d4fd2cb26452e87d15417ce13ae3c991935e8225e459450c7cb686fb02b
|
|
| MD5 |
79b2da63309e121d4498850c8f6223f9
|
|
| BLAKE2b-256 |
781039cc2e92ad4f25a912e34cfea6f5bd207627bff57586310092e413dd2857
|
Provenance
The following attestation bundles were made for jellfyin_openapi_client-1.0.0-py3-none-any.whl:
Publisher:
publish.yml on Thundernerd/jellyfin-openapi-client
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
jellfyin_openapi_client-1.0.0-py3-none-any.whl -
Subject digest:
d8685d4fd2cb26452e87d15417ce13ae3c991935e8225e459450c7cb686fb02b - Sigstore transparency entry: 245668926
- Sigstore integration time:
-
Permalink:
Thundernerd/jellyfin-openapi-client@1a41a109d838eb63e69ac987e2978e0b47b3ff3b -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/Thundernerd
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@1a41a109d838eb63e69ac987e2978e0b47b3ff3b -
Trigger Event:
release
-
Statement type: