Skip to content

Latest commit

 

History

History
855 lines (811 loc) · 76.4 KB

README.md

File metadata and controls

855 lines (811 loc) · 76.4 KB
Raw

Go API client for api

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

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 10.10.1
  • Package version: 1.0.0
  • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import api "github.com/sj14/jellyfin-go/api"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value api.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), api.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value api.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), api.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using api.ContextOperationServerIndices and api.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), api.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), api.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

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 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.
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 /UserImage 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 /UserImage 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 /UserImage Get user profile image.
ImageAPI PostUserImage Post /UserImage 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.
InstantMixAPI GetInstantMixFromAlbum Get /Albums/{itemId}/InstantMix Creates an instant playlist based on a given album.
InstantMixAPI GetInstantMixFromArtists Get /Artists/{itemId}/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/{itemId}/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/{itemId}/InstantMix Creates an instant playlist based on a given playlist.
InstantMixAPI GetInstantMixFromSong Get /Songs/{itemId}/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 GetItemUserData Get /UserItems/{itemId}/UserData Get Item User Data.
ItemsAPI GetItems Get /Items Gets items based on a query.
ItemsAPI GetResumeItems Get /UserItems/Resume Gets items based on a query.
ItemsAPI UpdateItemUserData Post /UserItems/{itemId}/UserData Update Item User Data.
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.
LyricsAPI DeleteLyrics Delete /Audio/{itemId}/Lyrics Deletes an external lyric file.
LyricsAPI DownloadRemoteLyrics Post /Audio/{itemId}/RemoteSearch/Lyrics/{lyricId} Downloads a remote lyric.
LyricsAPI GetLyrics Get /Audio/{itemId}/Lyrics Gets an item's lyrics.
LyricsAPI GetRemoteLyrics Get /Providers/Lyrics/{lyricId} Gets the remote lyrics.
LyricsAPI SearchRemoteLyrics Get /Audio/{itemId}/RemoteSearch/Lyrics Search remote lyrics.
LyricsAPI UploadLyrics Post /Audio/{itemId}/Lyrics Upload an external lyric file.
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.
MediaSegmentsAPI GetItemSegments Get /MediaSegments/{itemId} Gets all media segments based on an itemId.
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.
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 AddItemToPlaylist Post /Playlists/{playlistId}/Items Adds items to a playlist.
PlaylistsAPI CreatePlaylist Post /Playlists Creates a new playlist.
PlaylistsAPI GetPlaylist Get /Playlists/{playlistId} Get a playlist.
PlaylistsAPI GetPlaylistItems Get /Playlists/{playlistId}/Items Gets the original items of a playlist.
PlaylistsAPI GetPlaylistUser Get /Playlists/{playlistId}/Users/{userId} Get a playlist user.
PlaylistsAPI GetPlaylistUsers Get /Playlists/{playlistId}/Users Get a playlist's users.
PlaylistsAPI MoveItem Post /Playlists/{playlistId}/Items/{itemId}/Move/{newIndex} Moves a playlist item.
PlaylistsAPI RemoveItemFromPlaylist Delete /Playlists/{playlistId}/Items Removes items from a playlist.
PlaylistsAPI RemoveUserFromPlaylist Delete /Playlists/{playlistId}/Users/{userId} Remove a user from a playlist's users.
PlaylistsAPI UpdatePlaylist Post /Playlists/{playlistId} Updates a playlist.
PlaylistsAPI UpdatePlaylistUser Post /Playlists/{playlistId}/Users/{userId} Modify a user of a playlist's users.
PlaystateAPI MarkPlayedItem Post /UserPlayedItems/{itemId} Marks an item as played for user.
PlaystateAPI MarkUnplayedItem Delete /UserPlayedItems/{itemId} Marks an item as unplayed for user.
PlaystateAPI OnPlaybackProgress Post /PlayingItems/{itemId}/Progress Reports a session's playback progress.
PlaystateAPI OnPlaybackStart Post /PlayingItems/{itemId} Reports that a session has begun playing an item.
PlaystateAPI OnPlaybackStopped Delete /PlayingItems/{itemId} Reports that a session 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 AuthorizeQuickConnect Post /QuickConnect/Authorize Authorizes a pending quick connect request.
QuickConnectAPI GetQuickConnectEnabled Get /QuickConnect/Enabled Gets the current quick connect state.
QuickConnectAPI GetQuickConnectState Get /QuickConnect/Connect Attempts to retrieve authentication information.
QuickConnectAPI InitiateQuickConnect Post /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 GetSearchHints 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/{subtitleId} 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 /Items/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.
TrickplayAPI GetTrickplayHlsPlaylist Get /Videos/{itemId}/Trickplay/{width}/tiles.m3u8 Gets an image tiles playlist for trickplay.
TrickplayAPI GetTrickplayTileImage Get /Videos/{itemId}/Trickplay/{width}/{index}.jpg Gets a trickplay tile image.
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 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 Updates a user.
UserAPI UpdateUserConfiguration Post /Users/Configuration Updates a user configuration.
UserAPI UpdateUserPassword Post /Users/Password Updates a user's password.
UserAPI UpdateUserPolicy Post /Users/{userId}/Policy Updates a user policy.
UserLibraryAPI DeleteUserItemRating Delete /UserItems/{itemId}/Rating Deletes a user's saved personal rating for an item.
UserLibraryAPI GetIntros Get /Items/{itemId}/Intros Gets intros to play before the main media item plays.
UserLibraryAPI GetItem Get /Items/{itemId} Gets an item from a user's library.
UserLibraryAPI GetLatestMedia Get /Items/Latest Gets latest media.
UserLibraryAPI GetLocalTrailers Get /Items/{itemId}/LocalTrailers Gets local trailers for an item.
UserLibraryAPI GetRootFolder Get /Items/Root Gets the root folder from a user's library.
UserLibraryAPI GetSpecialFeatures Get /Items/{itemId}/SpecialFeatures Gets special features for an item.
UserLibraryAPI MarkFavoriteItem Post /UserFavoriteItems/{itemId} Marks an item as a favorite.
UserLibraryAPI UnmarkFavoriteItem Delete /UserFavoriteItems/{itemId} Unmarks item as a favorite.
UserLibraryAPI UpdateUserItemRating Post /UserItems/{itemId}/Rating Updates a user's rating for an item.
UserViewsAPI GetGroupingOptions Get /UserViews/GroupingOptions Get user view grouping options.
UserViewsAPI GetUserViews Get /UserViews 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

Note, each API key must be added to a map of map[string]APIKey where the key is: CustomAuthentication and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		api.ContextAPIKeys,
		map[string]api.APIKey{
			"CustomAuthentication": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author