From a9e03e3edb3fb9a1b11ced64f1ebc80cd58c977c Mon Sep 17 00:00:00 2001 From: Bill Thornton Date: Thu, 15 Sep 2022 11:08:18 -0400 Subject: [PATCH 1/2] Remove markdown docs --- docs/.nojekyll | 1 - docs/README.md | 126 - .../generated_client.ActivityLogApi.md | 114 - docs/classes/generated_client.ApiKeyApi.md | 169 - docs/classes/generated_client.ArtistsApi.md | 170 - docs/classes/generated_client.AudioApi.md | 198 - docs/classes/generated_client.BrandingApi.md | 167 - docs/classes/generated_client.ChannelsApi.md | 225 - docs/classes/generated_client.ClientLogApi.md | 114 - .../classes/generated_client.CollectionApi.md | 170 - .../classes/generated_client.Configuration.md | 178 - .../generated_client.ConfigurationApi.md | 252 - docs/classes/generated_client.DashboardApi.md | 142 - docs/classes/generated_client.DevicesApi.md | 226 - .../generated_client.DisplayPreferencesApi.md | 142 - docs/classes/generated_client.DlnaApi.md | 252 - .../classes/generated_client.DlnaServerApi.md | 534 -- .../classes/generated_client.DynamicHlsApi.md | 338 - .../generated_client.EnvironmentApi.md | 253 - docs/classes/generated_client.FilterApi.md | 142 - docs/classes/generated_client.GenresApi.md | 142 - .../classes/generated_client.HlsSegmentApi.md | 226 - docs/classes/generated_client.ImageApi.md | 1233 --- .../generated_client.ImageByNameApi.md | 251 - .../classes/generated_client.InstantMixApi.md | 312 - .../classes/generated_client.ItemLookupApi.md | 394 - .../generated_client.ItemRefreshApi.md | 114 - .../classes/generated_client.ItemUpdateApi.md | 170 - docs/classes/generated_client.ItemsApi.md | 170 - docs/classes/generated_client.LibraryApi.md | 786 -- .../generated_client.LibraryStructureApi.md | 309 - docs/classes/generated_client.LiveTvApi.md | 1235 --- .../generated_client.LocalizationApi.md | 194 - docs/classes/generated_client.MediaInfoApi.md | 228 - docs/classes/generated_client.MoviesApi.md | 114 - .../generated_client.MusicGenresApi.md | 144 - .../generated_client.NotificationsApi.md | 280 - docs/classes/generated_client.PackageApi.md | 252 - docs/classes/generated_client.PersonsApi.md | 142 - docs/classes/generated_client.PlaylistsApi.md | 228 - docs/classes/generated_client.PlaystateApi.md | 338 - docs/classes/generated_client.PluginsApi.md | 341 - .../generated_client.QuickConnectApi.md | 196 - .../generated_client.RemoteImageApi.md | 170 - .../generated_client.ScheduledTasksApi.md | 226 - docs/classes/generated_client.SearchApi.md | 114 - docs/classes/generated_client.SessionApi.md | 531 -- docs/classes/generated_client.StartupApi.md | 278 - docs/classes/generated_client.StudiosApi.md | 142 - docs/classes/generated_client.SubtitleApi.md | 365 - .../generated_client.SuggestionsApi.md | 114 - docs/classes/generated_client.SyncPlayApi.md | 669 -- docs/classes/generated_client.SystemApi.md | 359 - docs/classes/generated_client.TimeSyncApi.md | 113 - docs/classes/generated_client.TmdbApi.md | 113 - docs/classes/generated_client.TrailersApi.md | 114 - docs/classes/generated_client.TvShowsApi.md | 198 - .../generated_client.UniversalAudioApi.md | 142 - docs/classes/generated_client.UserApi.md | 532 -- .../generated_client.UserLibraryApi.md | 366 - docs/classes/generated_client.UserViewsApi.md | 142 - .../generated_client.VideoAttachmentsApi.md | 114 - docs/classes/generated_client.VideosApi.md | 282 - docs/classes/generated_client.YearsApi.md | 142 - docs/classes/index.Api.md | 195 - docs/classes/index.Jellyfin.md | 95 - docs/classes/index.ProductNameIssue.md | 55 - docs/classes/index.RecommendedServerIssue.md | 35 - docs/classes/index.SlowResponseIssue.md | 55 - docs/classes/index.SystemInfoIssue.md | 56 - docs/classes/index.VersionMissingIssue.md | 29 - docs/classes/index.VersionOutdatedIssue.md | 54 - docs/classes/index.VersionUnsupportedIssue.md | 54 - .../index.discovery.DiscoveryService.md | 162 - ...ex.discovery.RecommendedServerDiscovery.md | 97 - docs/enums/generated_client.Architecture.md | 78 - docs/enums/generated_client.BaseItemKind.md | 421 - .../generated_client.ChannelItemSortField.md | 89 - ...enerated_client.ChannelMediaContentType.md | 100 - .../generated_client.ChannelMediaType.md | 45 - docs/enums/generated_client.ChannelType.md | 36 - docs/enums/generated_client.CodecType.md | 45 - .../generated_client.CollectionTypeOptions.md | 100 - docs/enums/generated_client.DayOfWeek.md | 89 - docs/enums/generated_client.DayPattern.md | 45 - .../generated_client.DeviceProfileType.md | 34 - .../enums/generated_client.DlnaProfileType.md | 56 - .../generated_client.DynamicDayOfWeek.md | 124 - ...enerated_client.EmbeddedSubtitleOptions.md | 58 - .../enums/generated_client.EncodingContext.md | 34 - .../generated_client.ExternalIdMediaType.md | 146 - docs/enums/generated_client.FFmpegLocation.md | 58 - .../generated_client.FileSystemEntryType.md | 58 - .../generated_client.ForgotPasswordAction.md | 45 - .../generated_client.GeneralCommandType.md | 476 -- docs/enums/generated_client.GroupQueueMode.md | 36 - .../enums/generated_client.GroupRepeatMode.md | 47 - .../generated_client.GroupShuffleMode.md | 36 - docs/enums/generated_client.GroupStateType.md | 58 - .../enums/generated_client.GroupUpdateType.md | 135 - .../generated_client.HardwareEncodingType.md | 80 - .../enums/generated_client.HeaderMatchType.md | 45 - docs/enums/generated_client.ImageFormat.md | 69 - .../generated_client.ImageOrientation.md | 100 - .../generated_client.ImageSavingConvention.md | 34 - docs/enums/generated_client.ImageType.md | 157 - docs/enums/generated_client.IsoType.md | 36 - docs/enums/generated_client.ItemFields.md | 685 -- docs/enums/generated_client.ItemFilter.md | 113 - docs/enums/generated_client.KeepUntil.md | 56 - .../generated_client.LiveTvServiceStatus.md | 34 - docs/enums/generated_client.LocationType.md | 58 - docs/enums/generated_client.LogLevel.md | 89 - docs/enums/generated_client.MediaProtocol.md | 89 - .../enums/generated_client.MediaSourceType.md | 45 - .../enums/generated_client.MediaStreamType.md | 58 - docs/enums/generated_client.MetadataField.md | 113 - .../generated_client.MetadataRefreshMode.md | 56 - .../generated_client.NotificationLevel.md | 45 - docs/enums/generated_client.PlayAccess.md | 34 - docs/enums/generated_client.PlayCommand.md | 69 - docs/enums/generated_client.PlayMethod.md | 45 - .../generated_client.PlaybackErrorCode.md | 45 - .../generated_client.PlaystateCommand.md | 113 - docs/enums/generated_client.PluginStatus.md | 91 - .../generated_client.ProfileConditionType.md | 67 - .../generated_client.ProfileConditionValue.md | 276 - docs/enums/generated_client.ProgramAudio.md | 78 - docs/enums/generated_client.RatingType.md | 34 - .../generated_client.RecommendationType.md | 78 - .../enums/generated_client.RecordingStatus.md | 89 - docs/enums/generated_client.RepeatMode.md | 45 - .../enums/generated_client.ScrollDirection.md | 36 - .../enums/generated_client.SendCommandType.md | 58 - docs/enums/generated_client.SendToUserType.md | 45 - docs/enums/generated_client.SeriesStatus.md | 36 - .../generated_client.SessionMessageType.md | 388 - docs/enums/generated_client.SortOrder.md | 36 - ...generated_client.SubtitleDeliveryMethod.md | 69 - .../generated_client.SubtitlePlaybackMode.md | 69 - ...generated_client.SyncPlayUserAccessType.md | 47 - .../generated_client.TaskCompletionStatus.md | 58 - docs/enums/generated_client.TaskState.md | 47 - .../generated_client.TranscodeSeekInfo.md | 34 - ...ent.TranscodingInfoTranscodeReasonsEnum.md | 287 - ...nerated_client.TransportStreamTimestamp.md | 45 - docs/enums/generated_client.UnratedItem.md | 113 - docs/enums/generated_client.Video3DFormat.md | 67 - docs/enums/generated_client.VideoType.md | 58 - .../enums/index.RecommendedServerInfoScore.md | 56 - .../generated_client.AccessSchedule.md | 89 - ...ient.ActivityLogApiGetLogEntriesRequest.md | 76 - .../generated_client.ActivityLogEntry.md | 166 - ...ated_client.ActivityLogEntryQueryResult.md | 59 - .../generated_client.AddVirtualFolderDto.md | 29 - .../generated_client.AdminNotificationDto.md | 74 - docs/interfaces/generated_client.AlbumInfo.md | 218 - ...rated_client.AlbumInfoRemoteSearchQuery.md | 70 - .../generated_client.AllThemeMediaResult.md | 53 - ...erated_client.ApiKeyApiCreateKeyRequest.md | 31 - ...erated_client.ApiKeyApiRevokeKeyRequest.md | 31 - .../interfaces/generated_client.ArtistInfo.md | 184 - ...ated_client.ArtistInfoRemoteSearchQuery.md | 70 - ...client.ArtistsApiGetAlbumArtistsRequest.md | 496 -- ...client.ArtistsApiGetArtistByNameRequest.md | 46 - ...ated_client.ArtistsApiGetArtistsRequest.md | 496 -- ...udioApiGetAudioStreamByContainerRequest.md | 755 -- ...ed_client.AudioApiGetAudioStreamRequest.md | 755 -- ...dioApiHeadAudioStreamByContainerRequest.md | 755 -- ...d_client.AudioApiHeadAudioStreamRequest.md | 755 -- ...generated_client.AuthenticateUserByName.md | 63 - .../generated_client.AuthenticationInfo.md | 190 - ...ed_client.AuthenticationInfoQueryResult.md | 59 - .../generated_client.AuthenticationResult.md | 66 - docs/interfaces/generated_client.BaseItem.md | 161 - .../generated_client.BaseItemDto.md | 2189 ----- ...rated_client.BaseItemDtoImageBlurHashes.md | 237 - ...generated_client.BaseItemDtoQueryResult.md | 59 - .../generated_client.BaseItemPerson.md | 104 - ...ed_client.BaseItemPersonImageBlurHashes.md | 237 - docs/interfaces/generated_client.BookInfo.md | 184 - ...erated_client.BookInfoRemoteSearchQuery.md | 70 - .../interfaces/generated_client.BoxSetInfo.md | 171 - ...ated_client.BoxSetInfoRemoteSearchQuery.md | 70 - .../generated_client.BrandingOptions.md | 61 - .../generated_client.BufferRequestDto.md | 76 - .../generated_client.ChannelFeatures.md | 194 - ...nerated_client.ChannelMappingOptionsDto.md | 76 - ...nt.ChannelsApiGetChannelFeaturesRequest.md | 31 - ...lient.ChannelsApiGetChannelItemsRequest.md | 151 - ...ed_client.ChannelsApiGetChannelsRequest.md | 106 - ...ChannelsApiGetLatestChannelItemsRequest.md | 106 - .../generated_client.ChapterInfo.md | 87 - .../generated_client.ClientCapabilities.md | 144 - .../generated_client.ClientCapabilitiesDto.md | 164 - ...rated_client.ClientLogApiLogFileRequest.md | 29 - ...ted_client.ClientLogDocumentResponseDto.md | 31 - .../generated_client.CodecProfile.md | 79 - ...ent.CollectionApiAddToCollectionRequest.md | 46 - ...nt.CollectionApiCreateCollectionRequest.md | 76 - ...ollectionApiRemoveFromCollectionRequest.md | 46 - ...nerated_client.CollectionCreationResult.md | 27 - .../generated_client.ConfigImageTypes.md | 105 - ...gurationApiGetNamedConfigurationRequest.md | 31 - ...figurationApiUpdateConfigurationRequest.md | 31 - ...urationApiUpdateMediaEncoderPathRequest.md | 31 - ...ationApiUpdateNamedConfigurationRequest.md | 46 - .../generated_client.ConfigurationPageInfo.md | 106 - ...enerated_client.ConfigurationParameters.md | 100 - .../generated_client.ContainerProfile.md | 53 - .../generated_client.ControlResponse.md | 57 - .../generated_client.CountryInfo.md | 76 - .../generated_client.CreatePlaylistDto.md | 76 - .../generated_client.CreateUserByName.md | 46 - .../interfaces/generated_client.CultureDto.md | 89 - ...ashboardApiGetConfigurationPagesRequest.md | 31 - ...ApiGetDashboardConfigurationPageRequest.md | 31 - ...d_client.DefaultDirectoryBrowserInfoDto.md | 31 - .../generated_client.DeviceIdentification.md | 149 - .../interfaces/generated_client.DeviceInfo.md | 158 - .../generated_client.DeviceInfoQueryResult.md | 59 - .../generated_client.DeviceOptions.md | 61 - .../generated_client.DeviceOptionsDto.md | 61 - .../generated_client.DeviceProfile.md | 599 -- .../generated_client.DeviceProfileInfo.md | 57 - ...ed_client.DevicesApiDeleteDeviceRequest.md | 31 - ...d_client.DevicesApiGetDeviceInfoRequest.md | 31 - ...lient.DevicesApiGetDeviceOptionsRequest.md | 31 - ...ated_client.DevicesApiGetDevicesRequest.md | 46 - ...nt.DevicesApiUpdateDeviceOptionsRequest.md | 46 - .../generated_client.DirectPlayProfile.md | 66 - ...ferencesApiGetDisplayPreferencesRequest.md | 61 - ...encesApiUpdateDisplayPreferencesRequest.md | 76 - .../generated_client.DisplayPreferencesDto.md | 226 - ...ated_client.DlnaApiCreateProfileRequest.md | 31 - ...ated_client.DlnaApiDeleteProfileRequest.md | 31 - ...nerated_client.DlnaApiGetProfileRequest.md | 31 - ...ated_client.DlnaApiUpdateProfileRequest.md | 46 - .../generated_client.DlnaOptions.md | 181 - ...naServerApiGetConnectionManager2Request.md | 31 - ...naServerApiGetConnectionManager3Request.md | 31 - ...lnaServerApiGetConnectionManagerRequest.md | 31 - ...lnaServerApiGetContentDirectory2Request.md | 31 - ...lnaServerApiGetContentDirectory3Request.md | 31 - ...DlnaServerApiGetContentDirectoryRequest.md | 31 - ....DlnaServerApiGetDescriptionXml2Request.md | 31 - ...t.DlnaServerApiGetDescriptionXmlRequest.md | 31 - ...ed_client.DlnaServerApiGetIconIdRequest.md | 46 - ...ated_client.DlnaServerApiGetIconRequest.md | 31 - ...verApiGetMediaReceiverRegistrar2Request.md | 31 - ...verApiGetMediaReceiverRegistrar3Request.md | 31 - ...rverApiGetMediaReceiverRegistrarRequest.md | 31 - ...sConnectionManagerControlRequestRequest.md | 31 - ...ssContentDirectoryControlRequestRequest.md | 31 - ...aReceiverRegistrarControlRequestRequest.md | 31 - ....DynamicHlsApiGetHlsAudioSegmentRequest.md | 830 -- ....DynamicHlsApiGetHlsVideoSegmentRequest.md | 845 -- ...nt.DynamicHlsApiGetLiveHlsStreamRequest.md | 800 -- ...cHlsApiGetMasterHlsAudioPlaylistRequest.md | 770 -- ...cHlsApiGetMasterHlsVideoPlaylistRequest.md | 785 -- ...HlsApiGetVariantHlsAudioPlaylistRequest.md | 755 -- ...HlsApiGetVariantHlsVideoPlaylistRequest.md | 770 -- ...HlsApiHeadMasterHlsAudioPlaylistRequest.md | 770 -- ...HlsApiHeadMasterHlsVideoPlaylistRequest.md | 785 -- .../generated_client.EncodingOptions.md | 512 -- .../generated_client.EndPointInfo.md | 40 - ...vironmentApiGetDirectoryContentsRequest.md | 61 - ...ient.EnvironmentApiGetParentPathRequest.md | 31 - ...lient.EnvironmentApiValidatePathRequest.md | 31 - .../generated_client.ExternalIdInfo.md | 74 - .../generated_client.ExternalUrl.md | 44 - .../generated_client.FileSystemEntryInfo.md | 59 - ...t.FilterApiGetQueryFiltersLegacyRequest.md | 76 - ..._client.FilterApiGetQueryFiltersRequest.md | 166 - docs/interfaces/generated_client.FontFile.md | 76 - .../generated_client.ForgotPasswordDto.md | 31 - .../generated_client.ForgotPasswordPinDto.md | 31 - .../generated_client.ForgotPasswordResult.md | 57 - .../generated_client.GeneralCommand.md | 57 - ...nerated_client.GenresApiGetGenreRequest.md | 46 - ...erated_client.GenresApiGetGenresRequest.md | 286 - .../generated_client.GetProgramsDto.md | 421 - .../generated_client.GroupInfoDto.md | 89 - docs/interfaces/generated_client.GuideInfo.md | 44 - ...ntApiGetHlsAudioSegmentLegacyAacRequest.md | 46 - ...ntApiGetHlsAudioSegmentLegacyMp3Request.md | 46 - ...lsSegmentApiGetHlsPlaylistLegacyRequest.md | 46 - ...gmentApiGetHlsVideoSegmentLegacyRequest.md | 76 - ...HlsSegmentApiStopEncodingProcessRequest.md | 46 - .../generated_client.HttpHeaderInfo.md | 53 - docs/interfaces/generated_client.IPlugin.md | 121 - .../generated_client.IgnoreWaitRequestDto.md | 31 - ...t.ImageApiDeleteItemImageByIndexRequest.md | 61 - ...d_client.ImageApiDeleteItemImageRequest.md | 61 - ...t.ImageApiDeleteUserImageByIndexRequest.md | 61 - ...d_client.ImageApiDeleteUserImageRequest.md | 61 - ...ed_client.ImageApiGetArtistImageRequest.md | 301 - ...ent.ImageApiGetGenreImageByIndexRequest.md | 301 - ...ted_client.ImageApiGetGenreImageRequest.md | 301 - ...ted_client.ImageApiGetItemImage2Request.md | 301 - ...ient.ImageApiGetItemImageByIndexRequest.md | 301 - ...client.ImageApiGetItemImageInfosRequest.md | 31 - ...ated_client.ImageApiGetItemImageRequest.md | 301 - ...mageApiGetMusicGenreImageByIndexRequest.md | 301 - ...lient.ImageApiGetMusicGenreImageRequest.md | 301 - ...nt.ImageApiGetPersonImageByIndexRequest.md | 301 - ...ed_client.ImageApiGetPersonImageRequest.md | 301 - ...d_client.ImageApiGetSplashscreenRequest.md | 196 - ...nt.ImageApiGetStudioImageByIndexRequest.md | 301 - ...ed_client.ImageApiGetStudioImageRequest.md | 301 - ...ient.ImageApiGetUserImageByIndexRequest.md | 301 - ...ated_client.ImageApiGetUserImageRequest.md | 301 - ...d_client.ImageApiHeadArtistImageRequest.md | 301 - ...nt.ImageApiHeadGenreImageByIndexRequest.md | 301 - ...ed_client.ImageApiHeadGenreImageRequest.md | 301 - ...ed_client.ImageApiHeadItemImage2Request.md | 301 - ...ent.ImageApiHeadItemImageByIndexRequest.md | 301 - ...ted_client.ImageApiHeadItemImageRequest.md | 301 - ...ageApiHeadMusicGenreImageByIndexRequest.md | 301 - ...ient.ImageApiHeadMusicGenreImageRequest.md | 301 - ...t.ImageApiHeadPersonImageByIndexRequest.md | 301 - ...d_client.ImageApiHeadPersonImageRequest.md | 301 - ...t.ImageApiHeadStudioImageByIndexRequest.md | 301 - ...d_client.ImageApiHeadStudioImageRequest.md | 301 - ...ent.ImageApiHeadUserImageByIndexRequest.md | 301 - ...ted_client.ImageApiHeadUserImageRequest.md | 301 - ...ent.ImageApiPostUserImageByIndexRequest.md | 74 - ...ted_client.ImageApiPostUserImageRequest.md | 74 - ...ient.ImageApiSetItemImageByIndexRequest.md | 74 - ...ated_client.ImageApiSetItemImageRequest.md | 59 - ...ent.ImageApiUpdateItemImageIndexRequest.md | 76 - ...ImageApiUploadCustomSplashscreenRequest.md | 29 - ...nt.ImageByNameApiGetGeneralImageRequest.md | 46 - ....ImageByNameApiGetMediaInfoImageRequest.md | 46 - ...ent.ImageByNameApiGetRatingImageRequest.md | 46 - .../generated_client.ImageByNameInfo.md | 89 - docs/interfaces/generated_client.ImageInfo.md | 134 - .../generated_client.ImageOption.md | 57 - .../generated_client.ImageProviderInfo.md | 46 - .../generated_client.InstallationInfo.md | 119 - ...tantMixApiGetInstantMixFromAlbumRequest.md | 136 - ...tMixApiGetInstantMixFromArtists2Request.md | 136 - ...ntMixApiGetInstantMixFromArtistsRequest.md | 136 - ...stantMixApiGetInstantMixFromItemRequest.md | 136 - ...iGetInstantMixFromMusicGenreByIdRequest.md | 136 - ...etInstantMixFromMusicGenreByNameRequest.md | 136 - ...tMixApiGetInstantMixFromPlaylistRequest.md | 136 - ...stantMixApiGetInstantMixFromSongRequest.md | 136 - .../interfaces/generated_client.ItemCounts.md | 196 - ...ItemLookupApiApplySearchCriteriaRequest.md | 61 - ...kupApiGetBookRemoteSearchResultsRequest.md | 31 - ...pApiGetBoxSetRemoteSearchResultsRequest.md | 31 - ....ItemLookupApiGetExternalIdInfosRequest.md | 31 - ...upApiGetMovieRemoteSearchResultsRequest.md | 31 - ...GetMusicAlbumRemoteSearchResultsRequest.md | 31 - ...etMusicArtistRemoteSearchResultsRequest.md | 31 - ...GetMusicVideoRemoteSearchResultsRequest.md | 31 - ...pApiGetPersonRemoteSearchResultsRequest.md | 31 - ...pApiGetSeriesRemoteSearchResultsRequest.md | 31 - ...ApiGetTrailerRemoteSearchResultsRequest.md | 31 - ...client.ItemRefreshApiRefreshItemRequest.md | 91 - ...emUpdateApiGetMetadataEditorInfoRequest.md | 31 - ...emUpdateApiUpdateItemContentTypeRequest.md | 46 - ...d_client.ItemUpdateApiUpdateItemRequest.md | 46 - ..._client.ItemsApiGetItemsByUserIdRequest.md | 1291 --- ...enerated_client.ItemsApiGetItemsRequest.md | 1291 --- ...ed_client.ItemsApiGetResumeItemsRequest.md | 241 - .../generated_client.JoinGroupRequestDto.md | 31 - ...ated_client.LibraryApiDeleteItemRequest.md | 31 - ...ted_client.LibraryApiDeleteItemsRequest.md | 31 - ...ed_client.LibraryApiGetAncestorsRequest.md | 46 - ...lient.LibraryApiGetCriticReviewsRequest.md | 29 - ...ted_client.LibraryApiGetDownloadRequest.md | 31 - ...nerated_client.LibraryApiGetFileRequest.md | 31 - ...d_client.LibraryApiGetItemCountsRequest.md | 46 - ....LibraryApiGetLibraryOptionsInfoRequest.md | 46 - ...client.LibraryApiGetMediaFoldersRequest.md | 31 - ...lient.LibraryApiGetSimilarAlbumsRequest.md | 91 - ...ient.LibraryApiGetSimilarArtistsRequest.md | 91 - ...client.LibraryApiGetSimilarItemsRequest.md | 91 - ...lient.LibraryApiGetSimilarMoviesRequest.md | 91 - ...client.LibraryApiGetSimilarShowsRequest.md | 91 - ...ent.LibraryApiGetSimilarTrailersRequest.md | 91 - ...d_client.LibraryApiGetThemeMediaRequest.md | 61 - ...d_client.LibraryApiGetThemeSongsRequest.md | 61 - ..._client.LibraryApiGetThemeVideosRequest.md | 61 - ...client.LibraryApiPostAddedMoviesRequest.md | 46 - ...client.LibraryApiPostAddedSeriesRequest.md | 31 - ...lient.LibraryApiPostUpdatedMediaRequest.md | 31 - ...ient.LibraryApiPostUpdatedMoviesRequest.md | 46 - ...ient.LibraryApiPostUpdatedSeriesRequest.md | 31 - .../generated_client.LibraryOptionInfoDto.md | 46 - .../generated_client.LibraryOptions.md | 371 - ...enerated_client.LibraryOptionsResultDto.md | 76 - ....LibraryStructureApiAddMediaPathRequest.md | 46 - ...raryStructureApiAddVirtualFolderRequest.md | 91 - ...braryStructureApiRemoveMediaPathRequest.md | 61 - ...yStructureApiRemoveVirtualFolderRequest.md | 46 - ...yStructureApiRenameVirtualFolderRequest.md | 61 - ...StructureApiUpdateLibraryOptionsRequest.md | 31 - ...braryStructureApiUpdateMediaPathRequest.md | 31 - .../generated_client.LibraryTypeOptionsDto.md | 91 - .../generated_client.LibraryUpdateInfo.md | 117 - .../generated_client.ListingsProviderInfo.md | 248 - .../generated_client.LiveStreamResponse.md | 27 - ...ient.LiveTvApiAddListingProviderRequest.md | 76 - ...ted_client.LiveTvApiAddTunerHostRequest.md | 31 - ...lient.LiveTvApiCancelSeriesTimerRequest.md | 31 - ...ated_client.LiveTvApiCancelTimerRequest.md | 31 - ...lient.LiveTvApiCreateSeriesTimerRequest.md | 31 - ...ated_client.LiveTvApiCreateTimerRequest.md | 31 - ...t.LiveTvApiDeleteListingProviderRequest.md | 31 - ..._client.LiveTvApiDeleteRecordingRequest.md | 31 - ..._client.LiveTvApiDeleteTunerHostRequest.md | 31 - ...d_client.LiveTvApiDiscoverTunersRequest.md | 31 - ..._client.LiveTvApiDiscvoverTunersRequest.md | 31 - ...iveTvApiGetChannelMappingOptionsRequest.md | 31 - ...rated_client.LiveTvApiGetChannelRequest.md | 46 - ..._client.LiveTvApiGetDefaultTimerRequest.md | 31 - ...rated_client.LiveTvApiGetLineupsRequest.md | 76 - ...nt.LiveTvApiGetLiveRecordingFileRequest.md | 31 - ...lient.LiveTvApiGetLiveStreamFileRequest.md | 46 - ...lient.LiveTvApiGetLiveTvChannelsRequest.md | 331 - ...lient.LiveTvApiGetLiveTvProgramsRequest.md | 421 - ...rated_client.LiveTvApiGetProgramRequest.md | 46 - ...ated_client.LiveTvApiGetProgramsRequest.md | 31 - ....LiveTvApiGetRecommendedProgramsRequest.md | 256 - ...ent.LiveTvApiGetRecordingFoldersRequest.md | 31 - ...lient.LiveTvApiGetRecordingGroupRequest.md | 31 - ...ient.LiveTvApiGetRecordingGroupsRequest.md | 31 - ...ted_client.LiveTvApiGetRecordingRequest.md | 46 - ...ed_client.LiveTvApiGetRecordingsRequest.md | 301 - ...ent.LiveTvApiGetRecordingsSeriesRequest.md | 226 - ...d_client.LiveTvApiGetSeriesTimerRequest.md | 31 - ..._client.LiveTvApiGetSeriesTimersRequest.md | 46 - ...nerated_client.LiveTvApiGetTimerRequest.md | 31 - ...erated_client.LiveTvApiGetTimersRequest.md | 76 - ...rated_client.LiveTvApiResetTunerRequest.md | 31 - ...lient.LiveTvApiSetChannelMappingRequest.md | 31 - ...lient.LiveTvApiUpdateSeriesTimerRequest.md | 46 - ...ated_client.LiveTvApiUpdateTimerRequest.md | 46 - .../interfaces/generated_client.LiveTvInfo.md | 59 - .../generated_client.LiveTvOptions.md | 183 - .../generated_client.LiveTvServiceInfo.md | 132 - .../generated_client.LocalizationOption.md | 40 - docs/interfaces/generated_client.LogFile.md | 74 - .../generated_client.MediaAttachment.md | 121 - .../generated_client.MediaEncoderPathDto.md | 46 - ...ient.MediaInfoApiCloseLiveStreamRequest.md | 31 - ....MediaInfoApiGetBitrateTestBytesRequest.md | 31 - ...ient.MediaInfoApiGetPlaybackInfoRequest.md | 46 - ...ediaInfoApiGetPostedPlaybackInfoRequest.md | 256 - ...lient.MediaInfoApiOpenLiveStreamRequest.md | 196 - .../generated_client.MediaPathDto.md | 59 - .../generated_client.MediaPathInfo.md | 40 - .../generated_client.MediaSourceInfo.md | 562 -- .../generated_client.MediaStream.md | 866 -- .../generated_client.MediaUpdateInfoDto.md | 31 - ...generated_client.MediaUpdateInfoPathDto.md | 46 - docs/interfaces/generated_client.MediaUrl.md | 40 - .../generated_client.MessageCommand.md | 53 - .../generated_client.MetadataConfiguration.md | 27 - .../generated_client.MetadataEditorInfo.md | 92 - .../generated_client.MetadataOptions.md | 107 - ...rated_client.MovePlaylistItemRequestDto.md | 46 - docs/interfaces/generated_client.MovieInfo.md | 171 - ...rated_client.MovieInfoRemoteSearchQuery.md | 70 - ...MoviesApiGetMovieRecommendationsRequest.md | 91 - ...ient.MusicGenresApiGetMusicGenreRequest.md | 46 - ...ent.MusicGenresApiGetMusicGenresRequest.md | 286 - .../generated_client.MusicVideoInfo.md | 184 - ..._client.MusicVideoInfoRemoteSearchQuery.md | 70 - .../generated_client.NameGuidPair.md | 40 - .../interfaces/generated_client.NameIdPair.md | 44 - .../generated_client.NameValuePair.md | 44 - .../generated_client.NetworkConfiguration.md | 526 -- .../generated_client.NewGroupRequestDto.md | 31 - .../generated_client.NextItemRequestDto.md | 31 - .../generated_client.NotificationDto.md | 134 - .../generated_client.NotificationOption.md | 100 - .../generated_client.NotificationOptions.md | 27 - .../generated_client.NotificationResultDto.md | 46 - .../generated_client.NotificationTypeInfo.md | 79 - ...ationsApiCreateAdminNotificationRequest.md | 31 - ...NotificationsApiGetNotificationsRequest.md | 29 - ...ationsApiGetNotificationsSummaryRequest.md | 29 - ...d_client.NotificationsApiSetReadRequest.md | 29 - ...client.NotificationsApiSetUnreadRequest.md | 29 - ...enerated_client.NotificationsSummaryDto.md | 44 - .../generated_client.ObjectGroupUpdate.md | 59 - .../generated_client.OpenLiveStreamDto.md | 209 - ...kageApiCancelPackageInstallationRequest.md | 31 - ..._client.PackageApiGetPackageInfoRequest.md | 46 - ..._client.PackageApiInstallPackageRequest.md | 76 - ...client.PackageApiSetRepositoriesRequest.md | 31 - .../generated_client.PackageInfo.md | 136 - .../generated_client.ParentalRating.md | 46 - .../generated_client.PathSubstitution.md | 46 - .../generated_client.PersonLookupInfo.md | 171 - ...lient.PersonLookupInfoRemoteSearchQuery.md | 70 - ...rated_client.PersonsApiGetPersonRequest.md | 46 - ...ated_client.PersonsApiGetPersonsRequest.md | 211 - .../generated_client.PinRedeemResult.md | 44 - .../generated_client.PingRequestDto.md | 31 - .../generated_client.PlayRequest.md | 126 - .../generated_client.PlayRequestDto.md | 61 - .../generated_client.PlaybackInfoDto.md | 239 - .../generated_client.PlaybackInfoResponse.md | 59 - .../generated_client.PlaybackProgressInfo.md | 300 - .../generated_client.PlaybackStartInfo.md | 300 - .../generated_client.PlaybackStopInfo.md | 173 - .../generated_client.PlayerStateInfo.md | 175 - ...generated_client.PlaylistCreationResult.md | 27 - ...client.PlaylistsApiAddToPlaylistRequest.md | 61 - ...lient.PlaylistsApiCreatePlaylistRequest.md | 91 - ...ent.PlaylistsApiGetPlaylistItemsRequest.md | 151 - ...ated_client.PlaylistsApiMoveItemRequest.md | 61 - ...t.PlaylistsApiRemoveFromPlaylistRequest.md | 46 - ...lient.PlaystateApiMarkPlayedItemRequest.md | 61 - ...ent.PlaystateApiMarkUnplayedItemRequest.md | 46 - ...t.PlaystateApiOnPlaybackProgressRequest.md | 211 - ...ient.PlaystateApiOnPlaybackStartRequest.md | 151 - ...nt.PlaystateApiOnPlaybackStoppedRequest.md | 121 - ....PlaystateApiPingPlaybackSessionRequest.md | 31 - ...aystateApiReportPlaybackProgressRequest.md | 31 - ....PlaystateApiReportPlaybackStartRequest.md | 31 - ...laystateApiReportPlaybackStoppedRequest.md | 31 - .../generated_client.PlaystateRequest.md | 55 - .../interfaces/generated_client.PluginInfo.md | 134 - ...d_client.PluginsApiDisablePluginRequest.md | 46 - ...ed_client.PluginsApiEnablePluginRequest.md | 46 - ...PluginsApiGetPluginConfigurationRequest.md | 31 - ..._client.PluginsApiGetPluginImageRequest.md | 46 - ...ient.PluginsApiGetPluginManifestRequest.md | 31 - ...uginsApiUninstallPluginByVersionRequest.md | 46 - ...client.PluginsApiUninstallPluginRequest.md | 31 - ...ginsApiUpdatePluginConfigurationRequest.md | 31 - ...generated_client.PreviousItemRequestDto.md | 31 - .../generated_client.ProblemDetails.md | 83 - .../generated_client.ProfileCondition.md | 66 - .../generated_client.PublicSystemInfo.md | 119 - .../generated_client.QueryFilters.md | 40 - .../generated_client.QueryFiltersLegacy.md | 66 - docs/interfaces/generated_client.QueueItem.md | 40 - .../generated_client.QueueRequestDto.md | 44 - ..._client.QuickConnectApiAuthorizeRequest.md | 31 - ...ed_client.QuickConnectApiConnectRequest.md | 31 - .../generated_client.QuickConnectDto.md | 31 - .../generated_client.QuickConnectResult.md | 136 - .../generated_client.ReadyRequestDto.md | 76 - .../generated_client.RecommendationDto.md | 66 - ...emoteImageApiDownloadRemoteImageRequest.md | 61 - ...eImageApiGetRemoteImageProvidersRequest.md | 31 - ...nt.RemoteImageApiGetRemoteImagesRequest.md | 106 - .../generated_client.RemoteImageInfo.md | 162 - .../generated_client.RemoteImageResult.md | 61 - .../generated_client.RemoteSearchResult.md | 176 - .../generated_client.RemoteSubtitleInfo.md | 157 - ...ted_client.RemoveFromPlaylistRequestDto.md | 61 - .../generated_client.RepositoryInfo.md | 61 - .../generated_client.ResponseProfile.md | 105 - ..._client.ScheduledTasksApiGetTaskRequest.md | 31 - ...client.ScheduledTasksApiGetTasksRequest.md | 46 - ...lient.ScheduledTasksApiStartTaskRequest.md | 31 - ...client.ScheduledTasksApiStopTaskRequest.md | 31 - ...ient.ScheduledTasksApiUpdateTaskRequest.md | 46 - .../generated_client.SearchApiGetRequest.md | 286 - .../interfaces/generated_client.SearchHint.md | 439 - .../generated_client.SearchHintResult.md | 46 - .../generated_client.SeekRequestDto.md | 31 - .../generated_client.SendCommand.md | 104 - .../interfaces/generated_client.SeriesInfo.md | 171 - ...ated_client.SeriesInfoRemoteSearchQuery.md | 70 - .../generated_client.SeriesTimerInfoDto.md | 529 -- ...ed_client.SeriesTimerInfoDtoQueryResult.md | 59 - .../generated_client.ServerConfiguration.md | 698 -- .../generated_client.ServerDiscoveryInfo.md | 76 - ...lient.SessionApiAddUserToSessionRequest.md | 46 - ..._client.SessionApiDisplayContentRequest.md | 76 - ...ted_client.SessionApiGetSessionsRequest.md | 61 - .../generated_client.SessionApiPlayRequest.md | 136 - ...lient.SessionApiPostCapabilitiesRequest.md | 106 - ...t.SessionApiPostFullCapabilitiesRequest.md | 46 - ....SessionApiRemoveUserFromSessionRequest.md | 46 - ...d_client.SessionApiReportViewingRequest.md | 46 - ...SessionApiSendFullGeneralCommandRequest.md | 46 - ...ent.SessionApiSendGeneralCommandRequest.md | 46 - ...ent.SessionApiSendMessageCommandRequest.md | 46 - ...t.SessionApiSendPlaystateCommandRequest.md | 76 - ...ient.SessionApiSendSystemCommandRequest.md | 46 - .../generated_client.SessionInfo.md | 421 - .../generated_client.SessionUserInfo.md | 46 - .../generated_client.SetChannelMappingDto.md | 61 - ...erated_client.SetPlaylistItemRequestDto.md | 31 - ...enerated_client.SetRepeatModeRequestDto.md | 29 - ...nerated_client.SetShuffleModeRequestDto.md | 29 - docs/interfaces/generated_client.SongInfo.md | 210 - .../generated_client.SpecialViewOptionDto.md | 46 - ...client.StartupApiSetRemoteAccessRequest.md | 31 - ...tupApiUpdateInitialConfigurationRequest.md | 31 - ...ient.StartupApiUpdateStartupUserRequest.md | 31 - ...enerated_client.StartupConfigurationDto.md | 61 - ...generated_client.StartupRemoteAccessDto.md | 46 - .../generated_client.StartupUserDto.md | 46 - ...rated_client.StudiosApiGetStudioRequest.md | 46 - ...ated_client.StudiosApiGetStudiosRequest.md | 271 - ...client.SubtitleApiDeleteSubtitleRequest.md | 46 - ...btitleApiDownloadRemoteSubtitlesRequest.md | 46 - ...lient.SubtitleApiGetFallbackFontRequest.md | 31 - ...nt.SubtitleApiGetRemoteSubtitlesRequest.md | 31 - ...t.SubtitleApiGetSubtitlePlaylistRequest.md | 76 - ...ed_client.SubtitleApiGetSubtitleRequest.md | 196 - ....SubtitleApiGetSubtitleWithTicksRequest.md | 211 - ...SubtitleApiSearchRemoteSubtitlesRequest.md | 61 - ...client.SubtitleApiUploadSubtitleRequest.md | 46 - .../generated_client.SubtitleOptions.md | 131 - .../generated_client.SubtitleProfile.md | 79 - ...ent.SuggestionsApiGetSuggestionsRequest.md | 106 - ...ent.SyncPlayApiSyncPlayBufferingRequest.md | 31 - ...t.SyncPlayApiSyncPlayCreateGroupRequest.md | 31 - ...ent.SyncPlayApiSyncPlayJoinGroupRequest.md | 31 - ...cPlayApiSyncPlayMovePlaylistItemRequest.md | 31 - ...ient.SyncPlayApiSyncPlayNextItemRequest.md | 31 - ...d_client.SyncPlayApiSyncPlayPingRequest.md | 31 - ....SyncPlayApiSyncPlayPreviousItemRequest.md | 31 - ..._client.SyncPlayApiSyncPlayQueueRequest.md | 31 - ..._client.SyncPlayApiSyncPlayReadyRequest.md | 31 - ...layApiSyncPlayRemoveFromPlaylistRequest.md | 31 - ...d_client.SyncPlayApiSyncPlaySeekRequest.md | 31 - ...SyncPlayApiSyncPlaySetIgnoreWaitRequest.md | 31 - ...t.SyncPlayApiSyncPlaySetNewQueueRequest.md | 31 - ...ncPlayApiSyncPlaySetPlaylistItemRequest.md | 31 - ...SyncPlayApiSyncPlaySetRepeatModeRequest.md | 31 - ...yncPlayApiSyncPlaySetShuffleModeRequest.md | 31 - ...rated_client.SystemApiGetLogFileRequest.md | 31 - .../interfaces/generated_client.SystemInfo.md | 400 - docs/interfaces/generated_client.TaskInfo.md | 162 - .../interfaces/generated_client.TaskResult.md | 134 - .../generated_client.TaskTriggerInfo.md | 89 - .../generated_client.ThemeMediaResult.md | 76 - .../generated_client.TimerEventInfo.md | 40 - .../generated_client.TimerInfoDto.md | 424 - ...enerated_client.TimerInfoDtoQueryResult.md | 59 - .../generated_client.TrailerInfo.md | 171 - ...ted_client.TrailerInfoRemoteSearchQuery.md | 70 - ...ed_client.TrailersApiGetTrailersRequest.md | 1276 --- .../generated_client.TranscodingInfo.md | 183 - .../generated_client.TranscodingProfile.md | 222 - .../generated_client.TunerChannelMapping.md | 66 - .../generated_client.TunerHostInfo.md | 157 - ...ted_client.TvShowsApiGetEpisodesRequest.md | 241 - ...rated_client.TvShowsApiGetNextUpRequest.md | 226 - ...ated_client.TvShowsApiGetSeasonsRequest.md | 166 - ...nt.TvShowsApiGetUpcomingEpisodesRequest.md | 151 - .../generated_client.TypeOptions.md | 92 - ...lAudioApiGetUniversalAudioStreamRequest.md | 286 - ...AudioApiHeadUniversalAudioStreamRequest.md | 286 - ...enerated_client.UpdateLibraryOptionsDto.md | 44 - ...erated_client.UpdateMediaPathRequestDto.md | 44 - ...generated_client.UpdateUserEasyPassword.md | 61 - .../generated_client.UpdateUserPassword.md | 76 - .../generated_client.UploadSubtitleDto.md | 76 - ...nt.UserApiAuthenticateUserByNameRequest.md | 31 - ...d_client.UserApiAuthenticateUserRequest.md | 61 - ...rApiAuthenticateWithQuickConnectRequest.md | 31 - ...d_client.UserApiCreateUserByNameRequest.md | 31 - ...nerated_client.UserApiDeleteUserRequest.md | 31 - ..._client.UserApiForgotPasswordPinRequest.md | 31 - ...ted_client.UserApiForgotPasswordRequest.md | 31 - ...erated_client.UserApiGetUserByIdRequest.md | 31 - ...generated_client.UserApiGetUsersRequest.md | 46 - ...t.UserApiUpdateUserConfigurationRequest.md | 46 - ...nt.UserApiUpdateUserEasyPasswordRequest.md | 46 - ...client.UserApiUpdateUserPasswordRequest.md | 46 - ...d_client.UserApiUpdateUserPolicyRequest.md | 46 - ...nerated_client.UserApiUpdateUserRequest.md | 46 - .../generated_client.UserConfiguration.md | 217 - docs/interfaces/generated_client.UserDto.md | 222 - .../generated_client.UserItemDataDto.md | 181 - ...erLibraryApiDeleteUserItemRatingRequest.md | 46 - ...d_client.UserLibraryApiGetIntrosRequest.md | 46 - ...ted_client.UserLibraryApiGetItemRequest.md | 46 - ...ent.UserLibraryApiGetLatestMediaRequest.md | 181 - ...t.UserLibraryApiGetLocalTrailersRequest.md | 46 - ...ient.UserLibraryApiGetRootFolderRequest.md | 31 - ...UserLibraryApiGetSpecialFeaturesRequest.md | 46 - ...t.UserLibraryApiMarkFavoriteItemRequest.md | 46 - ...UserLibraryApiUnmarkFavoriteItemRequest.md | 46 - ...erLibraryApiUpdateUserItemRatingRequest.md | 61 - .../interfaces/generated_client.UserPolicy.md | 531 -- ...t.UserViewsApiGetGroupingOptionsRequest.md | 31 - ..._client.UserViewsApiGetUserViewsRequest.md | 76 - .../generated_client.UtcTimeResponse.md | 46 - .../generated_client.ValidatePathDto.md | 61 - .../generated_client.VersionInfo.md | 151 - ...VideoAttachmentsApiGetAttachmentRequest.md | 61 - ....VideosApiDeleteAlternateSourcesRequest.md | 31 - ...lient.VideosApiGetAdditionalPartRequest.md | 46 - ...deosApiGetVideoStreamByContainerRequest.md | 785 -- ...d_client.VideosApiGetVideoStreamRequest.md | 785 -- ...eosApiHeadVideoStreamByContainerRequest.md | 785 -- ..._client.VideosApiHeadVideoStreamRequest.md | 785 -- ...ed_client.VideosApiMergeVersionsRequest.md | 31 - .../generated_client.VirtualFolderInfo.md | 128 - .../generated_client.WakeOnLanInfo.md | 46 - .../generated_client.XbmcMetadataOptions.md | 79 - .../generated_client.XmlAttribute.md | 46 - ...generated_client.YearsApiGetYearRequest.md | 46 - ...enerated_client.YearsApiGetYearsRequest.md | 241 - docs/interfaces/index.ClientInfo.md | 34 - docs/interfaces/index.DeviceInfo.md | 34 - docs/interfaces/index.JellyfinParameters.md | 34 - .../interfaces/index.RecommendedServerInfo.md | 67 - ...dex.utils.DeviceProfileGeneratorOptions.md | 29 - docs/modules.md | 10 - docs/modules/generated_client.md | 7182 ----------------- docs/modules/index.discovery.md | 16 - docs/modules/index.md | 75 - docs/modules/index.utils.md | 249 - package-lock.json | 59 - package.json | 1 - 721 files changed, 106427 deletions(-) delete mode 100644 docs/.nojekyll delete mode 100644 docs/README.md delete mode 100644 docs/classes/generated_client.ActivityLogApi.md delete mode 100644 docs/classes/generated_client.ApiKeyApi.md delete mode 100644 docs/classes/generated_client.ArtistsApi.md delete mode 100644 docs/classes/generated_client.AudioApi.md delete mode 100644 docs/classes/generated_client.BrandingApi.md delete mode 100644 docs/classes/generated_client.ChannelsApi.md delete mode 100644 docs/classes/generated_client.ClientLogApi.md delete mode 100644 docs/classes/generated_client.CollectionApi.md delete mode 100644 docs/classes/generated_client.Configuration.md delete mode 100644 docs/classes/generated_client.ConfigurationApi.md delete mode 100644 docs/classes/generated_client.DashboardApi.md delete mode 100644 docs/classes/generated_client.DevicesApi.md delete mode 100644 docs/classes/generated_client.DisplayPreferencesApi.md delete mode 100644 docs/classes/generated_client.DlnaApi.md delete mode 100644 docs/classes/generated_client.DlnaServerApi.md delete mode 100644 docs/classes/generated_client.DynamicHlsApi.md delete mode 100644 docs/classes/generated_client.EnvironmentApi.md delete mode 100644 docs/classes/generated_client.FilterApi.md delete mode 100644 docs/classes/generated_client.GenresApi.md delete mode 100644 docs/classes/generated_client.HlsSegmentApi.md delete mode 100644 docs/classes/generated_client.ImageApi.md delete mode 100644 docs/classes/generated_client.ImageByNameApi.md delete mode 100644 docs/classes/generated_client.InstantMixApi.md delete mode 100644 docs/classes/generated_client.ItemLookupApi.md delete mode 100644 docs/classes/generated_client.ItemRefreshApi.md delete mode 100644 docs/classes/generated_client.ItemUpdateApi.md delete mode 100644 docs/classes/generated_client.ItemsApi.md delete mode 100644 docs/classes/generated_client.LibraryApi.md delete mode 100644 docs/classes/generated_client.LibraryStructureApi.md delete mode 100644 docs/classes/generated_client.LiveTvApi.md delete mode 100644 docs/classes/generated_client.LocalizationApi.md delete mode 100644 docs/classes/generated_client.MediaInfoApi.md delete mode 100644 docs/classes/generated_client.MoviesApi.md delete mode 100644 docs/classes/generated_client.MusicGenresApi.md delete mode 100644 docs/classes/generated_client.NotificationsApi.md delete mode 100644 docs/classes/generated_client.PackageApi.md delete mode 100644 docs/classes/generated_client.PersonsApi.md delete mode 100644 docs/classes/generated_client.PlaylistsApi.md delete mode 100644 docs/classes/generated_client.PlaystateApi.md delete mode 100644 docs/classes/generated_client.PluginsApi.md delete mode 100644 docs/classes/generated_client.QuickConnectApi.md delete mode 100644 docs/classes/generated_client.RemoteImageApi.md delete mode 100644 docs/classes/generated_client.ScheduledTasksApi.md delete mode 100644 docs/classes/generated_client.SearchApi.md delete mode 100644 docs/classes/generated_client.SessionApi.md delete mode 100644 docs/classes/generated_client.StartupApi.md delete mode 100644 docs/classes/generated_client.StudiosApi.md delete mode 100644 docs/classes/generated_client.SubtitleApi.md delete mode 100644 docs/classes/generated_client.SuggestionsApi.md delete mode 100644 docs/classes/generated_client.SyncPlayApi.md delete mode 100644 docs/classes/generated_client.SystemApi.md delete mode 100644 docs/classes/generated_client.TimeSyncApi.md delete mode 100644 docs/classes/generated_client.TmdbApi.md delete mode 100644 docs/classes/generated_client.TrailersApi.md delete mode 100644 docs/classes/generated_client.TvShowsApi.md delete mode 100644 docs/classes/generated_client.UniversalAudioApi.md delete mode 100644 docs/classes/generated_client.UserApi.md delete mode 100644 docs/classes/generated_client.UserLibraryApi.md delete mode 100644 docs/classes/generated_client.UserViewsApi.md delete mode 100644 docs/classes/generated_client.VideoAttachmentsApi.md delete mode 100644 docs/classes/generated_client.VideosApi.md delete mode 100644 docs/classes/generated_client.YearsApi.md delete mode 100644 docs/classes/index.Api.md delete mode 100644 docs/classes/index.Jellyfin.md delete mode 100644 docs/classes/index.ProductNameIssue.md delete mode 100644 docs/classes/index.RecommendedServerIssue.md delete mode 100644 docs/classes/index.SlowResponseIssue.md delete mode 100644 docs/classes/index.SystemInfoIssue.md delete mode 100644 docs/classes/index.VersionMissingIssue.md delete mode 100644 docs/classes/index.VersionOutdatedIssue.md delete mode 100644 docs/classes/index.VersionUnsupportedIssue.md delete mode 100644 docs/classes/index.discovery.DiscoveryService.md delete mode 100644 docs/classes/index.discovery.RecommendedServerDiscovery.md delete mode 100644 docs/enums/generated_client.Architecture.md delete mode 100644 docs/enums/generated_client.BaseItemKind.md delete mode 100644 docs/enums/generated_client.ChannelItemSortField.md delete mode 100644 docs/enums/generated_client.ChannelMediaContentType.md delete mode 100644 docs/enums/generated_client.ChannelMediaType.md delete mode 100644 docs/enums/generated_client.ChannelType.md delete mode 100644 docs/enums/generated_client.CodecType.md delete mode 100644 docs/enums/generated_client.CollectionTypeOptions.md delete mode 100644 docs/enums/generated_client.DayOfWeek.md delete mode 100644 docs/enums/generated_client.DayPattern.md delete mode 100644 docs/enums/generated_client.DeviceProfileType.md delete mode 100644 docs/enums/generated_client.DlnaProfileType.md delete mode 100644 docs/enums/generated_client.DynamicDayOfWeek.md delete mode 100644 docs/enums/generated_client.EmbeddedSubtitleOptions.md delete mode 100644 docs/enums/generated_client.EncodingContext.md delete mode 100644 docs/enums/generated_client.ExternalIdMediaType.md delete mode 100644 docs/enums/generated_client.FFmpegLocation.md delete mode 100644 docs/enums/generated_client.FileSystemEntryType.md delete mode 100644 docs/enums/generated_client.ForgotPasswordAction.md delete mode 100644 docs/enums/generated_client.GeneralCommandType.md delete mode 100644 docs/enums/generated_client.GroupQueueMode.md delete mode 100644 docs/enums/generated_client.GroupRepeatMode.md delete mode 100644 docs/enums/generated_client.GroupShuffleMode.md delete mode 100644 docs/enums/generated_client.GroupStateType.md delete mode 100644 docs/enums/generated_client.GroupUpdateType.md delete mode 100644 docs/enums/generated_client.HardwareEncodingType.md delete mode 100644 docs/enums/generated_client.HeaderMatchType.md delete mode 100644 docs/enums/generated_client.ImageFormat.md delete mode 100644 docs/enums/generated_client.ImageOrientation.md delete mode 100644 docs/enums/generated_client.ImageSavingConvention.md delete mode 100644 docs/enums/generated_client.ImageType.md delete mode 100644 docs/enums/generated_client.IsoType.md delete mode 100644 docs/enums/generated_client.ItemFields.md delete mode 100644 docs/enums/generated_client.ItemFilter.md delete mode 100644 docs/enums/generated_client.KeepUntil.md delete mode 100644 docs/enums/generated_client.LiveTvServiceStatus.md delete mode 100644 docs/enums/generated_client.LocationType.md delete mode 100644 docs/enums/generated_client.LogLevel.md delete mode 100644 docs/enums/generated_client.MediaProtocol.md delete mode 100644 docs/enums/generated_client.MediaSourceType.md delete mode 100644 docs/enums/generated_client.MediaStreamType.md delete mode 100644 docs/enums/generated_client.MetadataField.md delete mode 100644 docs/enums/generated_client.MetadataRefreshMode.md delete mode 100644 docs/enums/generated_client.NotificationLevel.md delete mode 100644 docs/enums/generated_client.PlayAccess.md delete mode 100644 docs/enums/generated_client.PlayCommand.md delete mode 100644 docs/enums/generated_client.PlayMethod.md delete mode 100644 docs/enums/generated_client.PlaybackErrorCode.md delete mode 100644 docs/enums/generated_client.PlaystateCommand.md delete mode 100644 docs/enums/generated_client.PluginStatus.md delete mode 100644 docs/enums/generated_client.ProfileConditionType.md delete mode 100644 docs/enums/generated_client.ProfileConditionValue.md delete mode 100644 docs/enums/generated_client.ProgramAudio.md delete mode 100644 docs/enums/generated_client.RatingType.md delete mode 100644 docs/enums/generated_client.RecommendationType.md delete mode 100644 docs/enums/generated_client.RecordingStatus.md delete mode 100644 docs/enums/generated_client.RepeatMode.md delete mode 100644 docs/enums/generated_client.ScrollDirection.md delete mode 100644 docs/enums/generated_client.SendCommandType.md delete mode 100644 docs/enums/generated_client.SendToUserType.md delete mode 100644 docs/enums/generated_client.SeriesStatus.md delete mode 100644 docs/enums/generated_client.SessionMessageType.md delete mode 100644 docs/enums/generated_client.SortOrder.md delete mode 100644 docs/enums/generated_client.SubtitleDeliveryMethod.md delete mode 100644 docs/enums/generated_client.SubtitlePlaybackMode.md delete mode 100644 docs/enums/generated_client.SyncPlayUserAccessType.md delete mode 100644 docs/enums/generated_client.TaskCompletionStatus.md delete mode 100644 docs/enums/generated_client.TaskState.md delete mode 100644 docs/enums/generated_client.TranscodeSeekInfo.md delete mode 100644 docs/enums/generated_client.TranscodingInfoTranscodeReasonsEnum.md delete mode 100644 docs/enums/generated_client.TransportStreamTimestamp.md delete mode 100644 docs/enums/generated_client.UnratedItem.md delete mode 100644 docs/enums/generated_client.Video3DFormat.md delete mode 100644 docs/enums/generated_client.VideoType.md delete mode 100644 docs/enums/index.RecommendedServerInfoScore.md delete mode 100644 docs/interfaces/generated_client.AccessSchedule.md delete mode 100644 docs/interfaces/generated_client.ActivityLogApiGetLogEntriesRequest.md delete mode 100644 docs/interfaces/generated_client.ActivityLogEntry.md delete mode 100644 docs/interfaces/generated_client.ActivityLogEntryQueryResult.md delete mode 100644 docs/interfaces/generated_client.AddVirtualFolderDto.md delete mode 100644 docs/interfaces/generated_client.AdminNotificationDto.md delete mode 100644 docs/interfaces/generated_client.AlbumInfo.md delete mode 100644 docs/interfaces/generated_client.AlbumInfoRemoteSearchQuery.md delete mode 100644 docs/interfaces/generated_client.AllThemeMediaResult.md delete mode 100644 docs/interfaces/generated_client.ApiKeyApiCreateKeyRequest.md delete mode 100644 docs/interfaces/generated_client.ApiKeyApiRevokeKeyRequest.md delete mode 100644 docs/interfaces/generated_client.ArtistInfo.md delete mode 100644 docs/interfaces/generated_client.ArtistInfoRemoteSearchQuery.md delete mode 100644 docs/interfaces/generated_client.ArtistsApiGetAlbumArtistsRequest.md delete mode 100644 docs/interfaces/generated_client.ArtistsApiGetArtistByNameRequest.md delete mode 100644 docs/interfaces/generated_client.ArtistsApiGetArtistsRequest.md delete mode 100644 docs/interfaces/generated_client.AudioApiGetAudioStreamByContainerRequest.md delete mode 100644 docs/interfaces/generated_client.AudioApiGetAudioStreamRequest.md delete mode 100644 docs/interfaces/generated_client.AudioApiHeadAudioStreamByContainerRequest.md delete mode 100644 docs/interfaces/generated_client.AudioApiHeadAudioStreamRequest.md delete mode 100644 docs/interfaces/generated_client.AuthenticateUserByName.md delete mode 100644 docs/interfaces/generated_client.AuthenticationInfo.md delete mode 100644 docs/interfaces/generated_client.AuthenticationInfoQueryResult.md delete mode 100644 docs/interfaces/generated_client.AuthenticationResult.md delete mode 100644 docs/interfaces/generated_client.BaseItem.md delete mode 100644 docs/interfaces/generated_client.BaseItemDto.md delete mode 100644 docs/interfaces/generated_client.BaseItemDtoImageBlurHashes.md delete mode 100644 docs/interfaces/generated_client.BaseItemDtoQueryResult.md delete mode 100644 docs/interfaces/generated_client.BaseItemPerson.md delete mode 100644 docs/interfaces/generated_client.BaseItemPersonImageBlurHashes.md delete mode 100644 docs/interfaces/generated_client.BookInfo.md delete mode 100644 docs/interfaces/generated_client.BookInfoRemoteSearchQuery.md delete mode 100644 docs/interfaces/generated_client.BoxSetInfo.md delete mode 100644 docs/interfaces/generated_client.BoxSetInfoRemoteSearchQuery.md delete mode 100644 docs/interfaces/generated_client.BrandingOptions.md delete mode 100644 docs/interfaces/generated_client.BufferRequestDto.md delete mode 100644 docs/interfaces/generated_client.ChannelFeatures.md delete mode 100644 docs/interfaces/generated_client.ChannelMappingOptionsDto.md delete mode 100644 docs/interfaces/generated_client.ChannelsApiGetChannelFeaturesRequest.md delete mode 100644 docs/interfaces/generated_client.ChannelsApiGetChannelItemsRequest.md delete mode 100644 docs/interfaces/generated_client.ChannelsApiGetChannelsRequest.md delete mode 100644 docs/interfaces/generated_client.ChannelsApiGetLatestChannelItemsRequest.md delete mode 100644 docs/interfaces/generated_client.ChapterInfo.md delete mode 100644 docs/interfaces/generated_client.ClientCapabilities.md delete mode 100644 docs/interfaces/generated_client.ClientCapabilitiesDto.md delete mode 100644 docs/interfaces/generated_client.ClientLogApiLogFileRequest.md delete mode 100644 docs/interfaces/generated_client.ClientLogDocumentResponseDto.md delete mode 100644 docs/interfaces/generated_client.CodecProfile.md delete mode 100644 docs/interfaces/generated_client.CollectionApiAddToCollectionRequest.md delete mode 100644 docs/interfaces/generated_client.CollectionApiCreateCollectionRequest.md delete mode 100644 docs/interfaces/generated_client.CollectionApiRemoveFromCollectionRequest.md delete mode 100644 docs/interfaces/generated_client.CollectionCreationResult.md delete mode 100644 docs/interfaces/generated_client.ConfigImageTypes.md delete mode 100644 docs/interfaces/generated_client.ConfigurationApiGetNamedConfigurationRequest.md delete mode 100644 docs/interfaces/generated_client.ConfigurationApiUpdateConfigurationRequest.md delete mode 100644 docs/interfaces/generated_client.ConfigurationApiUpdateMediaEncoderPathRequest.md delete mode 100644 docs/interfaces/generated_client.ConfigurationApiUpdateNamedConfigurationRequest.md delete mode 100644 docs/interfaces/generated_client.ConfigurationPageInfo.md delete mode 100644 docs/interfaces/generated_client.ConfigurationParameters.md delete mode 100644 docs/interfaces/generated_client.ContainerProfile.md delete mode 100644 docs/interfaces/generated_client.ControlResponse.md delete mode 100644 docs/interfaces/generated_client.CountryInfo.md delete mode 100644 docs/interfaces/generated_client.CreatePlaylistDto.md delete mode 100644 docs/interfaces/generated_client.CreateUserByName.md delete mode 100644 docs/interfaces/generated_client.CultureDto.md delete mode 100644 docs/interfaces/generated_client.DashboardApiGetConfigurationPagesRequest.md delete mode 100644 docs/interfaces/generated_client.DashboardApiGetDashboardConfigurationPageRequest.md delete mode 100644 docs/interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md delete mode 100644 docs/interfaces/generated_client.DeviceIdentification.md delete mode 100644 docs/interfaces/generated_client.DeviceInfo.md delete mode 100644 docs/interfaces/generated_client.DeviceInfoQueryResult.md delete mode 100644 docs/interfaces/generated_client.DeviceOptions.md delete mode 100644 docs/interfaces/generated_client.DeviceOptionsDto.md delete mode 100644 docs/interfaces/generated_client.DeviceProfile.md delete mode 100644 docs/interfaces/generated_client.DeviceProfileInfo.md delete mode 100644 docs/interfaces/generated_client.DevicesApiDeleteDeviceRequest.md delete mode 100644 docs/interfaces/generated_client.DevicesApiGetDeviceInfoRequest.md delete mode 100644 docs/interfaces/generated_client.DevicesApiGetDeviceOptionsRequest.md delete mode 100644 docs/interfaces/generated_client.DevicesApiGetDevicesRequest.md delete mode 100644 docs/interfaces/generated_client.DevicesApiUpdateDeviceOptionsRequest.md delete mode 100644 docs/interfaces/generated_client.DirectPlayProfile.md delete mode 100644 docs/interfaces/generated_client.DisplayPreferencesApiGetDisplayPreferencesRequest.md delete mode 100644 docs/interfaces/generated_client.DisplayPreferencesApiUpdateDisplayPreferencesRequest.md delete mode 100644 docs/interfaces/generated_client.DisplayPreferencesDto.md delete mode 100644 docs/interfaces/generated_client.DlnaApiCreateProfileRequest.md delete mode 100644 docs/interfaces/generated_client.DlnaApiDeleteProfileRequest.md delete mode 100644 docs/interfaces/generated_client.DlnaApiGetProfileRequest.md delete mode 100644 docs/interfaces/generated_client.DlnaApiUpdateProfileRequest.md delete mode 100644 docs/interfaces/generated_client.DlnaOptions.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetConnectionManager2Request.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetConnectionManager3Request.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetConnectionManagerRequest.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetContentDirectory2Request.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetContentDirectory3Request.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetContentDirectoryRequest.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetDescriptionXml2Request.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetDescriptionXmlRequest.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetIconIdRequest.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetIconRequest.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar2Request.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar3Request.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrarRequest.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiProcessConnectionManagerControlRequestRequest.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiProcessContentDirectoryControlRequestRequest.md delete mode 100644 docs/interfaces/generated_client.DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest.md delete mode 100644 docs/interfaces/generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md delete mode 100644 docs/interfaces/generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md delete mode 100644 docs/interfaces/generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md delete mode 100644 docs/interfaces/generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md delete mode 100644 docs/interfaces/generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md delete mode 100644 docs/interfaces/generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md delete mode 100644 docs/interfaces/generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md delete mode 100644 docs/interfaces/generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md delete mode 100644 docs/interfaces/generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md delete mode 100644 docs/interfaces/generated_client.EncodingOptions.md delete mode 100644 docs/interfaces/generated_client.EndPointInfo.md delete mode 100644 docs/interfaces/generated_client.EnvironmentApiGetDirectoryContentsRequest.md delete mode 100644 docs/interfaces/generated_client.EnvironmentApiGetParentPathRequest.md delete mode 100644 docs/interfaces/generated_client.EnvironmentApiValidatePathRequest.md delete mode 100644 docs/interfaces/generated_client.ExternalIdInfo.md delete mode 100644 docs/interfaces/generated_client.ExternalUrl.md delete mode 100644 docs/interfaces/generated_client.FileSystemEntryInfo.md delete mode 100644 docs/interfaces/generated_client.FilterApiGetQueryFiltersLegacyRequest.md delete mode 100644 docs/interfaces/generated_client.FilterApiGetQueryFiltersRequest.md delete mode 100644 docs/interfaces/generated_client.FontFile.md delete mode 100644 docs/interfaces/generated_client.ForgotPasswordDto.md delete mode 100644 docs/interfaces/generated_client.ForgotPasswordPinDto.md delete mode 100644 docs/interfaces/generated_client.ForgotPasswordResult.md delete mode 100644 docs/interfaces/generated_client.GeneralCommand.md delete mode 100644 docs/interfaces/generated_client.GenresApiGetGenreRequest.md delete mode 100644 docs/interfaces/generated_client.GenresApiGetGenresRequest.md delete mode 100644 docs/interfaces/generated_client.GetProgramsDto.md delete mode 100644 docs/interfaces/generated_client.GroupInfoDto.md delete mode 100644 docs/interfaces/generated_client.GuideInfo.md delete mode 100644 docs/interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest.md delete mode 100644 docs/interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request.md delete mode 100644 docs/interfaces/generated_client.HlsSegmentApiGetHlsPlaylistLegacyRequest.md delete mode 100644 docs/interfaces/generated_client.HlsSegmentApiGetHlsVideoSegmentLegacyRequest.md delete mode 100644 docs/interfaces/generated_client.HlsSegmentApiStopEncodingProcessRequest.md delete mode 100644 docs/interfaces/generated_client.HttpHeaderInfo.md delete mode 100644 docs/interfaces/generated_client.IPlugin.md delete mode 100644 docs/interfaces/generated_client.IgnoreWaitRequestDto.md delete mode 100644 docs/interfaces/generated_client.ImageApiDeleteItemImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiDeleteItemImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiDeleteUserImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiDeleteUserImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetArtistImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetGenreImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetGenreImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetItemImage2Request.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetItemImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetItemImageInfosRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetItemImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetMusicGenreImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetMusicGenreImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetPersonImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetPersonImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetSplashscreenRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetStudioImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetStudioImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetUserImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiGetUserImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadArtistImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadGenreImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadGenreImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadItemImage2Request.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadItemImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadItemImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadMusicGenreImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadPersonImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadPersonImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadStudioImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadStudioImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadUserImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiHeadUserImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiPostUserImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiPostUserImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiSetItemImageByIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiSetItemImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiUpdateItemImageIndexRequest.md delete mode 100644 docs/interfaces/generated_client.ImageApiUploadCustomSplashscreenRequest.md delete mode 100644 docs/interfaces/generated_client.ImageByNameApiGetGeneralImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageByNameApiGetMediaInfoImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageByNameApiGetRatingImageRequest.md delete mode 100644 docs/interfaces/generated_client.ImageByNameInfo.md delete mode 100644 docs/interfaces/generated_client.ImageInfo.md delete mode 100644 docs/interfaces/generated_client.ImageOption.md delete mode 100644 docs/interfaces/generated_client.ImageProviderInfo.md delete mode 100644 docs/interfaces/generated_client.InstallationInfo.md delete mode 100644 docs/interfaces/generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md delete mode 100644 docs/interfaces/generated_client.InstantMixApiGetInstantMixFromArtists2Request.md delete mode 100644 docs/interfaces/generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md delete mode 100644 docs/interfaces/generated_client.InstantMixApiGetInstantMixFromItemRequest.md delete mode 100644 docs/interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md delete mode 100644 docs/interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md delete mode 100644 docs/interfaces/generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md delete mode 100644 docs/interfaces/generated_client.InstantMixApiGetInstantMixFromSongRequest.md delete mode 100644 docs/interfaces/generated_client.ItemCounts.md delete mode 100644 docs/interfaces/generated_client.ItemLookupApiApplySearchCriteriaRequest.md delete mode 100644 docs/interfaces/generated_client.ItemLookupApiGetBookRemoteSearchResultsRequest.md delete mode 100644 docs/interfaces/generated_client.ItemLookupApiGetBoxSetRemoteSearchResultsRequest.md delete mode 100644 docs/interfaces/generated_client.ItemLookupApiGetExternalIdInfosRequest.md delete mode 100644 docs/interfaces/generated_client.ItemLookupApiGetMovieRemoteSearchResultsRequest.md delete mode 100644 docs/interfaces/generated_client.ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest.md delete mode 100644 docs/interfaces/generated_client.ItemLookupApiGetMusicArtistRemoteSearchResultsRequest.md delete mode 100644 docs/interfaces/generated_client.ItemLookupApiGetMusicVideoRemoteSearchResultsRequest.md delete mode 100644 docs/interfaces/generated_client.ItemLookupApiGetPersonRemoteSearchResultsRequest.md delete mode 100644 docs/interfaces/generated_client.ItemLookupApiGetSeriesRemoteSearchResultsRequest.md delete mode 100644 docs/interfaces/generated_client.ItemLookupApiGetTrailerRemoteSearchResultsRequest.md delete mode 100644 docs/interfaces/generated_client.ItemRefreshApiRefreshItemRequest.md delete mode 100644 docs/interfaces/generated_client.ItemUpdateApiGetMetadataEditorInfoRequest.md delete mode 100644 docs/interfaces/generated_client.ItemUpdateApiUpdateItemContentTypeRequest.md delete mode 100644 docs/interfaces/generated_client.ItemUpdateApiUpdateItemRequest.md delete mode 100644 docs/interfaces/generated_client.ItemsApiGetItemsByUserIdRequest.md delete mode 100644 docs/interfaces/generated_client.ItemsApiGetItemsRequest.md delete mode 100644 docs/interfaces/generated_client.ItemsApiGetResumeItemsRequest.md delete mode 100644 docs/interfaces/generated_client.JoinGroupRequestDto.md delete mode 100644 docs/interfaces/generated_client.LibraryApiDeleteItemRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiDeleteItemsRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetAncestorsRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetCriticReviewsRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetDownloadRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetFileRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetItemCountsRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetLibraryOptionsInfoRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetMediaFoldersRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetSimilarAlbumsRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetSimilarArtistsRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetSimilarItemsRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetSimilarMoviesRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetSimilarShowsRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetSimilarTrailersRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetThemeMediaRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetThemeSongsRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiGetThemeVideosRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiPostAddedMoviesRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiPostAddedSeriesRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiPostUpdatedMediaRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiPostUpdatedMoviesRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryApiPostUpdatedSeriesRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryOptionInfoDto.md delete mode 100644 docs/interfaces/generated_client.LibraryOptions.md delete mode 100644 docs/interfaces/generated_client.LibraryOptionsResultDto.md delete mode 100644 docs/interfaces/generated_client.LibraryStructureApiAddMediaPathRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryStructureApiAddVirtualFolderRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryStructureApiRemoveMediaPathRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryStructureApiRemoveVirtualFolderRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryStructureApiRenameVirtualFolderRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryStructureApiUpdateLibraryOptionsRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryStructureApiUpdateMediaPathRequest.md delete mode 100644 docs/interfaces/generated_client.LibraryTypeOptionsDto.md delete mode 100644 docs/interfaces/generated_client.LibraryUpdateInfo.md delete mode 100644 docs/interfaces/generated_client.ListingsProviderInfo.md delete mode 100644 docs/interfaces/generated_client.LiveStreamResponse.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiAddListingProviderRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiAddTunerHostRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiCancelSeriesTimerRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiCancelTimerRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiCreateSeriesTimerRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiCreateTimerRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiDeleteListingProviderRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiDeleteRecordingRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiDeleteTunerHostRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiDiscoverTunersRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiDiscvoverTunersRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetChannelMappingOptionsRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetChannelRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetDefaultTimerRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetLineupsRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetLiveRecordingFileRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetLiveStreamFileRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetLiveTvChannelsRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetLiveTvProgramsRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetProgramRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetProgramsRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetRecommendedProgramsRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetRecordingFoldersRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetRecordingGroupRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetRecordingGroupsRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetRecordingRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetRecordingsRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetRecordingsSeriesRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetSeriesTimerRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetSeriesTimersRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetTimerRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiGetTimersRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiResetTunerRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiSetChannelMappingRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiUpdateSeriesTimerRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvApiUpdateTimerRequest.md delete mode 100644 docs/interfaces/generated_client.LiveTvInfo.md delete mode 100644 docs/interfaces/generated_client.LiveTvOptions.md delete mode 100644 docs/interfaces/generated_client.LiveTvServiceInfo.md delete mode 100644 docs/interfaces/generated_client.LocalizationOption.md delete mode 100644 docs/interfaces/generated_client.LogFile.md delete mode 100644 docs/interfaces/generated_client.MediaAttachment.md delete mode 100644 docs/interfaces/generated_client.MediaEncoderPathDto.md delete mode 100644 docs/interfaces/generated_client.MediaInfoApiCloseLiveStreamRequest.md delete mode 100644 docs/interfaces/generated_client.MediaInfoApiGetBitrateTestBytesRequest.md delete mode 100644 docs/interfaces/generated_client.MediaInfoApiGetPlaybackInfoRequest.md delete mode 100644 docs/interfaces/generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md delete mode 100644 docs/interfaces/generated_client.MediaInfoApiOpenLiveStreamRequest.md delete mode 100644 docs/interfaces/generated_client.MediaPathDto.md delete mode 100644 docs/interfaces/generated_client.MediaPathInfo.md delete mode 100644 docs/interfaces/generated_client.MediaSourceInfo.md delete mode 100644 docs/interfaces/generated_client.MediaStream.md delete mode 100644 docs/interfaces/generated_client.MediaUpdateInfoDto.md delete mode 100644 docs/interfaces/generated_client.MediaUpdateInfoPathDto.md delete mode 100644 docs/interfaces/generated_client.MediaUrl.md delete mode 100644 docs/interfaces/generated_client.MessageCommand.md delete mode 100644 docs/interfaces/generated_client.MetadataConfiguration.md delete mode 100644 docs/interfaces/generated_client.MetadataEditorInfo.md delete mode 100644 docs/interfaces/generated_client.MetadataOptions.md delete mode 100644 docs/interfaces/generated_client.MovePlaylistItemRequestDto.md delete mode 100644 docs/interfaces/generated_client.MovieInfo.md delete mode 100644 docs/interfaces/generated_client.MovieInfoRemoteSearchQuery.md delete mode 100644 docs/interfaces/generated_client.MoviesApiGetMovieRecommendationsRequest.md delete mode 100644 docs/interfaces/generated_client.MusicGenresApiGetMusicGenreRequest.md delete mode 100644 docs/interfaces/generated_client.MusicGenresApiGetMusicGenresRequest.md delete mode 100644 docs/interfaces/generated_client.MusicVideoInfo.md delete mode 100644 docs/interfaces/generated_client.MusicVideoInfoRemoteSearchQuery.md delete mode 100644 docs/interfaces/generated_client.NameGuidPair.md delete mode 100644 docs/interfaces/generated_client.NameIdPair.md delete mode 100644 docs/interfaces/generated_client.NameValuePair.md delete mode 100644 docs/interfaces/generated_client.NetworkConfiguration.md delete mode 100644 docs/interfaces/generated_client.NewGroupRequestDto.md delete mode 100644 docs/interfaces/generated_client.NextItemRequestDto.md delete mode 100644 docs/interfaces/generated_client.NotificationDto.md delete mode 100644 docs/interfaces/generated_client.NotificationOption.md delete mode 100644 docs/interfaces/generated_client.NotificationOptions.md delete mode 100644 docs/interfaces/generated_client.NotificationResultDto.md delete mode 100644 docs/interfaces/generated_client.NotificationTypeInfo.md delete mode 100644 docs/interfaces/generated_client.NotificationsApiCreateAdminNotificationRequest.md delete mode 100644 docs/interfaces/generated_client.NotificationsApiGetNotificationsRequest.md delete mode 100644 docs/interfaces/generated_client.NotificationsApiGetNotificationsSummaryRequest.md delete mode 100644 docs/interfaces/generated_client.NotificationsApiSetReadRequest.md delete mode 100644 docs/interfaces/generated_client.NotificationsApiSetUnreadRequest.md delete mode 100644 docs/interfaces/generated_client.NotificationsSummaryDto.md delete mode 100644 docs/interfaces/generated_client.ObjectGroupUpdate.md delete mode 100644 docs/interfaces/generated_client.OpenLiveStreamDto.md delete mode 100644 docs/interfaces/generated_client.PackageApiCancelPackageInstallationRequest.md delete mode 100644 docs/interfaces/generated_client.PackageApiGetPackageInfoRequest.md delete mode 100644 docs/interfaces/generated_client.PackageApiInstallPackageRequest.md delete mode 100644 docs/interfaces/generated_client.PackageApiSetRepositoriesRequest.md delete mode 100644 docs/interfaces/generated_client.PackageInfo.md delete mode 100644 docs/interfaces/generated_client.ParentalRating.md delete mode 100644 docs/interfaces/generated_client.PathSubstitution.md delete mode 100644 docs/interfaces/generated_client.PersonLookupInfo.md delete mode 100644 docs/interfaces/generated_client.PersonLookupInfoRemoteSearchQuery.md delete mode 100644 docs/interfaces/generated_client.PersonsApiGetPersonRequest.md delete mode 100644 docs/interfaces/generated_client.PersonsApiGetPersonsRequest.md delete mode 100644 docs/interfaces/generated_client.PinRedeemResult.md delete mode 100644 docs/interfaces/generated_client.PingRequestDto.md delete mode 100644 docs/interfaces/generated_client.PlayRequest.md delete mode 100644 docs/interfaces/generated_client.PlayRequestDto.md delete mode 100644 docs/interfaces/generated_client.PlaybackInfoDto.md delete mode 100644 docs/interfaces/generated_client.PlaybackInfoResponse.md delete mode 100644 docs/interfaces/generated_client.PlaybackProgressInfo.md delete mode 100644 docs/interfaces/generated_client.PlaybackStartInfo.md delete mode 100644 docs/interfaces/generated_client.PlaybackStopInfo.md delete mode 100644 docs/interfaces/generated_client.PlayerStateInfo.md delete mode 100644 docs/interfaces/generated_client.PlaylistCreationResult.md delete mode 100644 docs/interfaces/generated_client.PlaylistsApiAddToPlaylistRequest.md delete mode 100644 docs/interfaces/generated_client.PlaylistsApiCreatePlaylistRequest.md delete mode 100644 docs/interfaces/generated_client.PlaylistsApiGetPlaylistItemsRequest.md delete mode 100644 docs/interfaces/generated_client.PlaylistsApiMoveItemRequest.md delete mode 100644 docs/interfaces/generated_client.PlaylistsApiRemoveFromPlaylistRequest.md delete mode 100644 docs/interfaces/generated_client.PlaystateApiMarkPlayedItemRequest.md delete mode 100644 docs/interfaces/generated_client.PlaystateApiMarkUnplayedItemRequest.md delete mode 100644 docs/interfaces/generated_client.PlaystateApiOnPlaybackProgressRequest.md delete mode 100644 docs/interfaces/generated_client.PlaystateApiOnPlaybackStartRequest.md delete mode 100644 docs/interfaces/generated_client.PlaystateApiOnPlaybackStoppedRequest.md delete mode 100644 docs/interfaces/generated_client.PlaystateApiPingPlaybackSessionRequest.md delete mode 100644 docs/interfaces/generated_client.PlaystateApiReportPlaybackProgressRequest.md delete mode 100644 docs/interfaces/generated_client.PlaystateApiReportPlaybackStartRequest.md delete mode 100644 docs/interfaces/generated_client.PlaystateApiReportPlaybackStoppedRequest.md delete mode 100644 docs/interfaces/generated_client.PlaystateRequest.md delete mode 100644 docs/interfaces/generated_client.PluginInfo.md delete mode 100644 docs/interfaces/generated_client.PluginsApiDisablePluginRequest.md delete mode 100644 docs/interfaces/generated_client.PluginsApiEnablePluginRequest.md delete mode 100644 docs/interfaces/generated_client.PluginsApiGetPluginConfigurationRequest.md delete mode 100644 docs/interfaces/generated_client.PluginsApiGetPluginImageRequest.md delete mode 100644 docs/interfaces/generated_client.PluginsApiGetPluginManifestRequest.md delete mode 100644 docs/interfaces/generated_client.PluginsApiUninstallPluginByVersionRequest.md delete mode 100644 docs/interfaces/generated_client.PluginsApiUninstallPluginRequest.md delete mode 100644 docs/interfaces/generated_client.PluginsApiUpdatePluginConfigurationRequest.md delete mode 100644 docs/interfaces/generated_client.PreviousItemRequestDto.md delete mode 100644 docs/interfaces/generated_client.ProblemDetails.md delete mode 100644 docs/interfaces/generated_client.ProfileCondition.md delete mode 100644 docs/interfaces/generated_client.PublicSystemInfo.md delete mode 100644 docs/interfaces/generated_client.QueryFilters.md delete mode 100644 docs/interfaces/generated_client.QueryFiltersLegacy.md delete mode 100644 docs/interfaces/generated_client.QueueItem.md delete mode 100644 docs/interfaces/generated_client.QueueRequestDto.md delete mode 100644 docs/interfaces/generated_client.QuickConnectApiAuthorizeRequest.md delete mode 100644 docs/interfaces/generated_client.QuickConnectApiConnectRequest.md delete mode 100644 docs/interfaces/generated_client.QuickConnectDto.md delete mode 100644 docs/interfaces/generated_client.QuickConnectResult.md delete mode 100644 docs/interfaces/generated_client.ReadyRequestDto.md delete mode 100644 docs/interfaces/generated_client.RecommendationDto.md delete mode 100644 docs/interfaces/generated_client.RemoteImageApiDownloadRemoteImageRequest.md delete mode 100644 docs/interfaces/generated_client.RemoteImageApiGetRemoteImageProvidersRequest.md delete mode 100644 docs/interfaces/generated_client.RemoteImageApiGetRemoteImagesRequest.md delete mode 100644 docs/interfaces/generated_client.RemoteImageInfo.md delete mode 100644 docs/interfaces/generated_client.RemoteImageResult.md delete mode 100644 docs/interfaces/generated_client.RemoteSearchResult.md delete mode 100644 docs/interfaces/generated_client.RemoteSubtitleInfo.md delete mode 100644 docs/interfaces/generated_client.RemoveFromPlaylistRequestDto.md delete mode 100644 docs/interfaces/generated_client.RepositoryInfo.md delete mode 100644 docs/interfaces/generated_client.ResponseProfile.md delete mode 100644 docs/interfaces/generated_client.ScheduledTasksApiGetTaskRequest.md delete mode 100644 docs/interfaces/generated_client.ScheduledTasksApiGetTasksRequest.md delete mode 100644 docs/interfaces/generated_client.ScheduledTasksApiStartTaskRequest.md delete mode 100644 docs/interfaces/generated_client.ScheduledTasksApiStopTaskRequest.md delete mode 100644 docs/interfaces/generated_client.ScheduledTasksApiUpdateTaskRequest.md delete mode 100644 docs/interfaces/generated_client.SearchApiGetRequest.md delete mode 100644 docs/interfaces/generated_client.SearchHint.md delete mode 100644 docs/interfaces/generated_client.SearchHintResult.md delete mode 100644 docs/interfaces/generated_client.SeekRequestDto.md delete mode 100644 docs/interfaces/generated_client.SendCommand.md delete mode 100644 docs/interfaces/generated_client.SeriesInfo.md delete mode 100644 docs/interfaces/generated_client.SeriesInfoRemoteSearchQuery.md delete mode 100644 docs/interfaces/generated_client.SeriesTimerInfoDto.md delete mode 100644 docs/interfaces/generated_client.SeriesTimerInfoDtoQueryResult.md delete mode 100644 docs/interfaces/generated_client.ServerConfiguration.md delete mode 100644 docs/interfaces/generated_client.ServerDiscoveryInfo.md delete mode 100644 docs/interfaces/generated_client.SessionApiAddUserToSessionRequest.md delete mode 100644 docs/interfaces/generated_client.SessionApiDisplayContentRequest.md delete mode 100644 docs/interfaces/generated_client.SessionApiGetSessionsRequest.md delete mode 100644 docs/interfaces/generated_client.SessionApiPlayRequest.md delete mode 100644 docs/interfaces/generated_client.SessionApiPostCapabilitiesRequest.md delete mode 100644 docs/interfaces/generated_client.SessionApiPostFullCapabilitiesRequest.md delete mode 100644 docs/interfaces/generated_client.SessionApiRemoveUserFromSessionRequest.md delete mode 100644 docs/interfaces/generated_client.SessionApiReportViewingRequest.md delete mode 100644 docs/interfaces/generated_client.SessionApiSendFullGeneralCommandRequest.md delete mode 100644 docs/interfaces/generated_client.SessionApiSendGeneralCommandRequest.md delete mode 100644 docs/interfaces/generated_client.SessionApiSendMessageCommandRequest.md delete mode 100644 docs/interfaces/generated_client.SessionApiSendPlaystateCommandRequest.md delete mode 100644 docs/interfaces/generated_client.SessionApiSendSystemCommandRequest.md delete mode 100644 docs/interfaces/generated_client.SessionInfo.md delete mode 100644 docs/interfaces/generated_client.SessionUserInfo.md delete mode 100644 docs/interfaces/generated_client.SetChannelMappingDto.md delete mode 100644 docs/interfaces/generated_client.SetPlaylistItemRequestDto.md delete mode 100644 docs/interfaces/generated_client.SetRepeatModeRequestDto.md delete mode 100644 docs/interfaces/generated_client.SetShuffleModeRequestDto.md delete mode 100644 docs/interfaces/generated_client.SongInfo.md delete mode 100644 docs/interfaces/generated_client.SpecialViewOptionDto.md delete mode 100644 docs/interfaces/generated_client.StartupApiSetRemoteAccessRequest.md delete mode 100644 docs/interfaces/generated_client.StartupApiUpdateInitialConfigurationRequest.md delete mode 100644 docs/interfaces/generated_client.StartupApiUpdateStartupUserRequest.md delete mode 100644 docs/interfaces/generated_client.StartupConfigurationDto.md delete mode 100644 docs/interfaces/generated_client.StartupRemoteAccessDto.md delete mode 100644 docs/interfaces/generated_client.StartupUserDto.md delete mode 100644 docs/interfaces/generated_client.StudiosApiGetStudioRequest.md delete mode 100644 docs/interfaces/generated_client.StudiosApiGetStudiosRequest.md delete mode 100644 docs/interfaces/generated_client.SubtitleApiDeleteSubtitleRequest.md delete mode 100644 docs/interfaces/generated_client.SubtitleApiDownloadRemoteSubtitlesRequest.md delete mode 100644 docs/interfaces/generated_client.SubtitleApiGetFallbackFontRequest.md delete mode 100644 docs/interfaces/generated_client.SubtitleApiGetRemoteSubtitlesRequest.md delete mode 100644 docs/interfaces/generated_client.SubtitleApiGetSubtitlePlaylistRequest.md delete mode 100644 docs/interfaces/generated_client.SubtitleApiGetSubtitleRequest.md delete mode 100644 docs/interfaces/generated_client.SubtitleApiGetSubtitleWithTicksRequest.md delete mode 100644 docs/interfaces/generated_client.SubtitleApiSearchRemoteSubtitlesRequest.md delete mode 100644 docs/interfaces/generated_client.SubtitleApiUploadSubtitleRequest.md delete mode 100644 docs/interfaces/generated_client.SubtitleOptions.md delete mode 100644 docs/interfaces/generated_client.SubtitleProfile.md delete mode 100644 docs/interfaces/generated_client.SuggestionsApiGetSuggestionsRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlayBufferingRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlayCreateGroupRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlayJoinGroupRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlayMovePlaylistItemRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlayNextItemRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlayPingRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlayPreviousItemRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlayQueueRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlayReadyRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlayRemoveFromPlaylistRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlaySeekRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlaySetIgnoreWaitRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlaySetNewQueueRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlaySetPlaylistItemRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlaySetRepeatModeRequest.md delete mode 100644 docs/interfaces/generated_client.SyncPlayApiSyncPlaySetShuffleModeRequest.md delete mode 100644 docs/interfaces/generated_client.SystemApiGetLogFileRequest.md delete mode 100644 docs/interfaces/generated_client.SystemInfo.md delete mode 100644 docs/interfaces/generated_client.TaskInfo.md delete mode 100644 docs/interfaces/generated_client.TaskResult.md delete mode 100644 docs/interfaces/generated_client.TaskTriggerInfo.md delete mode 100644 docs/interfaces/generated_client.ThemeMediaResult.md delete mode 100644 docs/interfaces/generated_client.TimerEventInfo.md delete mode 100644 docs/interfaces/generated_client.TimerInfoDto.md delete mode 100644 docs/interfaces/generated_client.TimerInfoDtoQueryResult.md delete mode 100644 docs/interfaces/generated_client.TrailerInfo.md delete mode 100644 docs/interfaces/generated_client.TrailerInfoRemoteSearchQuery.md delete mode 100644 docs/interfaces/generated_client.TrailersApiGetTrailersRequest.md delete mode 100644 docs/interfaces/generated_client.TranscodingInfo.md delete mode 100644 docs/interfaces/generated_client.TranscodingProfile.md delete mode 100644 docs/interfaces/generated_client.TunerChannelMapping.md delete mode 100644 docs/interfaces/generated_client.TunerHostInfo.md delete mode 100644 docs/interfaces/generated_client.TvShowsApiGetEpisodesRequest.md delete mode 100644 docs/interfaces/generated_client.TvShowsApiGetNextUpRequest.md delete mode 100644 docs/interfaces/generated_client.TvShowsApiGetSeasonsRequest.md delete mode 100644 docs/interfaces/generated_client.TvShowsApiGetUpcomingEpisodesRequest.md delete mode 100644 docs/interfaces/generated_client.TypeOptions.md delete mode 100644 docs/interfaces/generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md delete mode 100644 docs/interfaces/generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md delete mode 100644 docs/interfaces/generated_client.UpdateLibraryOptionsDto.md delete mode 100644 docs/interfaces/generated_client.UpdateMediaPathRequestDto.md delete mode 100644 docs/interfaces/generated_client.UpdateUserEasyPassword.md delete mode 100644 docs/interfaces/generated_client.UpdateUserPassword.md delete mode 100644 docs/interfaces/generated_client.UploadSubtitleDto.md delete mode 100644 docs/interfaces/generated_client.UserApiAuthenticateUserByNameRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiAuthenticateUserRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiAuthenticateWithQuickConnectRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiCreateUserByNameRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiDeleteUserRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiForgotPasswordPinRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiForgotPasswordRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiGetUserByIdRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiGetUsersRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiUpdateUserConfigurationRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiUpdateUserEasyPasswordRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiUpdateUserPasswordRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiUpdateUserPolicyRequest.md delete mode 100644 docs/interfaces/generated_client.UserApiUpdateUserRequest.md delete mode 100644 docs/interfaces/generated_client.UserConfiguration.md delete mode 100644 docs/interfaces/generated_client.UserDto.md delete mode 100644 docs/interfaces/generated_client.UserItemDataDto.md delete mode 100644 docs/interfaces/generated_client.UserLibraryApiDeleteUserItemRatingRequest.md delete mode 100644 docs/interfaces/generated_client.UserLibraryApiGetIntrosRequest.md delete mode 100644 docs/interfaces/generated_client.UserLibraryApiGetItemRequest.md delete mode 100644 docs/interfaces/generated_client.UserLibraryApiGetLatestMediaRequest.md delete mode 100644 docs/interfaces/generated_client.UserLibraryApiGetLocalTrailersRequest.md delete mode 100644 docs/interfaces/generated_client.UserLibraryApiGetRootFolderRequest.md delete mode 100644 docs/interfaces/generated_client.UserLibraryApiGetSpecialFeaturesRequest.md delete mode 100644 docs/interfaces/generated_client.UserLibraryApiMarkFavoriteItemRequest.md delete mode 100644 docs/interfaces/generated_client.UserLibraryApiUnmarkFavoriteItemRequest.md delete mode 100644 docs/interfaces/generated_client.UserLibraryApiUpdateUserItemRatingRequest.md delete mode 100644 docs/interfaces/generated_client.UserPolicy.md delete mode 100644 docs/interfaces/generated_client.UserViewsApiGetGroupingOptionsRequest.md delete mode 100644 docs/interfaces/generated_client.UserViewsApiGetUserViewsRequest.md delete mode 100644 docs/interfaces/generated_client.UtcTimeResponse.md delete mode 100644 docs/interfaces/generated_client.ValidatePathDto.md delete mode 100644 docs/interfaces/generated_client.VersionInfo.md delete mode 100644 docs/interfaces/generated_client.VideoAttachmentsApiGetAttachmentRequest.md delete mode 100644 docs/interfaces/generated_client.VideosApiDeleteAlternateSourcesRequest.md delete mode 100644 docs/interfaces/generated_client.VideosApiGetAdditionalPartRequest.md delete mode 100644 docs/interfaces/generated_client.VideosApiGetVideoStreamByContainerRequest.md delete mode 100644 docs/interfaces/generated_client.VideosApiGetVideoStreamRequest.md delete mode 100644 docs/interfaces/generated_client.VideosApiHeadVideoStreamByContainerRequest.md delete mode 100644 docs/interfaces/generated_client.VideosApiHeadVideoStreamRequest.md delete mode 100644 docs/interfaces/generated_client.VideosApiMergeVersionsRequest.md delete mode 100644 docs/interfaces/generated_client.VirtualFolderInfo.md delete mode 100644 docs/interfaces/generated_client.WakeOnLanInfo.md delete mode 100644 docs/interfaces/generated_client.XbmcMetadataOptions.md delete mode 100644 docs/interfaces/generated_client.XmlAttribute.md delete mode 100644 docs/interfaces/generated_client.YearsApiGetYearRequest.md delete mode 100644 docs/interfaces/generated_client.YearsApiGetYearsRequest.md delete mode 100644 docs/interfaces/index.ClientInfo.md delete mode 100644 docs/interfaces/index.DeviceInfo.md delete mode 100644 docs/interfaces/index.JellyfinParameters.md delete mode 100644 docs/interfaces/index.RecommendedServerInfo.md delete mode 100644 docs/interfaces/index.utils.DeviceProfileGeneratorOptions.md delete mode 100644 docs/modules.md delete mode 100644 docs/modules/generated_client.md delete mode 100644 docs/modules/index.discovery.md delete mode 100644 docs/modules/index.md delete mode 100644 docs/modules/index.utils.md diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e2ac6616a..000000000 --- a/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index d38175e88..000000000 --- a/docs/README.md +++ /dev/null @@ -1,126 +0,0 @@ -@thornbill/jellyfin-sdk / [Modules](modules.md) - -

jellyfin-sdk-typescript

-

Part of the Jellyfin Project

- ---- - -

-Logo Banner -
-
-MPL-2.0 license -Current Release -npm - -Codecov - -

- -A TypeScript SDK for Jellyfin. - -> Warning: This project is under active development, so API changes may occur. - -## Install - -```sh -npm i --save @thornbill/jellyfin-sdk -``` - -or - -```sh -yarn add @thornbill/jellyfin-sdk -``` - -### Supported Jellyfin Versions - -| SDK Version | Jellyfin Version | -|:-:|:-:| -| 0.5.0 | 10.8.x | -| <0.5.0 | 10.7.x | - -### React Native - -The generated Axios client used in this library depends on `URL` and `URLSearchParams` to be available on the global scope. -React Native only includes incomplete implementations for these classes, so a polyfill is required. -[React Native URL Polyfill](https://github.com/charpeni/react-native-url-polyfill) seems like a good solution for this. - -## Usage - -```js -// Create a new instance of the SDK -const jellyfin = new Jellyfin({ - clientInfo: { - name: 'My Client Application', - version: '1.0.0' - }, - deviceInfo: { - name: 'Device Name', - id: 'unique-device-id' - } -}); - -// Find a valid server by trying to connect using common protocols and ports. -// Each server receives a score based on security, speed, and other criteria. -const servers = await jellyfin.discovery.getRecommendedServerCandidates('demo.jellyfin.org/stable'); -// A utility function for finding the best result is available. -// If there is no "best" server, an error message should be displayed. -const best = jellyfin.discovery.findBestServer(servers); - -// Create an API instance -const api = jellyfin.createApi(best.address); - -// Each API endpoint is exposed via a getter on the SDK instance using -// a shared Configuration and Axios instance. For example the /System APIs -// are available as api.systemApi. - -// Fetch the public system info -const info = await getSystemApi(api).getPublicSystemInfo(); -console.log('Info =>', info.data); - -// Fetch the list of public users -const users = await getUserApi(api).getPublicUsers(); -console.log('Users =>', users.data); - -// A helper method for authentication has been added to the SDK because -// the default method exposed in the generated Axios client is rather -// cumbersome to use. -const auth = await api.authenticateUserByName('demo', ''); -console.log('Auth =>', auth.data); - -// Authentication state is stored internally in the Api class, so now -// requests that require authentication can be made normally -const libraries = await getLibraryApi(api).getMediaFolders(); -console.log('Libraries =>', libraries.data); - -// A helper method for logging out the current user has been added to the -// SDK so the internal state is updated correctly. -await api.logout(); -``` - -## Breaking Changes - -### v0.5.0 - -* Build directory is now `lib` instead of `dist`. - Any imports used that were previously in `dist` will need updated. - [#147](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/147) -* Duplicated exports were removed. - Any imports may need updated if you referenced one of the duplicates. - [#148](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/148) -* API classes are no longer exposed via getters. - Instead you need to call a function passing the `Api` instance as a parameter. - For example: `getSystemApi(api)`. - While I do feel this is a slightly worse developer experience, it was a necessary change to support tree-shaking. - [#149](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/149) -* `BaseItemKind` is now included in the generated client. - Imports will need updated. - [#187](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/187) - -## Roadmap to 1.0 - -* [ ] More complete device profile generation utilities -* [ ] Use custom generator templates for API versions -* [ ] Automate OpenAPI spec updates using GitHub - * [ ] Create branch tracking unstable Jellyfin builds diff --git a/docs/classes/generated_client.ActivityLogApi.md b/docs/classes/generated_client.ActivityLogApi.md deleted file mode 100644 index b666fb836..000000000 --- a/docs/classes/generated_client.ActivityLogApi.md +++ /dev/null @@ -1,114 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ActivityLogApi - -# Class: ActivityLogApi - -[generated-client](../modules/generated_client.md).ActivityLogApi - -ActivityLogApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ActivityLogApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ActivityLogApi.md#constructor) - -### Properties - -- [axios](generated_client.ActivityLogApi.md#axios) -- [basePath](generated_client.ActivityLogApi.md#basepath) -- [configuration](generated_client.ActivityLogApi.md#configuration) - -### Methods - -- [getLogEntries](generated_client.ActivityLogApi.md#getlogentries) - -## Constructors - -### constructor - -• **new ActivityLogApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getLogEntries - -▸ **getLogEntries**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ActivityLogEntryQueryResult`](../interfaces/generated_client.ActivityLogEntryQueryResult.md), `any`\>\> - -**`summary`** Gets activity log entries. - -**`throws`** {RequiredError} - -**`memberof`** ActivityLogApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ActivityLogApiGetLogEntriesRequest`](../interfaces/generated_client.ActivityLogApiGetLogEntriesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ActivityLogEntryQueryResult`](../interfaces/generated_client.ActivityLogEntryQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/activity-log-api.ts:186](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/activity-log-api.ts#L186) diff --git a/docs/classes/generated_client.ApiKeyApi.md b/docs/classes/generated_client.ApiKeyApi.md deleted file mode 100644 index 08480f710..000000000 --- a/docs/classes/generated_client.ApiKeyApi.md +++ /dev/null @@ -1,169 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ApiKeyApi - -# Class: ApiKeyApi - -[generated-client](../modules/generated_client.md).ApiKeyApi - -ApiKeyApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ApiKeyApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ApiKeyApi.md#constructor) - -### Properties - -- [axios](generated_client.ApiKeyApi.md#axios) -- [basePath](generated_client.ApiKeyApi.md#basepath) -- [configuration](generated_client.ApiKeyApi.md#configuration) - -### Methods - -- [createKey](generated_client.ApiKeyApi.md#createkey) -- [getKeys](generated_client.ApiKeyApi.md#getkeys) -- [revokeKey](generated_client.ApiKeyApi.md#revokekey) - -## Constructors - -### constructor - -• **new ApiKeyApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### createKey - -▸ **createKey**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Create a new api key. - -**`throws`** {RequiredError} - -**`memberof`** ApiKeyApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ApiKeyApiCreateKeyRequest`](../interfaces/generated_client.ApiKeyApiCreateKeyRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/api-key-api.ts:268](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L268) - -___ - -### getKeys - -▸ **getKeys**(`options?`): `Promise`<`AxiosResponse`<[`AuthenticationInfoQueryResult`](../interfaces/generated_client.AuthenticationInfoQueryResult.md), `any`\>\> - -**`summary`** Get all keys. - -**`throws`** {RequiredError} - -**`memberof`** ApiKeyApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`AuthenticationInfoQueryResult`](../interfaces/generated_client.AuthenticationInfoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/api-key-api.ts:279](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L279) - -___ - -### revokeKey - -▸ **revokeKey**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Remove an api key. - -**`throws`** {RequiredError} - -**`memberof`** ApiKeyApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ApiKeyApiRevokeKeyRequest`](../interfaces/generated_client.ApiKeyApiRevokeKeyRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/api-key-api.ts:291](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L291) diff --git a/docs/classes/generated_client.ArtistsApi.md b/docs/classes/generated_client.ArtistsApi.md deleted file mode 100644 index 435e24847..000000000 --- a/docs/classes/generated_client.ArtistsApi.md +++ /dev/null @@ -1,170 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ArtistsApi - -# Class: ArtistsApi - -[generated-client](../modules/generated_client.md).ArtistsApi - -ArtistsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ArtistsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ArtistsApi.md#constructor) - -### Properties - -- [axios](generated_client.ArtistsApi.md#axios) -- [basePath](generated_client.ArtistsApi.md#basepath) -- [configuration](generated_client.ArtistsApi.md#configuration) - -### Methods - -- [getAlbumArtists](generated_client.ArtistsApi.md#getalbumartists) -- [getArtistByName](generated_client.ArtistsApi.md#getartistbyname) -- [getArtists](generated_client.ArtistsApi.md#getartists) - -## Constructors - -### constructor - -• **new ArtistsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getAlbumArtists - -▸ **getAlbumArtists**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets all album artists from a given item, folder, or the entire library. - -**`throws`** {RequiredError} - -**`memberof`** ArtistsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ArtistsApiGetAlbumArtistsRequest`](../interfaces/generated_client.ArtistsApiGetAlbumArtistsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/artists-api.ts:1181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1181) - -___ - -### getArtistByName - -▸ **getArtistByName**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -**`summary`** Gets an artist by name. - -**`throws`** {RequiredError} - -**`memberof`** ArtistsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ArtistsApiGetArtistByNameRequest`](../interfaces/generated_client.ArtistsApiGetArtistByNameRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/artists-api.ts:1193](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1193) - -___ - -### getArtists - -▸ **getArtists**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets all artists from a given item, folder, or the entire library. - -**`throws`** {RequiredError} - -**`memberof`** ArtistsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ArtistsApiGetArtistsRequest`](../interfaces/generated_client.ArtistsApiGetArtistsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/artists-api.ts:1205](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1205) diff --git a/docs/classes/generated_client.AudioApi.md b/docs/classes/generated_client.AudioApi.md deleted file mode 100644 index e012a58d0..000000000 --- a/docs/classes/generated_client.AudioApi.md +++ /dev/null @@ -1,198 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AudioApi - -# Class: AudioApi - -[generated-client](../modules/generated_client.md).AudioApi - -AudioApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`AudioApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.AudioApi.md#constructor) - -### Properties - -- [axios](generated_client.AudioApi.md#axios) -- [basePath](generated_client.AudioApi.md#basepath) -- [configuration](generated_client.AudioApi.md#configuration) - -### Methods - -- [getAudioStream](generated_client.AudioApi.md#getaudiostream) -- [getAudioStreamByContainer](generated_client.AudioApi.md#getaudiostreambycontainer) -- [headAudioStream](generated_client.AudioApi.md#headaudiostream) -- [headAudioStreamByContainer](generated_client.AudioApi.md#headaudiostreambycontainer) - -## Constructors - -### constructor - -• **new AudioApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getAudioStream - -▸ **getAudioStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets an audio stream. - -**`throws`** {RequiredError} - -**`memberof`** AudioApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`AudioApiGetAudioStreamRequest`](../interfaces/generated_client.AudioApiGetAudioStreamRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/audio-api.ts:3033](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3033) - -___ - -### getAudioStreamByContainer - -▸ **getAudioStreamByContainer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets an audio stream. - -**`throws`** {RequiredError} - -**`memberof`** AudioApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`AudioApiGetAudioStreamByContainerRequest`](../interfaces/generated_client.AudioApiGetAudioStreamByContainerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/audio-api.ts:3045](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3045) - -___ - -### headAudioStream - -▸ **headAudioStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets an audio stream. - -**`throws`** {RequiredError} - -**`memberof`** AudioApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`AudioApiHeadAudioStreamRequest`](../interfaces/generated_client.AudioApiHeadAudioStreamRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/audio-api.ts:3057](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3057) - -___ - -### headAudioStreamByContainer - -▸ **headAudioStreamByContainer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets an audio stream. - -**`throws`** {RequiredError} - -**`memberof`** AudioApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`AudioApiHeadAudioStreamByContainerRequest`](../interfaces/generated_client.AudioApiHeadAudioStreamByContainerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/audio-api.ts:3069](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3069) diff --git a/docs/classes/generated_client.BrandingApi.md b/docs/classes/generated_client.BrandingApi.md deleted file mode 100644 index 55f12c549..000000000 --- a/docs/classes/generated_client.BrandingApi.md +++ /dev/null @@ -1,167 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BrandingApi - -# Class: BrandingApi - -[generated-client](../modules/generated_client.md).BrandingApi - -BrandingApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`BrandingApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.BrandingApi.md#constructor) - -### Properties - -- [axios](generated_client.BrandingApi.md#axios) -- [basePath](generated_client.BrandingApi.md#basepath) -- [configuration](generated_client.BrandingApi.md#configuration) - -### Methods - -- [getBrandingCss](generated_client.BrandingApi.md#getbrandingcss) -- [getBrandingCss2](generated_client.BrandingApi.md#getbrandingcss2) -- [getBrandingOptions](generated_client.BrandingApi.md#getbrandingoptions) - -## Constructors - -### constructor - -• **new BrandingApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getBrandingCss - -▸ **getBrandingCss**(`options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\> - -**`summary`** Gets branding css. - -**`throws`** {RequiredError} - -**`memberof`** BrandingApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`string`, `any`\>\> - -#### Defined in - -[generated-client/api/branding-api.ts:215](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/branding-api.ts#L215) - -___ - -### getBrandingCss2 - -▸ **getBrandingCss2**(`options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\> - -**`summary`** Gets branding css. - -**`throws`** {RequiredError} - -**`memberof`** BrandingApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`string`, `any`\>\> - -#### Defined in - -[generated-client/api/branding-api.ts:226](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/branding-api.ts#L226) - -___ - -### getBrandingOptions - -▸ **getBrandingOptions**(`options?`): `Promise`<`AxiosResponse`<[`BrandingOptions`](../interfaces/generated_client.BrandingOptions.md), `any`\>\> - -**`summary`** Gets branding configuration. - -**`throws`** {RequiredError} - -**`memberof`** BrandingApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`BrandingOptions`](../interfaces/generated_client.BrandingOptions.md), `any`\>\> - -#### Defined in - -[generated-client/api/branding-api.ts:237](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/branding-api.ts#L237) diff --git a/docs/classes/generated_client.ChannelsApi.md b/docs/classes/generated_client.ChannelsApi.md deleted file mode 100644 index df1f7c048..000000000 --- a/docs/classes/generated_client.ChannelsApi.md +++ /dev/null @@ -1,225 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelsApi - -# Class: ChannelsApi - -[generated-client](../modules/generated_client.md).ChannelsApi - -ChannelsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ChannelsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ChannelsApi.md#constructor) - -### Properties - -- [axios](generated_client.ChannelsApi.md#axios) -- [basePath](generated_client.ChannelsApi.md#basepath) -- [configuration](generated_client.ChannelsApi.md#configuration) - -### Methods - -- [getAllChannelFeatures](generated_client.ChannelsApi.md#getallchannelfeatures) -- [getChannelFeatures](generated_client.ChannelsApi.md#getchannelfeatures) -- [getChannelItems](generated_client.ChannelsApi.md#getchannelitems) -- [getChannels](generated_client.ChannelsApi.md#getchannels) -- [getLatestChannelItems](generated_client.ChannelsApi.md#getlatestchannelitems) - -## Constructors - -### constructor - -• **new ChannelsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getAllChannelFeatures - -▸ **getAllChannelFeatures**(`options?`): `Promise`<`AxiosResponse`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md)[], `any`\>\> - -**`summary`** Get all channel features. - -**`throws`** {RequiredError} - -**`memberof`** ChannelsApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/channels-api.ts:670](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L670) - -___ - -### getChannelFeatures - -▸ **getChannelFeatures**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md), `any`\>\> - -**`summary`** Get channel features. - -**`throws`** {RequiredError} - -**`memberof`** ChannelsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ChannelsApiGetChannelFeaturesRequest`](../interfaces/generated_client.ChannelsApiGetChannelFeaturesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md), `any`\>\> - -#### Defined in - -[generated-client/api/channels-api.ts:682](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L682) - -___ - -### getChannelItems - -▸ **getChannelItems**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Get channel items. - -**`throws`** {RequiredError} - -**`memberof`** ChannelsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ChannelsApiGetChannelItemsRequest`](../interfaces/generated_client.ChannelsApiGetChannelItemsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/channels-api.ts:694](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L694) - -___ - -### getChannels - -▸ **getChannels**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets available channels. - -**`throws`** {RequiredError} - -**`memberof`** ChannelsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ChannelsApiGetChannelsRequest`](../interfaces/generated_client.ChannelsApiGetChannelsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/channels-api.ts:706](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L706) - -___ - -### getLatestChannelItems - -▸ **getLatestChannelItems**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets latest channel items. - -**`throws`** {RequiredError} - -**`memberof`** ChannelsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ChannelsApiGetLatestChannelItemsRequest`](../interfaces/generated_client.ChannelsApiGetLatestChannelItemsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/channels-api.ts:718](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L718) diff --git a/docs/classes/generated_client.ClientLogApi.md b/docs/classes/generated_client.ClientLogApi.md deleted file mode 100644 index daf1b6e69..000000000 --- a/docs/classes/generated_client.ClientLogApi.md +++ /dev/null @@ -1,114 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ClientLogApi - -# Class: ClientLogApi - -[generated-client](../modules/generated_client.md).ClientLogApi - -ClientLogApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ClientLogApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ClientLogApi.md#constructor) - -### Properties - -- [axios](generated_client.ClientLogApi.md#axios) -- [basePath](generated_client.ClientLogApi.md#basepath) -- [configuration](generated_client.ClientLogApi.md#configuration) - -### Methods - -- [logFile](generated_client.ClientLogApi.md#logfile) - -## Constructors - -### constructor - -• **new ClientLogApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### logFile - -▸ **logFile**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ClientLogDocumentResponseDto`](../interfaces/generated_client.ClientLogDocumentResponseDto.md), `any`\>\> - -**`summary`** Upload a document. - -**`throws`** {RequiredError} - -**`memberof`** ClientLogApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ClientLogApiLogFileRequest`](../interfaces/generated_client.ClientLogApiLogFileRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ClientLogDocumentResponseDto`](../interfaces/generated_client.ClientLogDocumentResponseDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/client-log-api.ts:143](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/client-log-api.ts#L143) diff --git a/docs/classes/generated_client.CollectionApi.md b/docs/classes/generated_client.CollectionApi.md deleted file mode 100644 index fc9fc1de3..000000000 --- a/docs/classes/generated_client.CollectionApi.md +++ /dev/null @@ -1,170 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CollectionApi - -# Class: CollectionApi - -[generated-client](../modules/generated_client.md).CollectionApi - -CollectionApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`CollectionApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.CollectionApi.md#constructor) - -### Properties - -- [axios](generated_client.CollectionApi.md#axios) -- [basePath](generated_client.CollectionApi.md#basepath) -- [configuration](generated_client.CollectionApi.md#configuration) - -### Methods - -- [addToCollection](generated_client.CollectionApi.md#addtocollection) -- [createCollection](generated_client.CollectionApi.md#createcollection) -- [removeFromCollection](generated_client.CollectionApi.md#removefromcollection) - -## Constructors - -### constructor - -• **new CollectionApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### addToCollection - -▸ **addToCollection**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Adds items to a collection. - -**`throws`** {RequiredError} - -**`memberof`** CollectionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`CollectionApiAddToCollectionRequest`](../interfaces/generated_client.CollectionApiAddToCollectionRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/collection-api.ts:360](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L360) - -___ - -### createCollection - -▸ **createCollection**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`CollectionCreationResult`](../interfaces/generated_client.CollectionCreationResult.md), `any`\>\> - -**`summary`** Creates a new collection. - -**`throws`** {RequiredError} - -**`memberof`** CollectionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`CollectionApiCreateCollectionRequest`](../interfaces/generated_client.CollectionApiCreateCollectionRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`CollectionCreationResult`](../interfaces/generated_client.CollectionCreationResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/collection-api.ts:372](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L372) - -___ - -### removeFromCollection - -▸ **removeFromCollection**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Removes items from a collection. - -**`throws`** {RequiredError} - -**`memberof`** CollectionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`CollectionApiRemoveFromCollectionRequest`](../interfaces/generated_client.CollectionApiRemoveFromCollectionRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/collection-api.ts:384](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L384) diff --git a/docs/classes/generated_client.Configuration.md b/docs/classes/generated_client.Configuration.md deleted file mode 100644 index d18a73a50..000000000 --- a/docs/classes/generated_client.Configuration.md +++ /dev/null @@ -1,178 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / Configuration - -# Class: Configuration - -[generated-client](../modules/generated_client.md).Configuration - -## Table of contents - -### Constructors - -- [constructor](generated_client.Configuration.md#constructor) - -### Properties - -- [accessToken](generated_client.Configuration.md#accesstoken) -- [apiKey](generated_client.Configuration.md#apikey) -- [baseOptions](generated_client.Configuration.md#baseoptions) -- [basePath](generated_client.Configuration.md#basepath) -- [formDataCtor](generated_client.Configuration.md#formdatactor) -- [password](generated_client.Configuration.md#password) -- [username](generated_client.Configuration.md#username) - -### Methods - -- [isJsonMime](generated_client.Configuration.md#isjsonmime) - -## Constructors - -### constructor - -• **new Configuration**(`param?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `param` | [`ConfigurationParameters`](../interfaces/generated_client.ConfigurationParameters.md) | - -#### Defined in - -[generated-client/configuration.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L77) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` \| `Promise`<`string`\> \| (`name?`: `string`, `scopes?`: `string`[]) => `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `Promise`<`string`\> - -parameter for oauth2 security - -**`param`** security name - -**`param`** oauth2 scope - -**`memberof`** Configuration - -#### Defined in - -[generated-client/configuration.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L53) - -___ - -### apiKey - -• `Optional` **apiKey**: `string` \| `Promise`<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`<`string`\> - -parameter for apiKey security - -**`param`** security name - -**`memberof`** Configuration - -#### Defined in - -[generated-client/configuration.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L32) - -___ - -### baseOptions - -• `Optional` **baseOptions**: `any` - -base options for axios calls - -**`memberof`** Configuration - -#### Defined in - -[generated-client/configuration.ts:67](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L67) - -___ - -### basePath - -• `Optional` **basePath**: `string` - -override base path - -**`memberof`** Configuration - -#### Defined in - -[generated-client/configuration.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L60) - -___ - -### formDataCtor - -• `Optional` **formDataCtor**: () => `any` - -#### Type declaration - -• **new Configuration**() - -The FormData constructor that will be used to create multipart form data -requests. You can inject this here so that execution environments that -do not support the FormData class can still run the generated client. - -#### Defined in - -[generated-client/configuration.ts:75](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L75) - -___ - -### password - -• `Optional` **password**: `string` - -parameter for basic security - -**`memberof`** Configuration - -#### Defined in - -[generated-client/configuration.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L46) - -___ - -### username - -• `Optional` **username**: `string` - -parameter for basic security - -**`memberof`** Configuration - -#### Defined in - -[generated-client/configuration.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L39) - -## Methods - -### isJsonMime - -▸ **isJsonMime**(`mime`): `boolean` - -Check if the given MIME is a JSON MIME. -JSON MIME examples: - application/json - application/json; charset=UTF8 - APPLICATION/JSON - application/vnd.company+json - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `mime` | `string` | MIME (Multipurpose Internet Mail Extensions) | - -#### Returns - -`boolean` - -True if the given MIME is JSON, false otherwise. - -#### Defined in - -[generated-client/configuration.ts:97](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L97) diff --git a/docs/classes/generated_client.ConfigurationApi.md b/docs/classes/generated_client.ConfigurationApi.md deleted file mode 100644 index 29dd5bf7c..000000000 --- a/docs/classes/generated_client.ConfigurationApi.md +++ /dev/null @@ -1,252 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ConfigurationApi - -# Class: ConfigurationApi - -[generated-client](../modules/generated_client.md).ConfigurationApi - -ConfigurationApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ConfigurationApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ConfigurationApi.md#constructor) - -### Properties - -- [axios](generated_client.ConfigurationApi.md#axios) -- [basePath](generated_client.ConfigurationApi.md#basepath) -- [configuration](generated_client.ConfigurationApi.md#configuration) - -### Methods - -- [getConfiguration](generated_client.ConfigurationApi.md#getconfiguration) -- [getDefaultMetadataOptions](generated_client.ConfigurationApi.md#getdefaultmetadataoptions) -- [getNamedConfiguration](generated_client.ConfigurationApi.md#getnamedconfiguration) -- [updateConfiguration](generated_client.ConfigurationApi.md#updateconfiguration) -- [updateMediaEncoderPath](generated_client.ConfigurationApi.md#updatemediaencoderpath) -- [updateNamedConfiguration](generated_client.ConfigurationApi.md#updatenamedconfiguration) - -## Constructors - -### constructor - -• **new ConfigurationApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getConfiguration - -▸ **getConfiguration**(`options?`): `Promise`<`AxiosResponse`<[`ServerConfiguration`](../interfaces/generated_client.ServerConfiguration.md), `any`\>\> - -**`summary`** Gets application configuration. - -**`throws`** {RequiredError} - -**`memberof`** ConfigurationApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`ServerConfiguration`](../interfaces/generated_client.ServerConfiguration.md), `any`\>\> - -#### Defined in - -[generated-client/api/configuration-api.ts:483](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L483) - -___ - -### getDefaultMetadataOptions - -▸ **getDefaultMetadataOptions**(`options?`): `Promise`<`AxiosResponse`<[`MetadataOptions`](../interfaces/generated_client.MetadataOptions.md), `any`\>\> - -**`summary`** Gets a default MetadataOptions object. - -**`throws`** {RequiredError} - -**`memberof`** ConfigurationApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`MetadataOptions`](../interfaces/generated_client.MetadataOptions.md), `any`\>\> - -#### Defined in - -[generated-client/api/configuration-api.ts:494](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L494) - -___ - -### getNamedConfiguration - -▸ **getNamedConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a named configuration. - -**`throws`** {RequiredError} - -**`memberof`** ConfigurationApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ConfigurationApiGetNamedConfigurationRequest`](../interfaces/generated_client.ConfigurationApiGetNamedConfigurationRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/configuration-api.ts:506](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L506) - -___ - -### updateConfiguration - -▸ **updateConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates application configuration. - -**`throws`** {RequiredError} - -**`memberof`** ConfigurationApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ConfigurationApiUpdateConfigurationRequest`](../interfaces/generated_client.ConfigurationApiUpdateConfigurationRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/configuration-api.ts:518](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L518) - -___ - -### updateMediaEncoderPath - -▸ **updateMediaEncoderPath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates the path to the media encoder. - -**`throws`** {RequiredError} - -**`memberof`** ConfigurationApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ConfigurationApiUpdateMediaEncoderPathRequest`](../interfaces/generated_client.ConfigurationApiUpdateMediaEncoderPathRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/configuration-api.ts:530](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L530) - -___ - -### updateNamedConfiguration - -▸ **updateNamedConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates named configuration. - -**`throws`** {RequiredError} - -**`memberof`** ConfigurationApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ConfigurationApiUpdateNamedConfigurationRequest`](../interfaces/generated_client.ConfigurationApiUpdateNamedConfigurationRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/configuration-api.ts:542](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L542) diff --git a/docs/classes/generated_client.DashboardApi.md b/docs/classes/generated_client.DashboardApi.md deleted file mode 100644 index e1730d5fa..000000000 --- a/docs/classes/generated_client.DashboardApi.md +++ /dev/null @@ -1,142 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DashboardApi - -# Class: DashboardApi - -[generated-client](../modules/generated_client.md).DashboardApi - -DashboardApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`DashboardApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.DashboardApi.md#constructor) - -### Properties - -- [axios](generated_client.DashboardApi.md#axios) -- [basePath](generated_client.DashboardApi.md#basepath) -- [configuration](generated_client.DashboardApi.md#configuration) - -### Methods - -- [getConfigurationPages](generated_client.DashboardApi.md#getconfigurationpages) -- [getDashboardConfigurationPage](generated_client.DashboardApi.md#getdashboardconfigurationpage) - -## Constructors - -### constructor - -• **new DashboardApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getConfigurationPages - -▸ **getConfigurationPages**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ConfigurationPageInfo`](../interfaces/generated_client.ConfigurationPageInfo.md)[], `any`\>\> - -**`summary`** Gets the configuration pages. - -**`throws`** {RequiredError} - -**`memberof`** DashboardApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DashboardApiGetConfigurationPagesRequest`](../interfaces/generated_client.DashboardApiGetConfigurationPagesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ConfigurationPageInfo`](../interfaces/generated_client.ConfigurationPageInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/dashboard-api.ts:214](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dashboard-api.ts#L214) - -___ - -### getDashboardConfigurationPage - -▸ **getDashboardConfigurationPage**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a dashboard configuration page. - -**`throws`** {RequiredError} - -**`memberof`** DashboardApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DashboardApiGetDashboardConfigurationPageRequest`](../interfaces/generated_client.DashboardApiGetDashboardConfigurationPageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dashboard-api.ts:226](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dashboard-api.ts#L226) diff --git a/docs/classes/generated_client.DevicesApi.md b/docs/classes/generated_client.DevicesApi.md deleted file mode 100644 index 541372f31..000000000 --- a/docs/classes/generated_client.DevicesApi.md +++ /dev/null @@ -1,226 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DevicesApi - -# Class: DevicesApi - -[generated-client](../modules/generated_client.md).DevicesApi - -DevicesApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`DevicesApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.DevicesApi.md#constructor) - -### Properties - -- [axios](generated_client.DevicesApi.md#axios) -- [basePath](generated_client.DevicesApi.md#basepath) -- [configuration](generated_client.DevicesApi.md#configuration) - -### Methods - -- [deleteDevice](generated_client.DevicesApi.md#deletedevice) -- [getDeviceInfo](generated_client.DevicesApi.md#getdeviceinfo) -- [getDeviceOptions](generated_client.DevicesApi.md#getdeviceoptions) -- [getDevices](generated_client.DevicesApi.md#getdevices) -- [updateDeviceOptions](generated_client.DevicesApi.md#updatedeviceoptions) - -## Constructors - -### constructor - -• **new DevicesApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### deleteDevice - -▸ **deleteDevice**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Deletes a device. - -**`throws`** {RequiredError} - -**`memberof`** DevicesApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DevicesApiDeleteDeviceRequest`](../interfaces/generated_client.DevicesApiDeleteDeviceRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/devices-api.ts:479](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L479) - -___ - -### getDeviceInfo - -▸ **getDeviceInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`DeviceInfo`](../interfaces/generated_client.DeviceInfo.md), `any`\>\> - -**`summary`** Get info for a device. - -**`throws`** {RequiredError} - -**`memberof`** DevicesApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DevicesApiGetDeviceInfoRequest`](../interfaces/generated_client.DevicesApiGetDeviceInfoRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`DeviceInfo`](../interfaces/generated_client.DeviceInfo.md), `any`\>\> - -#### Defined in - -[generated-client/api/devices-api.ts:491](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L491) - -___ - -### getDeviceOptions - -▸ **getDeviceOptions**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`DeviceOptions`](../interfaces/generated_client.DeviceOptions.md), `any`\>\> - -**`summary`** Get options for a device. - -**`throws`** {RequiredError} - -**`memberof`** DevicesApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DevicesApiGetDeviceOptionsRequest`](../interfaces/generated_client.DevicesApiGetDeviceOptionsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`DeviceOptions`](../interfaces/generated_client.DeviceOptions.md), `any`\>\> - -#### Defined in - -[generated-client/api/devices-api.ts:503](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L503) - -___ - -### getDevices - -▸ **getDevices**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`DeviceInfoQueryResult`](../interfaces/generated_client.DeviceInfoQueryResult.md), `any`\>\> - -**`summary`** Get Devices. - -**`throws`** {RequiredError} - -**`memberof`** DevicesApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DevicesApiGetDevicesRequest`](../interfaces/generated_client.DevicesApiGetDevicesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`DeviceInfoQueryResult`](../interfaces/generated_client.DeviceInfoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/devices-api.ts:515](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L515) - -___ - -### updateDeviceOptions - -▸ **updateDeviceOptions**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Update device options. - -**`throws`** {RequiredError} - -**`memberof`** DevicesApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DevicesApiUpdateDeviceOptionsRequest`](../interfaces/generated_client.DevicesApiUpdateDeviceOptionsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/devices-api.ts:527](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L527) diff --git a/docs/classes/generated_client.DisplayPreferencesApi.md b/docs/classes/generated_client.DisplayPreferencesApi.md deleted file mode 100644 index 5717faa44..000000000 --- a/docs/classes/generated_client.DisplayPreferencesApi.md +++ /dev/null @@ -1,142 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DisplayPreferencesApi - -# Class: DisplayPreferencesApi - -[generated-client](../modules/generated_client.md).DisplayPreferencesApi - -DisplayPreferencesApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`DisplayPreferencesApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.DisplayPreferencesApi.md#constructor) - -### Properties - -- [axios](generated_client.DisplayPreferencesApi.md#axios) -- [basePath](generated_client.DisplayPreferencesApi.md#basepath) -- [configuration](generated_client.DisplayPreferencesApi.md#configuration) - -### Methods - -- [getDisplayPreferences](generated_client.DisplayPreferencesApi.md#getdisplaypreferences) -- [updateDisplayPreferences](generated_client.DisplayPreferencesApi.md#updatedisplaypreferences) - -## Constructors - -### constructor - -• **new DisplayPreferencesApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getDisplayPreferences - -▸ **getDisplayPreferences**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`DisplayPreferencesDto`](../interfaces/generated_client.DisplayPreferencesDto.md), `any`\>\> - -**`summary`** Get Display Preferences. - -**`throws`** {RequiredError} - -**`memberof`** DisplayPreferencesApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DisplayPreferencesApiGetDisplayPreferencesRequest`](../interfaces/generated_client.DisplayPreferencesApiGetDisplayPreferencesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`DisplayPreferencesDto`](../interfaces/generated_client.DisplayPreferencesDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/display-preferences-api.ts:292](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L292) - -___ - -### updateDisplayPreferences - -▸ **updateDisplayPreferences**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Update Display Preferences. - -**`throws`** {RequiredError} - -**`memberof`** DisplayPreferencesApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DisplayPreferencesApiUpdateDisplayPreferencesRequest`](../interfaces/generated_client.DisplayPreferencesApiUpdateDisplayPreferencesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/display-preferences-api.ts:304](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L304) diff --git a/docs/classes/generated_client.DlnaApi.md b/docs/classes/generated_client.DlnaApi.md deleted file mode 100644 index c54696b1f..000000000 --- a/docs/classes/generated_client.DlnaApi.md +++ /dev/null @@ -1,252 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaApi - -# Class: DlnaApi - -[generated-client](../modules/generated_client.md).DlnaApi - -DlnaApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`DlnaApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.DlnaApi.md#constructor) - -### Properties - -- [axios](generated_client.DlnaApi.md#axios) -- [basePath](generated_client.DlnaApi.md#basepath) -- [configuration](generated_client.DlnaApi.md#configuration) - -### Methods - -- [createProfile](generated_client.DlnaApi.md#createprofile) -- [deleteProfile](generated_client.DlnaApi.md#deleteprofile) -- [getDefaultProfile](generated_client.DlnaApi.md#getdefaultprofile) -- [getProfile](generated_client.DlnaApi.md#getprofile) -- [getProfileInfos](generated_client.DlnaApi.md#getprofileinfos) -- [updateProfile](generated_client.DlnaApi.md#updateprofile) - -## Constructors - -### constructor - -• **new DlnaApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### createProfile - -▸ **createProfile**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Creates a profile. - -**`throws`** {RequiredError} - -**`memberof`** DlnaApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaApiCreateProfileRequest`](../interfaces/generated_client.DlnaApiCreateProfileRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-api.ts:478](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L478) - -___ - -### deleteProfile - -▸ **deleteProfile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Deletes a profile. - -**`throws`** {RequiredError} - -**`memberof`** DlnaApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaApiDeleteProfileRequest`](../interfaces/generated_client.DlnaApiDeleteProfileRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-api.ts:490](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L490) - -___ - -### getDefaultProfile - -▸ **getDefaultProfile**(`options?`): `Promise`<`AxiosResponse`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `any`\>\> - -**`summary`** Gets the default profile. - -**`throws`** {RequiredError} - -**`memberof`** DlnaApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `any`\>\> - -#### Defined in - -[generated-client/api/dlna-api.ts:501](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L501) - -___ - -### getProfile - -▸ **getProfile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `any`\>\> - -**`summary`** Gets a single profile. - -**`throws`** {RequiredError} - -**`memberof`** DlnaApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaApiGetProfileRequest`](../interfaces/generated_client.DlnaApiGetProfileRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `any`\>\> - -#### Defined in - -[generated-client/api/dlna-api.ts:513](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L513) - -___ - -### getProfileInfos - -▸ **getProfileInfos**(`options?`): `Promise`<`AxiosResponse`<[`DeviceProfileInfo`](../interfaces/generated_client.DeviceProfileInfo.md)[], `any`\>\> - -**`summary`** Get profile infos. - -**`throws`** {RequiredError} - -**`memberof`** DlnaApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`DeviceProfileInfo`](../interfaces/generated_client.DeviceProfileInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/dlna-api.ts:524](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L524) - -___ - -### updateProfile - -▸ **updateProfile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates a profile. - -**`throws`** {RequiredError} - -**`memberof`** DlnaApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaApiUpdateProfileRequest`](../interfaces/generated_client.DlnaApiUpdateProfileRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-api.ts:536](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L536) diff --git a/docs/classes/generated_client.DlnaServerApi.md b/docs/classes/generated_client.DlnaServerApi.md deleted file mode 100644 index a39a240e2..000000000 --- a/docs/classes/generated_client.DlnaServerApi.md +++ /dev/null @@ -1,534 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApi - -# Class: DlnaServerApi - -[generated-client](../modules/generated_client.md).DlnaServerApi - -DlnaServerApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`DlnaServerApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.DlnaServerApi.md#constructor) - -### Properties - -- [axios](generated_client.DlnaServerApi.md#axios) -- [basePath](generated_client.DlnaServerApi.md#basepath) -- [configuration](generated_client.DlnaServerApi.md#configuration) - -### Methods - -- [getConnectionManager](generated_client.DlnaServerApi.md#getconnectionmanager) -- [getConnectionManager2](generated_client.DlnaServerApi.md#getconnectionmanager2) -- [getConnectionManager3](generated_client.DlnaServerApi.md#getconnectionmanager3) -- [getContentDirectory](generated_client.DlnaServerApi.md#getcontentdirectory) -- [getContentDirectory2](generated_client.DlnaServerApi.md#getcontentdirectory2) -- [getContentDirectory3](generated_client.DlnaServerApi.md#getcontentdirectory3) -- [getDescriptionXml](generated_client.DlnaServerApi.md#getdescriptionxml) -- [getDescriptionXml2](generated_client.DlnaServerApi.md#getdescriptionxml2) -- [getIcon](generated_client.DlnaServerApi.md#geticon) -- [getIconId](generated_client.DlnaServerApi.md#geticonid) -- [getMediaReceiverRegistrar](generated_client.DlnaServerApi.md#getmediareceiverregistrar) -- [getMediaReceiverRegistrar2](generated_client.DlnaServerApi.md#getmediareceiverregistrar2) -- [getMediaReceiverRegistrar3](generated_client.DlnaServerApi.md#getmediareceiverregistrar3) -- [processConnectionManagerControlRequest](generated_client.DlnaServerApi.md#processconnectionmanagercontrolrequest) -- [processContentDirectoryControlRequest](generated_client.DlnaServerApi.md#processcontentdirectorycontrolrequest) -- [processMediaReceiverRegistrarControlRequest](generated_client.DlnaServerApi.md#processmediareceiverregistrarcontrolrequest) - -## Constructors - -### constructor - -• **new DlnaServerApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getConnectionManager - -▸ **getConnectionManager**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets Dlna media receiver registrar xml. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetConnectionManagerRequest`](../interfaces/generated_client.DlnaServerApiGetConnectionManagerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1234](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1234) - -___ - -### getConnectionManager2 - -▸ **getConnectionManager2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets Dlna media receiver registrar xml. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetConnectionManager2Request`](../interfaces/generated_client.DlnaServerApiGetConnectionManager2Request.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1246](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1246) - -___ - -### getConnectionManager3 - -▸ **getConnectionManager3**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets Dlna media receiver registrar xml. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetConnectionManager3Request`](../interfaces/generated_client.DlnaServerApiGetConnectionManager3Request.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1258](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1258) - -___ - -### getContentDirectory - -▸ **getContentDirectory**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets Dlna content directory xml. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetContentDirectoryRequest`](../interfaces/generated_client.DlnaServerApiGetContentDirectoryRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1270](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1270) - -___ - -### getContentDirectory2 - -▸ **getContentDirectory2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets Dlna content directory xml. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetContentDirectory2Request`](../interfaces/generated_client.DlnaServerApiGetContentDirectory2Request.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1282](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1282) - -___ - -### getContentDirectory3 - -▸ **getContentDirectory3**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets Dlna content directory xml. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetContentDirectory3Request`](../interfaces/generated_client.DlnaServerApiGetContentDirectory3Request.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1294](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1294) - -___ - -### getDescriptionXml - -▸ **getDescriptionXml**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get Description Xml. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetDescriptionXmlRequest`](../interfaces/generated_client.DlnaServerApiGetDescriptionXmlRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1306](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1306) - -___ - -### getDescriptionXml2 - -▸ **getDescriptionXml2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get Description Xml. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetDescriptionXml2Request`](../interfaces/generated_client.DlnaServerApiGetDescriptionXml2Request.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1318](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1318) - -___ - -### getIcon - -▸ **getIcon**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a server icon. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetIconRequest`](../interfaces/generated_client.DlnaServerApiGetIconRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1330](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1330) - -___ - -### getIconId - -▸ **getIconId**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a server icon. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetIconIdRequest`](../interfaces/generated_client.DlnaServerApiGetIconIdRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1342](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1342) - -___ - -### getMediaReceiverRegistrar - -▸ **getMediaReceiverRegistrar**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets Dlna media receiver registrar xml. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetMediaReceiverRegistrarRequest`](../interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrarRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1354](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1354) - -___ - -### getMediaReceiverRegistrar2 - -▸ **getMediaReceiverRegistrar2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets Dlna media receiver registrar xml. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetMediaReceiverRegistrar2Request`](../interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar2Request.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1366](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1366) - -___ - -### getMediaReceiverRegistrar3 - -▸ **getMediaReceiverRegistrar3**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets Dlna media receiver registrar xml. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiGetMediaReceiverRegistrar3Request`](../interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar3Request.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1378](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1378) - -___ - -### processConnectionManagerControlRequest - -▸ **processConnectionManagerControlRequest**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Process a connection manager control request. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiProcessConnectionManagerControlRequestRequest`](../interfaces/generated_client.DlnaServerApiProcessConnectionManagerControlRequestRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1390](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1390) - -___ - -### processContentDirectoryControlRequest - -▸ **processContentDirectoryControlRequest**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Process a content directory control request. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiProcessContentDirectoryControlRequestRequest`](../interfaces/generated_client.DlnaServerApiProcessContentDirectoryControlRequestRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1402](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1402) - -___ - -### processMediaReceiverRegistrarControlRequest - -▸ **processMediaReceiverRegistrarControlRequest**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Process a media receiver registrar control request. - -**`throws`** {RequiredError} - -**`memberof`** DlnaServerApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest`](../interfaces/generated_client.DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1414](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1414) diff --git a/docs/classes/generated_client.DynamicHlsApi.md b/docs/classes/generated_client.DynamicHlsApi.md deleted file mode 100644 index 5606656b0..000000000 --- a/docs/classes/generated_client.DynamicHlsApi.md +++ /dev/null @@ -1,338 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicHlsApi - -# Class: DynamicHlsApi - -[generated-client](../modules/generated_client.md).DynamicHlsApi - -DynamicHlsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`DynamicHlsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.DynamicHlsApi.md#constructor) - -### Properties - -- [axios](generated_client.DynamicHlsApi.md#axios) -- [basePath](generated_client.DynamicHlsApi.md#basepath) -- [configuration](generated_client.DynamicHlsApi.md#configuration) - -### Methods - -- [getHlsAudioSegment](generated_client.DynamicHlsApi.md#gethlsaudiosegment) -- [getHlsVideoSegment](generated_client.DynamicHlsApi.md#gethlsvideosegment) -- [getLiveHlsStream](generated_client.DynamicHlsApi.md#getlivehlsstream) -- [getMasterHlsAudioPlaylist](generated_client.DynamicHlsApi.md#getmasterhlsaudioplaylist) -- [getMasterHlsVideoPlaylist](generated_client.DynamicHlsApi.md#getmasterhlsvideoplaylist) -- [getVariantHlsAudioPlaylist](generated_client.DynamicHlsApi.md#getvarianthlsaudioplaylist) -- [getVariantHlsVideoPlaylist](generated_client.DynamicHlsApi.md#getvarianthlsvideoplaylist) -- [headMasterHlsAudioPlaylist](generated_client.DynamicHlsApi.md#headmasterhlsaudioplaylist) -- [headMasterHlsVideoPlaylist](generated_client.DynamicHlsApi.md#headmasterhlsvideoplaylist) - -## Constructors - -### constructor - -• **new DynamicHlsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getHlsAudioSegment - -▸ **getHlsAudioSegment**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a video stream using HTTP live streaming. - -**`throws`** {RequiredError} - -**`memberof`** DynamicHlsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DynamicHlsApiGetHlsAudioSegmentRequest`](../interfaces/generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7071](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7071) - -___ - -### getHlsVideoSegment - -▸ **getHlsVideoSegment**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a video stream using HTTP live streaming. - -**`throws`** {RequiredError} - -**`memberof`** DynamicHlsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DynamicHlsApiGetHlsVideoSegmentRequest`](../interfaces/generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7083](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7083) - -___ - -### getLiveHlsStream - -▸ **getLiveHlsStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a hls live stream. - -**`throws`** {RequiredError} - -**`memberof`** DynamicHlsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DynamicHlsApiGetLiveHlsStreamRequest`](../interfaces/generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7095](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7095) - -___ - -### getMasterHlsAudioPlaylist - -▸ **getMasterHlsAudioPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets an audio hls playlist stream. - -**`throws`** {RequiredError} - -**`memberof`** DynamicHlsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DynamicHlsApiGetMasterHlsAudioPlaylistRequest`](../interfaces/generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7107](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7107) - -___ - -### getMasterHlsVideoPlaylist - -▸ **getMasterHlsVideoPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a video hls playlist stream. - -**`throws`** {RequiredError} - -**`memberof`** DynamicHlsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DynamicHlsApiGetMasterHlsVideoPlaylistRequest`](../interfaces/generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7119](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7119) - -___ - -### getVariantHlsAudioPlaylist - -▸ **getVariantHlsAudioPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets an audio stream using HTTP live streaming. - -**`throws`** {RequiredError} - -**`memberof`** DynamicHlsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DynamicHlsApiGetVariantHlsAudioPlaylistRequest`](../interfaces/generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7131](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7131) - -___ - -### getVariantHlsVideoPlaylist - -▸ **getVariantHlsVideoPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a video stream using HTTP live streaming. - -**`throws`** {RequiredError} - -**`memberof`** DynamicHlsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DynamicHlsApiGetVariantHlsVideoPlaylistRequest`](../interfaces/generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7143](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7143) - -___ - -### headMasterHlsAudioPlaylist - -▸ **headMasterHlsAudioPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets an audio hls playlist stream. - -**`throws`** {RequiredError} - -**`memberof`** DynamicHlsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DynamicHlsApiHeadMasterHlsAudioPlaylistRequest`](../interfaces/generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7155](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7155) - -___ - -### headMasterHlsVideoPlaylist - -▸ **headMasterHlsVideoPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a video hls playlist stream. - -**`throws`** {RequiredError} - -**`memberof`** DynamicHlsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`DynamicHlsApiHeadMasterHlsVideoPlaylistRequest`](../interfaces/generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7167](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7167) diff --git a/docs/classes/generated_client.EnvironmentApi.md b/docs/classes/generated_client.EnvironmentApi.md deleted file mode 100644 index 3766acbf3..000000000 --- a/docs/classes/generated_client.EnvironmentApi.md +++ /dev/null @@ -1,253 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / EnvironmentApi - -# Class: EnvironmentApi - -[generated-client](../modules/generated_client.md).EnvironmentApi - -EnvironmentApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`EnvironmentApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.EnvironmentApi.md#constructor) - -### Properties - -- [axios](generated_client.EnvironmentApi.md#axios) -- [basePath](generated_client.EnvironmentApi.md#basepath) -- [configuration](generated_client.EnvironmentApi.md#configuration) - -### Methods - -- [getDefaultDirectoryBrowser](generated_client.EnvironmentApi.md#getdefaultdirectorybrowser) -- [getDirectoryContents](generated_client.EnvironmentApi.md#getdirectorycontents) -- [getDrives](generated_client.EnvironmentApi.md#getdrives) -- [getNetworkShares](generated_client.EnvironmentApi.md#getnetworkshares) -- [getParentPath](generated_client.EnvironmentApi.md#getparentpath) -- [validatePath](generated_client.EnvironmentApi.md#validatepath) - -## Constructors - -### constructor - -• **new EnvironmentApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getDefaultDirectoryBrowser - -▸ **getDefaultDirectoryBrowser**(`options?`): `Promise`<`AxiosResponse`<[`DefaultDirectoryBrowserInfoDto`](../interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md), `any`\>\> - -**`summary`** Get Default directory browser. - -**`throws`** {RequiredError} - -**`memberof`** EnvironmentApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`DefaultDirectoryBrowserInfoDto`](../interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/environment-api.ts:485](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L485) - -___ - -### getDirectoryContents - -▸ **getDirectoryContents**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[], `any`\>\> - -**`summary`** Gets the contents of a given directory in the file system. - -**`throws`** {RequiredError} - -**`memberof`** EnvironmentApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`EnvironmentApiGetDirectoryContentsRequest`](../interfaces/generated_client.EnvironmentApiGetDirectoryContentsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/environment-api.ts:497](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L497) - -___ - -### getDrives - -▸ **getDrives**(`options?`): `Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[], `any`\>\> - -**`summary`** Gets available drives from the server\'s file system. - -**`throws`** {RequiredError} - -**`memberof`** EnvironmentApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/environment-api.ts:508](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L508) - -___ - -### getNetworkShares - -▸ **getNetworkShares**(`options?`): `Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[], `any`\>\> - -**`summary`** Gets network paths. - -**`deprecated`** - -**`throws`** {RequiredError} - -**`memberof`** EnvironmentApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/environment-api.ts:520](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L520) - -___ - -### getParentPath - -▸ **getParentPath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\> - -**`summary`** Gets the parent path of a given path. - -**`throws`** {RequiredError} - -**`memberof`** EnvironmentApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`EnvironmentApiGetParentPathRequest`](../interfaces/generated_client.EnvironmentApiGetParentPathRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`string`, `any`\>\> - -#### Defined in - -[generated-client/api/environment-api.ts:532](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L532) - -___ - -### validatePath - -▸ **validatePath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Validates path. - -**`throws`** {RequiredError} - -**`memberof`** EnvironmentApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`EnvironmentApiValidatePathRequest`](../interfaces/generated_client.EnvironmentApiValidatePathRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/environment-api.ts:544](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L544) diff --git a/docs/classes/generated_client.FilterApi.md b/docs/classes/generated_client.FilterApi.md deleted file mode 100644 index ad4173832..000000000 --- a/docs/classes/generated_client.FilterApi.md +++ /dev/null @@ -1,142 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / FilterApi - -# Class: FilterApi - -[generated-client](../modules/generated_client.md).FilterApi - -FilterApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`FilterApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.FilterApi.md#constructor) - -### Properties - -- [axios](generated_client.FilterApi.md#axios) -- [basePath](generated_client.FilterApi.md#basepath) -- [configuration](generated_client.FilterApi.md#configuration) - -### Methods - -- [getQueryFilters](generated_client.FilterApi.md#getqueryfilters) -- [getQueryFiltersLegacy](generated_client.FilterApi.md#getqueryfilterslegacy) - -## Constructors - -### constructor - -• **new FilterApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getQueryFilters - -▸ **getQueryFilters**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`QueryFilters`](../interfaces/generated_client.QueryFilters.md), `any`\>\> - -**`summary`** Gets query filters. - -**`throws`** {RequiredError} - -**`memberof`** FilterApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`FilterApiGetQueryFiltersRequest`](../interfaces/generated_client.FilterApiGetQueryFiltersRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`QueryFilters`](../interfaces/generated_client.QueryFilters.md), `any`\>\> - -#### Defined in - -[generated-client/api/filter-api.ts:387](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L387) - -___ - -### getQueryFiltersLegacy - -▸ **getQueryFiltersLegacy**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`QueryFiltersLegacy`](../interfaces/generated_client.QueryFiltersLegacy.md), `any`\>\> - -**`summary`** Gets legacy query filters. - -**`throws`** {RequiredError} - -**`memberof`** FilterApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`FilterApiGetQueryFiltersLegacyRequest`](../interfaces/generated_client.FilterApiGetQueryFiltersLegacyRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`QueryFiltersLegacy`](../interfaces/generated_client.QueryFiltersLegacy.md), `any`\>\> - -#### Defined in - -[generated-client/api/filter-api.ts:399](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L399) diff --git a/docs/classes/generated_client.GenresApi.md b/docs/classes/generated_client.GenresApi.md deleted file mode 100644 index 56e038bfa..000000000 --- a/docs/classes/generated_client.GenresApi.md +++ /dev/null @@ -1,142 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GenresApi - -# Class: GenresApi - -[generated-client](../modules/generated_client.md).GenresApi - -GenresApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`GenresApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.GenresApi.md#constructor) - -### Properties - -- [axios](generated_client.GenresApi.md#axios) -- [basePath](generated_client.GenresApi.md#basepath) -- [configuration](generated_client.GenresApi.md#configuration) - -### Methods - -- [getGenre](generated_client.GenresApi.md#getgenre) -- [getGenres](generated_client.GenresApi.md#getgenres) - -## Constructors - -### constructor - -• **new GenresApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getGenre - -▸ **getGenre**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -**`summary`** Gets a genre, by name. - -**`throws`** {RequiredError} - -**`memberof`** GenresApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`GenresApiGetGenreRequest`](../interfaces/generated_client.GenresApiGetGenreRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/genres-api.ts:476](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L476) - -___ - -### getGenres - -▸ **getGenres**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets all genres from a given item, folder, or the entire library. - -**`throws`** {RequiredError} - -**`memberof`** GenresApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`GenresApiGetGenresRequest`](../interfaces/generated_client.GenresApiGetGenresRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/genres-api.ts:488](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L488) diff --git a/docs/classes/generated_client.HlsSegmentApi.md b/docs/classes/generated_client.HlsSegmentApi.md deleted file mode 100644 index 5242b2285..000000000 --- a/docs/classes/generated_client.HlsSegmentApi.md +++ /dev/null @@ -1,226 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / HlsSegmentApi - -# Class: HlsSegmentApi - -[generated-client](../modules/generated_client.md).HlsSegmentApi - -HlsSegmentApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`HlsSegmentApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.HlsSegmentApi.md#constructor) - -### Properties - -- [axios](generated_client.HlsSegmentApi.md#axios) -- [basePath](generated_client.HlsSegmentApi.md#basepath) -- [configuration](generated_client.HlsSegmentApi.md#configuration) - -### Methods - -- [getHlsAudioSegmentLegacyAac](generated_client.HlsSegmentApi.md#gethlsaudiosegmentlegacyaac) -- [getHlsAudioSegmentLegacyMp3](generated_client.HlsSegmentApi.md#gethlsaudiosegmentlegacymp3) -- [getHlsPlaylistLegacy](generated_client.HlsSegmentApi.md#gethlsplaylistlegacy) -- [getHlsVideoSegmentLegacy](generated_client.HlsSegmentApi.md#gethlsvideosegmentlegacy) -- [stopEncodingProcess](generated_client.HlsSegmentApi.md#stopencodingprocess) - -## Constructors - -### constructor - -• **new HlsSegmentApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getHlsAudioSegmentLegacyAac - -▸ **getHlsAudioSegmentLegacyAac**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets the specified audio segment for an audio item. - -**`throws`** {RequiredError} - -**`memberof`** HlsSegmentApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest`](../interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/hls-segment-api.ts:517](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L517) - -___ - -### getHlsAudioSegmentLegacyMp3 - -▸ **getHlsAudioSegmentLegacyMp3**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets the specified audio segment for an audio item. - -**`throws`** {RequiredError} - -**`memberof`** HlsSegmentApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request`](../interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/hls-segment-api.ts:529](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L529) - -___ - -### getHlsPlaylistLegacy - -▸ **getHlsPlaylistLegacy**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a hls video playlist. - -**`throws`** {RequiredError} - -**`memberof`** HlsSegmentApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`HlsSegmentApiGetHlsPlaylistLegacyRequest`](../interfaces/generated_client.HlsSegmentApiGetHlsPlaylistLegacyRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/hls-segment-api.ts:541](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L541) - -___ - -### getHlsVideoSegmentLegacy - -▸ **getHlsVideoSegmentLegacy**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a hls video segment. - -**`throws`** {RequiredError} - -**`memberof`** HlsSegmentApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`HlsSegmentApiGetHlsVideoSegmentLegacyRequest`](../interfaces/generated_client.HlsSegmentApiGetHlsVideoSegmentLegacyRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/hls-segment-api.ts:553](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L553) - -___ - -### stopEncodingProcess - -▸ **stopEncodingProcess**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Stops an active encoding. - -**`throws`** {RequiredError} - -**`memberof`** HlsSegmentApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`HlsSegmentApiStopEncodingProcessRequest`](../interfaces/generated_client.HlsSegmentApiStopEncodingProcessRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/hls-segment-api.ts:565](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L565) diff --git a/docs/classes/generated_client.ImageApi.md b/docs/classes/generated_client.ImageApi.md deleted file mode 100644 index 3ab5d25d5..000000000 --- a/docs/classes/generated_client.ImageApi.md +++ /dev/null @@ -1,1233 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApi - -# Class: ImageApi - -[generated-client](../modules/generated_client.md).ImageApi - -ImageApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ImageApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ImageApi.md#constructor) - -### Properties - -- [axios](generated_client.ImageApi.md#axios) -- [basePath](generated_client.ImageApi.md#basepath) -- [configuration](generated_client.ImageApi.md#configuration) - -### Methods - -- [deleteCustomSplashscreen](generated_client.ImageApi.md#deletecustomsplashscreen) -- [deleteItemImage](generated_client.ImageApi.md#deleteitemimage) -- [deleteItemImageByIndex](generated_client.ImageApi.md#deleteitemimagebyindex) -- [deleteUserImage](generated_client.ImageApi.md#deleteuserimage) -- [deleteUserImageByIndex](generated_client.ImageApi.md#deleteuserimagebyindex) -- [getArtistImage](generated_client.ImageApi.md#getartistimage) -- [getGenreImage](generated_client.ImageApi.md#getgenreimage) -- [getGenreImageByIndex](generated_client.ImageApi.md#getgenreimagebyindex) -- [getItemImage](generated_client.ImageApi.md#getitemimage) -- [getItemImage2](generated_client.ImageApi.md#getitemimage2) -- [getItemImageByIndex](generated_client.ImageApi.md#getitemimagebyindex) -- [getItemImageInfos](generated_client.ImageApi.md#getitemimageinfos) -- [getMusicGenreImage](generated_client.ImageApi.md#getmusicgenreimage) -- [getMusicGenreImageByIndex](generated_client.ImageApi.md#getmusicgenreimagebyindex) -- [getPersonImage](generated_client.ImageApi.md#getpersonimage) -- [getPersonImageByIndex](generated_client.ImageApi.md#getpersonimagebyindex) -- [getSplashscreen](generated_client.ImageApi.md#getsplashscreen) -- [getStudioImage](generated_client.ImageApi.md#getstudioimage) -- [getStudioImageByIndex](generated_client.ImageApi.md#getstudioimagebyindex) -- [getUserImage](generated_client.ImageApi.md#getuserimage) -- [getUserImageByIndex](generated_client.ImageApi.md#getuserimagebyindex) -- [headArtistImage](generated_client.ImageApi.md#headartistimage) -- [headGenreImage](generated_client.ImageApi.md#headgenreimage) -- [headGenreImageByIndex](generated_client.ImageApi.md#headgenreimagebyindex) -- [headItemImage](generated_client.ImageApi.md#headitemimage) -- [headItemImage2](generated_client.ImageApi.md#headitemimage2) -- [headItemImageByIndex](generated_client.ImageApi.md#headitemimagebyindex) -- [headMusicGenreImage](generated_client.ImageApi.md#headmusicgenreimage) -- [headMusicGenreImageByIndex](generated_client.ImageApi.md#headmusicgenreimagebyindex) -- [headPersonImage](generated_client.ImageApi.md#headpersonimage) -- [headPersonImageByIndex](generated_client.ImageApi.md#headpersonimagebyindex) -- [headStudioImage](generated_client.ImageApi.md#headstudioimage) -- [headStudioImageByIndex](generated_client.ImageApi.md#headstudioimagebyindex) -- [headUserImage](generated_client.ImageApi.md#headuserimage) -- [headUserImageByIndex](generated_client.ImageApi.md#headuserimagebyindex) -- [postUserImage](generated_client.ImageApi.md#postuserimage) -- [postUserImageByIndex](generated_client.ImageApi.md#postuserimagebyindex) -- [setItemImage](generated_client.ImageApi.md#setitemimage) -- [setItemImageByIndex](generated_client.ImageApi.md#setitemimagebyindex) -- [updateItemImageIndex](generated_client.ImageApi.md#updateitemimageindex) -- [uploadCustomSplashscreen](generated_client.ImageApi.md#uploadcustomsplashscreen) - -## Constructors - -### constructor - -• **new ImageApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### deleteCustomSplashscreen - -▸ **deleteCustomSplashscreen**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Delete a custom splashscreen. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10366](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10366) - -___ - -### deleteItemImage - -▸ **deleteItemImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Delete an item\'s image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiDeleteItemImageRequest`](../interfaces/generated_client.ImageApiDeleteItemImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10378](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10378) - -___ - -### deleteItemImageByIndex - -▸ **deleteItemImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Delete an item\'s image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiDeleteItemImageByIndexRequest`](../interfaces/generated_client.ImageApiDeleteItemImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10390](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10390) - -___ - -### deleteUserImage - -▸ **deleteUserImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Delete the user\'s image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiDeleteUserImageRequest`](../interfaces/generated_client.ImageApiDeleteUserImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10402](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10402) - -___ - -### deleteUserImageByIndex - -▸ **deleteUserImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Delete the user\'s image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiDeleteUserImageByIndexRequest`](../interfaces/generated_client.ImageApiDeleteUserImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10414](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10414) - -___ - -### getArtistImage - -▸ **getArtistImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get artist image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetArtistImageRequest`](../interfaces/generated_client.ImageApiGetArtistImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10426](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10426) - -___ - -### getGenreImage - -▸ **getGenreImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get genre image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetGenreImageRequest`](../interfaces/generated_client.ImageApiGetGenreImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10438](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10438) - -___ - -### getGenreImageByIndex - -▸ **getGenreImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get genre image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetGenreImageByIndexRequest`](../interfaces/generated_client.ImageApiGetGenreImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10450](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10450) - -___ - -### getItemImage - -▸ **getItemImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets the item\'s image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetItemImageRequest`](../interfaces/generated_client.ImageApiGetItemImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10462](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10462) - -___ - -### getItemImage2 - -▸ **getItemImage2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets the item\'s image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetItemImage2Request`](../interfaces/generated_client.ImageApiGetItemImage2Request.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10474](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10474) - -___ - -### getItemImageByIndex - -▸ **getItemImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets the item\'s image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetItemImageByIndexRequest`](../interfaces/generated_client.ImageApiGetItemImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10486](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10486) - -___ - -### getItemImageInfos - -▸ **getItemImageInfos**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ImageInfo`](../interfaces/generated_client.ImageInfo.md)[], `any`\>\> - -**`summary`** Get item image infos. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetItemImageInfosRequest`](../interfaces/generated_client.ImageApiGetItemImageInfosRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ImageInfo`](../interfaces/generated_client.ImageInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10498](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10498) - -___ - -### getMusicGenreImage - -▸ **getMusicGenreImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get music genre image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetMusicGenreImageRequest`](../interfaces/generated_client.ImageApiGetMusicGenreImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10510](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10510) - -___ - -### getMusicGenreImageByIndex - -▸ **getMusicGenreImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get music genre image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetMusicGenreImageByIndexRequest`](../interfaces/generated_client.ImageApiGetMusicGenreImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10522](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10522) - -___ - -### getPersonImage - -▸ **getPersonImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get person image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetPersonImageRequest`](../interfaces/generated_client.ImageApiGetPersonImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10534](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10534) - -___ - -### getPersonImageByIndex - -▸ **getPersonImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get person image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetPersonImageByIndexRequest`](../interfaces/generated_client.ImageApiGetPersonImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10546](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10546) - -___ - -### getSplashscreen - -▸ **getSplashscreen**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Generates or gets the splashscreen. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetSplashscreenRequest`](../interfaces/generated_client.ImageApiGetSplashscreenRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10558](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10558) - -___ - -### getStudioImage - -▸ **getStudioImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get studio image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetStudioImageRequest`](../interfaces/generated_client.ImageApiGetStudioImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10570](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10570) - -___ - -### getStudioImageByIndex - -▸ **getStudioImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get studio image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetStudioImageByIndexRequest`](../interfaces/generated_client.ImageApiGetStudioImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10582](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10582) - -___ - -### getUserImage - -▸ **getUserImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get user profile image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetUserImageRequest`](../interfaces/generated_client.ImageApiGetUserImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10594](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10594) - -___ - -### getUserImageByIndex - -▸ **getUserImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get user profile image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiGetUserImageByIndexRequest`](../interfaces/generated_client.ImageApiGetUserImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10606](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10606) - -___ - -### headArtistImage - -▸ **headArtistImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get artist image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadArtistImageRequest`](../interfaces/generated_client.ImageApiHeadArtistImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10618](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10618) - -___ - -### headGenreImage - -▸ **headGenreImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get genre image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadGenreImageRequest`](../interfaces/generated_client.ImageApiHeadGenreImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10630](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10630) - -___ - -### headGenreImageByIndex - -▸ **headGenreImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get genre image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadGenreImageByIndexRequest`](../interfaces/generated_client.ImageApiHeadGenreImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10642](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10642) - -___ - -### headItemImage - -▸ **headItemImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets the item\'s image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadItemImageRequest`](../interfaces/generated_client.ImageApiHeadItemImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10654](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10654) - -___ - -### headItemImage2 - -▸ **headItemImage2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets the item\'s image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadItemImage2Request`](../interfaces/generated_client.ImageApiHeadItemImage2Request.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10666](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10666) - -___ - -### headItemImageByIndex - -▸ **headItemImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets the item\'s image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadItemImageByIndexRequest`](../interfaces/generated_client.ImageApiHeadItemImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10678](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10678) - -___ - -### headMusicGenreImage - -▸ **headMusicGenreImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get music genre image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadMusicGenreImageRequest`](../interfaces/generated_client.ImageApiHeadMusicGenreImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10690](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10690) - -___ - -### headMusicGenreImageByIndex - -▸ **headMusicGenreImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get music genre image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadMusicGenreImageByIndexRequest`](../interfaces/generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10702](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10702) - -___ - -### headPersonImage - -▸ **headPersonImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get person image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadPersonImageRequest`](../interfaces/generated_client.ImageApiHeadPersonImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10714](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10714) - -___ - -### headPersonImageByIndex - -▸ **headPersonImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get person image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadPersonImageByIndexRequest`](../interfaces/generated_client.ImageApiHeadPersonImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10726](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10726) - -___ - -### headStudioImage - -▸ **headStudioImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get studio image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadStudioImageRequest`](../interfaces/generated_client.ImageApiHeadStudioImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10738](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10738) - -___ - -### headStudioImageByIndex - -▸ **headStudioImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get studio image by name. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadStudioImageByIndexRequest`](../interfaces/generated_client.ImageApiHeadStudioImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10750](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10750) - -___ - -### headUserImage - -▸ **headUserImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get user profile image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadUserImageRequest`](../interfaces/generated_client.ImageApiHeadUserImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10762](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10762) - -___ - -### headUserImageByIndex - -▸ **headUserImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get user profile image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiHeadUserImageByIndexRequest`](../interfaces/generated_client.ImageApiHeadUserImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10774](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10774) - -___ - -### postUserImage - -▸ **postUserImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Sets the user image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiPostUserImageRequest`](../interfaces/generated_client.ImageApiPostUserImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10786](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10786) - -___ - -### postUserImageByIndex - -▸ **postUserImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Sets the user image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiPostUserImageByIndexRequest`](../interfaces/generated_client.ImageApiPostUserImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10798](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10798) - -___ - -### setItemImage - -▸ **setItemImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Set item image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiSetItemImageRequest`](../interfaces/generated_client.ImageApiSetItemImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10810](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10810) - -___ - -### setItemImageByIndex - -▸ **setItemImageByIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Set item image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiSetItemImageByIndexRequest`](../interfaces/generated_client.ImageApiSetItemImageByIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10822](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10822) - -___ - -### updateItemImageIndex - -▸ **updateItemImageIndex**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates the index for an item image. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiUpdateItemImageIndexRequest`](../interfaces/generated_client.ImageApiUpdateItemImageIndexRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10834](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10834) - -___ - -### uploadCustomSplashscreen - -▸ **uploadCustomSplashscreen**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Uploads a custom splashscreen. The body is expected to the image contents base64 encoded. - -**`throws`** {RequiredError} - -**`memberof`** ImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageApiUploadCustomSplashscreenRequest`](../interfaces/generated_client.ImageApiUploadCustomSplashscreenRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/image-api.ts:10846](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10846) diff --git a/docs/classes/generated_client.ImageByNameApi.md b/docs/classes/generated_client.ImageByNameApi.md deleted file mode 100644 index bc5cd7102..000000000 --- a/docs/classes/generated_client.ImageByNameApi.md +++ /dev/null @@ -1,251 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageByNameApi - -# Class: ImageByNameApi - -[generated-client](../modules/generated_client.md).ImageByNameApi - -ImageByNameApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ImageByNameApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ImageByNameApi.md#constructor) - -### Properties - -- [axios](generated_client.ImageByNameApi.md#axios) -- [basePath](generated_client.ImageByNameApi.md#basepath) -- [configuration](generated_client.ImageByNameApi.md#configuration) - -### Methods - -- [getGeneralImage](generated_client.ImageByNameApi.md#getgeneralimage) -- [getGeneralImages](generated_client.ImageByNameApi.md#getgeneralimages) -- [getMediaInfoImage](generated_client.ImageByNameApi.md#getmediainfoimage) -- [getMediaInfoImages](generated_client.ImageByNameApi.md#getmediainfoimages) -- [getRatingImage](generated_client.ImageByNameApi.md#getratingimage) -- [getRatingImages](generated_client.ImageByNameApi.md#getratingimages) - -## Constructors - -### constructor - -• **new ImageByNameApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getGeneralImage - -▸ **getGeneralImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get General Image. - -**`throws`** {RequiredError} - -**`memberof`** ImageByNameApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageByNameApiGetGeneralImageRequest`](../interfaces/generated_client.ImageByNameApiGetGeneralImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-by-name-api.ts:473](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L473) - -___ - -### getGeneralImages - -▸ **getGeneralImages**(`options?`): `Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[], `any`\>\> - -**`summary`** Get all general images. - -**`throws`** {RequiredError} - -**`memberof`** ImageByNameApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/image-by-name-api.ts:484](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L484) - -___ - -### getMediaInfoImage - -▸ **getMediaInfoImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get media info image. - -**`throws`** {RequiredError} - -**`memberof`** ImageByNameApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageByNameApiGetMediaInfoImageRequest`](../interfaces/generated_client.ImageByNameApiGetMediaInfoImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-by-name-api.ts:496](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L496) - -___ - -### getMediaInfoImages - -▸ **getMediaInfoImages**(`options?`): `Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[], `any`\>\> - -**`summary`** Get all media info images. - -**`throws`** {RequiredError} - -**`memberof`** ImageByNameApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/image-by-name-api.ts:507](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L507) - -___ - -### getRatingImage - -▸ **getRatingImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get rating image. - -**`throws`** {RequiredError} - -**`memberof`** ImageByNameApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ImageByNameApiGetRatingImageRequest`](../interfaces/generated_client.ImageByNameApiGetRatingImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/image-by-name-api.ts:519](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L519) - -___ - -### getRatingImages - -▸ **getRatingImages**(`options?`): `Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[], `any`\>\> - -**`summary`** Get all general images. - -**`throws`** {RequiredError} - -**`memberof`** ImageByNameApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/image-by-name-api.ts:530](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L530) diff --git a/docs/classes/generated_client.InstantMixApi.md b/docs/classes/generated_client.InstantMixApi.md deleted file mode 100644 index 1135f2d6a..000000000 --- a/docs/classes/generated_client.InstantMixApi.md +++ /dev/null @@ -1,312 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / InstantMixApi - -# Class: InstantMixApi - -[generated-client](../modules/generated_client.md).InstantMixApi - -InstantMixApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`InstantMixApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.InstantMixApi.md#constructor) - -### Properties - -- [axios](generated_client.InstantMixApi.md#axios) -- [basePath](generated_client.InstantMixApi.md#basepath) -- [configuration](generated_client.InstantMixApi.md#configuration) - -### Methods - -- [getInstantMixFromAlbum](generated_client.InstantMixApi.md#getinstantmixfromalbum) -- [getInstantMixFromArtists](generated_client.InstantMixApi.md#getinstantmixfromartists) -- [getInstantMixFromArtists2](generated_client.InstantMixApi.md#getinstantmixfromartists2) -- [getInstantMixFromItem](generated_client.InstantMixApi.md#getinstantmixfromitem) -- [getInstantMixFromMusicGenreById](generated_client.InstantMixApi.md#getinstantmixfrommusicgenrebyid) -- [getInstantMixFromMusicGenreByName](generated_client.InstantMixApi.md#getinstantmixfrommusicgenrebyname) -- [getInstantMixFromPlaylist](generated_client.InstantMixApi.md#getinstantmixfromplaylist) -- [getInstantMixFromSong](generated_client.InstantMixApi.md#getinstantmixfromsong) - -## Constructors - -### constructor - -• **new InstantMixApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getInstantMixFromAlbum - -▸ **getInstantMixFromAlbum**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Creates an instant playlist based on a given album. - -**`throws`** {RequiredError} - -**`memberof`** InstantMixApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`InstantMixApiGetInstantMixFromAlbumRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1442](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1442) - -___ - -### getInstantMixFromArtists - -▸ **getInstantMixFromArtists**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Creates an instant playlist based on a given artist. - -**`throws`** {RequiredError} - -**`memberof`** InstantMixApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`InstantMixApiGetInstantMixFromArtistsRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1454](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1454) - -___ - -### getInstantMixFromArtists2 - -▸ **getInstantMixFromArtists2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Creates an instant playlist based on a given artist. - -**`deprecated`** - -**`throws`** {RequiredError} - -**`memberof`** InstantMixApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`InstantMixApiGetInstantMixFromArtists2Request`](../interfaces/generated_client.InstantMixApiGetInstantMixFromArtists2Request.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1467](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1467) - -___ - -### getInstantMixFromItem - -▸ **getInstantMixFromItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Creates an instant playlist based on a given item. - -**`throws`** {RequiredError} - -**`memberof`** InstantMixApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`InstantMixApiGetInstantMixFromItemRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1479](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1479) - -___ - -### getInstantMixFromMusicGenreById - -▸ **getInstantMixFromMusicGenreById**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Creates an instant playlist based on a given genre. - -**`throws`** {RequiredError} - -**`memberof`** InstantMixApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`InstantMixApiGetInstantMixFromMusicGenreByIdRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1491](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1491) - -___ - -### getInstantMixFromMusicGenreByName - -▸ **getInstantMixFromMusicGenreByName**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Creates an instant playlist based on a given genre. - -**`throws`** {RequiredError} - -**`memberof`** InstantMixApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`InstantMixApiGetInstantMixFromMusicGenreByNameRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1503](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1503) - -___ - -### getInstantMixFromPlaylist - -▸ **getInstantMixFromPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Creates an instant playlist based on a given playlist. - -**`throws`** {RequiredError} - -**`memberof`** InstantMixApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`InstantMixApiGetInstantMixFromPlaylistRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1515](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1515) - -___ - -### getInstantMixFromSong - -▸ **getInstantMixFromSong**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Creates an instant playlist based on a given song. - -**`throws`** {RequiredError} - -**`memberof`** InstantMixApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`InstantMixApiGetInstantMixFromSongRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromSongRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1527](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1527) diff --git a/docs/classes/generated_client.ItemLookupApi.md b/docs/classes/generated_client.ItemLookupApi.md deleted file mode 100644 index 6a5c7564f..000000000 --- a/docs/classes/generated_client.ItemLookupApi.md +++ /dev/null @@ -1,394 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApi - -# Class: ItemLookupApi - -[generated-client](../modules/generated_client.md).ItemLookupApi - -ItemLookupApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ItemLookupApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ItemLookupApi.md#constructor) - -### Properties - -- [axios](generated_client.ItemLookupApi.md#axios) -- [basePath](generated_client.ItemLookupApi.md#basepath) -- [configuration](generated_client.ItemLookupApi.md#configuration) - -### Methods - -- [applySearchCriteria](generated_client.ItemLookupApi.md#applysearchcriteria) -- [getBookRemoteSearchResults](generated_client.ItemLookupApi.md#getbookremotesearchresults) -- [getBoxSetRemoteSearchResults](generated_client.ItemLookupApi.md#getboxsetremotesearchresults) -- [getExternalIdInfos](generated_client.ItemLookupApi.md#getexternalidinfos) -- [getMovieRemoteSearchResults](generated_client.ItemLookupApi.md#getmovieremotesearchresults) -- [getMusicAlbumRemoteSearchResults](generated_client.ItemLookupApi.md#getmusicalbumremotesearchresults) -- [getMusicArtistRemoteSearchResults](generated_client.ItemLookupApi.md#getmusicartistremotesearchresults) -- [getMusicVideoRemoteSearchResults](generated_client.ItemLookupApi.md#getmusicvideoremotesearchresults) -- [getPersonRemoteSearchResults](generated_client.ItemLookupApi.md#getpersonremotesearchresults) -- [getSeriesRemoteSearchResults](generated_client.ItemLookupApi.md#getseriesremotesearchresults) -- [getTrailerRemoteSearchResults](generated_client.ItemLookupApi.md#gettrailerremotesearchresults) - -## Constructors - -### constructor - -• **new ItemLookupApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### applySearchCriteria - -▸ **applySearchCriteria**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Applies search criteria to an item and refreshes metadata. - -**`throws`** {RequiredError} - -**`memberof`** ItemLookupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemLookupApiApplySearchCriteriaRequest`](../interfaces/generated_client.ItemLookupApiApplySearchCriteriaRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/item-lookup-api.ts:930](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L930) - -___ - -### getBookRemoteSearchResults - -▸ **getBookRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -**`summary`** Get book remote search. - -**`throws`** {RequiredError} - -**`memberof`** ItemLookupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemLookupApiGetBookRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetBookRemoteSearchResultsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/item-lookup-api.ts:942](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L942) - -___ - -### getBoxSetRemoteSearchResults - -▸ **getBoxSetRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -**`summary`** Get box set remote search. - -**`throws`** {RequiredError} - -**`memberof`** ItemLookupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemLookupApiGetBoxSetRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetBoxSetRemoteSearchResultsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/item-lookup-api.ts:954](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L954) - -___ - -### getExternalIdInfos - -▸ **getExternalIdInfos**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ExternalIdInfo`](../interfaces/generated_client.ExternalIdInfo.md)[], `any`\>\> - -**`summary`** Get the item\'s external id info. - -**`throws`** {RequiredError} - -**`memberof`** ItemLookupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemLookupApiGetExternalIdInfosRequest`](../interfaces/generated_client.ItemLookupApiGetExternalIdInfosRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ExternalIdInfo`](../interfaces/generated_client.ExternalIdInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/item-lookup-api.ts:966](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L966) - -___ - -### getMovieRemoteSearchResults - -▸ **getMovieRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -**`summary`** Get movie remote search. - -**`throws`** {RequiredError} - -**`memberof`** ItemLookupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemLookupApiGetMovieRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetMovieRemoteSearchResultsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/item-lookup-api.ts:978](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L978) - -___ - -### getMusicAlbumRemoteSearchResults - -▸ **getMusicAlbumRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -**`summary`** Get music album remote search. - -**`throws`** {RequiredError} - -**`memberof`** ItemLookupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/item-lookup-api.ts:990](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L990) - -___ - -### getMusicArtistRemoteSearchResults - -▸ **getMusicArtistRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -**`summary`** Get music artist remote search. - -**`throws`** {RequiredError} - -**`memberof`** ItemLookupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemLookupApiGetMusicArtistRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetMusicArtistRemoteSearchResultsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/item-lookup-api.ts:1002](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L1002) - -___ - -### getMusicVideoRemoteSearchResults - -▸ **getMusicVideoRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -**`summary`** Get music video remote search. - -**`throws`** {RequiredError} - -**`memberof`** ItemLookupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemLookupApiGetMusicVideoRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetMusicVideoRemoteSearchResultsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/item-lookup-api.ts:1014](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L1014) - -___ - -### getPersonRemoteSearchResults - -▸ **getPersonRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -**`summary`** Get person remote search. - -**`throws`** {RequiredError} - -**`memberof`** ItemLookupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemLookupApiGetPersonRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetPersonRemoteSearchResultsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/item-lookup-api.ts:1026](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L1026) - -___ - -### getSeriesRemoteSearchResults - -▸ **getSeriesRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -**`summary`** Get series remote search. - -**`throws`** {RequiredError} - -**`memberof`** ItemLookupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemLookupApiGetSeriesRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetSeriesRemoteSearchResultsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/item-lookup-api.ts:1038](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L1038) - -___ - -### getTrailerRemoteSearchResults - -▸ **getTrailerRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -**`summary`** Get trailer remote search. - -**`throws`** {RequiredError} - -**`memberof`** ItemLookupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemLookupApiGetTrailerRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetTrailerRemoteSearchResultsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/item-lookup-api.ts:1050](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L1050) diff --git a/docs/classes/generated_client.ItemRefreshApi.md b/docs/classes/generated_client.ItemRefreshApi.md deleted file mode 100644 index d36ac4073..000000000 --- a/docs/classes/generated_client.ItemRefreshApi.md +++ /dev/null @@ -1,114 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemRefreshApi - -# Class: ItemRefreshApi - -[generated-client](../modules/generated_client.md).ItemRefreshApi - -ItemRefreshApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ItemRefreshApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ItemRefreshApi.md#constructor) - -### Properties - -- [axios](generated_client.ItemRefreshApi.md#axios) -- [basePath](generated_client.ItemRefreshApi.md#basepath) -- [configuration](generated_client.ItemRefreshApi.md#configuration) - -### Methods - -- [refreshItem](generated_client.ItemRefreshApi.md#refreshitem) - -## Constructors - -### constructor - -• **new ItemRefreshApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### refreshItem - -▸ **refreshItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Refreshes metadata for an item. - -**`throws`** {RequiredError} - -**`memberof`** ItemRefreshApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemRefreshApiRefreshItemRequest`](../interfaces/generated_client.ItemRefreshApiRefreshItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/item-refresh-api.ts:199](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-refresh-api.ts#L199) diff --git a/docs/classes/generated_client.ItemUpdateApi.md b/docs/classes/generated_client.ItemUpdateApi.md deleted file mode 100644 index 1ff718af2..000000000 --- a/docs/classes/generated_client.ItemUpdateApi.md +++ /dev/null @@ -1,170 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemUpdateApi - -# Class: ItemUpdateApi - -[generated-client](../modules/generated_client.md).ItemUpdateApi - -ItemUpdateApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ItemUpdateApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ItemUpdateApi.md#constructor) - -### Properties - -- [axios](generated_client.ItemUpdateApi.md#axios) -- [basePath](generated_client.ItemUpdateApi.md#basepath) -- [configuration](generated_client.ItemUpdateApi.md#configuration) - -### Methods - -- [getMetadataEditorInfo](generated_client.ItemUpdateApi.md#getmetadataeditorinfo) -- [updateItem](generated_client.ItemUpdateApi.md#updateitem) -- [updateItemContentType](generated_client.ItemUpdateApi.md#updateitemcontenttype) - -## Constructors - -### constructor - -• **new ItemUpdateApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getMetadataEditorInfo - -▸ **getMetadataEditorInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`MetadataEditorInfo`](../interfaces/generated_client.MetadataEditorInfo.md), `any`\>\> - -**`summary`** Gets metadata editor info for an item. - -**`throws`** {RequiredError} - -**`memberof`** ItemUpdateApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemUpdateApiGetMetadataEditorInfoRequest`](../interfaces/generated_client.ItemUpdateApiGetMetadataEditorInfoRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`MetadataEditorInfo`](../interfaces/generated_client.MetadataEditorInfo.md), `any`\>\> - -#### Defined in - -[generated-client/api/item-update-api.ts:318](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L318) - -___ - -### updateItem - -▸ **updateItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates an item. - -**`throws`** {RequiredError} - -**`memberof`** ItemUpdateApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemUpdateApiUpdateItemRequest`](../interfaces/generated_client.ItemUpdateApiUpdateItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/item-update-api.ts:330](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L330) - -___ - -### updateItemContentType - -▸ **updateItemContentType**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates an item\'s content type. - -**`throws`** {RequiredError} - -**`memberof`** ItemUpdateApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemUpdateApiUpdateItemContentTypeRequest`](../interfaces/generated_client.ItemUpdateApiUpdateItemContentTypeRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/item-update-api.ts:342](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L342) diff --git a/docs/classes/generated_client.ItemsApi.md b/docs/classes/generated_client.ItemsApi.md deleted file mode 100644 index e83a383cb..000000000 --- a/docs/classes/generated_client.ItemsApi.md +++ /dev/null @@ -1,170 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemsApi - -# Class: ItemsApi - -[generated-client](../modules/generated_client.md).ItemsApi - -ItemsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ItemsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ItemsApi.md#constructor) - -### Properties - -- [axios](generated_client.ItemsApi.md#axios) -- [basePath](generated_client.ItemsApi.md#basepath) -- [configuration](generated_client.ItemsApi.md#configuration) - -### Methods - -- [getItems](generated_client.ItemsApi.md#getitems) -- [getItemsByUserId](generated_client.ItemsApi.md#getitemsbyuserid) -- [getResumeItems](generated_client.ItemsApi.md#getresumeitems) - -## Constructors - -### constructor - -• **new ItemsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getItems - -▸ **getItems**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets items based on a query. - -**`throws`** {RequiredError} - -**`memberof`** ItemsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemsApiGetItemsRequest`](../interfaces/generated_client.ItemsApiGetItemsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/items-api.ts:2866](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2866) - -___ - -### getItemsByUserId - -▸ **getItemsByUserId**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets items based on a query. - -**`throws`** {RequiredError} - -**`memberof`** ItemsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemsApiGetItemsByUserIdRequest`](../interfaces/generated_client.ItemsApiGetItemsByUserIdRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/items-api.ts:2878](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2878) - -___ - -### getResumeItems - -▸ **getResumeItems**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets items based on a query. - -**`throws`** {RequiredError} - -**`memberof`** ItemsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ItemsApiGetResumeItemsRequest`](../interfaces/generated_client.ItemsApiGetResumeItemsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/items-api.ts:2890](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2890) diff --git a/docs/classes/generated_client.LibraryApi.md b/docs/classes/generated_client.LibraryApi.md deleted file mode 100644 index b963155cc..000000000 --- a/docs/classes/generated_client.LibraryApi.md +++ /dev/null @@ -1,786 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApi - -# Class: LibraryApi - -[generated-client](../modules/generated_client.md).LibraryApi - -LibraryApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`LibraryApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.LibraryApi.md#constructor) - -### Properties - -- [axios](generated_client.LibraryApi.md#axios) -- [basePath](generated_client.LibraryApi.md#basepath) -- [configuration](generated_client.LibraryApi.md#configuration) - -### Methods - -- [deleteItem](generated_client.LibraryApi.md#deleteitem) -- [deleteItems](generated_client.LibraryApi.md#deleteitems) -- [getAncestors](generated_client.LibraryApi.md#getancestors) -- [getCriticReviews](generated_client.LibraryApi.md#getcriticreviews) -- [getDownload](generated_client.LibraryApi.md#getdownload) -- [getFile](generated_client.LibraryApi.md#getfile) -- [getItemCounts](generated_client.LibraryApi.md#getitemcounts) -- [getLibraryOptionsInfo](generated_client.LibraryApi.md#getlibraryoptionsinfo) -- [getMediaFolders](generated_client.LibraryApi.md#getmediafolders) -- [getPhysicalPaths](generated_client.LibraryApi.md#getphysicalpaths) -- [getSimilarAlbums](generated_client.LibraryApi.md#getsimilaralbums) -- [getSimilarArtists](generated_client.LibraryApi.md#getsimilarartists) -- [getSimilarItems](generated_client.LibraryApi.md#getsimilaritems) -- [getSimilarMovies](generated_client.LibraryApi.md#getsimilarmovies) -- [getSimilarShows](generated_client.LibraryApi.md#getsimilarshows) -- [getSimilarTrailers](generated_client.LibraryApi.md#getsimilartrailers) -- [getThemeMedia](generated_client.LibraryApi.md#getthememedia) -- [getThemeSongs](generated_client.LibraryApi.md#getthemesongs) -- [getThemeVideos](generated_client.LibraryApi.md#getthemevideos) -- [postAddedMovies](generated_client.LibraryApi.md#postaddedmovies) -- [postAddedSeries](generated_client.LibraryApi.md#postaddedseries) -- [postUpdatedMedia](generated_client.LibraryApi.md#postupdatedmedia) -- [postUpdatedMovies](generated_client.LibraryApi.md#postupdatedmovies) -- [postUpdatedSeries](generated_client.LibraryApi.md#postupdatedseries) -- [refreshLibrary](generated_client.LibraryApi.md#refreshlibrary) - -## Constructors - -### constructor - -• **new LibraryApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### deleteItem - -▸ **deleteItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Deletes an item from the library and filesystem. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiDeleteItemRequest`](../interfaces/generated_client.LibraryApiDeleteItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2348](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2348) - -___ - -### deleteItems - -▸ **deleteItems**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Deletes items from the library and filesystem. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiDeleteItemsRequest`](../interfaces/generated_client.LibraryApiDeleteItemsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2360](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2360) - -___ - -### getAncestors - -▸ **getAncestors**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\> - -**`summary`** Gets all parents of an item. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetAncestorsRequest`](../interfaces/generated_client.LibraryApiGetAncestorsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2372](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2372) - -___ - -### getCriticReviews - -▸ **getCriticReviews**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets critic review for an item. - -**`deprecated`** - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetCriticReviewsRequest`](../interfaces/generated_client.LibraryApiGetCriticReviewsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2385](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2385) - -___ - -### getDownload - -▸ **getDownload**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Downloads item media. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetDownloadRequest`](../interfaces/generated_client.LibraryApiGetDownloadRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2397](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2397) - -___ - -### getFile - -▸ **getFile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get the original file of an item. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetFileRequest`](../interfaces/generated_client.LibraryApiGetFileRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2409](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2409) - -___ - -### getItemCounts - -▸ **getItemCounts**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ItemCounts`](../interfaces/generated_client.ItemCounts.md), `any`\>\> - -**`summary`** Get item counts. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetItemCountsRequest`](../interfaces/generated_client.LibraryApiGetItemCountsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ItemCounts`](../interfaces/generated_client.ItemCounts.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2421](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2421) - -___ - -### getLibraryOptionsInfo - -▸ **getLibraryOptionsInfo**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`LibraryOptionsResultDto`](../interfaces/generated_client.LibraryOptionsResultDto.md), `any`\>\> - -**`summary`** Gets the library options info. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetLibraryOptionsInfoRequest`](../interfaces/generated_client.LibraryApiGetLibraryOptionsInfoRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`LibraryOptionsResultDto`](../interfaces/generated_client.LibraryOptionsResultDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2433](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2433) - -___ - -### getMediaFolders - -▸ **getMediaFolders**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets all user media folders. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetMediaFoldersRequest`](../interfaces/generated_client.LibraryApiGetMediaFoldersRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2445](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2445) - -___ - -### getPhysicalPaths - -▸ **getPhysicalPaths**(`options?`): `Promise`<`AxiosResponse`<`string`[], `any`\>\> - -**`summary`** Gets a list of physical paths from virtual folders. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`string`[], `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2456](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2456) - -___ - -### getSimilarAlbums - -▸ **getSimilarAlbums**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets similar items. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetSimilarAlbumsRequest`](../interfaces/generated_client.LibraryApiGetSimilarAlbumsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2468](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2468) - -___ - -### getSimilarArtists - -▸ **getSimilarArtists**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets similar items. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetSimilarArtistsRequest`](../interfaces/generated_client.LibraryApiGetSimilarArtistsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2480](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2480) - -___ - -### getSimilarItems - -▸ **getSimilarItems**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets similar items. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetSimilarItemsRequest`](../interfaces/generated_client.LibraryApiGetSimilarItemsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2492](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2492) - -___ - -### getSimilarMovies - -▸ **getSimilarMovies**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets similar items. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetSimilarMoviesRequest`](../interfaces/generated_client.LibraryApiGetSimilarMoviesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2504](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2504) - -___ - -### getSimilarShows - -▸ **getSimilarShows**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets similar items. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetSimilarShowsRequest`](../interfaces/generated_client.LibraryApiGetSimilarShowsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2516](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2516) - -___ - -### getSimilarTrailers - -▸ **getSimilarTrailers**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets similar items. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetSimilarTrailersRequest`](../interfaces/generated_client.LibraryApiGetSimilarTrailersRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2528](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2528) - -___ - -### getThemeMedia - -▸ **getThemeMedia**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`AllThemeMediaResult`](../interfaces/generated_client.AllThemeMediaResult.md), `any`\>\> - -**`summary`** Get theme songs and videos for an item. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetThemeMediaRequest`](../interfaces/generated_client.LibraryApiGetThemeMediaRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`AllThemeMediaResult`](../interfaces/generated_client.AllThemeMediaResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2540](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2540) - -___ - -### getThemeSongs - -▸ **getThemeSongs**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md), `any`\>\> - -**`summary`** Get theme songs for an item. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetThemeSongsRequest`](../interfaces/generated_client.LibraryApiGetThemeSongsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2552](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2552) - -___ - -### getThemeVideos - -▸ **getThemeVideos**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md), `any`\>\> - -**`summary`** Get theme videos for an item. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiGetThemeVideosRequest`](../interfaces/generated_client.LibraryApiGetThemeVideosRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2564](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2564) - -___ - -### postAddedMovies - -▸ **postAddedMovies**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports that new movies have been added by an external source. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiPostAddedMoviesRequest`](../interfaces/generated_client.LibraryApiPostAddedMoviesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2576](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2576) - -___ - -### postAddedSeries - -▸ **postAddedSeries**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports that new episodes of a series have been added by an external source. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiPostAddedSeriesRequest`](../interfaces/generated_client.LibraryApiPostAddedSeriesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2588](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2588) - -___ - -### postUpdatedMedia - -▸ **postUpdatedMedia**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports that new movies have been added by an external source. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiPostUpdatedMediaRequest`](../interfaces/generated_client.LibraryApiPostUpdatedMediaRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2600](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2600) - -___ - -### postUpdatedMovies - -▸ **postUpdatedMovies**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports that new movies have been added by an external source. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiPostUpdatedMoviesRequest`](../interfaces/generated_client.LibraryApiPostUpdatedMoviesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2612](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2612) - -___ - -### postUpdatedSeries - -▸ **postUpdatedSeries**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports that new episodes of a series have been added by an external source. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryApiPostUpdatedSeriesRequest`](../interfaces/generated_client.LibraryApiPostUpdatedSeriesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2624](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2624) - -___ - -### refreshLibrary - -▸ **refreshLibrary**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Starts a library scan. - -**`throws`** {RequiredError} - -**`memberof`** LibraryApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-api.ts:2635](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2635) diff --git a/docs/classes/generated_client.LibraryStructureApi.md b/docs/classes/generated_client.LibraryStructureApi.md deleted file mode 100644 index c14a2514d..000000000 --- a/docs/classes/generated_client.LibraryStructureApi.md +++ /dev/null @@ -1,309 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryStructureApi - -# Class: LibraryStructureApi - -[generated-client](../modules/generated_client.md).LibraryStructureApi - -LibraryStructureApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`LibraryStructureApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.LibraryStructureApi.md#constructor) - -### Properties - -- [axios](generated_client.LibraryStructureApi.md#axios) -- [basePath](generated_client.LibraryStructureApi.md#basepath) -- [configuration](generated_client.LibraryStructureApi.md#configuration) - -### Methods - -- [addMediaPath](generated_client.LibraryStructureApi.md#addmediapath) -- [addVirtualFolder](generated_client.LibraryStructureApi.md#addvirtualfolder) -- [getVirtualFolders](generated_client.LibraryStructureApi.md#getvirtualfolders) -- [removeMediaPath](generated_client.LibraryStructureApi.md#removemediapath) -- [removeVirtualFolder](generated_client.LibraryStructureApi.md#removevirtualfolder) -- [renameVirtualFolder](generated_client.LibraryStructureApi.md#renamevirtualfolder) -- [updateLibraryOptions](generated_client.LibraryStructureApi.md#updatelibraryoptions) -- [updateMediaPath](generated_client.LibraryStructureApi.md#updatemediapath) - -## Constructors - -### constructor - -• **new LibraryStructureApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### addMediaPath - -▸ **addMediaPath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Add a media path to a library. - -**`throws`** {RequiredError} - -**`memberof`** LibraryStructureApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryStructureApiAddMediaPathRequest`](../interfaces/generated_client.LibraryStructureApiAddMediaPathRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-structure-api.ts:784](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L784) - -___ - -### addVirtualFolder - -▸ **addVirtualFolder**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Adds a virtual folder. - -**`throws`** {RequiredError} - -**`memberof`** LibraryStructureApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryStructureApiAddVirtualFolderRequest`](../interfaces/generated_client.LibraryStructureApiAddVirtualFolderRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-structure-api.ts:796](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L796) - -___ - -### getVirtualFolders - -▸ **getVirtualFolders**(`options?`): `Promise`<`AxiosResponse`<[`VirtualFolderInfo`](../interfaces/generated_client.VirtualFolderInfo.md)[], `any`\>\> - -**`summary`** Gets all virtual folders. - -**`throws`** {RequiredError} - -**`memberof`** LibraryStructureApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`VirtualFolderInfo`](../interfaces/generated_client.VirtualFolderInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/library-structure-api.ts:807](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L807) - -___ - -### removeMediaPath - -▸ **removeMediaPath**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Remove a media path. - -**`throws`** {RequiredError} - -**`memberof`** LibraryStructureApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryStructureApiRemoveMediaPathRequest`](../interfaces/generated_client.LibraryStructureApiRemoveMediaPathRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-structure-api.ts:819](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L819) - -___ - -### removeVirtualFolder - -▸ **removeVirtualFolder**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Removes a virtual folder. - -**`throws`** {RequiredError} - -**`memberof`** LibraryStructureApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryStructureApiRemoveVirtualFolderRequest`](../interfaces/generated_client.LibraryStructureApiRemoveVirtualFolderRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-structure-api.ts:831](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L831) - -___ - -### renameVirtualFolder - -▸ **renameVirtualFolder**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Renames a virtual folder. - -**`throws`** {RequiredError} - -**`memberof`** LibraryStructureApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryStructureApiRenameVirtualFolderRequest`](../interfaces/generated_client.LibraryStructureApiRenameVirtualFolderRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-structure-api.ts:843](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L843) - -___ - -### updateLibraryOptions - -▸ **updateLibraryOptions**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Update library options. - -**`throws`** {RequiredError} - -**`memberof`** LibraryStructureApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryStructureApiUpdateLibraryOptionsRequest`](../interfaces/generated_client.LibraryStructureApiUpdateLibraryOptionsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-structure-api.ts:855](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L855) - -___ - -### updateMediaPath - -▸ **updateMediaPath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates a media path. - -**`throws`** {RequiredError} - -**`memberof`** LibraryStructureApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LibraryStructureApiUpdateMediaPathRequest`](../interfaces/generated_client.LibraryStructureApiUpdateMediaPathRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/library-structure-api.ts:867](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L867) diff --git a/docs/classes/generated_client.LiveTvApi.md b/docs/classes/generated_client.LiveTvApi.md deleted file mode 100644 index e5921c7a5..000000000 --- a/docs/classes/generated_client.LiveTvApi.md +++ /dev/null @@ -1,1235 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApi - -# Class: LiveTvApi - -[generated-client](../modules/generated_client.md).LiveTvApi - -LiveTvApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`LiveTvApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.LiveTvApi.md#constructor) - -### Properties - -- [axios](generated_client.LiveTvApi.md#axios) -- [basePath](generated_client.LiveTvApi.md#basepath) -- [configuration](generated_client.LiveTvApi.md#configuration) - -### Methods - -- [addListingProvider](generated_client.LiveTvApi.md#addlistingprovider) -- [addTunerHost](generated_client.LiveTvApi.md#addtunerhost) -- [cancelSeriesTimer](generated_client.LiveTvApi.md#cancelseriestimer) -- [cancelTimer](generated_client.LiveTvApi.md#canceltimer) -- [createSeriesTimer](generated_client.LiveTvApi.md#createseriestimer) -- [createTimer](generated_client.LiveTvApi.md#createtimer) -- [deleteListingProvider](generated_client.LiveTvApi.md#deletelistingprovider) -- [deleteRecording](generated_client.LiveTvApi.md#deleterecording) -- [deleteTunerHost](generated_client.LiveTvApi.md#deletetunerhost) -- [discoverTuners](generated_client.LiveTvApi.md#discovertuners) -- [discvoverTuners](generated_client.LiveTvApi.md#discvovertuners) -- [getChannel](generated_client.LiveTvApi.md#getchannel) -- [getChannelMappingOptions](generated_client.LiveTvApi.md#getchannelmappingoptions) -- [getDefaultListingProvider](generated_client.LiveTvApi.md#getdefaultlistingprovider) -- [getDefaultTimer](generated_client.LiveTvApi.md#getdefaulttimer) -- [getGuideInfo](generated_client.LiveTvApi.md#getguideinfo) -- [getLineups](generated_client.LiveTvApi.md#getlineups) -- [getLiveRecordingFile](generated_client.LiveTvApi.md#getliverecordingfile) -- [getLiveStreamFile](generated_client.LiveTvApi.md#getlivestreamfile) -- [getLiveTvChannels](generated_client.LiveTvApi.md#getlivetvchannels) -- [getLiveTvInfo](generated_client.LiveTvApi.md#getlivetvinfo) -- [getLiveTvPrograms](generated_client.LiveTvApi.md#getlivetvprograms) -- [getProgram](generated_client.LiveTvApi.md#getprogram) -- [getPrograms](generated_client.LiveTvApi.md#getprograms) -- [getRecommendedPrograms](generated_client.LiveTvApi.md#getrecommendedprograms) -- [getRecording](generated_client.LiveTvApi.md#getrecording) -- [getRecordingFolders](generated_client.LiveTvApi.md#getrecordingfolders) -- [getRecordingGroup](generated_client.LiveTvApi.md#getrecordinggroup) -- [getRecordingGroups](generated_client.LiveTvApi.md#getrecordinggroups) -- [getRecordings](generated_client.LiveTvApi.md#getrecordings) -- [getRecordingsSeries](generated_client.LiveTvApi.md#getrecordingsseries) -- [getSchedulesDirectCountries](generated_client.LiveTvApi.md#getschedulesdirectcountries) -- [getSeriesTimer](generated_client.LiveTvApi.md#getseriestimer) -- [getSeriesTimers](generated_client.LiveTvApi.md#getseriestimers) -- [getTimer](generated_client.LiveTvApi.md#gettimer) -- [getTimers](generated_client.LiveTvApi.md#gettimers) -- [getTunerHostTypes](generated_client.LiveTvApi.md#gettunerhosttypes) -- [resetTuner](generated_client.LiveTvApi.md#resettuner) -- [setChannelMapping](generated_client.LiveTvApi.md#setchannelmapping) -- [updateSeriesTimer](generated_client.LiveTvApi.md#updateseriestimer) -- [updateTimer](generated_client.LiveTvApi.md#updatetimer) - -## Constructors - -### constructor - -• **new LiveTvApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### addListingProvider - -▸ **addListingProvider**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ListingsProviderInfo`](../interfaces/generated_client.ListingsProviderInfo.md), `any`\>\> - -**`summary`** Adds a listings provider. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiAddListingProviderRequest`](../interfaces/generated_client.LiveTvApiAddListingProviderRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ListingsProviderInfo`](../interfaces/generated_client.ListingsProviderInfo.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4499](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4499) - -___ - -### addTunerHost - -▸ **addTunerHost**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md), `any`\>\> - -**`summary`** Adds a tuner host. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiAddTunerHostRequest`](../interfaces/generated_client.LiveTvApiAddTunerHostRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4511](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4511) - -___ - -### cancelSeriesTimer - -▸ **cancelSeriesTimer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Cancels a live tv series timer. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiCancelSeriesTimerRequest`](../interfaces/generated_client.LiveTvApiCancelSeriesTimerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4523](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4523) - -___ - -### cancelTimer - -▸ **cancelTimer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Cancels a live tv timer. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiCancelTimerRequest`](../interfaces/generated_client.LiveTvApiCancelTimerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4535](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4535) - -___ - -### createSeriesTimer - -▸ **createSeriesTimer**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Creates a live tv series timer. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiCreateSeriesTimerRequest`](../interfaces/generated_client.LiveTvApiCreateSeriesTimerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4547](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4547) - -___ - -### createTimer - -▸ **createTimer**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Creates a live tv timer. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiCreateTimerRequest`](../interfaces/generated_client.LiveTvApiCreateTimerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4559](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4559) - -___ - -### deleteListingProvider - -▸ **deleteListingProvider**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Delete listing provider. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiDeleteListingProviderRequest`](../interfaces/generated_client.LiveTvApiDeleteListingProviderRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4571](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4571) - -___ - -### deleteRecording - -▸ **deleteRecording**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Deletes a live tv recording. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiDeleteRecordingRequest`](../interfaces/generated_client.LiveTvApiDeleteRecordingRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4583](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4583) - -___ - -### deleteTunerHost - -▸ **deleteTunerHost**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Deletes a tuner host. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiDeleteTunerHostRequest`](../interfaces/generated_client.LiveTvApiDeleteTunerHostRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4595](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4595) - -___ - -### discoverTuners - -▸ **discoverTuners**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md)[], `any`\>\> - -**`summary`** Discover tuners. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiDiscoverTunersRequest`](../interfaces/generated_client.LiveTvApiDiscoverTunersRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4607](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4607) - -___ - -### discvoverTuners - -▸ **discvoverTuners**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md)[], `any`\>\> - -**`summary`** Discover tuners. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiDiscvoverTunersRequest`](../interfaces/generated_client.LiveTvApiDiscvoverTunersRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4619](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4619) - -___ - -### getChannel - -▸ **getChannel**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -**`summary`** Gets a live tv channel. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetChannelRequest`](../interfaces/generated_client.LiveTvApiGetChannelRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4631](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4631) - -___ - -### getChannelMappingOptions - -▸ **getChannelMappingOptions**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ChannelMappingOptionsDto`](../interfaces/generated_client.ChannelMappingOptionsDto.md), `any`\>\> - -**`summary`** Get channel mapping options. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetChannelMappingOptionsRequest`](../interfaces/generated_client.LiveTvApiGetChannelMappingOptionsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ChannelMappingOptionsDto`](../interfaces/generated_client.ChannelMappingOptionsDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4643](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4643) - -___ - -### getDefaultListingProvider - -▸ **getDefaultListingProvider**(`options?`): `Promise`<`AxiosResponse`<[`ListingsProviderInfo`](../interfaces/generated_client.ListingsProviderInfo.md), `any`\>\> - -**`summary`** Gets default listings provider info. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`ListingsProviderInfo`](../interfaces/generated_client.ListingsProviderInfo.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4654](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4654) - -___ - -### getDefaultTimer - -▸ **getDefaultTimer**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md), `any`\>\> - -**`summary`** Gets the default values for a new timer. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetDefaultTimerRequest`](../interfaces/generated_client.LiveTvApiGetDefaultTimerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4666](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4666) - -___ - -### getGuideInfo - -▸ **getGuideInfo**(`options?`): `Promise`<`AxiosResponse`<[`GuideInfo`](../interfaces/generated_client.GuideInfo.md), `any`\>\> - -**`summary`** Get guid info. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`GuideInfo`](../interfaces/generated_client.GuideInfo.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4677](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4677) - -___ - -### getLineups - -▸ **getLineups**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\> - -**`summary`** Gets available lineups. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetLineupsRequest`](../interfaces/generated_client.LiveTvApiGetLineupsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4689](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4689) - -___ - -### getLiveRecordingFile - -▸ **getLiveRecordingFile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a live tv recording stream. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetLiveRecordingFileRequest`](../interfaces/generated_client.LiveTvApiGetLiveRecordingFileRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4701](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4701) - -___ - -### getLiveStreamFile - -▸ **getLiveStreamFile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a live tv channel stream. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetLiveStreamFileRequest`](../interfaces/generated_client.LiveTvApiGetLiveStreamFileRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4713](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4713) - -___ - -### getLiveTvChannels - -▸ **getLiveTvChannels**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets available live tv channels. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetLiveTvChannelsRequest`](../interfaces/generated_client.LiveTvApiGetLiveTvChannelsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4725](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4725) - -___ - -### getLiveTvInfo - -▸ **getLiveTvInfo**(`options?`): `Promise`<`AxiosResponse`<[`LiveTvInfo`](../interfaces/generated_client.LiveTvInfo.md), `any`\>\> - -**`summary`** Gets available live tv services. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`LiveTvInfo`](../interfaces/generated_client.LiveTvInfo.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4736](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4736) - -___ - -### getLiveTvPrograms - -▸ **getLiveTvPrograms**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets available live tv epgs. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetLiveTvProgramsRequest`](../interfaces/generated_client.LiveTvApiGetLiveTvProgramsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4748](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4748) - -___ - -### getProgram - -▸ **getProgram**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -**`summary`** Gets a live tv program. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetProgramRequest`](../interfaces/generated_client.LiveTvApiGetProgramRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4760](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4760) - -___ - -### getPrograms - -▸ **getPrograms**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets available live tv epgs. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetProgramsRequest`](../interfaces/generated_client.LiveTvApiGetProgramsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4772](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4772) - -___ - -### getRecommendedPrograms - -▸ **getRecommendedPrograms**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets recommended live tv epgs. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetRecommendedProgramsRequest`](../interfaces/generated_client.LiveTvApiGetRecommendedProgramsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4784](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4784) - -___ - -### getRecording - -▸ **getRecording**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -**`summary`** Gets a live tv recording. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetRecordingRequest`](../interfaces/generated_client.LiveTvApiGetRecordingRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4796](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4796) - -___ - -### getRecordingFolders - -▸ **getRecordingFolders**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets recording folders. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetRecordingFoldersRequest`](../interfaces/generated_client.LiveTvApiGetRecordingFoldersRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4808](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4808) - -___ - -### getRecordingGroup - -▸ **getRecordingGroup**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Get recording group. - -**`deprecated`** - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetRecordingGroupRequest`](../interfaces/generated_client.LiveTvApiGetRecordingGroupRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4821](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4821) - -___ - -### getRecordingGroups - -▸ **getRecordingGroups**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets live tv recording groups. - -**`deprecated`** - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetRecordingGroupsRequest`](../interfaces/generated_client.LiveTvApiGetRecordingGroupsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4834](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4834) - -___ - -### getRecordings - -▸ **getRecordings**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets live tv recordings. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetRecordingsRequest`](../interfaces/generated_client.LiveTvApiGetRecordingsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4846](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4846) - -___ - -### getRecordingsSeries - -▸ **getRecordingsSeries**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets live tv recording series. - -**`deprecated`** - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetRecordingsSeriesRequest`](../interfaces/generated_client.LiveTvApiGetRecordingsSeriesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4859](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4859) - -___ - -### getSchedulesDirectCountries - -▸ **getSchedulesDirectCountries**(`options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets available countries. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4870](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4870) - -___ - -### getSeriesTimer - -▸ **getSeriesTimer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md), `any`\>\> - -**`summary`** Gets a live tv series timer. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetSeriesTimerRequest`](../interfaces/generated_client.LiveTvApiGetSeriesTimerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4882](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4882) - -___ - -### getSeriesTimers - -▸ **getSeriesTimers**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`SeriesTimerInfoDtoQueryResult`](../interfaces/generated_client.SeriesTimerInfoDtoQueryResult.md), `any`\>\> - -**`summary`** Gets live tv series timers. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetSeriesTimersRequest`](../interfaces/generated_client.LiveTvApiGetSeriesTimersRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`SeriesTimerInfoDtoQueryResult`](../interfaces/generated_client.SeriesTimerInfoDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4894](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4894) - -___ - -### getTimer - -▸ **getTimer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`TimerInfoDto`](../interfaces/generated_client.TimerInfoDto.md), `any`\>\> - -**`summary`** Gets a timer. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetTimerRequest`](../interfaces/generated_client.LiveTvApiGetTimerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`TimerInfoDto`](../interfaces/generated_client.TimerInfoDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4906](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4906) - -___ - -### getTimers - -▸ **getTimers**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`TimerInfoDtoQueryResult`](../interfaces/generated_client.TimerInfoDtoQueryResult.md), `any`\>\> - -**`summary`** Gets the live tv timers. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiGetTimersRequest`](../interfaces/generated_client.LiveTvApiGetTimersRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`TimerInfoDtoQueryResult`](../interfaces/generated_client.TimerInfoDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4918](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4918) - -___ - -### getTunerHostTypes - -▸ **getTunerHostTypes**(`options?`): `Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\> - -**`summary`** Get tuner host types. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4929](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4929) - -___ - -### resetTuner - -▸ **resetTuner**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Resets a tv tuner. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiResetTunerRequest`](../interfaces/generated_client.LiveTvApiResetTunerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4941](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4941) - -___ - -### setChannelMapping - -▸ **setChannelMapping**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`TunerChannelMapping`](../interfaces/generated_client.TunerChannelMapping.md), `any`\>\> - -**`summary`** Set channel mappings. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiSetChannelMappingRequest`](../interfaces/generated_client.LiveTvApiSetChannelMappingRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`TunerChannelMapping`](../interfaces/generated_client.TunerChannelMapping.md), `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4953](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4953) - -___ - -### updateSeriesTimer - -▸ **updateSeriesTimer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates a live tv series timer. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiUpdateSeriesTimerRequest`](../interfaces/generated_client.LiveTvApiUpdateSeriesTimerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4965](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4965) - -___ - -### updateTimer - -▸ **updateTimer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates a live tv timer. - -**`throws`** {RequiredError} - -**`memberof`** LiveTvApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`LiveTvApiUpdateTimerRequest`](../interfaces/generated_client.LiveTvApiUpdateTimerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/live-tv-api.ts:4977](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4977) diff --git a/docs/classes/generated_client.LocalizationApi.md b/docs/classes/generated_client.LocalizationApi.md deleted file mode 100644 index 1628b0c29..000000000 --- a/docs/classes/generated_client.LocalizationApi.md +++ /dev/null @@ -1,194 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LocalizationApi - -# Class: LocalizationApi - -[generated-client](../modules/generated_client.md).LocalizationApi - -LocalizationApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`LocalizationApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.LocalizationApi.md#constructor) - -### Properties - -- [axios](generated_client.LocalizationApi.md#axios) -- [basePath](generated_client.LocalizationApi.md#basepath) -- [configuration](generated_client.LocalizationApi.md#configuration) - -### Methods - -- [getCountries](generated_client.LocalizationApi.md#getcountries) -- [getCultures](generated_client.LocalizationApi.md#getcultures) -- [getLocalizationOptions](generated_client.LocalizationApi.md#getlocalizationoptions) -- [getParentalRatings](generated_client.LocalizationApi.md#getparentalratings) - -## Constructors - -### constructor - -• **new LocalizationApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getCountries - -▸ **getCountries**(`options?`): `Promise`<`AxiosResponse`<[`CountryInfo`](../interfaces/generated_client.CountryInfo.md)[], `any`\>\> - -**`summary`** Gets known countries. - -**`throws`** {RequiredError} - -**`memberof`** LocalizationApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`CountryInfo`](../interfaces/generated_client.CountryInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/localization-api.ts:282](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/localization-api.ts#L282) - -___ - -### getCultures - -▸ **getCultures**(`options?`): `Promise`<`AxiosResponse`<[`CultureDto`](../interfaces/generated_client.CultureDto.md)[], `any`\>\> - -**`summary`** Gets known cultures. - -**`throws`** {RequiredError} - -**`memberof`** LocalizationApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`CultureDto`](../interfaces/generated_client.CultureDto.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/localization-api.ts:293](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/localization-api.ts#L293) - -___ - -### getLocalizationOptions - -▸ **getLocalizationOptions**(`options?`): `Promise`<`AxiosResponse`<[`LocalizationOption`](../interfaces/generated_client.LocalizationOption.md)[], `any`\>\> - -**`summary`** Gets localization options. - -**`throws`** {RequiredError} - -**`memberof`** LocalizationApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`LocalizationOption`](../interfaces/generated_client.LocalizationOption.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/localization-api.ts:304](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/localization-api.ts#L304) - -___ - -### getParentalRatings - -▸ **getParentalRatings**(`options?`): `Promise`<`AxiosResponse`<[`ParentalRating`](../interfaces/generated_client.ParentalRating.md)[], `any`\>\> - -**`summary`** Gets known parental ratings. - -**`throws`** {RequiredError} - -**`memberof`** LocalizationApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`ParentalRating`](../interfaces/generated_client.ParentalRating.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/localization-api.ts:315](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/localization-api.ts#L315) diff --git a/docs/classes/generated_client.MediaInfoApi.md b/docs/classes/generated_client.MediaInfoApi.md deleted file mode 100644 index e0748f76d..000000000 --- a/docs/classes/generated_client.MediaInfoApi.md +++ /dev/null @@ -1,228 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaInfoApi - -# Class: MediaInfoApi - -[generated-client](../modules/generated_client.md).MediaInfoApi - -MediaInfoApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`MediaInfoApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.MediaInfoApi.md#constructor) - -### Properties - -- [axios](generated_client.MediaInfoApi.md#axios) -- [basePath](generated_client.MediaInfoApi.md#basepath) -- [configuration](generated_client.MediaInfoApi.md#configuration) - -### Methods - -- [closeLiveStream](generated_client.MediaInfoApi.md#closelivestream) -- [getBitrateTestBytes](generated_client.MediaInfoApi.md#getbitratetestbytes) -- [getPlaybackInfo](generated_client.MediaInfoApi.md#getplaybackinfo) -- [getPostedPlaybackInfo](generated_client.MediaInfoApi.md#getpostedplaybackinfo) -- [openLiveStream](generated_client.MediaInfoApi.md#openlivestream) - -## Constructors - -### constructor - -• **new MediaInfoApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### closeLiveStream - -▸ **closeLiveStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Closes a media source. - -**`throws`** {RequiredError} - -**`memberof`** MediaInfoApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`MediaInfoApiCloseLiveStreamRequest`](../interfaces/generated_client.MediaInfoApiCloseLiveStreamRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/media-info-api.ts:818](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L818) - -___ - -### getBitrateTestBytes - -▸ **getBitrateTestBytes**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Tests the network with a request with the size of the bitrate. - -**`throws`** {RequiredError} - -**`memberof`** MediaInfoApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`MediaInfoApiGetBitrateTestBytesRequest`](../interfaces/generated_client.MediaInfoApiGetBitrateTestBytesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/media-info-api.ts:830](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L830) - -___ - -### getPlaybackInfo - -▸ **getPlaybackInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md), `any`\>\> - -**`summary`** Gets live playback media info for an item. - -**`throws`** {RequiredError} - -**`memberof`** MediaInfoApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`MediaInfoApiGetPlaybackInfoRequest`](../interfaces/generated_client.MediaInfoApiGetPlaybackInfoRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md), `any`\>\> - -#### Defined in - -[generated-client/api/media-info-api.ts:842](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L842) - -___ - -### getPostedPlaybackInfo - -▸ **getPostedPlaybackInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md), `any`\>\> - -For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete. - -**`summary`** Gets live playback media info for an item. - -**`throws`** {RequiredError} - -**`memberof`** MediaInfoApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`MediaInfoApiGetPostedPlaybackInfoRequest`](../interfaces/generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md), `any`\>\> - -#### Defined in - -[generated-client/api/media-info-api.ts:854](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L854) - -___ - -### openLiveStream - -▸ **openLiveStream**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`LiveStreamResponse`](../interfaces/generated_client.LiveStreamResponse.md), `any`\>\> - -**`summary`** Opens a media source. - -**`throws`** {RequiredError} - -**`memberof`** MediaInfoApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`MediaInfoApiOpenLiveStreamRequest`](../interfaces/generated_client.MediaInfoApiOpenLiveStreamRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`LiveStreamResponse`](../interfaces/generated_client.LiveStreamResponse.md), `any`\>\> - -#### Defined in - -[generated-client/api/media-info-api.ts:866](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L866) diff --git a/docs/classes/generated_client.MoviesApi.md b/docs/classes/generated_client.MoviesApi.md deleted file mode 100644 index a871d5f54..000000000 --- a/docs/classes/generated_client.MoviesApi.md +++ /dev/null @@ -1,114 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MoviesApi - -# Class: MoviesApi - -[generated-client](../modules/generated_client.md).MoviesApi - -MoviesApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`MoviesApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.MoviesApi.md#constructor) - -### Properties - -- [axios](generated_client.MoviesApi.md#axios) -- [basePath](generated_client.MoviesApi.md#basepath) -- [configuration](generated_client.MoviesApi.md#configuration) - -### Methods - -- [getMovieRecommendations](generated_client.MoviesApi.md#getmovierecommendations) - -## Constructors - -### constructor - -• **new MoviesApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getMovieRecommendations - -▸ **getMovieRecommendations**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`RecommendationDto`](../interfaces/generated_client.RecommendationDto.md)[], `any`\>\> - -**`summary`** Gets movie recommendations. - -**`throws`** {RequiredError} - -**`memberof`** MoviesApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`MoviesApiGetMovieRecommendationsRequest`](../interfaces/generated_client.MoviesApiGetMovieRecommendationsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`RecommendationDto`](../interfaces/generated_client.RecommendationDto.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/movies-api.ts:200](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/movies-api.ts#L200) diff --git a/docs/classes/generated_client.MusicGenresApi.md b/docs/classes/generated_client.MusicGenresApi.md deleted file mode 100644 index 941f31d93..000000000 --- a/docs/classes/generated_client.MusicGenresApi.md +++ /dev/null @@ -1,144 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MusicGenresApi - -# Class: MusicGenresApi - -[generated-client](../modules/generated_client.md).MusicGenresApi - -MusicGenresApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`MusicGenresApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.MusicGenresApi.md#constructor) - -### Properties - -- [axios](generated_client.MusicGenresApi.md#axios) -- [basePath](generated_client.MusicGenresApi.md#basepath) -- [configuration](generated_client.MusicGenresApi.md#configuration) - -### Methods - -- [getMusicGenre](generated_client.MusicGenresApi.md#getmusicgenre) -- [getMusicGenres](generated_client.MusicGenresApi.md#getmusicgenres) - -## Constructors - -### constructor - -• **new MusicGenresApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getMusicGenre - -▸ **getMusicGenre**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -**`summary`** Gets a music genre, by name. - -**`throws`** {RequiredError} - -**`memberof`** MusicGenresApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`MusicGenresApiGetMusicGenreRequest`](../interfaces/generated_client.MusicGenresApiGetMusicGenreRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/music-genres-api.ts:479](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L479) - -___ - -### getMusicGenres - -▸ **getMusicGenres**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets all music genres from a given item, folder, or the entire library. - -**`deprecated`** - -**`throws`** {RequiredError} - -**`memberof`** MusicGenresApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`MusicGenresApiGetMusicGenresRequest`](../interfaces/generated_client.MusicGenresApiGetMusicGenresRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/music-genres-api.ts:492](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L492) diff --git a/docs/classes/generated_client.NotificationsApi.md b/docs/classes/generated_client.NotificationsApi.md deleted file mode 100644 index a19ab2b80..000000000 --- a/docs/classes/generated_client.NotificationsApi.md +++ /dev/null @@ -1,280 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationsApi - -# Class: NotificationsApi - -[generated-client](../modules/generated_client.md).NotificationsApi - -NotificationsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`NotificationsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.NotificationsApi.md#constructor) - -### Properties - -- [axios](generated_client.NotificationsApi.md#axios) -- [basePath](generated_client.NotificationsApi.md#basepath) -- [configuration](generated_client.NotificationsApi.md#configuration) - -### Methods - -- [createAdminNotification](generated_client.NotificationsApi.md#createadminnotification) -- [getNotificationServices](generated_client.NotificationsApi.md#getnotificationservices) -- [getNotificationTypes](generated_client.NotificationsApi.md#getnotificationtypes) -- [getNotifications](generated_client.NotificationsApi.md#getnotifications) -- [getNotificationsSummary](generated_client.NotificationsApi.md#getnotificationssummary) -- [setRead](generated_client.NotificationsApi.md#setread) -- [setUnread](generated_client.NotificationsApi.md#setunread) - -## Constructors - -### constructor - -• **new NotificationsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### createAdminNotification - -▸ **createAdminNotification**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Sends a notification to all admins. - -**`throws`** {RequiredError} - -**`memberof`** NotificationsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`NotificationsApiCreateAdminNotificationRequest`](../interfaces/generated_client.NotificationsApiCreateAdminNotificationRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/notifications-api.ts:543](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L543) - -___ - -### getNotificationServices - -▸ **getNotificationServices**(`options?`): `Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\> - -**`summary`** Gets notification services. - -**`throws`** {RequiredError} - -**`memberof`** NotificationsApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/notifications-api.ts:554](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L554) - -___ - -### getNotificationTypes - -▸ **getNotificationTypes**(`options?`): `Promise`<`AxiosResponse`<[`NotificationTypeInfo`](../interfaces/generated_client.NotificationTypeInfo.md)[], `any`\>\> - -**`summary`** Gets notification types. - -**`throws`** {RequiredError} - -**`memberof`** NotificationsApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`NotificationTypeInfo`](../interfaces/generated_client.NotificationTypeInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/notifications-api.ts:565](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L565) - -___ - -### getNotifications - -▸ **getNotifications**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`NotificationResultDto`](../interfaces/generated_client.NotificationResultDto.md), `any`\>\> - -**`summary`** Gets a user\'s notifications. - -**`throws`** {RequiredError} - -**`memberof`** NotificationsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`NotificationsApiGetNotificationsRequest`](../interfaces/generated_client.NotificationsApiGetNotificationsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`NotificationResultDto`](../interfaces/generated_client.NotificationResultDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/notifications-api.ts:577](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L577) - -___ - -### getNotificationsSummary - -▸ **getNotificationsSummary**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`NotificationsSummaryDto`](../interfaces/generated_client.NotificationsSummaryDto.md), `any`\>\> - -**`summary`** Gets a user\'s notification summary. - -**`throws`** {RequiredError} - -**`memberof`** NotificationsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`NotificationsApiGetNotificationsSummaryRequest`](../interfaces/generated_client.NotificationsApiGetNotificationsSummaryRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`NotificationsSummaryDto`](../interfaces/generated_client.NotificationsSummaryDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/notifications-api.ts:589](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L589) - -___ - -### setRead - -▸ **setRead**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Sets notifications as read. - -**`throws`** {RequiredError} - -**`memberof`** NotificationsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`NotificationsApiSetReadRequest`](../interfaces/generated_client.NotificationsApiSetReadRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/notifications-api.ts:601](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L601) - -___ - -### setUnread - -▸ **setUnread**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Sets notifications as unread. - -**`throws`** {RequiredError} - -**`memberof`** NotificationsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`NotificationsApiSetUnreadRequest`](../interfaces/generated_client.NotificationsApiSetUnreadRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/notifications-api.ts:613](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L613) diff --git a/docs/classes/generated_client.PackageApi.md b/docs/classes/generated_client.PackageApi.md deleted file mode 100644 index 3ef5e91bd..000000000 --- a/docs/classes/generated_client.PackageApi.md +++ /dev/null @@ -1,252 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PackageApi - -# Class: PackageApi - -[generated-client](../modules/generated_client.md).PackageApi - -PackageApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`PackageApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.PackageApi.md#constructor) - -### Properties - -- [axios](generated_client.PackageApi.md#axios) -- [basePath](generated_client.PackageApi.md#basepath) -- [configuration](generated_client.PackageApi.md#configuration) - -### Methods - -- [cancelPackageInstallation](generated_client.PackageApi.md#cancelpackageinstallation) -- [getPackageInfo](generated_client.PackageApi.md#getpackageinfo) -- [getPackages](generated_client.PackageApi.md#getpackages) -- [getRepositories](generated_client.PackageApi.md#getrepositories) -- [installPackage](generated_client.PackageApi.md#installpackage) -- [setRepositories](generated_client.PackageApi.md#setrepositories) - -## Constructors - -### constructor - -• **new PackageApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### cancelPackageInstallation - -▸ **cancelPackageInstallation**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Cancels a package installation. - -**`throws`** {RequiredError} - -**`memberof`** PackageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PackageApiCancelPackageInstallationRequest`](../interfaces/generated_client.PackageApiCancelPackageInstallationRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/package-api.ts:523](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L523) - -___ - -### getPackageInfo - -▸ **getPackageInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md), `any`\>\> - -**`summary`** Gets a package by name or assembly GUID. - -**`throws`** {RequiredError} - -**`memberof`** PackageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PackageApiGetPackageInfoRequest`](../interfaces/generated_client.PackageApiGetPackageInfoRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md), `any`\>\> - -#### Defined in - -[generated-client/api/package-api.ts:535](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L535) - -___ - -### getPackages - -▸ **getPackages**(`options?`): `Promise`<`AxiosResponse`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md)[], `any`\>\> - -**`summary`** Gets available packages. - -**`throws`** {RequiredError} - -**`memberof`** PackageApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/package-api.ts:546](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L546) - -___ - -### getRepositories - -▸ **getRepositories**(`options?`): `Promise`<`AxiosResponse`<[`RepositoryInfo`](../interfaces/generated_client.RepositoryInfo.md)[], `any`\>\> - -**`summary`** Gets all package repositories. - -**`throws`** {RequiredError} - -**`memberof`** PackageApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`RepositoryInfo`](../interfaces/generated_client.RepositoryInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/package-api.ts:557](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L557) - -___ - -### installPackage - -▸ **installPackage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Installs a package. - -**`throws`** {RequiredError} - -**`memberof`** PackageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PackageApiInstallPackageRequest`](../interfaces/generated_client.PackageApiInstallPackageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/package-api.ts:569](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L569) - -___ - -### setRepositories - -▸ **setRepositories**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Sets the enabled and existing package repositories. - -**`throws`** {RequiredError} - -**`memberof`** PackageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PackageApiSetRepositoriesRequest`](../interfaces/generated_client.PackageApiSetRepositoriesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/package-api.ts:581](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L581) diff --git a/docs/classes/generated_client.PersonsApi.md b/docs/classes/generated_client.PersonsApi.md deleted file mode 100644 index 8b0af7164..000000000 --- a/docs/classes/generated_client.PersonsApi.md +++ /dev/null @@ -1,142 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PersonsApi - -# Class: PersonsApi - -[generated-client](../modules/generated_client.md).PersonsApi - -PersonsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`PersonsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.PersonsApi.md#constructor) - -### Properties - -- [axios](generated_client.PersonsApi.md#axios) -- [basePath](generated_client.PersonsApi.md#basepath) -- [configuration](generated_client.PersonsApi.md#configuration) - -### Methods - -- [getPerson](generated_client.PersonsApi.md#getperson) -- [getPersons](generated_client.PersonsApi.md#getpersons) - -## Constructors - -### constructor - -• **new PersonsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getPerson - -▸ **getPerson**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -**`summary`** Get person by name. - -**`throws`** {RequiredError} - -**`memberof`** PersonsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PersonsApiGetPersonRequest`](../interfaces/generated_client.PersonsApiGetPersonRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/persons-api.ts:406](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L406) - -___ - -### getPersons - -▸ **getPersons**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets all persons. - -**`throws`** {RequiredError} - -**`memberof`** PersonsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PersonsApiGetPersonsRequest`](../interfaces/generated_client.PersonsApiGetPersonsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/persons-api.ts:418](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L418) diff --git a/docs/classes/generated_client.PlaylistsApi.md b/docs/classes/generated_client.PlaylistsApi.md deleted file mode 100644 index df1efefad..000000000 --- a/docs/classes/generated_client.PlaylistsApi.md +++ /dev/null @@ -1,228 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaylistsApi - -# Class: PlaylistsApi - -[generated-client](../modules/generated_client.md).PlaylistsApi - -PlaylistsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`PlaylistsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.PlaylistsApi.md#constructor) - -### Properties - -- [axios](generated_client.PlaylistsApi.md#axios) -- [basePath](generated_client.PlaylistsApi.md#basepath) -- [configuration](generated_client.PlaylistsApi.md#configuration) - -### Methods - -- [addToPlaylist](generated_client.PlaylistsApi.md#addtoplaylist) -- [createPlaylist](generated_client.PlaylistsApi.md#createplaylist) -- [getPlaylistItems](generated_client.PlaylistsApi.md#getplaylistitems) -- [moveItem](generated_client.PlaylistsApi.md#moveitem) -- [removeFromPlaylist](generated_client.PlaylistsApi.md#removefromplaylist) - -## Constructors - -### constructor - -• **new PlaylistsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### addToPlaylist - -▸ **addToPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Adds items to a playlist. - -**`throws`** {RequiredError} - -**`memberof`** PlaylistsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaylistsApiAddToPlaylistRequest`](../interfaces/generated_client.PlaylistsApiAddToPlaylistRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/playlists-api.ts:675](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L675) - -___ - -### createPlaylist - -▸ **createPlaylist**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`PlaylistCreationResult`](../interfaces/generated_client.PlaylistCreationResult.md), `any`\>\> - -For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete. - -**`summary`** Creates a new playlist. - -**`throws`** {RequiredError} - -**`memberof`** PlaylistsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaylistsApiCreatePlaylistRequest`](../interfaces/generated_client.PlaylistsApiCreatePlaylistRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`PlaylistCreationResult`](../interfaces/generated_client.PlaylistCreationResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/playlists-api.ts:687](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L687) - -___ - -### getPlaylistItems - -▸ **getPlaylistItems**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets the original items of a playlist. - -**`throws`** {RequiredError} - -**`memberof`** PlaylistsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaylistsApiGetPlaylistItemsRequest`](../interfaces/generated_client.PlaylistsApiGetPlaylistItemsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/playlists-api.ts:699](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L699) - -___ - -### moveItem - -▸ **moveItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Moves a playlist item. - -**`throws`** {RequiredError} - -**`memberof`** PlaylistsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaylistsApiMoveItemRequest`](../interfaces/generated_client.PlaylistsApiMoveItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/playlists-api.ts:711](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L711) - -___ - -### removeFromPlaylist - -▸ **removeFromPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Removes items from a playlist. - -**`throws`** {RequiredError} - -**`memberof`** PlaylistsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaylistsApiRemoveFromPlaylistRequest`](../interfaces/generated_client.PlaylistsApiRemoveFromPlaylistRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/playlists-api.ts:723](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L723) diff --git a/docs/classes/generated_client.PlaystateApi.md b/docs/classes/generated_client.PlaystateApi.md deleted file mode 100644 index 9116134b6..000000000 --- a/docs/classes/generated_client.PlaystateApi.md +++ /dev/null @@ -1,338 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateApi - -# Class: PlaystateApi - -[generated-client](../modules/generated_client.md).PlaystateApi - -PlaystateApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`PlaystateApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.PlaystateApi.md#constructor) - -### Properties - -- [axios](generated_client.PlaystateApi.md#axios) -- [basePath](generated_client.PlaystateApi.md#basepath) -- [configuration](generated_client.PlaystateApi.md#configuration) - -### Methods - -- [markPlayedItem](generated_client.PlaystateApi.md#markplayeditem) -- [markUnplayedItem](generated_client.PlaystateApi.md#markunplayeditem) -- [onPlaybackProgress](generated_client.PlaystateApi.md#onplaybackprogress) -- [onPlaybackStart](generated_client.PlaystateApi.md#onplaybackstart) -- [onPlaybackStopped](generated_client.PlaystateApi.md#onplaybackstopped) -- [pingPlaybackSession](generated_client.PlaystateApi.md#pingplaybacksession) -- [reportPlaybackProgress](generated_client.PlaystateApi.md#reportplaybackprogress) -- [reportPlaybackStart](generated_client.PlaystateApi.md#reportplaybackstart) -- [reportPlaybackStopped](generated_client.PlaystateApi.md#reportplaybackstopped) - -## Constructors - -### constructor - -• **new PlaystateApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### markPlayedItem - -▸ **markPlayedItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\> - -**`summary`** Marks an item as played for user. - -**`throws`** {RequiredError} - -**`memberof`** PlaystateApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaystateApiMarkPlayedItemRequest`](../interfaces/generated_client.PlaystateApiMarkPlayedItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/playstate-api.ts:1133](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1133) - -___ - -### markUnplayedItem - -▸ **markUnplayedItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\> - -**`summary`** Marks an item as unplayed for user. - -**`throws`** {RequiredError} - -**`memberof`** PlaystateApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaystateApiMarkUnplayedItemRequest`](../interfaces/generated_client.PlaystateApiMarkUnplayedItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/playstate-api.ts:1145](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1145) - -___ - -### onPlaybackProgress - -▸ **onPlaybackProgress**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports a user\'s playback progress. - -**`throws`** {RequiredError} - -**`memberof`** PlaystateApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaystateApiOnPlaybackProgressRequest`](../interfaces/generated_client.PlaystateApiOnPlaybackProgressRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/playstate-api.ts:1157](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1157) - -___ - -### onPlaybackStart - -▸ **onPlaybackStart**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports that a user has begun playing an item. - -**`throws`** {RequiredError} - -**`memberof`** PlaystateApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaystateApiOnPlaybackStartRequest`](../interfaces/generated_client.PlaystateApiOnPlaybackStartRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/playstate-api.ts:1169](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1169) - -___ - -### onPlaybackStopped - -▸ **onPlaybackStopped**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports that a user has stopped playing an item. - -**`throws`** {RequiredError} - -**`memberof`** PlaystateApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaystateApiOnPlaybackStoppedRequest`](../interfaces/generated_client.PlaystateApiOnPlaybackStoppedRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/playstate-api.ts:1181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1181) - -___ - -### pingPlaybackSession - -▸ **pingPlaybackSession**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Pings a playback session. - -**`throws`** {RequiredError} - -**`memberof`** PlaystateApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaystateApiPingPlaybackSessionRequest`](../interfaces/generated_client.PlaystateApiPingPlaybackSessionRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/playstate-api.ts:1193](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1193) - -___ - -### reportPlaybackProgress - -▸ **reportPlaybackProgress**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports playback progress within a session. - -**`throws`** {RequiredError} - -**`memberof`** PlaystateApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaystateApiReportPlaybackProgressRequest`](../interfaces/generated_client.PlaystateApiReportPlaybackProgressRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/playstate-api.ts:1205](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1205) - -___ - -### reportPlaybackStart - -▸ **reportPlaybackStart**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports playback has started within a session. - -**`throws`** {RequiredError} - -**`memberof`** PlaystateApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaystateApiReportPlaybackStartRequest`](../interfaces/generated_client.PlaystateApiReportPlaybackStartRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/playstate-api.ts:1217](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1217) - -___ - -### reportPlaybackStopped - -▸ **reportPlaybackStopped**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports playback has stopped within a session. - -**`throws`** {RequiredError} - -**`memberof`** PlaystateApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PlaystateApiReportPlaybackStoppedRequest`](../interfaces/generated_client.PlaystateApiReportPlaybackStoppedRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/playstate-api.ts:1229](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1229) diff --git a/docs/classes/generated_client.PluginsApi.md b/docs/classes/generated_client.PluginsApi.md deleted file mode 100644 index 37f4421c2..000000000 --- a/docs/classes/generated_client.PluginsApi.md +++ /dev/null @@ -1,341 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PluginsApi - -# Class: PluginsApi - -[generated-client](../modules/generated_client.md).PluginsApi - -PluginsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`PluginsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.PluginsApi.md#constructor) - -### Properties - -- [axios](generated_client.PluginsApi.md#axios) -- [basePath](generated_client.PluginsApi.md#basepath) -- [configuration](generated_client.PluginsApi.md#configuration) - -### Methods - -- [disablePlugin](generated_client.PluginsApi.md#disableplugin) -- [enablePlugin](generated_client.PluginsApi.md#enableplugin) -- [getPluginConfiguration](generated_client.PluginsApi.md#getpluginconfiguration) -- [getPluginImage](generated_client.PluginsApi.md#getpluginimage) -- [getPluginManifest](generated_client.PluginsApi.md#getpluginmanifest) -- [getPlugins](generated_client.PluginsApi.md#getplugins) -- [uninstallPlugin](generated_client.PluginsApi.md#uninstallplugin) -- [uninstallPluginByVersion](generated_client.PluginsApi.md#uninstallpluginbyversion) -- [updatePluginConfiguration](generated_client.PluginsApi.md#updatepluginconfiguration) - -## Constructors - -### constructor - -• **new PluginsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### disablePlugin - -▸ **disablePlugin**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Disable a plugin. - -**`throws`** {RequiredError} - -**`memberof`** PluginsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PluginsApiDisablePluginRequest`](../interfaces/generated_client.PluginsApiDisablePluginRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/plugins-api.ts:754](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L754) - -___ - -### enablePlugin - -▸ **enablePlugin**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Enables a disabled plugin. - -**`throws`** {RequiredError} - -**`memberof`** PluginsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PluginsApiEnablePluginRequest`](../interfaces/generated_client.PluginsApiEnablePluginRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/plugins-api.ts:766](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L766) - -___ - -### getPluginConfiguration - -▸ **getPluginConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`object`, `any`\>\> - -**`summary`** Gets plugin configuration. - -**`throws`** {RequiredError} - -**`memberof`** PluginsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PluginsApiGetPluginConfigurationRequest`](../interfaces/generated_client.PluginsApiGetPluginConfigurationRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`object`, `any`\>\> - -#### Defined in - -[generated-client/api/plugins-api.ts:778](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L778) - -___ - -### getPluginImage - -▸ **getPluginImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a plugin\'s image. - -**`throws`** {RequiredError} - -**`memberof`** PluginsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PluginsApiGetPluginImageRequest`](../interfaces/generated_client.PluginsApiGetPluginImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/plugins-api.ts:790](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L790) - -___ - -### getPluginManifest - -▸ **getPluginManifest**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Gets a plugin\'s manifest. - -**`throws`** {RequiredError} - -**`memberof`** PluginsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PluginsApiGetPluginManifestRequest`](../interfaces/generated_client.PluginsApiGetPluginManifestRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/plugins-api.ts:802](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L802) - -___ - -### getPlugins - -▸ **getPlugins**(`options?`): `Promise`<`AxiosResponse`<[`PluginInfo`](../interfaces/generated_client.PluginInfo.md)[], `any`\>\> - -**`summary`** Gets a list of currently installed plugins. - -**`throws`** {RequiredError} - -**`memberof`** PluginsApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`PluginInfo`](../interfaces/generated_client.PluginInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/plugins-api.ts:813](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L813) - -___ - -### uninstallPlugin - -▸ **uninstallPlugin**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Uninstalls a plugin. - -**`deprecated`** - -**`throws`** {RequiredError} - -**`memberof`** PluginsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PluginsApiUninstallPluginRequest`](../interfaces/generated_client.PluginsApiUninstallPluginRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/plugins-api.ts:826](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L826) - -___ - -### uninstallPluginByVersion - -▸ **uninstallPluginByVersion**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Uninstalls a plugin by version. - -**`throws`** {RequiredError} - -**`memberof`** PluginsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PluginsApiUninstallPluginByVersionRequest`](../interfaces/generated_client.PluginsApiUninstallPluginByVersionRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/plugins-api.ts:838](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L838) - -___ - -### updatePluginConfiguration - -▸ **updatePluginConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -Accepts plugin configuration as JSON body. - -**`summary`** Updates plugin configuration. - -**`throws`** {RequiredError} - -**`memberof`** PluginsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`PluginsApiUpdatePluginConfigurationRequest`](../interfaces/generated_client.PluginsApiUpdatePluginConfigurationRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/plugins-api.ts:850](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L850) diff --git a/docs/classes/generated_client.QuickConnectApi.md b/docs/classes/generated_client.QuickConnectApi.md deleted file mode 100644 index 6cd414e26..000000000 --- a/docs/classes/generated_client.QuickConnectApi.md +++ /dev/null @@ -1,196 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / QuickConnectApi - -# Class: QuickConnectApi - -[generated-client](../modules/generated_client.md).QuickConnectApi - -QuickConnectApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`QuickConnectApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.QuickConnectApi.md#constructor) - -### Properties - -- [axios](generated_client.QuickConnectApi.md#axios) -- [basePath](generated_client.QuickConnectApi.md#basepath) -- [configuration](generated_client.QuickConnectApi.md#configuration) - -### Methods - -- [authorize](generated_client.QuickConnectApi.md#authorize) -- [connect](generated_client.QuickConnectApi.md#connect) -- [getEnabled](generated_client.QuickConnectApi.md#getenabled) -- [initiate](generated_client.QuickConnectApi.md#initiate) - -## Constructors - -### constructor - -• **new QuickConnectApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### authorize - -▸ **authorize**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`boolean`, `any`\>\> - -**`summary`** Authorizes a pending quick connect request. - -**`throws`** {RequiredError} - -**`memberof`** QuickConnectApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`QuickConnectApiAuthorizeRequest`](../interfaces/generated_client.QuickConnectApiAuthorizeRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`boolean`, `any`\>\> - -#### Defined in - -[generated-client/api/quick-connect-api.ts:316](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L316) - -___ - -### connect - -▸ **connect**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md), `any`\>\> - -**`summary`** Attempts to retrieve authentication information. - -**`throws`** {RequiredError} - -**`memberof`** QuickConnectApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`QuickConnectApiConnectRequest`](../interfaces/generated_client.QuickConnectApiConnectRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/quick-connect-api.ts:328](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L328) - -___ - -### getEnabled - -▸ **getEnabled**(`options?`): `Promise`<`AxiosResponse`<`boolean`, `any`\>\> - -**`summary`** Gets the current quick connect state. - -**`throws`** {RequiredError} - -**`memberof`** QuickConnectApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`boolean`, `any`\>\> - -#### Defined in - -[generated-client/api/quick-connect-api.ts:339](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L339) - -___ - -### initiate - -▸ **initiate**(`options?`): `Promise`<`AxiosResponse`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md), `any`\>\> - -**`summary`** Initiate a new quick connect request. - -**`throws`** {RequiredError} - -**`memberof`** QuickConnectApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/quick-connect-api.ts:350](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L350) diff --git a/docs/classes/generated_client.RemoteImageApi.md b/docs/classes/generated_client.RemoteImageApi.md deleted file mode 100644 index e71ce81d8..000000000 --- a/docs/classes/generated_client.RemoteImageApi.md +++ /dev/null @@ -1,170 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RemoteImageApi - -# Class: RemoteImageApi - -[generated-client](../modules/generated_client.md).RemoteImageApi - -RemoteImageApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`RemoteImageApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.RemoteImageApi.md#constructor) - -### Properties - -- [axios](generated_client.RemoteImageApi.md#axios) -- [basePath](generated_client.RemoteImageApi.md#basepath) -- [configuration](generated_client.RemoteImageApi.md#configuration) - -### Methods - -- [downloadRemoteImage](generated_client.RemoteImageApi.md#downloadremoteimage) -- [getRemoteImageProviders](generated_client.RemoteImageApi.md#getremoteimageproviders) -- [getRemoteImages](generated_client.RemoteImageApi.md#getremoteimages) - -## Constructors - -### constructor - -• **new RemoteImageApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### downloadRemoteImage - -▸ **downloadRemoteImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Downloads a remote image for an item. - -**`throws`** {RequiredError} - -**`memberof`** RemoteImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`RemoteImageApiDownloadRemoteImageRequest`](../interfaces/generated_client.RemoteImageApiDownloadRemoteImageRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/remote-image-api.ts:391](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L391) - -___ - -### getRemoteImageProviders - -▸ **getRemoteImageProviders**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ImageProviderInfo`](../interfaces/generated_client.ImageProviderInfo.md)[], `any`\>\> - -**`summary`** Gets available remote image providers for an item. - -**`throws`** {RequiredError} - -**`memberof`** RemoteImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`RemoteImageApiGetRemoteImageProvidersRequest`](../interfaces/generated_client.RemoteImageApiGetRemoteImageProvidersRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ImageProviderInfo`](../interfaces/generated_client.ImageProviderInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/remote-image-api.ts:403](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L403) - -___ - -### getRemoteImages - -▸ **getRemoteImages**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteImageResult`](../interfaces/generated_client.RemoteImageResult.md), `any`\>\> - -**`summary`** Gets available remote images for an item. - -**`throws`** {RequiredError} - -**`memberof`** RemoteImageApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`RemoteImageApiGetRemoteImagesRequest`](../interfaces/generated_client.RemoteImageApiGetRemoteImagesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`RemoteImageResult`](../interfaces/generated_client.RemoteImageResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/remote-image-api.ts:415](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L415) diff --git a/docs/classes/generated_client.ScheduledTasksApi.md b/docs/classes/generated_client.ScheduledTasksApi.md deleted file mode 100644 index 4eaabb0c5..000000000 --- a/docs/classes/generated_client.ScheduledTasksApi.md +++ /dev/null @@ -1,226 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ScheduledTasksApi - -# Class: ScheduledTasksApi - -[generated-client](../modules/generated_client.md).ScheduledTasksApi - -ScheduledTasksApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`ScheduledTasksApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.ScheduledTasksApi.md#constructor) - -### Properties - -- [axios](generated_client.ScheduledTasksApi.md#axios) -- [basePath](generated_client.ScheduledTasksApi.md#basepath) -- [configuration](generated_client.ScheduledTasksApi.md#configuration) - -### Methods - -- [getTask](generated_client.ScheduledTasksApi.md#gettask) -- [getTasks](generated_client.ScheduledTasksApi.md#gettasks) -- [startTask](generated_client.ScheduledTasksApi.md#starttask) -- [stopTask](generated_client.ScheduledTasksApi.md#stoptask) -- [updateTask](generated_client.ScheduledTasksApi.md#updatetask) - -## Constructors - -### constructor - -• **new ScheduledTasksApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getTask - -▸ **getTask**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md), `any`\>\> - -**`summary`** Get task by id. - -**`throws`** {RequiredError} - -**`memberof`** ScheduledTasksApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ScheduledTasksApiGetTaskRequest`](../interfaces/generated_client.ScheduledTasksApiGetTaskRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md), `any`\>\> - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:463](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L463) - -___ - -### getTasks - -▸ **getTasks**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md)[], `any`\>\> - -**`summary`** Get tasks. - -**`throws`** {RequiredError} - -**`memberof`** ScheduledTasksApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ScheduledTasksApiGetTasksRequest`](../interfaces/generated_client.ScheduledTasksApiGetTasksRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:475](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L475) - -___ - -### startTask - -▸ **startTask**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Start specified task. - -**`throws`** {RequiredError} - -**`memberof`** ScheduledTasksApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ScheduledTasksApiStartTaskRequest`](../interfaces/generated_client.ScheduledTasksApiStartTaskRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:487](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L487) - -___ - -### stopTask - -▸ **stopTask**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Stop specified task. - -**`throws`** {RequiredError} - -**`memberof`** ScheduledTasksApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ScheduledTasksApiStopTaskRequest`](../interfaces/generated_client.ScheduledTasksApiStopTaskRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:499](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L499) - -___ - -### updateTask - -▸ **updateTask**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Update specified task triggers. - -**`throws`** {RequiredError} - -**`memberof`** ScheduledTasksApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`ScheduledTasksApiUpdateTaskRequest`](../interfaces/generated_client.ScheduledTasksApiUpdateTaskRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:511](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L511) diff --git a/docs/classes/generated_client.SearchApi.md b/docs/classes/generated_client.SearchApi.md deleted file mode 100644 index d1ad08879..000000000 --- a/docs/classes/generated_client.SearchApi.md +++ /dev/null @@ -1,114 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SearchApi - -# Class: SearchApi - -[generated-client](../modules/generated_client.md).SearchApi - -SearchApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`SearchApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.SearchApi.md#constructor) - -### Properties - -- [axios](generated_client.SearchApi.md#axios) -- [basePath](generated_client.SearchApi.md#basepath) -- [configuration](generated_client.SearchApi.md#configuration) - -### Methods - -- [get](generated_client.SearchApi.md#get) - -## Constructors - -### constructor - -• **new SearchApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### get - -▸ **get**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`SearchHintResult`](../interfaces/generated_client.SearchHintResult.md), `any`\>\> - -**`summary`** Gets the search hint result. - -**`throws`** {RequiredError} - -**`memberof`** SearchApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SearchApiGetRequest`](../interfaces/generated_client.SearchApiGetRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`SearchHintResult`](../interfaces/generated_client.SearchHintResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/search-api.ts:384](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L384) diff --git a/docs/classes/generated_client.SessionApi.md b/docs/classes/generated_client.SessionApi.md deleted file mode 100644 index 6295ed30c..000000000 --- a/docs/classes/generated_client.SessionApi.md +++ /dev/null @@ -1,531 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApi - -# Class: SessionApi - -[generated-client](../modules/generated_client.md).SessionApi - -SessionApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`SessionApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.SessionApi.md#constructor) - -### Properties - -- [axios](generated_client.SessionApi.md#axios) -- [basePath](generated_client.SessionApi.md#basepath) -- [configuration](generated_client.SessionApi.md#configuration) - -### Methods - -- [addUserToSession](generated_client.SessionApi.md#addusertosession) -- [displayContent](generated_client.SessionApi.md#displaycontent) -- [getAuthProviders](generated_client.SessionApi.md#getauthproviders) -- [getPasswordResetProviders](generated_client.SessionApi.md#getpasswordresetproviders) -- [getSessions](generated_client.SessionApi.md#getsessions) -- [play](generated_client.SessionApi.md#play) -- [postCapabilities](generated_client.SessionApi.md#postcapabilities) -- [postFullCapabilities](generated_client.SessionApi.md#postfullcapabilities) -- [removeUserFromSession](generated_client.SessionApi.md#removeuserfromsession) -- [reportSessionEnded](generated_client.SessionApi.md#reportsessionended) -- [reportViewing](generated_client.SessionApi.md#reportviewing) -- [sendFullGeneralCommand](generated_client.SessionApi.md#sendfullgeneralcommand) -- [sendGeneralCommand](generated_client.SessionApi.md#sendgeneralcommand) -- [sendMessageCommand](generated_client.SessionApi.md#sendmessagecommand) -- [sendPlaystateCommand](generated_client.SessionApi.md#sendplaystatecommand) -- [sendSystemCommand](generated_client.SessionApi.md#sendsystemcommand) - -## Constructors - -### constructor - -• **new SessionApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### addUserToSession - -▸ **addUserToSession**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Adds an additional user to a session. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiAddUserToSessionRequest`](../interfaces/generated_client.SessionApiAddUserToSessionRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1583](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1583) - -___ - -### displayContent - -▸ **displayContent**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Instructs a session to browse to an item or view. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiDisplayContentRequest`](../interfaces/generated_client.SessionApiDisplayContentRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1595](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1595) - -___ - -### getAuthProviders - -▸ **getAuthProviders**(`options?`): `Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\> - -**`summary`** Get all auth providers. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1606](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1606) - -___ - -### getPasswordResetProviders - -▸ **getPasswordResetProviders**(`options?`): `Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\> - -**`summary`** Get all password reset providers. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1617](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1617) - -___ - -### getSessions - -▸ **getSessions**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`SessionInfo`](../interfaces/generated_client.SessionInfo.md)[], `any`\>\> - -**`summary`** Gets a list of sessions. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiGetSessionsRequest`](../interfaces/generated_client.SessionApiGetSessionsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`SessionInfo`](../interfaces/generated_client.SessionInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1629](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1629) - -___ - -### play - -▸ **play**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Instructs a session to play an item. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiPlayRequest`](../interfaces/generated_client.SessionApiPlayRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1641](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1641) - -___ - -### postCapabilities - -▸ **postCapabilities**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates capabilities for a device. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiPostCapabilitiesRequest`](../interfaces/generated_client.SessionApiPostCapabilitiesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1653](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1653) - -___ - -### postFullCapabilities - -▸ **postFullCapabilities**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates capabilities for a device. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiPostFullCapabilitiesRequest`](../interfaces/generated_client.SessionApiPostFullCapabilitiesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1665](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1665) - -___ - -### removeUserFromSession - -▸ **removeUserFromSession**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Removes an additional user from a session. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiRemoveUserFromSessionRequest`](../interfaces/generated_client.SessionApiRemoveUserFromSessionRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1677](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1677) - -___ - -### reportSessionEnded - -▸ **reportSessionEnded**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports that a session has ended. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1688](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1688) - -___ - -### reportViewing - -▸ **reportViewing**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Reports that a session is viewing an item. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiReportViewingRequest`](../interfaces/generated_client.SessionApiReportViewingRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1700](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1700) - -___ - -### sendFullGeneralCommand - -▸ **sendFullGeneralCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Issues a full general command to a client. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiSendFullGeneralCommandRequest`](../interfaces/generated_client.SessionApiSendFullGeneralCommandRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1712](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1712) - -___ - -### sendGeneralCommand - -▸ **sendGeneralCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Issues a general command to a client. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiSendGeneralCommandRequest`](../interfaces/generated_client.SessionApiSendGeneralCommandRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1724](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1724) - -___ - -### sendMessageCommand - -▸ **sendMessageCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Issues a command to a client to display a message to the user. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiSendMessageCommandRequest`](../interfaces/generated_client.SessionApiSendMessageCommandRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1736](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1736) - -___ - -### sendPlaystateCommand - -▸ **sendPlaystateCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Issues a playstate command to a client. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiSendPlaystateCommandRequest`](../interfaces/generated_client.SessionApiSendPlaystateCommandRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1748](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1748) - -___ - -### sendSystemCommand - -▸ **sendSystemCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Issues a system command to a client. - -**`throws`** {RequiredError} - -**`memberof`** SessionApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SessionApiSendSystemCommandRequest`](../interfaces/generated_client.SessionApiSendSystemCommandRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/session-api.ts:1760](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1760) diff --git a/docs/classes/generated_client.StartupApi.md b/docs/classes/generated_client.StartupApi.md deleted file mode 100644 index c4b11ea63..000000000 --- a/docs/classes/generated_client.StartupApi.md +++ /dev/null @@ -1,278 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / StartupApi - -# Class: StartupApi - -[generated-client](../modules/generated_client.md).StartupApi - -StartupApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`StartupApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.StartupApi.md#constructor) - -### Properties - -- [axios](generated_client.StartupApi.md#axios) -- [basePath](generated_client.StartupApi.md#basepath) -- [configuration](generated_client.StartupApi.md#configuration) - -### Methods - -- [completeWizard](generated_client.StartupApi.md#completewizard) -- [getFirstUser](generated_client.StartupApi.md#getfirstuser) -- [getFirstUser2](generated_client.StartupApi.md#getfirstuser2) -- [getStartupConfiguration](generated_client.StartupApi.md#getstartupconfiguration) -- [setRemoteAccess](generated_client.StartupApi.md#setremoteaccess) -- [updateInitialConfiguration](generated_client.StartupApi.md#updateinitialconfiguration) -- [updateStartupUser](generated_client.StartupApi.md#updatestartupuser) - -## Constructors - -### constructor - -• **new StartupApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### completeWizard - -▸ **completeWizard**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Completes the startup wizard. - -**`throws`** {RequiredError} - -**`memberof`** StartupApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/startup-api.ts:500](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L500) - -___ - -### getFirstUser - -▸ **getFirstUser**(`options?`): `Promise`<`AxiosResponse`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md), `any`\>\> - -**`summary`** Gets the first user. - -**`throws`** {RequiredError} - -**`memberof`** StartupApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/startup-api.ts:511](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L511) - -___ - -### getFirstUser2 - -▸ **getFirstUser2**(`options?`): `Promise`<`AxiosResponse`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md), `any`\>\> - -**`summary`** Gets the first user. - -**`throws`** {RequiredError} - -**`memberof`** StartupApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/startup-api.ts:522](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L522) - -___ - -### getStartupConfiguration - -▸ **getStartupConfiguration**(`options?`): `Promise`<`AxiosResponse`<[`StartupConfigurationDto`](../interfaces/generated_client.StartupConfigurationDto.md), `any`\>\> - -**`summary`** Gets the initial startup wizard configuration. - -**`throws`** {RequiredError} - -**`memberof`** StartupApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`StartupConfigurationDto`](../interfaces/generated_client.StartupConfigurationDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/startup-api.ts:533](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L533) - -___ - -### setRemoteAccess - -▸ **setRemoteAccess**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Sets remote access and UPnP. - -**`throws`** {RequiredError} - -**`memberof`** StartupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`StartupApiSetRemoteAccessRequest`](../interfaces/generated_client.StartupApiSetRemoteAccessRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/startup-api.ts:545](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L545) - -___ - -### updateInitialConfiguration - -▸ **updateInitialConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Sets the initial startup wizard configuration. - -**`throws`** {RequiredError} - -**`memberof`** StartupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`StartupApiUpdateInitialConfigurationRequest`](../interfaces/generated_client.StartupApiUpdateInitialConfigurationRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/startup-api.ts:557](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L557) - -___ - -### updateStartupUser - -▸ **updateStartupUser**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Sets the user name and password. - -**`throws`** {RequiredError} - -**`memberof`** StartupApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`StartupApiUpdateStartupUserRequest`](../interfaces/generated_client.StartupApiUpdateStartupUserRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/startup-api.ts:569](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L569) diff --git a/docs/classes/generated_client.StudiosApi.md b/docs/classes/generated_client.StudiosApi.md deleted file mode 100644 index d853972d8..000000000 --- a/docs/classes/generated_client.StudiosApi.md +++ /dev/null @@ -1,142 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / StudiosApi - -# Class: StudiosApi - -[generated-client](../modules/generated_client.md).StudiosApi - -StudiosApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`StudiosApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.StudiosApi.md#constructor) - -### Properties - -- [axios](generated_client.StudiosApi.md#axios) -- [basePath](generated_client.StudiosApi.md#basepath) -- [configuration](generated_client.StudiosApi.md#configuration) - -### Methods - -- [getStudio](generated_client.StudiosApi.md#getstudio) -- [getStudios](generated_client.StudiosApi.md#getstudios) - -## Constructors - -### constructor - -• **new StudiosApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getStudio - -▸ **getStudio**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -**`summary`** Gets a studio by name. - -**`throws`** {RequiredError} - -**`memberof`** StudiosApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`StudiosApiGetStudioRequest`](../interfaces/generated_client.StudiosApiGetStudioRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/studios-api.ts:460](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L460) - -___ - -### getStudios - -▸ **getStudios**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets all studios from a given item, folder, or the entire library. - -**`throws`** {RequiredError} - -**`memberof`** StudiosApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`StudiosApiGetStudiosRequest`](../interfaces/generated_client.StudiosApiGetStudiosRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/studios-api.ts:472](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L472) diff --git a/docs/classes/generated_client.SubtitleApi.md b/docs/classes/generated_client.SubtitleApi.md deleted file mode 100644 index c26580126..000000000 --- a/docs/classes/generated_client.SubtitleApi.md +++ /dev/null @@ -1,365 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleApi - -# Class: SubtitleApi - -[generated-client](../modules/generated_client.md).SubtitleApi - -SubtitleApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`SubtitleApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.SubtitleApi.md#constructor) - -### Properties - -- [axios](generated_client.SubtitleApi.md#axios) -- [basePath](generated_client.SubtitleApi.md#basepath) -- [configuration](generated_client.SubtitleApi.md#configuration) - -### Methods - -- [deleteSubtitle](generated_client.SubtitleApi.md#deletesubtitle) -- [downloadRemoteSubtitles](generated_client.SubtitleApi.md#downloadremotesubtitles) -- [getFallbackFont](generated_client.SubtitleApi.md#getfallbackfont) -- [getFallbackFontList](generated_client.SubtitleApi.md#getfallbackfontlist) -- [getRemoteSubtitles](generated_client.SubtitleApi.md#getremotesubtitles) -- [getSubtitle](generated_client.SubtitleApi.md#getsubtitle) -- [getSubtitlePlaylist](generated_client.SubtitleApi.md#getsubtitleplaylist) -- [getSubtitleWithTicks](generated_client.SubtitleApi.md#getsubtitlewithticks) -- [searchRemoteSubtitles](generated_client.SubtitleApi.md#searchremotesubtitles) -- [uploadSubtitle](generated_client.SubtitleApi.md#uploadsubtitle) - -## Constructors - -### constructor - -• **new SubtitleApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### deleteSubtitle - -▸ **deleteSubtitle**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Deletes an external subtitle file. - -**`throws`** {RequiredError} - -**`memberof`** SubtitleApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SubtitleApiDeleteSubtitleRequest`](../interfaces/generated_client.SubtitleApiDeleteSubtitleRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/subtitle-api.ts:1194](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1194) - -___ - -### downloadRemoteSubtitles - -▸ **downloadRemoteSubtitles**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Downloads a remote subtitle. - -**`throws`** {RequiredError} - -**`memberof`** SubtitleApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SubtitleApiDownloadRemoteSubtitlesRequest`](../interfaces/generated_client.SubtitleApiDownloadRemoteSubtitlesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/subtitle-api.ts:1206](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1206) - -___ - -### getFallbackFont - -▸ **getFallbackFont**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a fallback font file. - -**`throws`** {RequiredError} - -**`memberof`** SubtitleApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SubtitleApiGetFallbackFontRequest`](../interfaces/generated_client.SubtitleApiGetFallbackFontRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/subtitle-api.ts:1218](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1218) - -___ - -### getFallbackFontList - -▸ **getFallbackFontList**(`options?`): `Promise`<`AxiosResponse`<[`FontFile`](../interfaces/generated_client.FontFile.md)[], `any`\>\> - -**`summary`** Gets a list of available fallback font files. - -**`throws`** {RequiredError} - -**`memberof`** SubtitleApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`FontFile`](../interfaces/generated_client.FontFile.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/subtitle-api.ts:1229](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1229) - -___ - -### getRemoteSubtitles - -▸ **getRemoteSubtitles**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets the remote subtitles. - -**`throws`** {RequiredError} - -**`memberof`** SubtitleApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SubtitleApiGetRemoteSubtitlesRequest`](../interfaces/generated_client.SubtitleApiGetRemoteSubtitlesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/subtitle-api.ts:1241](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1241) - -___ - -### getSubtitle - -▸ **getSubtitle**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets subtitles in a specified format. - -**`throws`** {RequiredError} - -**`memberof`** SubtitleApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SubtitleApiGetSubtitleRequest`](../interfaces/generated_client.SubtitleApiGetSubtitleRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/subtitle-api.ts:1253](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1253) - -___ - -### getSubtitlePlaylist - -▸ **getSubtitlePlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets an HLS subtitle playlist. - -**`throws`** {RequiredError} - -**`memberof`** SubtitleApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SubtitleApiGetSubtitlePlaylistRequest`](../interfaces/generated_client.SubtitleApiGetSubtitlePlaylistRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/subtitle-api.ts:1265](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1265) - -___ - -### getSubtitleWithTicks - -▸ **getSubtitleWithTicks**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets subtitles in a specified format. - -**`throws`** {RequiredError} - -**`memberof`** SubtitleApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SubtitleApiGetSubtitleWithTicksRequest`](../interfaces/generated_client.SubtitleApiGetSubtitleWithTicksRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/subtitle-api.ts:1277](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1277) - -___ - -### searchRemoteSubtitles - -▸ **searchRemoteSubtitles**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSubtitleInfo`](../interfaces/generated_client.RemoteSubtitleInfo.md)[], `any`\>\> - -**`summary`** Search remote subtitles. - -**`throws`** {RequiredError} - -**`memberof`** SubtitleApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SubtitleApiSearchRemoteSubtitlesRequest`](../interfaces/generated_client.SubtitleApiSearchRemoteSubtitlesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`RemoteSubtitleInfo`](../interfaces/generated_client.RemoteSubtitleInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/subtitle-api.ts:1289](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1289) - -___ - -### uploadSubtitle - -▸ **uploadSubtitle**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Upload an external subtitle file. - -**`throws`** {RequiredError} - -**`memberof`** SubtitleApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SubtitleApiUploadSubtitleRequest`](../interfaces/generated_client.SubtitleApiUploadSubtitleRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/subtitle-api.ts:1301](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1301) diff --git a/docs/classes/generated_client.SuggestionsApi.md b/docs/classes/generated_client.SuggestionsApi.md deleted file mode 100644 index 95ce27d68..000000000 --- a/docs/classes/generated_client.SuggestionsApi.md +++ /dev/null @@ -1,114 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SuggestionsApi - -# Class: SuggestionsApi - -[generated-client](../modules/generated_client.md).SuggestionsApi - -SuggestionsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`SuggestionsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.SuggestionsApi.md#constructor) - -### Properties - -- [axios](generated_client.SuggestionsApi.md#axios) -- [basePath](generated_client.SuggestionsApi.md#basepath) -- [configuration](generated_client.SuggestionsApi.md#configuration) - -### Methods - -- [getSuggestions](generated_client.SuggestionsApi.md#getsuggestions) - -## Constructors - -### constructor - -• **new SuggestionsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getSuggestions - -▸ **getSuggestions**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets suggestions. - -**`throws`** {RequiredError} - -**`memberof`** SuggestionsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SuggestionsApiGetSuggestionsRequest`](../interfaces/generated_client.SuggestionsApiGetSuggestionsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/suggestions-api.ts:213](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/suggestions-api.ts#L213) diff --git a/docs/classes/generated_client.SyncPlayApi.md b/docs/classes/generated_client.SyncPlayApi.md deleted file mode 100644 index 847f14d2e..000000000 --- a/docs/classes/generated_client.SyncPlayApi.md +++ /dev/null @@ -1,669 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApi - -# Class: SyncPlayApi - -[generated-client](../modules/generated_client.md).SyncPlayApi - -SyncPlayApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`SyncPlayApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.SyncPlayApi.md#constructor) - -### Properties - -- [axios](generated_client.SyncPlayApi.md#axios) -- [basePath](generated_client.SyncPlayApi.md#basepath) -- [configuration](generated_client.SyncPlayApi.md#configuration) - -### Methods - -- [syncPlayBuffering](generated_client.SyncPlayApi.md#syncplaybuffering) -- [syncPlayCreateGroup](generated_client.SyncPlayApi.md#syncplaycreategroup) -- [syncPlayGetGroups](generated_client.SyncPlayApi.md#syncplaygetgroups) -- [syncPlayJoinGroup](generated_client.SyncPlayApi.md#syncplayjoingroup) -- [syncPlayLeaveGroup](generated_client.SyncPlayApi.md#syncplayleavegroup) -- [syncPlayMovePlaylistItem](generated_client.SyncPlayApi.md#syncplaymoveplaylistitem) -- [syncPlayNextItem](generated_client.SyncPlayApi.md#syncplaynextitem) -- [syncPlayPause](generated_client.SyncPlayApi.md#syncplaypause) -- [syncPlayPing](generated_client.SyncPlayApi.md#syncplayping) -- [syncPlayPreviousItem](generated_client.SyncPlayApi.md#syncplaypreviousitem) -- [syncPlayQueue](generated_client.SyncPlayApi.md#syncplayqueue) -- [syncPlayReady](generated_client.SyncPlayApi.md#syncplayready) -- [syncPlayRemoveFromPlaylist](generated_client.SyncPlayApi.md#syncplayremovefromplaylist) -- [syncPlaySeek](generated_client.SyncPlayApi.md#syncplayseek) -- [syncPlaySetIgnoreWait](generated_client.SyncPlayApi.md#syncplaysetignorewait) -- [syncPlaySetNewQueue](generated_client.SyncPlayApi.md#syncplaysetnewqueue) -- [syncPlaySetPlaylistItem](generated_client.SyncPlayApi.md#syncplaysetplaylistitem) -- [syncPlaySetRepeatMode](generated_client.SyncPlayApi.md#syncplaysetrepeatmode) -- [syncPlaySetShuffleMode](generated_client.SyncPlayApi.md#syncplaysetshufflemode) -- [syncPlayStop](generated_client.SyncPlayApi.md#syncplaystop) -- [syncPlayUnpause](generated_client.SyncPlayApi.md#syncplayunpause) - -## Constructors - -### constructor - -• **new SyncPlayApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### syncPlayBuffering - -▸ **syncPlayBuffering**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Notify SyncPlay group that member is buffering. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlayBufferingRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayBufferingRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1545](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1545) - -___ - -### syncPlayCreateGroup - -▸ **syncPlayCreateGroup**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Create a new SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlayCreateGroupRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayCreateGroupRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1557](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1557) - -___ - -### syncPlayGetGroups - -▸ **syncPlayGetGroups**(`options?`): `Promise`<`AxiosResponse`<[`GroupInfoDto`](../interfaces/generated_client.GroupInfoDto.md)[], `any`\>\> - -**`summary`** Gets all SyncPlay groups. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`GroupInfoDto`](../interfaces/generated_client.GroupInfoDto.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1568](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1568) - -___ - -### syncPlayJoinGroup - -▸ **syncPlayJoinGroup**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Join an existing SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlayJoinGroupRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayJoinGroupRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1580](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1580) - -___ - -### syncPlayLeaveGroup - -▸ **syncPlayLeaveGroup**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Leave the joined SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1591](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1591) - -___ - -### syncPlayMovePlaylistItem - -▸ **syncPlayMovePlaylistItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request to move an item in the playlist in SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlayMovePlaylistItemRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayMovePlaylistItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1603](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1603) - -___ - -### syncPlayNextItem - -▸ **syncPlayNextItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request next item in SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlayNextItemRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayNextItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1615](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1615) - -___ - -### syncPlayPause - -▸ **syncPlayPause**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request pause in SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1626](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1626) - -___ - -### syncPlayPing - -▸ **syncPlayPing**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Update session ping. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlayPingRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayPingRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1638](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1638) - -___ - -### syncPlayPreviousItem - -▸ **syncPlayPreviousItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request previous item in SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlayPreviousItemRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayPreviousItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1650](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1650) - -___ - -### syncPlayQueue - -▸ **syncPlayQueue**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request to queue items to the playlist of a SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlayQueueRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayQueueRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1662](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1662) - -___ - -### syncPlayReady - -▸ **syncPlayReady**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Notify SyncPlay group that member is ready for playback. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlayReadyRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayReadyRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1674](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1674) - -___ - -### syncPlayRemoveFromPlaylist - -▸ **syncPlayRemoveFromPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request to remove items from the playlist in SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlayRemoveFromPlaylistRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayRemoveFromPlaylistRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1686](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1686) - -___ - -### syncPlaySeek - -▸ **syncPlaySeek**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request seek in SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlaySeekRequest`](../interfaces/generated_client.SyncPlayApiSyncPlaySeekRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1698](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1698) - -___ - -### syncPlaySetIgnoreWait - -▸ **syncPlaySetIgnoreWait**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request SyncPlay group to ignore member during group-wait. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlaySetIgnoreWaitRequest`](../interfaces/generated_client.SyncPlayApiSyncPlaySetIgnoreWaitRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1710](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1710) - -___ - -### syncPlaySetNewQueue - -▸ **syncPlaySetNewQueue**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request to set new playlist in SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlaySetNewQueueRequest`](../interfaces/generated_client.SyncPlayApiSyncPlaySetNewQueueRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1722](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1722) - -___ - -### syncPlaySetPlaylistItem - -▸ **syncPlaySetPlaylistItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request to change playlist item in SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlaySetPlaylistItemRequest`](../interfaces/generated_client.SyncPlayApiSyncPlaySetPlaylistItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1734](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1734) - -___ - -### syncPlaySetRepeatMode - -▸ **syncPlaySetRepeatMode**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request to set repeat mode in SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlaySetRepeatModeRequest`](../interfaces/generated_client.SyncPlayApiSyncPlaySetRepeatModeRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1746](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1746) - -___ - -### syncPlaySetShuffleMode - -▸ **syncPlaySetShuffleMode**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request to set shuffle mode in SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SyncPlayApiSyncPlaySetShuffleModeRequest`](../interfaces/generated_client.SyncPlayApiSyncPlaySetShuffleModeRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1758](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1758) - -___ - -### syncPlayStop - -▸ **syncPlayStop**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request stop in SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1769](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1769) - -___ - -### syncPlayUnpause - -▸ **syncPlayUnpause**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Request unpause in SyncPlay group. - -**`throws`** {RequiredError} - -**`memberof`** SyncPlayApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/sync-play-api.ts:1780](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1780) diff --git a/docs/classes/generated_client.SystemApi.md b/docs/classes/generated_client.SystemApi.md deleted file mode 100644 index 1ebbf86eb..000000000 --- a/docs/classes/generated_client.SystemApi.md +++ /dev/null @@ -1,359 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SystemApi - -# Class: SystemApi - -[generated-client](../modules/generated_client.md).SystemApi - -SystemApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`SystemApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.SystemApi.md#constructor) - -### Properties - -- [axios](generated_client.SystemApi.md#axios) -- [basePath](generated_client.SystemApi.md#basepath) -- [configuration](generated_client.SystemApi.md#configuration) - -### Methods - -- [getEndpointInfo](generated_client.SystemApi.md#getendpointinfo) -- [getLogFile](generated_client.SystemApi.md#getlogfile) -- [getPingSystem](generated_client.SystemApi.md#getpingsystem) -- [getPublicSystemInfo](generated_client.SystemApi.md#getpublicsysteminfo) -- [getServerLogs](generated_client.SystemApi.md#getserverlogs) -- [getSystemInfo](generated_client.SystemApi.md#getsysteminfo) -- [getWakeOnLanInfo](generated_client.SystemApi.md#getwakeonlaninfo) -- [postPingSystem](generated_client.SystemApi.md#postpingsystem) -- [restartApplication](generated_client.SystemApi.md#restartapplication) -- [shutdownApplication](generated_client.SystemApi.md#shutdownapplication) - -## Constructors - -### constructor - -• **new SystemApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getEndpointInfo - -▸ **getEndpointInfo**(`options?`): `Promise`<`AxiosResponse`<[`EndPointInfo`](../interfaces/generated_client.EndPointInfo.md), `any`\>\> - -**`summary`** Gets information about the request endpoint. - -**`throws`** {RequiredError} - -**`memberof`** SystemApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`EndPointInfo`](../interfaces/generated_client.EndPointInfo.md), `any`\>\> - -#### Defined in - -[generated-client/api/system-api.ts:613](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L613) - -___ - -### getLogFile - -▸ **getLogFile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a log file. - -**`throws`** {RequiredError} - -**`memberof`** SystemApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`SystemApiGetLogFileRequest`](../interfaces/generated_client.SystemApiGetLogFileRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/system-api.ts:625](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L625) - -___ - -### getPingSystem - -▸ **getPingSystem**(`options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\> - -**`summary`** Pings the system. - -**`throws`** {RequiredError} - -**`memberof`** SystemApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`string`, `any`\>\> - -#### Defined in - -[generated-client/api/system-api.ts:636](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L636) - -___ - -### getPublicSystemInfo - -▸ **getPublicSystemInfo**(`options?`): `Promise`<`AxiosResponse`<[`PublicSystemInfo`](../interfaces/generated_client.PublicSystemInfo.md), `any`\>\> - -**`summary`** Gets public information about the server. - -**`throws`** {RequiredError} - -**`memberof`** SystemApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`PublicSystemInfo`](../interfaces/generated_client.PublicSystemInfo.md), `any`\>\> - -#### Defined in - -[generated-client/api/system-api.ts:647](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L647) - -___ - -### getServerLogs - -▸ **getServerLogs**(`options?`): `Promise`<`AxiosResponse`<[`LogFile`](../interfaces/generated_client.LogFile.md)[], `any`\>\> - -**`summary`** Gets a list of available server log files. - -**`throws`** {RequiredError} - -**`memberof`** SystemApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`LogFile`](../interfaces/generated_client.LogFile.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/system-api.ts:658](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L658) - -___ - -### getSystemInfo - -▸ **getSystemInfo**(`options?`): `Promise`<`AxiosResponse`<[`SystemInfo`](../interfaces/generated_client.SystemInfo.md), `any`\>\> - -**`summary`** Gets information about the server. - -**`throws`** {RequiredError} - -**`memberof`** SystemApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`SystemInfo`](../interfaces/generated_client.SystemInfo.md), `any`\>\> - -#### Defined in - -[generated-client/api/system-api.ts:669](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L669) - -___ - -### getWakeOnLanInfo - -▸ **getWakeOnLanInfo**(`options?`): `Promise`<`AxiosResponse`<[`WakeOnLanInfo`](../interfaces/generated_client.WakeOnLanInfo.md)[], `any`\>\> - -**`summary`** Gets wake on lan information. - -**`deprecated`** - -**`throws`** {RequiredError} - -**`memberof`** SystemApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`WakeOnLanInfo`](../interfaces/generated_client.WakeOnLanInfo.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/system-api.ts:681](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L681) - -___ - -### postPingSystem - -▸ **postPingSystem**(`options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\> - -**`summary`** Pings the system. - -**`throws`** {RequiredError} - -**`memberof`** SystemApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`string`, `any`\>\> - -#### Defined in - -[generated-client/api/system-api.ts:692](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L692) - -___ - -### restartApplication - -▸ **restartApplication**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Restarts the application. - -**`throws`** {RequiredError} - -**`memberof`** SystemApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/system-api.ts:703](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L703) - -___ - -### shutdownApplication - -▸ **shutdownApplication**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Shuts down the application. - -**`throws`** {RequiredError} - -**`memberof`** SystemApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/system-api.ts:714](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L714) diff --git a/docs/classes/generated_client.TimeSyncApi.md b/docs/classes/generated_client.TimeSyncApi.md deleted file mode 100644 index 1fb4f86d4..000000000 --- a/docs/classes/generated_client.TimeSyncApi.md +++ /dev/null @@ -1,113 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TimeSyncApi - -# Class: TimeSyncApi - -[generated-client](../modules/generated_client.md).TimeSyncApi - -TimeSyncApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`TimeSyncApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.TimeSyncApi.md#constructor) - -### Properties - -- [axios](generated_client.TimeSyncApi.md#axios) -- [basePath](generated_client.TimeSyncApi.md#basepath) -- [configuration](generated_client.TimeSyncApi.md#configuration) - -### Methods - -- [getUtcTime](generated_client.TimeSyncApi.md#getutctime) - -## Constructors - -### constructor - -• **new TimeSyncApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getUtcTime - -▸ **getUtcTime**(`options?`): `Promise`<`AxiosResponse`<[`UtcTimeResponse`](../interfaces/generated_client.UtcTimeResponse.md), `any`\>\> - -**`summary`** Gets the current UTC time. - -**`throws`** {RequiredError} - -**`memberof`** TimeSyncApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`UtcTimeResponse`](../interfaces/generated_client.UtcTimeResponse.md), `any`\>\> - -#### Defined in - -[generated-client/api/time-sync-api.ts:117](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/time-sync-api.ts#L117) diff --git a/docs/classes/generated_client.TmdbApi.md b/docs/classes/generated_client.TmdbApi.md deleted file mode 100644 index 8889c3d4e..000000000 --- a/docs/classes/generated_client.TmdbApi.md +++ /dev/null @@ -1,113 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TmdbApi - -# Class: TmdbApi - -[generated-client](../modules/generated_client.md).TmdbApi - -TmdbApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`TmdbApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.TmdbApi.md#constructor) - -### Properties - -- [axios](generated_client.TmdbApi.md#axios) -- [basePath](generated_client.TmdbApi.md#basepath) -- [configuration](generated_client.TmdbApi.md#configuration) - -### Methods - -- [tmdbClientConfiguration](generated_client.TmdbApi.md#tmdbclientconfiguration) - -## Constructors - -### constructor - -• **new TmdbApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### tmdbClientConfiguration - -▸ **tmdbClientConfiguration**(`options?`): `Promise`<`AxiosResponse`<[`ConfigImageTypes`](../interfaces/generated_client.ConfigImageTypes.md), `any`\>\> - -**`summary`** Gets the TMDb image configuration options. - -**`throws`** {RequiredError} - -**`memberof`** TmdbApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`ConfigImageTypes`](../interfaces/generated_client.ConfigImageTypes.md), `any`\>\> - -#### Defined in - -[generated-client/api/tmdb-api.ts:120](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tmdb-api.ts#L120) diff --git a/docs/classes/generated_client.TrailersApi.md b/docs/classes/generated_client.TrailersApi.md deleted file mode 100644 index 4f3166ca4..000000000 --- a/docs/classes/generated_client.TrailersApi.md +++ /dev/null @@ -1,114 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TrailersApi - -# Class: TrailersApi - -[generated-client](../modules/generated_client.md).TrailersApi - -TrailersApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`TrailersApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.TrailersApi.md#constructor) - -### Properties - -- [axios](generated_client.TrailersApi.md#axios) -- [basePath](generated_client.TrailersApi.md#basepath) -- [configuration](generated_client.TrailersApi.md#configuration) - -### Methods - -- [getTrailers](generated_client.TrailersApi.md#gettrailers) - -## Constructors - -### constructor - -• **new TrailersApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getTrailers - -▸ **getTrailers**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Finds movies and trailers similar to a given trailer. - -**`throws`** {RequiredError} - -**`memberof`** TrailersApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`TrailersApiGetTrailersRequest`](../interfaces/generated_client.TrailersApiGetTrailersRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/trailers-api.ts:1328](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1328) diff --git a/docs/classes/generated_client.TvShowsApi.md b/docs/classes/generated_client.TvShowsApi.md deleted file mode 100644 index 3e7719ac8..000000000 --- a/docs/classes/generated_client.TvShowsApi.md +++ /dev/null @@ -1,198 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TvShowsApi - -# Class: TvShowsApi - -[generated-client](../modules/generated_client.md).TvShowsApi - -TvShowsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`TvShowsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.TvShowsApi.md#constructor) - -### Properties - -- [axios](generated_client.TvShowsApi.md#axios) -- [basePath](generated_client.TvShowsApi.md#basepath) -- [configuration](generated_client.TvShowsApi.md#configuration) - -### Methods - -- [getEpisodes](generated_client.TvShowsApi.md#getepisodes) -- [getNextUp](generated_client.TvShowsApi.md#getnextup) -- [getSeasons](generated_client.TvShowsApi.md#getseasons) -- [getUpcomingEpisodes](generated_client.TvShowsApi.md#getupcomingepisodes) - -## Constructors - -### constructor - -• **new TvShowsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getEpisodes - -▸ **getEpisodes**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets episodes for a tv season. - -**`throws`** {RequiredError} - -**`memberof`** TvShowsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`TvShowsApiGetEpisodesRequest`](../interfaces/generated_client.TvShowsApiGetEpisodesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/tv-shows-api.ts:983](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L983) - -___ - -### getNextUp - -▸ **getNextUp**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets a list of next up episodes. - -**`throws`** {RequiredError} - -**`memberof`** TvShowsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`TvShowsApiGetNextUpRequest`](../interfaces/generated_client.TvShowsApiGetNextUpRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/tv-shows-api.ts:995](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L995) - -___ - -### getSeasons - -▸ **getSeasons**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets seasons for a tv series. - -**`throws`** {RequiredError} - -**`memberof`** TvShowsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`TvShowsApiGetSeasonsRequest`](../interfaces/generated_client.TvShowsApiGetSeasonsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/tv-shows-api.ts:1007](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L1007) - -___ - -### getUpcomingEpisodes - -▸ **getUpcomingEpisodes**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets a list of upcoming episodes. - -**`throws`** {RequiredError} - -**`memberof`** TvShowsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`TvShowsApiGetUpcomingEpisodesRequest`](../interfaces/generated_client.TvShowsApiGetUpcomingEpisodesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/tv-shows-api.ts:1019](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L1019) diff --git a/docs/classes/generated_client.UniversalAudioApi.md b/docs/classes/generated_client.UniversalAudioApi.md deleted file mode 100644 index 949c9884e..000000000 --- a/docs/classes/generated_client.UniversalAudioApi.md +++ /dev/null @@ -1,142 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UniversalAudioApi - -# Class: UniversalAudioApi - -[generated-client](../modules/generated_client.md).UniversalAudioApi - -UniversalAudioApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`UniversalAudioApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.UniversalAudioApi.md#constructor) - -### Properties - -- [axios](generated_client.UniversalAudioApi.md#axios) -- [basePath](generated_client.UniversalAudioApi.md#basepath) -- [configuration](generated_client.UniversalAudioApi.md#configuration) - -### Methods - -- [getUniversalAudioStream](generated_client.UniversalAudioApi.md#getuniversalaudiostream) -- [headUniversalAudioStream](generated_client.UniversalAudioApi.md#headuniversalaudiostream) - -## Constructors - -### constructor - -• **new UniversalAudioApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getUniversalAudioStream - -▸ **getUniversalAudioStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets an audio stream. - -**`throws`** {RequiredError} - -**`memberof`** UniversalAudioApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UniversalAudioApiGetUniversalAudioStreamRequest`](../interfaces/generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/universal-audio-api.ts:687](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L687) - -___ - -### headUniversalAudioStream - -▸ **headUniversalAudioStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets an audio stream. - -**`throws`** {RequiredError} - -**`memberof`** UniversalAudioApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UniversalAudioApiHeadUniversalAudioStreamRequest`](../interfaces/generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/universal-audio-api.ts:699](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L699) diff --git a/docs/classes/generated_client.UserApi.md b/docs/classes/generated_client.UserApi.md deleted file mode 100644 index e18517972..000000000 --- a/docs/classes/generated_client.UserApi.md +++ /dev/null @@ -1,532 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApi - -# Class: UserApi - -[generated-client](../modules/generated_client.md).UserApi - -UserApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`UserApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.UserApi.md#constructor) - -### Properties - -- [axios](generated_client.UserApi.md#axios) -- [basePath](generated_client.UserApi.md#basepath) -- [configuration](generated_client.UserApi.md#configuration) - -### Methods - -- [authenticateUser](generated_client.UserApi.md#authenticateuser) -- [authenticateUserByName](generated_client.UserApi.md#authenticateuserbyname) -- [authenticateWithQuickConnect](generated_client.UserApi.md#authenticatewithquickconnect) -- [createUserByName](generated_client.UserApi.md#createuserbyname) -- [deleteUser](generated_client.UserApi.md#deleteuser) -- [forgotPassword](generated_client.UserApi.md#forgotpassword) -- [forgotPasswordPin](generated_client.UserApi.md#forgotpasswordpin) -- [getCurrentUser](generated_client.UserApi.md#getcurrentuser) -- [getPublicUsers](generated_client.UserApi.md#getpublicusers) -- [getUserById](generated_client.UserApi.md#getuserbyid) -- [getUsers](generated_client.UserApi.md#getusers) -- [updateUser](generated_client.UserApi.md#updateuser) -- [updateUserConfiguration](generated_client.UserApi.md#updateuserconfiguration) -- [updateUserEasyPassword](generated_client.UserApi.md#updateusereasypassword) -- [updateUserPassword](generated_client.UserApi.md#updateuserpassword) -- [updateUserPolicy](generated_client.UserApi.md#updateuserpolicy) - -## Constructors - -### constructor - -• **new UserApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### authenticateUser - -▸ **authenticateUser**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\> - -**`summary`** Authenticates a user. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiAuthenticateUserRequest`](../interfaces/generated_client.UserApiAuthenticateUserRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1319](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1319) - -___ - -### authenticateUserByName - -▸ **authenticateUserByName**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\> - -**`summary`** Authenticates a user by name. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiAuthenticateUserByNameRequest`](../interfaces/generated_client.UserApiAuthenticateUserByNameRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1331](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1331) - -___ - -### authenticateWithQuickConnect - -▸ **authenticateWithQuickConnect**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\> - -**`summary`** Authenticates a user with quick connect. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiAuthenticateWithQuickConnectRequest`](../interfaces/generated_client.UserApiAuthenticateWithQuickConnectRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1343](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1343) - -___ - -### createUserByName - -▸ **createUserByName**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md), `any`\>\> - -**`summary`** Creates a user. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiCreateUserByNameRequest`](../interfaces/generated_client.UserApiCreateUserByNameRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1355](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1355) - -___ - -### deleteUser - -▸ **deleteUser**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Deletes a user. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiDeleteUserRequest`](../interfaces/generated_client.UserApiDeleteUserRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1367](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1367) - -___ - -### forgotPassword - -▸ **forgotPassword**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ForgotPasswordResult`](../interfaces/generated_client.ForgotPasswordResult.md), `any`\>\> - -**`summary`** Initiates the forgot password process for a local user. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiForgotPasswordRequest`](../interfaces/generated_client.UserApiForgotPasswordRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`ForgotPasswordResult`](../interfaces/generated_client.ForgotPasswordResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1379](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1379) - -___ - -### forgotPasswordPin - -▸ **forgotPasswordPin**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`PinRedeemResult`](../interfaces/generated_client.PinRedeemResult.md), `any`\>\> - -**`summary`** Redeems a forgot password pin. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiForgotPasswordPinRequest`](../interfaces/generated_client.UserApiForgotPasswordPinRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`PinRedeemResult`](../interfaces/generated_client.PinRedeemResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1391](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1391) - -___ - -### getCurrentUser - -▸ **getCurrentUser**(`options?`): `Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md), `any`\>\> - -**`summary`** Gets the user based on auth token. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1402](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1402) - -___ - -### getPublicUsers - -▸ **getPublicUsers**(`options?`): `Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md)[], `any`\>\> - -**`summary`** Gets a list of publicly visible users for display on a login screen. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | - -#### Returns - -`Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1413](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1413) - -___ - -### getUserById - -▸ **getUserById**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md), `any`\>\> - -**`summary`** Gets a user by Id. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiGetUserByIdRequest`](../interfaces/generated_client.UserApiGetUserByIdRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1425](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1425) - -___ - -### getUsers - -▸ **getUsers**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md)[], `any`\>\> - -**`summary`** Gets a list of users. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiGetUsersRequest`](../interfaces/generated_client.UserApiGetUsersRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1437](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1437) - -___ - -### updateUser - -▸ **updateUser**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates a user. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiUpdateUserRequest`](../interfaces/generated_client.UserApiUpdateUserRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1449](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1449) - -___ - -### updateUserConfiguration - -▸ **updateUserConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates a user configuration. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiUpdateUserConfigurationRequest`](../interfaces/generated_client.UserApiUpdateUserConfigurationRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1461](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1461) - -___ - -### updateUserEasyPassword - -▸ **updateUserEasyPassword**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates a user\'s easy password. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiUpdateUserEasyPasswordRequest`](../interfaces/generated_client.UserApiUpdateUserEasyPasswordRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1473](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1473) - -___ - -### updateUserPassword - -▸ **updateUserPassword**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates a user\'s password. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiUpdateUserPasswordRequest`](../interfaces/generated_client.UserApiUpdateUserPasswordRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1485](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1485) - -___ - -### updateUserPolicy - -▸ **updateUserPolicy**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Updates a user policy. - -**`throws`** {RequiredError} - -**`memberof`** UserApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserApiUpdateUserPolicyRequest`](../interfaces/generated_client.UserApiUpdateUserPolicyRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/user-api.ts:1497](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1497) diff --git a/docs/classes/generated_client.UserLibraryApi.md b/docs/classes/generated_client.UserLibraryApi.md deleted file mode 100644 index 190acf492..000000000 --- a/docs/classes/generated_client.UserLibraryApi.md +++ /dev/null @@ -1,366 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserLibraryApi - -# Class: UserLibraryApi - -[generated-client](../modules/generated_client.md).UserLibraryApi - -UserLibraryApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`UserLibraryApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.UserLibraryApi.md#constructor) - -### Properties - -- [axios](generated_client.UserLibraryApi.md#axios) -- [basePath](generated_client.UserLibraryApi.md#basepath) -- [configuration](generated_client.UserLibraryApi.md#configuration) - -### Methods - -- [deleteUserItemRating](generated_client.UserLibraryApi.md#deleteuseritemrating) -- [getIntros](generated_client.UserLibraryApi.md#getintros) -- [getItem](generated_client.UserLibraryApi.md#getitem) -- [getLatestMedia](generated_client.UserLibraryApi.md#getlatestmedia) -- [getLocalTrailers](generated_client.UserLibraryApi.md#getlocaltrailers) -- [getRootFolder](generated_client.UserLibraryApi.md#getrootfolder) -- [getSpecialFeatures](generated_client.UserLibraryApi.md#getspecialfeatures) -- [markFavoriteItem](generated_client.UserLibraryApi.md#markfavoriteitem) -- [unmarkFavoriteItem](generated_client.UserLibraryApi.md#unmarkfavoriteitem) -- [updateUserItemRating](generated_client.UserLibraryApi.md#updateuseritemrating) - -## Constructors - -### constructor - -• **new UserLibraryApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### deleteUserItemRating - -▸ **deleteUserItemRating**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\> - -**`summary`** Deletes a user\'s saved personal rating for an item. - -**`throws`** {RequiredError} - -**`memberof`** UserLibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserLibraryApiDeleteUserItemRatingRequest`](../interfaces/generated_client.UserLibraryApiDeleteUserItemRatingRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-library-api.ts:1057](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1057) - -___ - -### getIntros - -▸ **getIntros**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets intros to play before the main media item plays. - -**`throws`** {RequiredError} - -**`memberof`** UserLibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserLibraryApiGetIntrosRequest`](../interfaces/generated_client.UserLibraryApiGetIntrosRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-library-api.ts:1069](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1069) - -___ - -### getItem - -▸ **getItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -**`summary`** Gets an item from a user\'s library. - -**`throws`** {RequiredError} - -**`memberof`** UserLibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserLibraryApiGetItemRequest`](../interfaces/generated_client.UserLibraryApiGetItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-library-api.ts:1081](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1081) - -___ - -### getLatestMedia - -▸ **getLatestMedia**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\> - -**`summary`** Gets latest media. - -**`throws`** {RequiredError} - -**`memberof`** UserLibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserLibraryApiGetLatestMediaRequest`](../interfaces/generated_client.UserLibraryApiGetLatestMediaRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/user-library-api.ts:1093](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1093) - -___ - -### getLocalTrailers - -▸ **getLocalTrailers**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\> - -**`summary`** Gets local trailers for an item. - -**`throws`** {RequiredError} - -**`memberof`** UserLibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserLibraryApiGetLocalTrailersRequest`](../interfaces/generated_client.UserLibraryApiGetLocalTrailersRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/user-library-api.ts:1105](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1105) - -___ - -### getRootFolder - -▸ **getRootFolder**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -**`summary`** Gets the root folder from a user\'s library. - -**`throws`** {RequiredError} - -**`memberof`** UserLibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserLibraryApiGetRootFolderRequest`](../interfaces/generated_client.UserLibraryApiGetRootFolderRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-library-api.ts:1117](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1117) - -___ - -### getSpecialFeatures - -▸ **getSpecialFeatures**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\> - -**`summary`** Gets special features for an item. - -**`throws`** {RequiredError} - -**`memberof`** UserLibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserLibraryApiGetSpecialFeaturesRequest`](../interfaces/generated_client.UserLibraryApiGetSpecialFeaturesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/user-library-api.ts:1129](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1129) - -___ - -### markFavoriteItem - -▸ **markFavoriteItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\> - -**`summary`** Marks an item as a favorite. - -**`throws`** {RequiredError} - -**`memberof`** UserLibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserLibraryApiMarkFavoriteItemRequest`](../interfaces/generated_client.UserLibraryApiMarkFavoriteItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-library-api.ts:1141](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1141) - -___ - -### unmarkFavoriteItem - -▸ **unmarkFavoriteItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\> - -**`summary`** Unmarks item as a favorite. - -**`throws`** {RequiredError} - -**`memberof`** UserLibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserLibraryApiUnmarkFavoriteItemRequest`](../interfaces/generated_client.UserLibraryApiUnmarkFavoriteItemRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-library-api.ts:1153](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1153) - -___ - -### updateUserItemRating - -▸ **updateUserItemRating**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\> - -**`summary`** Updates a user\'s rating for an item. - -**`throws`** {RequiredError} - -**`memberof`** UserLibraryApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserLibraryApiUpdateUserItemRatingRequest`](../interfaces/generated_client.UserLibraryApiUpdateUserItemRatingRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-library-api.ts:1165](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1165) diff --git a/docs/classes/generated_client.UserViewsApi.md b/docs/classes/generated_client.UserViewsApi.md deleted file mode 100644 index 5c5428948..000000000 --- a/docs/classes/generated_client.UserViewsApi.md +++ /dev/null @@ -1,142 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserViewsApi - -# Class: UserViewsApi - -[generated-client](../modules/generated_client.md).UserViewsApi - -UserViewsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`UserViewsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.UserViewsApi.md#constructor) - -### Properties - -- [axios](generated_client.UserViewsApi.md#axios) -- [basePath](generated_client.UserViewsApi.md#basepath) -- [configuration](generated_client.UserViewsApi.md#configuration) - -### Methods - -- [getGroupingOptions](generated_client.UserViewsApi.md#getgroupingoptions) -- [getUserViews](generated_client.UserViewsApi.md#getuserviews) - -## Constructors - -### constructor - -• **new UserViewsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getGroupingOptions - -▸ **getGroupingOptions**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`SpecialViewOptionDto`](../interfaces/generated_client.SpecialViewOptionDto.md)[], `any`\>\> - -**`summary`** Get user view grouping options. - -**`throws`** {RequiredError} - -**`memberof`** UserViewsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserViewsApiGetGroupingOptionsRequest`](../interfaces/generated_client.UserViewsApiGetGroupingOptionsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`SpecialViewOptionDto`](../interfaces/generated_client.SpecialViewOptionDto.md)[], `any`\>\> - -#### Defined in - -[generated-client/api/user-views-api.ts:259](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-views-api.ts#L259) - -___ - -### getUserViews - -▸ **getUserViews**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Get user views. - -**`throws`** {RequiredError} - -**`memberof`** UserViewsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`UserViewsApiGetUserViewsRequest`](../interfaces/generated_client.UserViewsApiGetUserViewsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/user-views-api.ts:271](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-views-api.ts#L271) diff --git a/docs/classes/generated_client.VideoAttachmentsApi.md b/docs/classes/generated_client.VideoAttachmentsApi.md deleted file mode 100644 index c4939517e..000000000 --- a/docs/classes/generated_client.VideoAttachmentsApi.md +++ /dev/null @@ -1,114 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideoAttachmentsApi - -# Class: VideoAttachmentsApi - -[generated-client](../modules/generated_client.md).VideoAttachmentsApi - -VideoAttachmentsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`VideoAttachmentsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.VideoAttachmentsApi.md#constructor) - -### Properties - -- [axios](generated_client.VideoAttachmentsApi.md#axios) -- [basePath](generated_client.VideoAttachmentsApi.md#basepath) -- [configuration](generated_client.VideoAttachmentsApi.md#configuration) - -### Methods - -- [getAttachment](generated_client.VideoAttachmentsApi.md#getattachment) - -## Constructors - -### constructor - -• **new VideoAttachmentsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getAttachment - -▸ **getAttachment**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Get video attachment. - -**`throws`** {RequiredError} - -**`memberof`** VideoAttachmentsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`VideoAttachmentsApiGetAttachmentRequest`](../interfaces/generated_client.VideoAttachmentsApiGetAttachmentRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/video-attachments-api.ts:164](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/video-attachments-api.ts#L164) diff --git a/docs/classes/generated_client.VideosApi.md b/docs/classes/generated_client.VideosApi.md deleted file mode 100644 index 3abd7188b..000000000 --- a/docs/classes/generated_client.VideosApi.md +++ /dev/null @@ -1,282 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideosApi - -# Class: VideosApi - -[generated-client](../modules/generated_client.md).VideosApi - -VideosApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`VideosApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.VideosApi.md#constructor) - -### Properties - -- [axios](generated_client.VideosApi.md#axios) -- [basePath](generated_client.VideosApi.md#basepath) -- [configuration](generated_client.VideosApi.md#configuration) - -### Methods - -- [deleteAlternateSources](generated_client.VideosApi.md#deletealternatesources) -- [getAdditionalPart](generated_client.VideosApi.md#getadditionalpart) -- [getVideoStream](generated_client.VideosApi.md#getvideostream) -- [getVideoStreamByContainer](generated_client.VideosApi.md#getvideostreambycontainer) -- [headVideoStream](generated_client.VideosApi.md#headvideostream) -- [headVideoStreamByContainer](generated_client.VideosApi.md#headvideostreambycontainer) -- [mergeVersions](generated_client.VideosApi.md#mergeversions) - -## Constructors - -### constructor - -• **new VideosApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### deleteAlternateSources - -▸ **deleteAlternateSources**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Removes alternate video sources. - -**`throws`** {RequiredError} - -**`memberof`** VideosApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`VideosApiDeleteAlternateSourcesRequest`](../interfaces/generated_client.VideosApiDeleteAlternateSourcesRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/videos-api.ts:3382](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3382) - -___ - -### getAdditionalPart - -▸ **getAdditionalPart**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Gets additional parts for a video. - -**`throws`** {RequiredError} - -**`memberof`** VideosApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`VideosApiGetAdditionalPartRequest`](../interfaces/generated_client.VideosApiGetAdditionalPartRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/videos-api.ts:3394](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3394) - -___ - -### getVideoStream - -▸ **getVideoStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a video stream. - -**`throws`** {RequiredError} - -**`memberof`** VideosApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`VideosApiGetVideoStreamRequest`](../interfaces/generated_client.VideosApiGetVideoStreamRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/videos-api.ts:3406](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3406) - -___ - -### getVideoStreamByContainer - -▸ **getVideoStreamByContainer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a video stream. - -**`throws`** {RequiredError} - -**`memberof`** VideosApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`VideosApiGetVideoStreamByContainerRequest`](../interfaces/generated_client.VideosApiGetVideoStreamByContainerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/videos-api.ts:3418](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3418) - -___ - -### headVideoStream - -▸ **headVideoStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a video stream. - -**`throws`** {RequiredError} - -**`memberof`** VideosApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`VideosApiHeadVideoStreamRequest`](../interfaces/generated_client.VideosApiHeadVideoStreamRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/videos-api.ts:3430](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3430) - -___ - -### headVideoStreamByContainer - -▸ **headVideoStreamByContainer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> - -**`summary`** Gets a video stream. - -**`throws`** {RequiredError} - -**`memberof`** VideosApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`VideosApiHeadVideoStreamByContainerRequest`](../interfaces/generated_client.VideosApiHeadVideoStreamByContainerRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`any`, `any`\>\> - -#### Defined in - -[generated-client/api/videos-api.ts:3442](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3442) - -___ - -### mergeVersions - -▸ **mergeVersions**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> - -**`summary`** Merges videos into a single record. - -**`throws`** {RequiredError} - -**`memberof`** VideosApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`VideosApiMergeVersionsRequest`](../interfaces/generated_client.VideosApiMergeVersionsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\>\> - -#### Defined in - -[generated-client/api/videos-api.ts:3454](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3454) diff --git a/docs/classes/generated_client.YearsApi.md b/docs/classes/generated_client.YearsApi.md deleted file mode 100644 index 5d6a597f2..000000000 --- a/docs/classes/generated_client.YearsApi.md +++ /dev/null @@ -1,142 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / YearsApi - -# Class: YearsApi - -[generated-client](../modules/generated_client.md).YearsApi - -YearsApi - object-oriented interface - -**`export`** - -## Hierarchy - -- `BaseAPI` - - ↳ **`YearsApi`** - -## Table of contents - -### Constructors - -- [constructor](generated_client.YearsApi.md#constructor) - -### Properties - -- [axios](generated_client.YearsApi.md#axios) -- [basePath](generated_client.YearsApi.md#basepath) -- [configuration](generated_client.YearsApi.md#configuration) - -### Methods - -- [getYear](generated_client.YearsApi.md#getyear) -- [getYears](generated_client.YearsApi.md#getyears) - -## Constructors - -### constructor - -• **new YearsApi**(`configuration?`, `basePath?`, `axios?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50) - -## Methods - -### getYear - -▸ **getYear**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -**`summary`** Gets a year. - -**`throws`** {RequiredError} - -**`memberof`** YearsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`YearsApiGetYearRequest`](../interfaces/generated_client.YearsApiGetYearRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\> - -#### Defined in - -[generated-client/api/years-api.ts:436](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L436) - -___ - -### getYears - -▸ **getYears**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -**`summary`** Get years. - -**`throws`** {RequiredError} - -**`memberof`** YearsApi - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestParameters` | [`YearsApiGetYearsRequest`](../interfaces/generated_client.YearsApiGetYearsRequest.md) | Request parameters. | -| `options?` | `any` | - | - -#### Returns - -`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\> - -#### Defined in - -[generated-client/api/years-api.ts:448](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L448) diff --git a/docs/classes/index.Api.md b/docs/classes/index.Api.md deleted file mode 100644 index cbe72a2da..000000000 --- a/docs/classes/index.Api.md +++ /dev/null @@ -1,195 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / Api - -# Class: Api - -[index](../modules/index.md).Api - -Class representing the Jellyfin API. - -## Table of contents - -### Constructors - -- [constructor](index.Api.md#constructor) - -### Properties - -- [accessToken](index.Api.md#accesstoken) -- [axiosInstance](index.Api.md#axiosinstance) -- [basePath](index.Api.md#basepath) -- [clientInfo](index.Api.md#clientinfo) -- [deviceInfo](index.Api.md#deviceinfo) - -### Accessors - -- [authorizationHeader](index.Api.md#authorizationheader) -- [configuration](index.Api.md#configuration) - -### Methods - -- [authenticateUserByName](index.Api.md#authenticateuserbyname) -- [getItemImageUrl](index.Api.md#getitemimageurl) -- [logout](index.Api.md#logout) - -## Constructors - -### constructor - -• **new Api**(`basePath`, `clientInfo`, `deviceInfo`, `accessToken?`, `axiosInstance?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `basePath` | `string` | `undefined` | -| `clientInfo` | [`ClientInfo`](../interfaces/index.ClientInfo.md) | `undefined` | -| `deviceInfo` | [`DeviceInfo`](../interfaces/index.DeviceInfo.md) | `undefined` | -| `accessToken` | `string` | `''` | -| `axiosInstance` | `AxiosInstance` | `globalInstance` | - -#### Defined in - -[api.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L33) - -## Properties - -### accessToken - -• **accessToken**: `string` - -#### Defined in - -[api.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L30) - -___ - -### axiosInstance - -• **axiosInstance**: `AxiosInstance` - -#### Defined in - -[api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L31) - -___ - -### basePath - -• **basePath**: `string` - -#### Defined in - -[api.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L27) - -___ - -### clientInfo - -• **clientInfo**: [`ClientInfo`](../interfaces/index.ClientInfo.md) - -#### Defined in - -[api.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L28) - -___ - -### deviceInfo - -• **deviceInfo**: [`DeviceInfo`](../interfaces/index.DeviceInfo.md) - -#### Defined in - -[api.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L29) - -## Accessors - -### authorizationHeader - -• `get` **authorizationHeader**(): `string` - -#### Returns - -`string` - -#### Defined in - -[api.ts:100](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L100) - -___ - -### configuration - -• `get` **configuration**(): [`Configuration`](generated_client.Configuration.md) - -#### Returns - -[`Configuration`](generated_client.Configuration.md) - -#### Defined in - -[api.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L47) - -## Methods - -### authenticateUserByName - -▸ **authenticateUserByName**(`username`, `password?`): `Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\> - -Convenience method for authenticating a user by name and updating the internal state. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `username` | `string` | The username. | -| `password?` | `string` | The user password if required. | - -#### Returns - -`Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\> - -#### Defined in - -[api.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L59) - -___ - -### getItemImageUrl - -▸ **getItemImageUrl**(`itemId`, `imageType?`, `params?`): `undefined` \| `string` - -Get an item image URL. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `itemId` | `string` | `undefined` | The Item ID. | -| `imageType` | [`ImageType`](../enums/generated_client.ImageType.md) | `ImageType.Primary` | An optional Image Type (Primary by default). | -| `params` | `ImageRequestParameters` | `{}` | Additional request parameters. | - -#### Returns - -`undefined` \| `string` - -The image URL. - -#### Defined in - -[api.ts:89](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L89) - -___ - -### logout - -▸ **logout**(): `Promise`<`AxiosResponse`<`void`, `any`\> \| `AxiosResponse`<`never`, `any`\>\> - -Convenience method for logging out and updating the internal state. - -#### Returns - -`Promise`<`AxiosResponse`<`void`, `any`\> \| `AxiosResponse`<`never`, `any`\>\> - -#### Defined in - -[api.ts:75](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L75) diff --git a/docs/classes/index.Jellyfin.md b/docs/classes/index.Jellyfin.md deleted file mode 100644 index 7747bc9c9..000000000 --- a/docs/classes/index.Jellyfin.md +++ /dev/null @@ -1,95 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / Jellyfin - -# Class: Jellyfin - -[index](../modules/index.md).Jellyfin - -Class representing the Jellyfin SDK. - -## Table of contents - -### Constructors - -- [constructor](index.Jellyfin.md#constructor) - -### Properties - -- [clientInfo](index.Jellyfin.md#clientinfo) -- [deviceInfo](index.Jellyfin.md#deviceinfo) -- [discovery](index.Jellyfin.md#discovery) - -### Methods - -- [createApi](index.Jellyfin.md#createapi) - -## Constructors - -### constructor - -• **new Jellyfin**(`parameters`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `parameters` | [`JellyfinParameters`](../interfaces/index.JellyfinParameters.md) | - -#### Defined in - -[jellyfin.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L32) - -## Properties - -### clientInfo - -• **clientInfo**: [`ClientInfo`](../interfaces/index.ClientInfo.md) - -#### Defined in - -[jellyfin.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L28) - -___ - -### deviceInfo - -• **deviceInfo**: [`DeviceInfo`](../interfaces/index.DeviceInfo.md) - -#### Defined in - -[jellyfin.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L29) - -___ - -### discovery - -• **discovery**: [`DiscoveryService`](index.discovery.DiscoveryService.md) - -#### Defined in - -[jellyfin.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L30) - -## Methods - -### createApi - -▸ **createApi**(`basePath`, `accessToken?`, `axiosInstance?`): [`Api`](index.Api.md) - -Creates an Api instance for a given server path. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `basePath` | `string` | A base path of a server. | -| `accessToken?` | `string` | An (optional) access token to use for authentication. | -| `axiosInstance?` | `AxiosInstance` | An (optional) Axios instance for the Api to use. | - -#### Returns - -[`Api`](index.Api.md) - -An Api instance. - -#### Defined in - -[jellyfin.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L45) diff --git a/docs/classes/index.ProductNameIssue.md b/docs/classes/index.ProductNameIssue.md deleted file mode 100644 index aafa699c1..000000000 --- a/docs/classes/index.ProductNameIssue.md +++ /dev/null @@ -1,55 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / ProductNameIssue - -# Class: ProductNameIssue - -[index](../modules/index.md).ProductNameIssue - -Class representing an issue with the returned product name. - -## Hierarchy - -- [`RecommendedServerIssue`](index.RecommendedServerIssue.md) - - ↳ **`ProductNameIssue`** - -## Table of contents - -### Constructors - -- [constructor](index.ProductNameIssue.md#constructor) - -### Properties - -- [productName](index.ProductNameIssue.md#productname) - -## Constructors - -### constructor - -• **new ProductNameIssue**(`productName?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `productName?` | ``null`` \| `string` | - -#### Overrides - -[RecommendedServerIssue](index.RecommendedServerIssue.md).[constructor](index.RecommendedServerIssue.md#constructor) - -#### Defined in - -[models/recommended-server-issue.ts:15](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L15) - -## Properties - -### productName - -• **productName**: `undefined` \| ``null`` \| `string` - -The product name returned in the system information. - -#### Defined in - -[models/recommended-server-issue.ts:13](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L13) diff --git a/docs/classes/index.RecommendedServerIssue.md b/docs/classes/index.RecommendedServerIssue.md deleted file mode 100644 index f8170c861..000000000 --- a/docs/classes/index.RecommendedServerIssue.md +++ /dev/null @@ -1,35 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / RecommendedServerIssue - -# Class: RecommendedServerIssue - -[index](../modules/index.md).RecommendedServerIssue - -Class representing an issue encountered with a recommended server. - -## Hierarchy - -- **`RecommendedServerIssue`** - - ↳ [`ProductNameIssue`](index.ProductNameIssue.md) - - ↳ [`SlowResponseIssue`](index.SlowResponseIssue.md) - - ↳ [`SystemInfoIssue`](index.SystemInfoIssue.md) - - ↳ [`VersionMissingIssue`](index.VersionMissingIssue.md) - - ↳ [`VersionOutdatedIssue`](index.VersionOutdatedIssue.md) - - ↳ [`VersionUnsupportedIssue`](index.VersionUnsupportedIssue.md) - -## Table of contents - -### Constructors - -- [constructor](index.RecommendedServerIssue.md#constructor) - -## Constructors - -### constructor - -• **new RecommendedServerIssue**() diff --git a/docs/classes/index.SlowResponseIssue.md b/docs/classes/index.SlowResponseIssue.md deleted file mode 100644 index 271cf5c31..000000000 --- a/docs/classes/index.SlowResponseIssue.md +++ /dev/null @@ -1,55 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / SlowResponseIssue - -# Class: SlowResponseIssue - -[index](../modules/index.md).SlowResponseIssue - -Class representing a slow response from a server. - -## Hierarchy - -- [`RecommendedServerIssue`](index.RecommendedServerIssue.md) - - ↳ **`SlowResponseIssue`** - -## Table of contents - -### Constructors - -- [constructor](index.SlowResponseIssue.md#constructor) - -### Properties - -- [responseTime](index.SlowResponseIssue.md#responsetime) - -## Constructors - -### constructor - -• **new SlowResponseIssue**(`responseTime`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `responseTime` | `number` | - -#### Overrides - -[RecommendedServerIssue](index.RecommendedServerIssue.md).[constructor](index.RecommendedServerIssue.md#constructor) - -#### Defined in - -[models/recommended-server-issue.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L26) - -## Properties - -### responseTime - -• **responseTime**: `number` - -The response time from the server. - -#### Defined in - -[models/recommended-server-issue.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L24) diff --git a/docs/classes/index.SystemInfoIssue.md b/docs/classes/index.SystemInfoIssue.md deleted file mode 100644 index 23c606e7a..000000000 --- a/docs/classes/index.SystemInfoIssue.md +++ /dev/null @@ -1,56 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / SystemInfoIssue - -# Class: SystemInfoIssue - -[index](../modules/index.md).SystemInfoIssue - -Class representing an issue with the system information. -This could be due to a networking error or invalid address. - -## Hierarchy - -- [`RecommendedServerIssue`](index.RecommendedServerIssue.md) - - ↳ **`SystemInfoIssue`** - -## Table of contents - -### Constructors - -- [constructor](index.SystemInfoIssue.md#constructor) - -### Properties - -- [error](index.SystemInfoIssue.md#error) - -## Constructors - -### constructor - -• **new SystemInfoIssue**(`error?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error?` | `Error` | - -#### Overrides - -[RecommendedServerIssue](index.RecommendedServerIssue.md).[constructor](index.RecommendedServerIssue.md#constructor) - -#### Defined in - -[models/recommended-server-issue.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L40) - -## Properties - -### error - -• **error**: `undefined` \| `Error` - -The error generated by the request. - -#### Defined in - -[models/recommended-server-issue.ts:38](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L38) diff --git a/docs/classes/index.VersionMissingIssue.md b/docs/classes/index.VersionMissingIssue.md deleted file mode 100644 index f167a66d9..000000000 --- a/docs/classes/index.VersionMissingIssue.md +++ /dev/null @@ -1,29 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / VersionMissingIssue - -# Class: VersionMissingIssue - -[index](../modules/index.md).VersionMissingIssue - -Class representing the version was missing from system information. - -## Hierarchy - -- [`RecommendedServerIssue`](index.RecommendedServerIssue.md) - - ↳ **`VersionMissingIssue`** - -## Table of contents - -### Constructors - -- [constructor](index.VersionMissingIssue.md#constructor) - -## Constructors - -### constructor - -• **new VersionMissingIssue**() - -#### Inherited from - -[RecommendedServerIssue](index.RecommendedServerIssue.md).[constructor](index.RecommendedServerIssue.md#constructor) diff --git a/docs/classes/index.VersionOutdatedIssue.md b/docs/classes/index.VersionOutdatedIssue.md deleted file mode 100644 index df4cb2f45..000000000 --- a/docs/classes/index.VersionOutdatedIssue.md +++ /dev/null @@ -1,54 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / VersionOutdatedIssue - -# Class: VersionOutdatedIssue - -[index](../modules/index.md).VersionOutdatedIssue - -Class representing the server version is outdated. -(The version is lower than the generated client, but higher than the minimum supported.) - -## Hierarchy - -- [`RecommendedServerIssue`](index.RecommendedServerIssue.md) - - ↳ **`VersionOutdatedIssue`** - -## Table of contents - -### Constructors - -- [constructor](index.VersionOutdatedIssue.md#constructor) - -### Properties - -- [version](index.VersionOutdatedIssue.md#version) - -## Constructors - -### constructor - -• **new VersionOutdatedIssue**(`version`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `version` | `string` | - -#### Overrides - -[RecommendedServerIssue](index.RecommendedServerIssue.md).[constructor](index.RecommendedServerIssue.md#constructor) - -#### Defined in - -[models/recommended-server-issue.ts:56](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L56) - -## Properties - -### version - -• **version**: `string` - -#### Defined in - -[models/recommended-server-issue.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L54) diff --git a/docs/classes/index.VersionUnsupportedIssue.md b/docs/classes/index.VersionUnsupportedIssue.md deleted file mode 100644 index 7ed579bf6..000000000 --- a/docs/classes/index.VersionUnsupportedIssue.md +++ /dev/null @@ -1,54 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / VersionUnsupportedIssue - -# Class: VersionUnsupportedIssue - -[index](../modules/index.md).VersionUnsupportedIssue - -Class representing the server version is unsupported. -(The version is lower than the minimum supported.) - -## Hierarchy - -- [`RecommendedServerIssue`](index.RecommendedServerIssue.md) - - ↳ **`VersionUnsupportedIssue`** - -## Table of contents - -### Constructors - -- [constructor](index.VersionUnsupportedIssue.md#constructor) - -### Properties - -- [version](index.VersionUnsupportedIssue.md#version) - -## Constructors - -### constructor - -• **new VersionUnsupportedIssue**(`version`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `version` | `string` | - -#### Overrides - -[RecommendedServerIssue](index.RecommendedServerIssue.md).[constructor](index.RecommendedServerIssue.md#constructor) - -#### Defined in - -[models/recommended-server-issue.ts:69](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L69) - -## Properties - -### version - -• **version**: `string` - -#### Defined in - -[models/recommended-server-issue.ts:67](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L67) diff --git a/docs/classes/index.discovery.DiscoveryService.md b/docs/classes/index.discovery.DiscoveryService.md deleted file mode 100644 index b34a630f8..000000000 --- a/docs/classes/index.discovery.DiscoveryService.md +++ /dev/null @@ -1,162 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / [discovery](../modules/index.discovery.md) / DiscoveryService - -# Class: DiscoveryService - -[index](../modules/index.md).[discovery](../modules/index.discovery.md).DiscoveryService - -Class used for discovering recommended servers. - -## Table of contents - -### Constructors - -- [constructor](index.discovery.DiscoveryService.md#constructor) - -### Properties - -- [jellyfin](index.discovery.DiscoveryService.md#jellyfin) -- [recommendedServerDiscovery](index.discovery.DiscoveryService.md#recommendedserverdiscovery) - -### Methods - -- [findBestServer](index.discovery.DiscoveryService.md#findbestserver) -- [getAddressCandidates](index.discovery.DiscoveryService.md#getaddresscandidates) -- [getRecommendedServerCandidates](index.discovery.DiscoveryService.md#getrecommendedservercandidates) -- [getRecommendedServers](index.discovery.DiscoveryService.md#getrecommendedservers) - -## Constructors - -### constructor - -• **new DiscoveryService**(`jellyfin`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `jellyfin` | [`Jellyfin`](index.Jellyfin.md) | - -#### Defined in - -[discovery/discovery-service.ts:18](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L18) - -## Properties - -### jellyfin - -• `Private` **jellyfin**: [`Jellyfin`](index.Jellyfin.md) - -#### Defined in - -[discovery/discovery-service.ts:15](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L15) - -___ - -### recommendedServerDiscovery - -• `Private` **recommendedServerDiscovery**: [`RecommendedServerDiscovery`](index.discovery.RecommendedServerDiscovery.md) - -#### Defined in - -[discovery/discovery-service.ts:16](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L16) - -## Methods - -### findBestServer - -▸ **findBestServer**(`servers`): `undefined` \| [`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md) - -Finds the best server from a list of recommended servers by score. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `servers` | [`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[] | A list of recommended servers. | - -#### Returns - -`undefined` \| [`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md) - -The best scoring recommended server. - -#### Defined in - -[discovery/discovery-service.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L28) - -___ - -### getAddressCandidates - -▸ **getAddressCandidates**(`input`): `string`[] - -Gets a list of address candidates url strings -from a provided url address string. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `input` | `string` | A server url address string. | - -#### Returns - -`string`[] - -A list of potential server addresses. - -#### Defined in - -[discovery/discovery-service.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L49) - -___ - -### getRecommendedServerCandidates - -▸ **getRecommendedServerCandidates**(`input`, `minimumScore?`): `Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[]\> - -Gets a list of recommended server information from the address -candidates of a potential server address. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `input` | `string` | A potential server address. | -| `minimumScore?` | [`RecommendedServerInfoScore`](../enums/index.RecommendedServerInfoScore.md) | The minimum server score to include in the results. | - -#### Returns - -`Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[]\> - -A list of RecommendedServerInfo from the address candidates. - -#### Defined in - -[discovery/discovery-service.ts:74](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L74) - -___ - -### getRecommendedServers - -▸ **getRecommendedServers**(`servers`, `minimumScore?`): `Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[]\> - -Gets a list of recommended server information from a provided -list of possible server addresses. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `servers` | `string`[] | A list of possible server addresses. | -| `minimumScore?` | [`RecommendedServerInfoScore`](../enums/index.RecommendedServerInfoScore.md) | The minimum server score to include in the results. | - -#### Returns - -`Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[]\> - -A list of RecommendedServerInfo from the possible server addresses. - -#### Defined in - -[discovery/discovery-service.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L60) diff --git a/docs/classes/index.discovery.RecommendedServerDiscovery.md b/docs/classes/index.discovery.RecommendedServerDiscovery.md deleted file mode 100644 index 7cb02519d..000000000 --- a/docs/classes/index.discovery.RecommendedServerDiscovery.md +++ /dev/null @@ -1,97 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / [discovery](../modules/index.discovery.md) / RecommendedServerDiscovery - -# Class: RecommendedServerDiscovery - -[index](../modules/index.md).[discovery](../modules/index.discovery.md).RecommendedServerDiscovery - -Class to discover and evaluate potential servers. - -## Table of contents - -### Constructors - -- [constructor](index.discovery.RecommendedServerDiscovery.md#constructor) - -### Properties - -- [jellyfin](index.discovery.RecommendedServerDiscovery.md#jellyfin) - -### Methods - -- [discover](index.discovery.RecommendedServerDiscovery.md#discover) -- [fetchRecommendedServerInfo](index.discovery.RecommendedServerDiscovery.md#fetchrecommendedserverinfo) - -## Constructors - -### constructor - -• **new RecommendedServerDiscovery**(`jellyfin`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `jellyfin` | [`Jellyfin`](index.Jellyfin.md) | - -#### Defined in - -[discovery/recommended-server-discovery.ts:83](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/recommended-server-discovery.ts#L83) - -## Properties - -### jellyfin - -• `Private` **jellyfin**: [`Jellyfin`](index.Jellyfin.md) - -#### Defined in - -[discovery/recommended-server-discovery.ts:81](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/recommended-server-discovery.ts#L81) - -## Methods - -### discover - -▸ **discover**(`servers`, `minimumScore?`): `Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[]\> - -Fetches the RecommendedServerInfo for multiple server addresses. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `servers` | `string`[] | `undefined` | An array of server addresses. | -| `minimumScore` | [`RecommendedServerInfoScore`](../enums/index.RecommendedServerInfoScore.md) | `RecommendedServerInfoScore.BAD` | - | - -#### Returns - -`Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[]\> - -The RecommendedServerInfo for each address. - -#### Defined in - -[discovery/recommended-server-discovery.ts:115](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/recommended-server-discovery.ts#L115) - -___ - -### fetchRecommendedServerInfo - -▸ **fetchRecommendedServerInfo**(`address`): `Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)\> - -Fetches the RecommendedServerInfo for a single server address. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `address` | `string` | The server address. | - -#### Returns - -`Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)\> - -The resulting RecommendedServerInfo. - -#### Defined in - -[discovery/recommended-server-discovery.ts:92](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/recommended-server-discovery.ts#L92) diff --git a/docs/enums/generated_client.Architecture.md b/docs/enums/generated_client.Architecture.md deleted file mode 100644 index 234294266..000000000 --- a/docs/enums/generated_client.Architecture.md +++ /dev/null @@ -1,78 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / Architecture - -# Enumeration: Architecture - -[generated-client](../modules/generated_client.md).Architecture - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Arm](generated_client.Architecture.md#arm) -- [Arm64](generated_client.Architecture.md#arm64) -- [S390x](generated_client.Architecture.md#s390x) -- [Wasm](generated_client.Architecture.md#wasm) -- [X64](generated_client.Architecture.md#x64) -- [X86](generated_client.Architecture.md#x86) - -## Enumeration Members - -### Arm - -• **Arm** - -#### Defined in - -[generated-client/models/architecture.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/architecture.ts#L26) - -___ - -### Arm64 - -• **Arm64** - -#### Defined in - -[generated-client/models/architecture.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/architecture.ts#L27) - -___ - -### S390x - -• **S390x** - -#### Defined in - -[generated-client/models/architecture.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/architecture.ts#L29) - -___ - -### Wasm - -• **Wasm** - -#### Defined in - -[generated-client/models/architecture.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/architecture.ts#L28) - -___ - -### X64 - -• **X64** - -#### Defined in - -[generated-client/models/architecture.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/architecture.ts#L25) - -___ - -### X86 - -• **X86** - -#### Defined in - -[generated-client/models/architecture.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/architecture.ts#L24) diff --git a/docs/enums/generated_client.BaseItemKind.md b/docs/enums/generated_client.BaseItemKind.md deleted file mode 100644 index 14c79a588..000000000 --- a/docs/enums/generated_client.BaseItemKind.md +++ /dev/null @@ -1,421 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BaseItemKind - -# Enumeration: BaseItemKind - -[generated-client](../modules/generated_client.md).BaseItemKind - -The base item kind. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [AggregateFolder](generated_client.BaseItemKind.md#aggregatefolder) -- [Audio](generated_client.BaseItemKind.md#audio) -- [AudioBook](generated_client.BaseItemKind.md#audiobook) -- [BasePluginFolder](generated_client.BaseItemKind.md#basepluginfolder) -- [Book](generated_client.BaseItemKind.md#book) -- [BoxSet](generated_client.BaseItemKind.md#boxset) -- [Channel](generated_client.BaseItemKind.md#channel) -- [ChannelFolderItem](generated_client.BaseItemKind.md#channelfolderitem) -- [CollectionFolder](generated_client.BaseItemKind.md#collectionfolder) -- [Episode](generated_client.BaseItemKind.md#episode) -- [Folder](generated_client.BaseItemKind.md#folder) -- [Genre](generated_client.BaseItemKind.md#genre) -- [LiveTvChannel](generated_client.BaseItemKind.md#livetvchannel) -- [LiveTvProgram](generated_client.BaseItemKind.md#livetvprogram) -- [ManualPlaylistsFolder](generated_client.BaseItemKind.md#manualplaylistsfolder) -- [Movie](generated_client.BaseItemKind.md#movie) -- [MusicAlbum](generated_client.BaseItemKind.md#musicalbum) -- [MusicArtist](generated_client.BaseItemKind.md#musicartist) -- [MusicGenre](generated_client.BaseItemKind.md#musicgenre) -- [MusicVideo](generated_client.BaseItemKind.md#musicvideo) -- [Person](generated_client.BaseItemKind.md#person) -- [Photo](generated_client.BaseItemKind.md#photo) -- [PhotoAlbum](generated_client.BaseItemKind.md#photoalbum) -- [Playlist](generated_client.BaseItemKind.md#playlist) -- [PlaylistsFolder](generated_client.BaseItemKind.md#playlistsfolder) -- [Program](generated_client.BaseItemKind.md#program) -- [Recording](generated_client.BaseItemKind.md#recording) -- [Season](generated_client.BaseItemKind.md#season) -- [Series](generated_client.BaseItemKind.md#series) -- [Studio](generated_client.BaseItemKind.md#studio) -- [Trailer](generated_client.BaseItemKind.md#trailer) -- [TvChannel](generated_client.BaseItemKind.md#tvchannel) -- [TvProgram](generated_client.BaseItemKind.md#tvprogram) -- [UserRootFolder](generated_client.BaseItemKind.md#userrootfolder) -- [UserView](generated_client.BaseItemKind.md#userview) -- [Video](generated_client.BaseItemKind.md#video) -- [Year](generated_client.BaseItemKind.md#year) - -## Enumeration Members - -### AggregateFolder - -• **AggregateFolder** - -#### Defined in - -[generated-client/models/base-item-kind.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L24) - -___ - -### Audio - -• **Audio** - -#### Defined in - -[generated-client/models/base-item-kind.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L25) - -___ - -### AudioBook - -• **AudioBook** - -#### Defined in - -[generated-client/models/base-item-kind.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L26) - -___ - -### BasePluginFolder - -• **BasePluginFolder** - -#### Defined in - -[generated-client/models/base-item-kind.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L27) - -___ - -### Book - -• **Book** - -#### Defined in - -[generated-client/models/base-item-kind.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L28) - -___ - -### BoxSet - -• **BoxSet** - -#### Defined in - -[generated-client/models/base-item-kind.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L29) - -___ - -### Channel - -• **Channel** - -#### Defined in - -[generated-client/models/base-item-kind.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L30) - -___ - -### ChannelFolderItem - -• **ChannelFolderItem** - -#### Defined in - -[generated-client/models/base-item-kind.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L31) - -___ - -### CollectionFolder - -• **CollectionFolder** - -#### Defined in - -[generated-client/models/base-item-kind.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L32) - -___ - -### Episode - -• **Episode** - -#### Defined in - -[generated-client/models/base-item-kind.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L33) - -___ - -### Folder - -• **Folder** - -#### Defined in - -[generated-client/models/base-item-kind.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L34) - -___ - -### Genre - -• **Genre** - -#### Defined in - -[generated-client/models/base-item-kind.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L35) - -___ - -### LiveTvChannel - -• **LiveTvChannel** - -#### Defined in - -[generated-client/models/base-item-kind.ts:38](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L38) - -___ - -### LiveTvProgram - -• **LiveTvProgram** - -#### Defined in - -[generated-client/models/base-item-kind.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L39) - -___ - -### ManualPlaylistsFolder - -• **ManualPlaylistsFolder** - -#### Defined in - -[generated-client/models/base-item-kind.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L36) - -___ - -### Movie - -• **Movie** - -#### Defined in - -[generated-client/models/base-item-kind.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L37) - -___ - -### MusicAlbum - -• **MusicAlbum** - -#### Defined in - -[generated-client/models/base-item-kind.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L40) - -___ - -### MusicArtist - -• **MusicArtist** - -#### Defined in - -[generated-client/models/base-item-kind.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L41) - -___ - -### MusicGenre - -• **MusicGenre** - -#### Defined in - -[generated-client/models/base-item-kind.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L42) - -___ - -### MusicVideo - -• **MusicVideo** - -#### Defined in - -[generated-client/models/base-item-kind.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L43) - -___ - -### Person - -• **Person** - -#### Defined in - -[generated-client/models/base-item-kind.ts:44](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L44) - -___ - -### Photo - -• **Photo** - -#### Defined in - -[generated-client/models/base-item-kind.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L45) - -___ - -### PhotoAlbum - -• **PhotoAlbum** - -#### Defined in - -[generated-client/models/base-item-kind.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L46) - -___ - -### Playlist - -• **Playlist** - -#### Defined in - -[generated-client/models/base-item-kind.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L47) - -___ - -### PlaylistsFolder - -• **PlaylistsFolder** - -#### Defined in - -[generated-client/models/base-item-kind.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L48) - -___ - -### Program - -• **Program** - -#### Defined in - -[generated-client/models/base-item-kind.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L49) - -___ - -### Recording - -• **Recording** - -#### Defined in - -[generated-client/models/base-item-kind.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L50) - -___ - -### Season - -• **Season** - -#### Defined in - -[generated-client/models/base-item-kind.ts:51](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L51) - -___ - -### Series - -• **Series** - -#### Defined in - -[generated-client/models/base-item-kind.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L52) - -___ - -### Studio - -• **Studio** - -#### Defined in - -[generated-client/models/base-item-kind.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L53) - -___ - -### Trailer - -• **Trailer** - -#### Defined in - -[generated-client/models/base-item-kind.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L54) - -___ - -### TvChannel - -• **TvChannel** - -#### Defined in - -[generated-client/models/base-item-kind.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L55) - -___ - -### TvProgram - -• **TvProgram** - -#### Defined in - -[generated-client/models/base-item-kind.ts:56](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L56) - -___ - -### UserRootFolder - -• **UserRootFolder** - -#### Defined in - -[generated-client/models/base-item-kind.ts:57](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L57) - -___ - -### UserView - -• **UserView** - -#### Defined in - -[generated-client/models/base-item-kind.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L58) - -___ - -### Video - -• **Video** - -#### Defined in - -[generated-client/models/base-item-kind.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L59) - -___ - -### Year - -• **Year** - -#### Defined in - -[generated-client/models/base-item-kind.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L60) diff --git a/docs/enums/generated_client.ChannelItemSortField.md b/docs/enums/generated_client.ChannelItemSortField.md deleted file mode 100644 index 4d14a6b7f..000000000 --- a/docs/enums/generated_client.ChannelItemSortField.md +++ /dev/null @@ -1,89 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelItemSortField - -# Enumeration: ChannelItemSortField - -[generated-client](../modules/generated_client.md).ChannelItemSortField - -**`export`** - -## Table of contents - -### Enumeration Members - -- [CommunityPlayCount](generated_client.ChannelItemSortField.md#communityplaycount) -- [CommunityRating](generated_client.ChannelItemSortField.md#communityrating) -- [DateCreated](generated_client.ChannelItemSortField.md#datecreated) -- [Name](generated_client.ChannelItemSortField.md#name) -- [PlayCount](generated_client.ChannelItemSortField.md#playcount) -- [PremiereDate](generated_client.ChannelItemSortField.md#premieredate) -- [Runtime](generated_client.ChannelItemSortField.md#runtime) - -## Enumeration Members - -### CommunityPlayCount - -• **CommunityPlayCount** - -#### Defined in - -[generated-client/models/channel-item-sort-field.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L30) - -___ - -### CommunityRating - -• **CommunityRating** - -#### Defined in - -[generated-client/models/channel-item-sort-field.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L25) - -___ - -### DateCreated - -• **DateCreated** - -#### Defined in - -[generated-client/models/channel-item-sort-field.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L27) - -___ - -### Name - -• **Name** - -#### Defined in - -[generated-client/models/channel-item-sort-field.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L24) - -___ - -### PlayCount - -• **PlayCount** - -#### Defined in - -[generated-client/models/channel-item-sort-field.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L29) - -___ - -### PremiereDate - -• **PremiereDate** - -#### Defined in - -[generated-client/models/channel-item-sort-field.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L26) - -___ - -### Runtime - -• **Runtime** - -#### Defined in - -[generated-client/models/channel-item-sort-field.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L28) diff --git a/docs/enums/generated_client.ChannelMediaContentType.md b/docs/enums/generated_client.ChannelMediaContentType.md deleted file mode 100644 index 800ca9610..000000000 --- a/docs/enums/generated_client.ChannelMediaContentType.md +++ /dev/null @@ -1,100 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelMediaContentType - -# Enumeration: ChannelMediaContentType - -[generated-client](../modules/generated_client.md).ChannelMediaContentType - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Clip](generated_client.ChannelMediaContentType.md#clip) -- [Episode](generated_client.ChannelMediaContentType.md#episode) -- [Movie](generated_client.ChannelMediaContentType.md#movie) -- [MovieExtra](generated_client.ChannelMediaContentType.md#movieextra) -- [Podcast](generated_client.ChannelMediaContentType.md#podcast) -- [Song](generated_client.ChannelMediaContentType.md#song) -- [Trailer](generated_client.ChannelMediaContentType.md#trailer) -- [TvExtra](generated_client.ChannelMediaContentType.md#tvextra) - -## Enumeration Members - -### Clip - -• **Clip** - -#### Defined in - -[generated-client/models/channel-media-content-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L24) - -___ - -### Episode - -• **Episode** - -#### Defined in - -[generated-client/models/channel-media-content-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L28) - -___ - -### Movie - -• **Movie** - -#### Defined in - -[generated-client/models/channel-media-content-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L27) - -___ - -### MovieExtra - -• **MovieExtra** - -#### Defined in - -[generated-client/models/channel-media-content-type.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L30) - -___ - -### Podcast - -• **Podcast** - -#### Defined in - -[generated-client/models/channel-media-content-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L25) - -___ - -### Song - -• **Song** - -#### Defined in - -[generated-client/models/channel-media-content-type.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L29) - -___ - -### Trailer - -• **Trailer** - -#### Defined in - -[generated-client/models/channel-media-content-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L26) - -___ - -### TvExtra - -• **TvExtra** - -#### Defined in - -[generated-client/models/channel-media-content-type.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L31) diff --git a/docs/enums/generated_client.ChannelMediaType.md b/docs/enums/generated_client.ChannelMediaType.md deleted file mode 100644 index be4565dc1..000000000 --- a/docs/enums/generated_client.ChannelMediaType.md +++ /dev/null @@ -1,45 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelMediaType - -# Enumeration: ChannelMediaType - -[generated-client](../modules/generated_client.md).ChannelMediaType - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Audio](generated_client.ChannelMediaType.md#audio) -- [Photo](generated_client.ChannelMediaType.md#photo) -- [Video](generated_client.ChannelMediaType.md#video) - -## Enumeration Members - -### Audio - -• **Audio** - -#### Defined in - -[generated-client/models/channel-media-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-type.ts#L24) - -___ - -### Photo - -• **Photo** - -#### Defined in - -[generated-client/models/channel-media-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-type.ts#L26) - -___ - -### Video - -• **Video** - -#### Defined in - -[generated-client/models/channel-media-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-type.ts#L25) diff --git a/docs/enums/generated_client.ChannelType.md b/docs/enums/generated_client.ChannelType.md deleted file mode 100644 index bff722698..000000000 --- a/docs/enums/generated_client.ChannelType.md +++ /dev/null @@ -1,36 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelType - -# Enumeration: ChannelType - -[generated-client](../modules/generated_client.md).ChannelType - -Enum ChannelType. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Radio](generated_client.ChannelType.md#radio) -- [Tv](generated_client.ChannelType.md#tv) - -## Enumeration Members - -### Radio - -• **Radio** - -#### Defined in - -[generated-client/models/channel-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-type.ts#L25) - -___ - -### Tv - -• **Tv** - -#### Defined in - -[generated-client/models/channel-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-type.ts#L24) diff --git a/docs/enums/generated_client.CodecType.md b/docs/enums/generated_client.CodecType.md deleted file mode 100644 index f065130d7..000000000 --- a/docs/enums/generated_client.CodecType.md +++ /dev/null @@ -1,45 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CodecType - -# Enumeration: CodecType - -[generated-client](../modules/generated_client.md).CodecType - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Audio](generated_client.CodecType.md#audio) -- [Video](generated_client.CodecType.md#video) -- [VideoAudio](generated_client.CodecType.md#videoaudio) - -## Enumeration Members - -### Audio - -• **Audio** - -#### Defined in - -[generated-client/models/codec-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/codec-type.ts#L26) - -___ - -### Video - -• **Video** - -#### Defined in - -[generated-client/models/codec-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/codec-type.ts#L24) - -___ - -### VideoAudio - -• **VideoAudio** - -#### Defined in - -[generated-client/models/codec-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/codec-type.ts#L25) diff --git a/docs/enums/generated_client.CollectionTypeOptions.md b/docs/enums/generated_client.CollectionTypeOptions.md deleted file mode 100644 index 89e71b06a..000000000 --- a/docs/enums/generated_client.CollectionTypeOptions.md +++ /dev/null @@ -1,100 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CollectionTypeOptions - -# Enumeration: CollectionTypeOptions - -[generated-client](../modules/generated_client.md).CollectionTypeOptions - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Books](generated_client.CollectionTypeOptions.md#books) -- [BoxSets](generated_client.CollectionTypeOptions.md#boxsets) -- [HomeVideos](generated_client.CollectionTypeOptions.md#homevideos) -- [Mixed](generated_client.CollectionTypeOptions.md#mixed) -- [Movies](generated_client.CollectionTypeOptions.md#movies) -- [Music](generated_client.CollectionTypeOptions.md#music) -- [MusicVideos](generated_client.CollectionTypeOptions.md#musicvideos) -- [TvShows](generated_client.CollectionTypeOptions.md#tvshows) - -## Enumeration Members - -### Books - -• **Books** - -#### Defined in - -[generated-client/models/collection-type-options.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L30) - -___ - -### BoxSets - -• **BoxSets** - -#### Defined in - -[generated-client/models/collection-type-options.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L29) - -___ - -### HomeVideos - -• **HomeVideos** - -#### Defined in - -[generated-client/models/collection-type-options.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L28) - -___ - -### Mixed - -• **Mixed** - -#### Defined in - -[generated-client/models/collection-type-options.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L31) - -___ - -### Movies - -• **Movies** - -#### Defined in - -[generated-client/models/collection-type-options.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L24) - -___ - -### Music - -• **Music** - -#### Defined in - -[generated-client/models/collection-type-options.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L26) - -___ - -### MusicVideos - -• **MusicVideos** - -#### Defined in - -[generated-client/models/collection-type-options.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L27) - -___ - -### TvShows - -• **TvShows** - -#### Defined in - -[generated-client/models/collection-type-options.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L25) diff --git a/docs/enums/generated_client.DayOfWeek.md b/docs/enums/generated_client.DayOfWeek.md deleted file mode 100644 index 6fc7cfe59..000000000 --- a/docs/enums/generated_client.DayOfWeek.md +++ /dev/null @@ -1,89 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DayOfWeek - -# Enumeration: DayOfWeek - -[generated-client](../modules/generated_client.md).DayOfWeek - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Friday](generated_client.DayOfWeek.md#friday) -- [Monday](generated_client.DayOfWeek.md#monday) -- [Saturday](generated_client.DayOfWeek.md#saturday) -- [Sunday](generated_client.DayOfWeek.md#sunday) -- [Thursday](generated_client.DayOfWeek.md#thursday) -- [Tuesday](generated_client.DayOfWeek.md#tuesday) -- [Wednesday](generated_client.DayOfWeek.md#wednesday) - -## Enumeration Members - -### Friday - -• **Friday** - -#### Defined in - -[generated-client/models/day-of-week.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L29) - -___ - -### Monday - -• **Monday** - -#### Defined in - -[generated-client/models/day-of-week.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L25) - -___ - -### Saturday - -• **Saturday** - -#### Defined in - -[generated-client/models/day-of-week.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L30) - -___ - -### Sunday - -• **Sunday** - -#### Defined in - -[generated-client/models/day-of-week.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L24) - -___ - -### Thursday - -• **Thursday** - -#### Defined in - -[generated-client/models/day-of-week.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L28) - -___ - -### Tuesday - -• **Tuesday** - -#### Defined in - -[generated-client/models/day-of-week.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L26) - -___ - -### Wednesday - -• **Wednesday** - -#### Defined in - -[generated-client/models/day-of-week.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L27) diff --git a/docs/enums/generated_client.DayPattern.md b/docs/enums/generated_client.DayPattern.md deleted file mode 100644 index 4b277d104..000000000 --- a/docs/enums/generated_client.DayPattern.md +++ /dev/null @@ -1,45 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DayPattern - -# Enumeration: DayPattern - -[generated-client](../modules/generated_client.md).DayPattern - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Daily](generated_client.DayPattern.md#daily) -- [Weekdays](generated_client.DayPattern.md#weekdays) -- [Weekends](generated_client.DayPattern.md#weekends) - -## Enumeration Members - -### Daily - -• **Daily** - -#### Defined in - -[generated-client/models/day-pattern.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-pattern.ts#L24) - -___ - -### Weekdays - -• **Weekdays** - -#### Defined in - -[generated-client/models/day-pattern.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-pattern.ts#L25) - -___ - -### Weekends - -• **Weekends** - -#### Defined in - -[generated-client/models/day-pattern.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-pattern.ts#L26) diff --git a/docs/enums/generated_client.DeviceProfileType.md b/docs/enums/generated_client.DeviceProfileType.md deleted file mode 100644 index d4918c682..000000000 --- a/docs/enums/generated_client.DeviceProfileType.md +++ /dev/null @@ -1,34 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DeviceProfileType - -# Enumeration: DeviceProfileType - -[generated-client](../modules/generated_client.md).DeviceProfileType - -**`export`** - -## Table of contents - -### Enumeration Members - -- [System](generated_client.DeviceProfileType.md#system) -- [User](generated_client.DeviceProfileType.md#user) - -## Enumeration Members - -### System - -• **System** - -#### Defined in - -[generated-client/models/device-profile-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile-type.ts#L24) - -___ - -### User - -• **User** - -#### Defined in - -[generated-client/models/device-profile-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile-type.ts#L25) diff --git a/docs/enums/generated_client.DlnaProfileType.md b/docs/enums/generated_client.DlnaProfileType.md deleted file mode 100644 index b2b5b0ddc..000000000 --- a/docs/enums/generated_client.DlnaProfileType.md +++ /dev/null @@ -1,56 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaProfileType - -# Enumeration: DlnaProfileType - -[generated-client](../modules/generated_client.md).DlnaProfileType - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Audio](generated_client.DlnaProfileType.md#audio) -- [Photo](generated_client.DlnaProfileType.md#photo) -- [Subtitle](generated_client.DlnaProfileType.md#subtitle) -- [Video](generated_client.DlnaProfileType.md#video) - -## Enumeration Members - -### Audio - -• **Audio** - -#### Defined in - -[generated-client/models/dlna-profile-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-profile-type.ts#L24) - -___ - -### Photo - -• **Photo** - -#### Defined in - -[generated-client/models/dlna-profile-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-profile-type.ts#L26) - -___ - -### Subtitle - -• **Subtitle** - -#### Defined in - -[generated-client/models/dlna-profile-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-profile-type.ts#L27) - -___ - -### Video - -• **Video** - -#### Defined in - -[generated-client/models/dlna-profile-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-profile-type.ts#L25) diff --git a/docs/enums/generated_client.DynamicDayOfWeek.md b/docs/enums/generated_client.DynamicDayOfWeek.md deleted file mode 100644 index 20ab01c5d..000000000 --- a/docs/enums/generated_client.DynamicDayOfWeek.md +++ /dev/null @@ -1,124 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicDayOfWeek - -# Enumeration: DynamicDayOfWeek - -[generated-client](../modules/generated_client.md).DynamicDayOfWeek - -An enum that represents a day of the week, weekdays, weekends, or all days. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Everyday](generated_client.DynamicDayOfWeek.md#everyday) -- [Friday](generated_client.DynamicDayOfWeek.md#friday) -- [Monday](generated_client.DynamicDayOfWeek.md#monday) -- [Saturday](generated_client.DynamicDayOfWeek.md#saturday) -- [Sunday](generated_client.DynamicDayOfWeek.md#sunday) -- [Thursday](generated_client.DynamicDayOfWeek.md#thursday) -- [Tuesday](generated_client.DynamicDayOfWeek.md#tuesday) -- [Wednesday](generated_client.DynamicDayOfWeek.md#wednesday) -- [Weekday](generated_client.DynamicDayOfWeek.md#weekday) -- [Weekend](generated_client.DynamicDayOfWeek.md#weekend) - -## Enumeration Members - -### Everyday - -• **Everyday** - -#### Defined in - -[generated-client/models/dynamic-day-of-week.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L31) - -___ - -### Friday - -• **Friday** - -#### Defined in - -[generated-client/models/dynamic-day-of-week.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L29) - -___ - -### Monday - -• **Monday** - -#### Defined in - -[generated-client/models/dynamic-day-of-week.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L25) - -___ - -### Saturday - -• **Saturday** - -#### Defined in - -[generated-client/models/dynamic-day-of-week.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L30) - -___ - -### Sunday - -• **Sunday** - -#### Defined in - -[generated-client/models/dynamic-day-of-week.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L24) - -___ - -### Thursday - -• **Thursday** - -#### Defined in - -[generated-client/models/dynamic-day-of-week.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L28) - -___ - -### Tuesday - -• **Tuesday** - -#### Defined in - -[generated-client/models/dynamic-day-of-week.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L26) - -___ - -### Wednesday - -• **Wednesday** - -#### Defined in - -[generated-client/models/dynamic-day-of-week.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L27) - -___ - -### Weekday - -• **Weekday** - -#### Defined in - -[generated-client/models/dynamic-day-of-week.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L32) - -___ - -### Weekend - -• **Weekend** - -#### Defined in - -[generated-client/models/dynamic-day-of-week.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L33) diff --git a/docs/enums/generated_client.EmbeddedSubtitleOptions.md b/docs/enums/generated_client.EmbeddedSubtitleOptions.md deleted file mode 100644 index 42f2b7f6e..000000000 --- a/docs/enums/generated_client.EmbeddedSubtitleOptions.md +++ /dev/null @@ -1,58 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / EmbeddedSubtitleOptions - -# Enumeration: EmbeddedSubtitleOptions - -[generated-client](../modules/generated_client.md).EmbeddedSubtitleOptions - -An enum representing the options to disable embedded subs. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [AllowAll](generated_client.EmbeddedSubtitleOptions.md#allowall) -- [AllowImage](generated_client.EmbeddedSubtitleOptions.md#allowimage) -- [AllowNone](generated_client.EmbeddedSubtitleOptions.md#allownone) -- [AllowText](generated_client.EmbeddedSubtitleOptions.md#allowtext) - -## Enumeration Members - -### AllowAll - -• **AllowAll** - -#### Defined in - -[generated-client/models/embedded-subtitle-options.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/embedded-subtitle-options.ts#L24) - -___ - -### AllowImage - -• **AllowImage** - -#### Defined in - -[generated-client/models/embedded-subtitle-options.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/embedded-subtitle-options.ts#L26) - -___ - -### AllowNone - -• **AllowNone** - -#### Defined in - -[generated-client/models/embedded-subtitle-options.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/embedded-subtitle-options.ts#L27) - -___ - -### AllowText - -• **AllowText** - -#### Defined in - -[generated-client/models/embedded-subtitle-options.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/embedded-subtitle-options.ts#L25) diff --git a/docs/enums/generated_client.EncodingContext.md b/docs/enums/generated_client.EncodingContext.md deleted file mode 100644 index 4c768ef3c..000000000 --- a/docs/enums/generated_client.EncodingContext.md +++ /dev/null @@ -1,34 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / EncodingContext - -# Enumeration: EncodingContext - -[generated-client](../modules/generated_client.md).EncodingContext - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Static](generated_client.EncodingContext.md#static) -- [Streaming](generated_client.EncodingContext.md#streaming) - -## Enumeration Members - -### Static - -• **Static** - -#### Defined in - -[generated-client/models/encoding-context.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-context.ts#L25) - -___ - -### Streaming - -• **Streaming** - -#### Defined in - -[generated-client/models/encoding-context.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-context.ts#L24) diff --git a/docs/enums/generated_client.ExternalIdMediaType.md b/docs/enums/generated_client.ExternalIdMediaType.md deleted file mode 100644 index 652bed984..000000000 --- a/docs/enums/generated_client.ExternalIdMediaType.md +++ /dev/null @@ -1,146 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ExternalIdMediaType - -# Enumeration: ExternalIdMediaType - -[generated-client](../modules/generated_client.md).ExternalIdMediaType - -The specific media type of an MediaBrowser.Model.Providers.ExternalIdInfo. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Album](generated_client.ExternalIdMediaType.md#album) -- [AlbumArtist](generated_client.ExternalIdMediaType.md#albumartist) -- [Artist](generated_client.ExternalIdMediaType.md#artist) -- [BoxSet](generated_client.ExternalIdMediaType.md#boxset) -- [Episode](generated_client.ExternalIdMediaType.md#episode) -- [Movie](generated_client.ExternalIdMediaType.md#movie) -- [OtherArtist](generated_client.ExternalIdMediaType.md#otherartist) -- [Person](generated_client.ExternalIdMediaType.md#person) -- [ReleaseGroup](generated_client.ExternalIdMediaType.md#releasegroup) -- [Season](generated_client.ExternalIdMediaType.md#season) -- [Series](generated_client.ExternalIdMediaType.md#series) -- [Track](generated_client.ExternalIdMediaType.md#track) - -## Enumeration Members - -### Album - -• **Album** - -#### Defined in - -[generated-client/models/external-id-media-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L24) - -___ - -### AlbumArtist - -• **AlbumArtist** - -#### Defined in - -[generated-client/models/external-id-media-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L25) - -___ - -### Artist - -• **Artist** - -#### Defined in - -[generated-client/models/external-id-media-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L26) - -___ - -### BoxSet - -• **BoxSet** - -#### Defined in - -[generated-client/models/external-id-media-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L27) - -___ - -### Episode - -• **Episode** - -#### Defined in - -[generated-client/models/external-id-media-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L28) - -___ - -### Movie - -• **Movie** - -#### Defined in - -[generated-client/models/external-id-media-type.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L29) - -___ - -### OtherArtist - -• **OtherArtist** - -#### Defined in - -[generated-client/models/external-id-media-type.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L30) - -___ - -### Person - -• **Person** - -#### Defined in - -[generated-client/models/external-id-media-type.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L31) - -___ - -### ReleaseGroup - -• **ReleaseGroup** - -#### Defined in - -[generated-client/models/external-id-media-type.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L32) - -___ - -### Season - -• **Season** - -#### Defined in - -[generated-client/models/external-id-media-type.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L33) - -___ - -### Series - -• **Series** - -#### Defined in - -[generated-client/models/external-id-media-type.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L34) - -___ - -### Track - -• **Track** - -#### Defined in - -[generated-client/models/external-id-media-type.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L35) diff --git a/docs/enums/generated_client.FFmpegLocation.md b/docs/enums/generated_client.FFmpegLocation.md deleted file mode 100644 index 96fa0ed31..000000000 --- a/docs/enums/generated_client.FFmpegLocation.md +++ /dev/null @@ -1,58 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / FFmpegLocation - -# Enumeration: FFmpegLocation - -[generated-client](../modules/generated_client.md).FFmpegLocation - -Enum describing the location of the FFmpeg tool. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Custom](generated_client.FFmpegLocation.md#custom) -- [NotFound](generated_client.FFmpegLocation.md#notfound) -- [SetByArgument](generated_client.FFmpegLocation.md#setbyargument) -- [System](generated_client.FFmpegLocation.md#system) - -## Enumeration Members - -### Custom - -• **Custom** - -#### Defined in - -[generated-client/models/ffmpeg-location.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ffmpeg-location.ts#L26) - -___ - -### NotFound - -• **NotFound** - -#### Defined in - -[generated-client/models/ffmpeg-location.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ffmpeg-location.ts#L24) - -___ - -### SetByArgument - -• **SetByArgument** - -#### Defined in - -[generated-client/models/ffmpeg-location.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ffmpeg-location.ts#L25) - -___ - -### System - -• **System** - -#### Defined in - -[generated-client/models/ffmpeg-location.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ffmpeg-location.ts#L27) diff --git a/docs/enums/generated_client.FileSystemEntryType.md b/docs/enums/generated_client.FileSystemEntryType.md deleted file mode 100644 index 6187dec2f..000000000 --- a/docs/enums/generated_client.FileSystemEntryType.md +++ /dev/null @@ -1,58 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / FileSystemEntryType - -# Enumeration: FileSystemEntryType - -[generated-client](../modules/generated_client.md).FileSystemEntryType - -Enum FileSystemEntryType. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Directory](generated_client.FileSystemEntryType.md#directory) -- [File](generated_client.FileSystemEntryType.md#file) -- [NetworkComputer](generated_client.FileSystemEntryType.md#networkcomputer) -- [NetworkShare](generated_client.FileSystemEntryType.md#networkshare) - -## Enumeration Members - -### Directory - -• **Directory** - -#### Defined in - -[generated-client/models/file-system-entry-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/file-system-entry-type.ts#L25) - -___ - -### File - -• **File** - -#### Defined in - -[generated-client/models/file-system-entry-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/file-system-entry-type.ts#L24) - -___ - -### NetworkComputer - -• **NetworkComputer** - -#### Defined in - -[generated-client/models/file-system-entry-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/file-system-entry-type.ts#L26) - -___ - -### NetworkShare - -• **NetworkShare** - -#### Defined in - -[generated-client/models/file-system-entry-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/file-system-entry-type.ts#L27) diff --git a/docs/enums/generated_client.ForgotPasswordAction.md b/docs/enums/generated_client.ForgotPasswordAction.md deleted file mode 100644 index 1e93cb24e..000000000 --- a/docs/enums/generated_client.ForgotPasswordAction.md +++ /dev/null @@ -1,45 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ForgotPasswordAction - -# Enumeration: ForgotPasswordAction - -[generated-client](../modules/generated_client.md).ForgotPasswordAction - -**`export`** - -## Table of contents - -### Enumeration Members - -- [ContactAdmin](generated_client.ForgotPasswordAction.md#contactadmin) -- [InNetworkRequired](generated_client.ForgotPasswordAction.md#innetworkrequired) -- [PinCode](generated_client.ForgotPasswordAction.md#pincode) - -## Enumeration Members - -### ContactAdmin - -• **ContactAdmin** - -#### Defined in - -[generated-client/models/forgot-password-action.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/forgot-password-action.ts#L24) - -___ - -### InNetworkRequired - -• **InNetworkRequired** - -#### Defined in - -[generated-client/models/forgot-password-action.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/forgot-password-action.ts#L26) - -___ - -### PinCode - -• **PinCode** - -#### Defined in - -[generated-client/models/forgot-password-action.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/forgot-password-action.ts#L25) diff --git a/docs/enums/generated_client.GeneralCommandType.md b/docs/enums/generated_client.GeneralCommandType.md deleted file mode 100644 index 4e4d61b8a..000000000 --- a/docs/enums/generated_client.GeneralCommandType.md +++ /dev/null @@ -1,476 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GeneralCommandType - -# Enumeration: GeneralCommandType - -[generated-client](../modules/generated_client.md).GeneralCommandType - -This exists simply to identify a set of known commands. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Back](generated_client.GeneralCommandType.md#back) -- [ChannelDown](generated_client.GeneralCommandType.md#channeldown) -- [ChannelUp](generated_client.GeneralCommandType.md#channelup) -- [DisplayContent](generated_client.GeneralCommandType.md#displaycontent) -- [DisplayMessage](generated_client.GeneralCommandType.md#displaymessage) -- [GoHome](generated_client.GeneralCommandType.md#gohome) -- [GoToSearch](generated_client.GeneralCommandType.md#gotosearch) -- [GoToSettings](generated_client.GeneralCommandType.md#gotosettings) -- [Guide](generated_client.GeneralCommandType.md#guide) -- [MoveDown](generated_client.GeneralCommandType.md#movedown) -- [MoveLeft](generated_client.GeneralCommandType.md#moveleft) -- [MoveRight](generated_client.GeneralCommandType.md#moveright) -- [MoveUp](generated_client.GeneralCommandType.md#moveup) -- [Mute](generated_client.GeneralCommandType.md#mute) -- [NextLetter](generated_client.GeneralCommandType.md#nextletter) -- [PageDown](generated_client.GeneralCommandType.md#pagedown) -- [PageUp](generated_client.GeneralCommandType.md#pageup) -- [Play](generated_client.GeneralCommandType.md#play) -- [PlayMediaSource](generated_client.GeneralCommandType.md#playmediasource) -- [PlayNext](generated_client.GeneralCommandType.md#playnext) -- [PlayState](generated_client.GeneralCommandType.md#playstate) -- [PlayTrailers](generated_client.GeneralCommandType.md#playtrailers) -- [PreviousLetter](generated_client.GeneralCommandType.md#previousletter) -- [Select](generated_client.GeneralCommandType.md#select) -- [SendKey](generated_client.GeneralCommandType.md#sendkey) -- [SendString](generated_client.GeneralCommandType.md#sendstring) -- [SetAudioStreamIndex](generated_client.GeneralCommandType.md#setaudiostreamindex) -- [SetMaxStreamingBitrate](generated_client.GeneralCommandType.md#setmaxstreamingbitrate) -- [SetRepeatMode](generated_client.GeneralCommandType.md#setrepeatmode) -- [SetShuffleQueue](generated_client.GeneralCommandType.md#setshufflequeue) -- [SetSubtitleStreamIndex](generated_client.GeneralCommandType.md#setsubtitlestreamindex) -- [SetVolume](generated_client.GeneralCommandType.md#setvolume) -- [TakeScreenshot](generated_client.GeneralCommandType.md#takescreenshot) -- [ToggleContextMenu](generated_client.GeneralCommandType.md#togglecontextmenu) -- [ToggleFullscreen](generated_client.GeneralCommandType.md#togglefullscreen) -- [ToggleMute](generated_client.GeneralCommandType.md#togglemute) -- [ToggleOsd](generated_client.GeneralCommandType.md#toggleosd) -- [ToggleOsdMenu](generated_client.GeneralCommandType.md#toggleosdmenu) -- [ToggleStats](generated_client.GeneralCommandType.md#togglestats) -- [Unmute](generated_client.GeneralCommandType.md#unmute) -- [VolumeDown](generated_client.GeneralCommandType.md#volumedown) -- [VolumeUp](generated_client.GeneralCommandType.md#volumeup) - -## Enumeration Members - -### Back - -• **Back** - -#### Defined in - -[generated-client/models/general-command-type.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L35) - -___ - -### ChannelDown - -• **ChannelDown** - -#### Defined in - -[generated-client/models/general-command-type.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L55) - -___ - -### ChannelUp - -• **ChannelUp** - -#### Defined in - -[generated-client/models/general-command-type.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L54) - -___ - -### DisplayContent - -• **DisplayContent** - -#### Defined in - -[generated-client/models/general-command-type.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L50) - -___ - -### DisplayMessage - -• **DisplayMessage** - -#### Defined in - -[generated-client/models/general-command-type.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L52) - -___ - -### GoHome - -• **GoHome** - -#### Defined in - -[generated-client/models/general-command-type.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L39) - -___ - -### GoToSearch - -• **GoToSearch** - -#### Defined in - -[generated-client/models/general-command-type.ts:51](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L51) - -___ - -### GoToSettings - -• **GoToSettings** - -#### Defined in - -[generated-client/models/general-command-type.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L40) - -___ - -### Guide - -• **Guide** - -#### Defined in - -[generated-client/models/general-command-type.ts:56](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L56) - -___ - -### MoveDown - -• **MoveDown** - -#### Defined in - -[generated-client/models/general-command-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L25) - -___ - -### MoveLeft - -• **MoveLeft** - -#### Defined in - -[generated-client/models/general-command-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L26) - -___ - -### MoveRight - -• **MoveRight** - -#### Defined in - -[generated-client/models/general-command-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L27) - -___ - -### MoveUp - -• **MoveUp** - -#### Defined in - -[generated-client/models/general-command-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L24) - -___ - -### Mute - -• **Mute** - -#### Defined in - -[generated-client/models/general-command-type.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L43) - -___ - -### NextLetter - -• **NextLetter** - -#### Defined in - -[generated-client/models/general-command-type.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L31) - -___ - -### PageDown - -• **PageDown** - -#### Defined in - -[generated-client/models/general-command-type.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L29) - -___ - -### PageUp - -• **PageUp** - -#### Defined in - -[generated-client/models/general-command-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L28) - -___ - -### Play - -• **Play** - -#### Defined in - -[generated-client/models/general-command-type.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L64) - -___ - -### PlayMediaSource - -• **PlayMediaSource** - -#### Defined in - -[generated-client/models/general-command-type.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L58) - -___ - -### PlayNext - -• **PlayNext** - -#### Defined in - -[generated-client/models/general-command-type.ts:62](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L62) - -___ - -### PlayState - -• **PlayState** - -#### Defined in - -[generated-client/models/general-command-type.ts:61](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L61) - -___ - -### PlayTrailers - -• **PlayTrailers** - -#### Defined in - -[generated-client/models/general-command-type.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L59) - -___ - -### PreviousLetter - -• **PreviousLetter** - -#### Defined in - -[generated-client/models/general-command-type.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L30) - -___ - -### Select - -• **Select** - -#### Defined in - -[generated-client/models/general-command-type.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L34) - -___ - -### SendKey - -• **SendKey** - -#### Defined in - -[generated-client/models/general-command-type.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L37) - -___ - -### SendString - -• **SendString** - -#### Defined in - -[generated-client/models/general-command-type.ts:38](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L38) - -___ - -### SetAudioStreamIndex - -• **SetAudioStreamIndex** - -#### Defined in - -[generated-client/models/general-command-type.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L47) - -___ - -### SetMaxStreamingBitrate - -• **SetMaxStreamingBitrate** - -#### Defined in - -[generated-client/models/general-command-type.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L65) - -___ - -### SetRepeatMode - -• **SetRepeatMode** - -#### Defined in - -[generated-client/models/general-command-type.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L53) - -___ - -### SetShuffleQueue - -• **SetShuffleQueue** - -#### Defined in - -[generated-client/models/general-command-type.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L60) - -___ - -### SetSubtitleStreamIndex - -• **SetSubtitleStreamIndex** - -#### Defined in - -[generated-client/models/general-command-type.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L48) - -___ - -### SetVolume - -• **SetVolume** - -#### Defined in - -[generated-client/models/general-command-type.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L46) - -___ - -### TakeScreenshot - -• **TakeScreenshot** - -#### Defined in - -[generated-client/models/general-command-type.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L36) - -___ - -### ToggleContextMenu - -• **ToggleContextMenu** - -#### Defined in - -[generated-client/models/general-command-type.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L33) - -___ - -### ToggleFullscreen - -• **ToggleFullscreen** - -#### Defined in - -[generated-client/models/general-command-type.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L49) - -___ - -### ToggleMute - -• **ToggleMute** - -#### Defined in - -[generated-client/models/general-command-type.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L45) - -___ - -### ToggleOsd - -• **ToggleOsd** - -#### Defined in - -[generated-client/models/general-command-type.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L32) - -___ - -### ToggleOsdMenu - -• **ToggleOsdMenu** - -#### Defined in - -[generated-client/models/general-command-type.ts:63](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L63) - -___ - -### ToggleStats - -• **ToggleStats** - -#### Defined in - -[generated-client/models/general-command-type.ts:57](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L57) - -___ - -### Unmute - -• **Unmute** - -#### Defined in - -[generated-client/models/general-command-type.ts:44](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L44) - -___ - -### VolumeDown - -• **VolumeDown** - -#### Defined in - -[generated-client/models/general-command-type.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L42) - -___ - -### VolumeUp - -• **VolumeUp** - -#### Defined in - -[generated-client/models/general-command-type.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L41) diff --git a/docs/enums/generated_client.GroupQueueMode.md b/docs/enums/generated_client.GroupQueueMode.md deleted file mode 100644 index b8db5b6fd..000000000 --- a/docs/enums/generated_client.GroupQueueMode.md +++ /dev/null @@ -1,36 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GroupQueueMode - -# Enumeration: GroupQueueMode - -[generated-client](../modules/generated_client.md).GroupQueueMode - -Enum GroupQueueMode. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Queue](generated_client.GroupQueueMode.md#queue) -- [QueueNext](generated_client.GroupQueueMode.md#queuenext) - -## Enumeration Members - -### Queue - -• **Queue** - -#### Defined in - -[generated-client/models/group-queue-mode.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-queue-mode.ts#L24) - -___ - -### QueueNext - -• **QueueNext** - -#### Defined in - -[generated-client/models/group-queue-mode.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-queue-mode.ts#L25) diff --git a/docs/enums/generated_client.GroupRepeatMode.md b/docs/enums/generated_client.GroupRepeatMode.md deleted file mode 100644 index ef6b27ec6..000000000 --- a/docs/enums/generated_client.GroupRepeatMode.md +++ /dev/null @@ -1,47 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GroupRepeatMode - -# Enumeration: GroupRepeatMode - -[generated-client](../modules/generated_client.md).GroupRepeatMode - -Enum GroupRepeatMode. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [RepeatAll](generated_client.GroupRepeatMode.md#repeatall) -- [RepeatNone](generated_client.GroupRepeatMode.md#repeatnone) -- [RepeatOne](generated_client.GroupRepeatMode.md#repeatone) - -## Enumeration Members - -### RepeatAll - -• **RepeatAll** - -#### Defined in - -[generated-client/models/group-repeat-mode.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-repeat-mode.ts#L25) - -___ - -### RepeatNone - -• **RepeatNone** - -#### Defined in - -[generated-client/models/group-repeat-mode.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-repeat-mode.ts#L26) - -___ - -### RepeatOne - -• **RepeatOne** - -#### Defined in - -[generated-client/models/group-repeat-mode.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-repeat-mode.ts#L24) diff --git a/docs/enums/generated_client.GroupShuffleMode.md b/docs/enums/generated_client.GroupShuffleMode.md deleted file mode 100644 index acf9f21de..000000000 --- a/docs/enums/generated_client.GroupShuffleMode.md +++ /dev/null @@ -1,36 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GroupShuffleMode - -# Enumeration: GroupShuffleMode - -[generated-client](../modules/generated_client.md).GroupShuffleMode - -Enum GroupShuffleMode. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Shuffle](generated_client.GroupShuffleMode.md#shuffle) -- [Sorted](generated_client.GroupShuffleMode.md#sorted) - -## Enumeration Members - -### Shuffle - -• **Shuffle** - -#### Defined in - -[generated-client/models/group-shuffle-mode.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-shuffle-mode.ts#L25) - -___ - -### Sorted - -• **Sorted** - -#### Defined in - -[generated-client/models/group-shuffle-mode.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-shuffle-mode.ts#L24) diff --git a/docs/enums/generated_client.GroupStateType.md b/docs/enums/generated_client.GroupStateType.md deleted file mode 100644 index 3fabb9459..000000000 --- a/docs/enums/generated_client.GroupStateType.md +++ /dev/null @@ -1,58 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GroupStateType - -# Enumeration: GroupStateType - -[generated-client](../modules/generated_client.md).GroupStateType - -Enum GroupState. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Idle](generated_client.GroupStateType.md#idle) -- [Paused](generated_client.GroupStateType.md#paused) -- [Playing](generated_client.GroupStateType.md#playing) -- [Waiting](generated_client.GroupStateType.md#waiting) - -## Enumeration Members - -### Idle - -• **Idle** - -#### Defined in - -[generated-client/models/group-state-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-state-type.ts#L24) - -___ - -### Paused - -• **Paused** - -#### Defined in - -[generated-client/models/group-state-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-state-type.ts#L26) - -___ - -### Playing - -• **Playing** - -#### Defined in - -[generated-client/models/group-state-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-state-type.ts#L27) - -___ - -### Waiting - -• **Waiting** - -#### Defined in - -[generated-client/models/group-state-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-state-type.ts#L25) diff --git a/docs/enums/generated_client.GroupUpdateType.md b/docs/enums/generated_client.GroupUpdateType.md deleted file mode 100644 index a71b38232..000000000 --- a/docs/enums/generated_client.GroupUpdateType.md +++ /dev/null @@ -1,135 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GroupUpdateType - -# Enumeration: GroupUpdateType - -[generated-client](../modules/generated_client.md).GroupUpdateType - -Enum GroupUpdateType. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [CreateGroupDenied](generated_client.GroupUpdateType.md#creategroupdenied) -- [GroupDoesNotExist](generated_client.GroupUpdateType.md#groupdoesnotexist) -- [GroupJoined](generated_client.GroupUpdateType.md#groupjoined) -- [GroupLeft](generated_client.GroupUpdateType.md#groupleft) -- [JoinGroupDenied](generated_client.GroupUpdateType.md#joingroupdenied) -- [LibraryAccessDenied](generated_client.GroupUpdateType.md#libraryaccessdenied) -- [NotInGroup](generated_client.GroupUpdateType.md#notingroup) -- [PlayQueue](generated_client.GroupUpdateType.md#playqueue) -- [StateUpdate](generated_client.GroupUpdateType.md#stateupdate) -- [UserJoined](generated_client.GroupUpdateType.md#userjoined) -- [UserLeft](generated_client.GroupUpdateType.md#userleft) - -## Enumeration Members - -### CreateGroupDenied - -• **CreateGroupDenied** - -#### Defined in - -[generated-client/models/group-update-type.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L32) - -___ - -### GroupDoesNotExist - -• **GroupDoesNotExist** - -#### Defined in - -[generated-client/models/group-update-type.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L31) - -___ - -### GroupJoined - -• **GroupJoined** - -#### Defined in - -[generated-client/models/group-update-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L26) - -___ - -### GroupLeft - -• **GroupLeft** - -#### Defined in - -[generated-client/models/group-update-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L27) - -___ - -### JoinGroupDenied - -• **JoinGroupDenied** - -#### Defined in - -[generated-client/models/group-update-type.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L33) - -___ - -### LibraryAccessDenied - -• **LibraryAccessDenied** - -#### Defined in - -[generated-client/models/group-update-type.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L34) - -___ - -### NotInGroup - -• **NotInGroup** - -#### Defined in - -[generated-client/models/group-update-type.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L30) - -___ - -### PlayQueue - -• **PlayQueue** - -#### Defined in - -[generated-client/models/group-update-type.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L29) - -___ - -### StateUpdate - -• **StateUpdate** - -#### Defined in - -[generated-client/models/group-update-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L28) - -___ - -### UserJoined - -• **UserJoined** - -#### Defined in - -[generated-client/models/group-update-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L24) - -___ - -### UserLeft - -• **UserLeft** - -#### Defined in - -[generated-client/models/group-update-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L25) diff --git a/docs/enums/generated_client.HardwareEncodingType.md b/docs/enums/generated_client.HardwareEncodingType.md deleted file mode 100644 index 4d9411f75..000000000 --- a/docs/enums/generated_client.HardwareEncodingType.md +++ /dev/null @@ -1,80 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / HardwareEncodingType - -# Enumeration: HardwareEncodingType - -[generated-client](../modules/generated_client.md).HardwareEncodingType - -Enum HardwareEncodingType. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Amf](generated_client.HardwareEncodingType.md#amf) -- [Nvenc](generated_client.HardwareEncodingType.md#nvenc) -- [Qsv](generated_client.HardwareEncodingType.md#qsv) -- [V4L2M2M](generated_client.HardwareEncodingType.md#v4l2m2m) -- [Vaapi](generated_client.HardwareEncodingType.md#vaapi) -- [VideoToolBox](generated_client.HardwareEncodingType.md#videotoolbox) - -## Enumeration Members - -### Amf - -• **Amf** - -#### Defined in - -[generated-client/models/hardware-encoding-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/hardware-encoding-type.ts#L24) - -___ - -### Nvenc - -• **Nvenc** - -#### Defined in - -[generated-client/models/hardware-encoding-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/hardware-encoding-type.ts#L26) - -___ - -### Qsv - -• **Qsv** - -#### Defined in - -[generated-client/models/hardware-encoding-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/hardware-encoding-type.ts#L25) - -___ - -### V4L2M2M - -• **V4L2M2M** - -#### Defined in - -[generated-client/models/hardware-encoding-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/hardware-encoding-type.ts#L27) - -___ - -### Vaapi - -• **Vaapi** - -#### Defined in - -[generated-client/models/hardware-encoding-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/hardware-encoding-type.ts#L28) - -___ - -### VideoToolBox - -• **VideoToolBox** - -#### Defined in - -[generated-client/models/hardware-encoding-type.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/hardware-encoding-type.ts#L29) diff --git a/docs/enums/generated_client.HeaderMatchType.md b/docs/enums/generated_client.HeaderMatchType.md deleted file mode 100644 index 21aab9bbe..000000000 --- a/docs/enums/generated_client.HeaderMatchType.md +++ /dev/null @@ -1,45 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / HeaderMatchType - -# Enumeration: HeaderMatchType - -[generated-client](../modules/generated_client.md).HeaderMatchType - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Equals](generated_client.HeaderMatchType.md#equals) -- [Regex](generated_client.HeaderMatchType.md#regex) -- [Substring](generated_client.HeaderMatchType.md#substring) - -## Enumeration Members - -### Equals - -• **Equals** - -#### Defined in - -[generated-client/models/header-match-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/header-match-type.ts#L24) - -___ - -### Regex - -• **Regex** - -#### Defined in - -[generated-client/models/header-match-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/header-match-type.ts#L25) - -___ - -### Substring - -• **Substring** - -#### Defined in - -[generated-client/models/header-match-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/header-match-type.ts#L26) diff --git a/docs/enums/generated_client.ImageFormat.md b/docs/enums/generated_client.ImageFormat.md deleted file mode 100644 index 712b91190..000000000 --- a/docs/enums/generated_client.ImageFormat.md +++ /dev/null @@ -1,69 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageFormat - -# Enumeration: ImageFormat - -[generated-client](../modules/generated_client.md).ImageFormat - -Enum ImageOutputFormat. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Bmp](generated_client.ImageFormat.md#bmp) -- [Gif](generated_client.ImageFormat.md#gif) -- [Jpg](generated_client.ImageFormat.md#jpg) -- [Png](generated_client.ImageFormat.md#png) -- [Webp](generated_client.ImageFormat.md#webp) - -## Enumeration Members - -### Bmp - -• **Bmp** - -#### Defined in - -[generated-client/models/image-format.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-format.ts#L24) - -___ - -### Gif - -• **Gif** - -#### Defined in - -[generated-client/models/image-format.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-format.ts#L25) - -___ - -### Jpg - -• **Jpg** - -#### Defined in - -[generated-client/models/image-format.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-format.ts#L26) - -___ - -### Png - -• **Png** - -#### Defined in - -[generated-client/models/image-format.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-format.ts#L27) - -___ - -### Webp - -• **Webp** - -#### Defined in - -[generated-client/models/image-format.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-format.ts#L28) diff --git a/docs/enums/generated_client.ImageOrientation.md b/docs/enums/generated_client.ImageOrientation.md deleted file mode 100644 index a48b7bd1a..000000000 --- a/docs/enums/generated_client.ImageOrientation.md +++ /dev/null @@ -1,100 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageOrientation - -# Enumeration: ImageOrientation - -[generated-client](../modules/generated_client.md).ImageOrientation - -**`export`** - -## Table of contents - -### Enumeration Members - -- [BottomLeft](generated_client.ImageOrientation.md#bottomleft) -- [BottomRight](generated_client.ImageOrientation.md#bottomright) -- [LeftBottom](generated_client.ImageOrientation.md#leftbottom) -- [LeftTop](generated_client.ImageOrientation.md#lefttop) -- [RightBottom](generated_client.ImageOrientation.md#rightbottom) -- [RightTop](generated_client.ImageOrientation.md#righttop) -- [TopLeft](generated_client.ImageOrientation.md#topleft) -- [TopRight](generated_client.ImageOrientation.md#topright) - -## Enumeration Members - -### BottomLeft - -• **BottomLeft** - -#### Defined in - -[generated-client/models/image-orientation.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-orientation.ts#L27) - -___ - -### BottomRight - -• **BottomRight** - -#### Defined in - -[generated-client/models/image-orientation.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-orientation.ts#L26) - -___ - -### LeftBottom - -• **LeftBottom** - -#### Defined in - -[generated-client/models/image-orientation.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-orientation.ts#L31) - -___ - -### LeftTop - -• **LeftTop** - -#### Defined in - -[generated-client/models/image-orientation.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-orientation.ts#L28) - -___ - -### RightBottom - -• **RightBottom** - -#### Defined in - -[generated-client/models/image-orientation.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-orientation.ts#L30) - -___ - -### RightTop - -• **RightTop** - -#### Defined in - -[generated-client/models/image-orientation.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-orientation.ts#L29) - -___ - -### TopLeft - -• **TopLeft** - -#### Defined in - -[generated-client/models/image-orientation.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-orientation.ts#L24) - -___ - -### TopRight - -• **TopRight** - -#### Defined in - -[generated-client/models/image-orientation.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-orientation.ts#L25) diff --git a/docs/enums/generated_client.ImageSavingConvention.md b/docs/enums/generated_client.ImageSavingConvention.md deleted file mode 100644 index 6f266e377..000000000 --- a/docs/enums/generated_client.ImageSavingConvention.md +++ /dev/null @@ -1,34 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageSavingConvention - -# Enumeration: ImageSavingConvention - -[generated-client](../modules/generated_client.md).ImageSavingConvention - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Compatible](generated_client.ImageSavingConvention.md#compatible) -- [Legacy](generated_client.ImageSavingConvention.md#legacy) - -## Enumeration Members - -### Compatible - -• **Compatible** - -#### Defined in - -[generated-client/models/image-saving-convention.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-saving-convention.ts#L25) - -___ - -### Legacy - -• **Legacy** - -#### Defined in - -[generated-client/models/image-saving-convention.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-saving-convention.ts#L24) diff --git a/docs/enums/generated_client.ImageType.md b/docs/enums/generated_client.ImageType.md deleted file mode 100644 index 1ee0c0087..000000000 --- a/docs/enums/generated_client.ImageType.md +++ /dev/null @@ -1,157 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageType - -# Enumeration: ImageType - -[generated-client](../modules/generated_client.md).ImageType - -Enum ImageType. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Art](generated_client.ImageType.md#art) -- [Backdrop](generated_client.ImageType.md#backdrop) -- [Banner](generated_client.ImageType.md#banner) -- [Box](generated_client.ImageType.md#box) -- [BoxRear](generated_client.ImageType.md#boxrear) -- [Chapter](generated_client.ImageType.md#chapter) -- [Disc](generated_client.ImageType.md#disc) -- [Logo](generated_client.ImageType.md#logo) -- [Menu](generated_client.ImageType.md#menu) -- [Primary](generated_client.ImageType.md#primary) -- [Profile](generated_client.ImageType.md#profile) -- [Screenshot](generated_client.ImageType.md#screenshot) -- [Thumb](generated_client.ImageType.md#thumb) - -## Enumeration Members - -### Art - -• **Art** - -#### Defined in - -[generated-client/models/image-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L25) - -___ - -### Backdrop - -• **Backdrop** - -#### Defined in - -[generated-client/models/image-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L26) - -___ - -### Banner - -• **Banner** - -#### Defined in - -[generated-client/models/image-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L27) - -___ - -### Box - -• **Box** - -#### Defined in - -[generated-client/models/image-type.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L31) - -___ - -### BoxRear - -• **BoxRear** - -#### Defined in - -[generated-client/models/image-type.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L35) - -___ - -### Chapter - -• **Chapter** - -#### Defined in - -[generated-client/models/image-type.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L34) - -___ - -### Disc - -• **Disc** - -#### Defined in - -[generated-client/models/image-type.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L30) - -___ - -### Logo - -• **Logo** - -#### Defined in - -[generated-client/models/image-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L28) - -___ - -### Menu - -• **Menu** - -#### Defined in - -[generated-client/models/image-type.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L33) - -___ - -### Primary - -• **Primary** - -#### Defined in - -[generated-client/models/image-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L24) - -___ - -### Profile - -• **Profile** - -#### Defined in - -[generated-client/models/image-type.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L36) - -___ - -### Screenshot - -• **Screenshot** - -#### Defined in - -[generated-client/models/image-type.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L32) - -___ - -### Thumb - -• **Thumb** - -#### Defined in - -[generated-client/models/image-type.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-type.ts#L29) diff --git a/docs/enums/generated_client.IsoType.md b/docs/enums/generated_client.IsoType.md deleted file mode 100644 index e066e185f..000000000 --- a/docs/enums/generated_client.IsoType.md +++ /dev/null @@ -1,36 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / IsoType - -# Enumeration: IsoType - -[generated-client](../modules/generated_client.md).IsoType - -Enum IsoType. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [BluRay](generated_client.IsoType.md#bluray) -- [Dvd](generated_client.IsoType.md#dvd) - -## Enumeration Members - -### BluRay - -• **BluRay** - -#### Defined in - -[generated-client/models/iso-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/iso-type.ts#L25) - -___ - -### Dvd - -• **Dvd** - -#### Defined in - -[generated-client/models/iso-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/iso-type.ts#L24) diff --git a/docs/enums/generated_client.ItemFields.md b/docs/enums/generated_client.ItemFields.md deleted file mode 100644 index 78932e74a..000000000 --- a/docs/enums/generated_client.ItemFields.md +++ /dev/null @@ -1,685 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemFields - -# Enumeration: ItemFields - -[generated-client](../modules/generated_client.md).ItemFields - -Used to control the data that gets attached to DtoBaseItems. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [AirTime](generated_client.ItemFields.md#airtime) -- [BasicSyncInfo](generated_client.ItemFields.md#basicsyncinfo) -- [CanDelete](generated_client.ItemFields.md#candelete) -- [CanDownload](generated_client.ItemFields.md#candownload) -- [ChannelImage](generated_client.ItemFields.md#channelimage) -- [ChannelInfo](generated_client.ItemFields.md#channelinfo) -- [Chapters](generated_client.ItemFields.md#chapters) -- [ChildCount](generated_client.ItemFields.md#childcount) -- [CumulativeRunTimeTicks](generated_client.ItemFields.md#cumulativeruntimeticks) -- [CustomRating](generated_client.ItemFields.md#customrating) -- [DateCreated](generated_client.ItemFields.md#datecreated) -- [DateLastMediaAdded](generated_client.ItemFields.md#datelastmediaadded) -- [DateLastRefreshed](generated_client.ItemFields.md#datelastrefreshed) -- [DateLastSaved](generated_client.ItemFields.md#datelastsaved) -- [DisplayPreferencesId](generated_client.ItemFields.md#displaypreferencesid) -- [EnableMediaSourceDisplay](generated_client.ItemFields.md#enablemediasourcedisplay) -- [Etag](generated_client.ItemFields.md#etag) -- [ExternalEtag](generated_client.ItemFields.md#externaletag) -- [ExternalSeriesId](generated_client.ItemFields.md#externalseriesid) -- [ExternalUrls](generated_client.ItemFields.md#externalurls) -- [ExtraIds](generated_client.ItemFields.md#extraids) -- [Genres](generated_client.ItemFields.md#genres) -- [Height](generated_client.ItemFields.md#height) -- [HomePageUrl](generated_client.ItemFields.md#homepageurl) -- [InheritedParentalRatingValue](generated_client.ItemFields.md#inheritedparentalratingvalue) -- [IsHd](generated_client.ItemFields.md#ishd) -- [ItemCounts](generated_client.ItemFields.md#itemcounts) -- [LocalTrailerCount](generated_client.ItemFields.md#localtrailercount) -- [MediaSourceCount](generated_client.ItemFields.md#mediasourcecount) -- [MediaSources](generated_client.ItemFields.md#mediasources) -- [MediaStreams](generated_client.ItemFields.md#mediastreams) -- [OriginalTitle](generated_client.ItemFields.md#originaltitle) -- [Overview](generated_client.ItemFields.md#overview) -- [ParentId](generated_client.ItemFields.md#parentid) -- [Path](generated_client.ItemFields.md#path) -- [People](generated_client.ItemFields.md#people) -- [PlayAccess](generated_client.ItemFields.md#playaccess) -- [PresentationUniqueKey](generated_client.ItemFields.md#presentationuniquekey) -- [PrimaryImageAspectRatio](generated_client.ItemFields.md#primaryimageaspectratio) -- [ProductionLocations](generated_client.ItemFields.md#productionlocations) -- [ProviderIds](generated_client.ItemFields.md#providerids) -- [RecursiveItemCount](generated_client.ItemFields.md#recursiveitemcount) -- [RefreshState](generated_client.ItemFields.md#refreshstate) -- [RemoteTrailers](generated_client.ItemFields.md#remotetrailers) -- [ScreenshotImageTags](generated_client.ItemFields.md#screenshotimagetags) -- [SeasonUserData](generated_client.ItemFields.md#seasonuserdata) -- [SeriesPresentationUniqueKey](generated_client.ItemFields.md#seriespresentationuniquekey) -- [SeriesPrimaryImage](generated_client.ItemFields.md#seriesprimaryimage) -- [SeriesStudio](generated_client.ItemFields.md#seriesstudio) -- [ServiceName](generated_client.ItemFields.md#servicename) -- [Settings](generated_client.ItemFields.md#settings) -- [SortName](generated_client.ItemFields.md#sortname) -- [SpecialEpisodeNumbers](generated_client.ItemFields.md#specialepisodenumbers) -- [SpecialFeatureCount](generated_client.ItemFields.md#specialfeaturecount) -- [Studios](generated_client.ItemFields.md#studios) -- [SyncInfo](generated_client.ItemFields.md#syncinfo) -- [Taglines](generated_client.ItemFields.md#taglines) -- [Tags](generated_client.ItemFields.md#tags) -- [ThemeSongIds](generated_client.ItemFields.md#themesongids) -- [ThemeVideoIds](generated_client.ItemFields.md#themevideoids) -- [Width](generated_client.ItemFields.md#width) - -## Enumeration Members - -### AirTime - -• **AirTime** - -#### Defined in - -[generated-client/models/item-fields.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L24) - -___ - -### BasicSyncInfo - -• **BasicSyncInfo** - -#### Defined in - -[generated-client/models/item-fields.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L59) - -___ - -### CanDelete - -• **CanDelete** - -#### Defined in - -[generated-client/models/item-fields.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L25) - -___ - -### CanDownload - -• **CanDownload** - -#### Defined in - -[generated-client/models/item-fields.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L26) - -___ - -### ChannelImage - -• **ChannelImage** - -#### Defined in - -[generated-client/models/item-fields.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L77) - -___ - -### ChannelInfo - -• **ChannelInfo** - -#### Defined in - -[generated-client/models/item-fields.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L27) - -___ - -### Chapters - -• **Chapters** - -#### Defined in - -[generated-client/models/item-fields.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L28) - -___ - -### ChildCount - -• **ChildCount** - -#### Defined in - -[generated-client/models/item-fields.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L29) - -___ - -### CumulativeRunTimeTicks - -• **CumulativeRunTimeTicks** - -#### Defined in - -[generated-client/models/item-fields.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L30) - -___ - -### CustomRating - -• **CustomRating** - -#### Defined in - -[generated-client/models/item-fields.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L31) - -___ - -### DateCreated - -• **DateCreated** - -#### Defined in - -[generated-client/models/item-fields.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L32) - -___ - -### DateLastMediaAdded - -• **DateLastMediaAdded** - -#### Defined in - -[generated-client/models/item-fields.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L33) - -___ - -### DateLastRefreshed - -• **DateLastRefreshed** - -#### Defined in - -[generated-client/models/item-fields.ts:74](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L74) - -___ - -### DateLastSaved - -• **DateLastSaved** - -#### Defined in - -[generated-client/models/item-fields.ts:75](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L75) - -___ - -### DisplayPreferencesId - -• **DisplayPreferencesId** - -#### Defined in - -[generated-client/models/item-fields.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L34) - -___ - -### EnableMediaSourceDisplay - -• **EnableMediaSourceDisplay** - -#### Defined in - -[generated-client/models/item-fields.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L78) - -___ - -### Etag - -• **Etag** - -#### Defined in - -[generated-client/models/item-fields.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L35) - -___ - -### ExternalEtag - -• **ExternalEtag** - -#### Defined in - -[generated-client/models/item-fields.ts:69](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L69) - -___ - -### ExternalSeriesId - -• **ExternalSeriesId** - -#### Defined in - -[generated-client/models/item-fields.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L72) - -___ - -### ExternalUrls - -• **ExternalUrls** - -#### Defined in - -[generated-client/models/item-fields.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L36) - -___ - -### ExtraIds - -• **ExtraIds** - -#### Defined in - -[generated-client/models/item-fields.ts:81](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L81) - -___ - -### Genres - -• **Genres** - -#### Defined in - -[generated-client/models/item-fields.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L37) - -___ - -### Height - -• **Height** - -#### Defined in - -[generated-client/models/item-fields.ts:80](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L80) - -___ - -### HomePageUrl - -• **HomePageUrl** - -#### Defined in - -[generated-client/models/item-fields.ts:38](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L38) - -___ - -### InheritedParentalRatingValue - -• **InheritedParentalRatingValue** - -#### Defined in - -[generated-client/models/item-fields.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L71) - -___ - -### IsHd - -• **IsHd** - -#### Defined in - -[generated-client/models/item-fields.ts:83](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L83) - -___ - -### ItemCounts - -• **ItemCounts** - -#### Defined in - -[generated-client/models/item-fields.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L39) - -___ - -### LocalTrailerCount - -• **LocalTrailerCount** - -#### Defined in - -[generated-client/models/item-fields.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L82) - -___ - -### MediaSourceCount - -• **MediaSourceCount** - -#### Defined in - -[generated-client/models/item-fields.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L40) - -___ - -### MediaSources - -• **MediaSources** - -#### Defined in - -[generated-client/models/item-fields.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L41) - -___ - -### MediaStreams - -• **MediaStreams** - -#### Defined in - -[generated-client/models/item-fields.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L64) - -___ - -### OriginalTitle - -• **OriginalTitle** - -#### Defined in - -[generated-client/models/item-fields.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L42) - -___ - -### Overview - -• **Overview** - -#### Defined in - -[generated-client/models/item-fields.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L43) - -___ - -### ParentId - -• **ParentId** - -#### Defined in - -[generated-client/models/item-fields.ts:44](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L44) - -___ - -### Path - -• **Path** - -#### Defined in - -[generated-client/models/item-fields.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L45) - -___ - -### People - -• **People** - -#### Defined in - -[generated-client/models/item-fields.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L46) - -___ - -### PlayAccess - -• **PlayAccess** - -#### Defined in - -[generated-client/models/item-fields.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L47) - -___ - -### PresentationUniqueKey - -• **PresentationUniqueKey** - -#### Defined in - -[generated-client/models/item-fields.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L70) - -___ - -### PrimaryImageAspectRatio - -• **PrimaryImageAspectRatio** - -#### Defined in - -[generated-client/models/item-fields.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L50) - -___ - -### ProductionLocations - -• **ProductionLocations** - -#### Defined in - -[generated-client/models/item-fields.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L48) - -___ - -### ProviderIds - -• **ProviderIds** - -#### Defined in - -[generated-client/models/item-fields.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L49) - -___ - -### RecursiveItemCount - -• **RecursiveItemCount** - -#### Defined in - -[generated-client/models/item-fields.ts:51](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L51) - -___ - -### RefreshState - -• **RefreshState** - -#### Defined in - -[generated-client/models/item-fields.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L76) - -___ - -### RemoteTrailers - -• **RemoteTrailers** - -#### Defined in - -[generated-client/models/item-fields.ts:63](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L63) - -___ - -### ScreenshotImageTags - -• **ScreenshotImageTags** - -#### Defined in - -[generated-client/models/item-fields.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L53) - -___ - -### SeasonUserData - -• **SeasonUserData** - -#### Defined in - -[generated-client/models/item-fields.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L65) - -___ - -### SeriesPresentationUniqueKey - -• **SeriesPresentationUniqueKey** - -#### Defined in - -[generated-client/models/item-fields.ts:73](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L73) - -___ - -### SeriesPrimaryImage - -• **SeriesPrimaryImage** - -#### Defined in - -[generated-client/models/item-fields.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L54) - -___ - -### SeriesStudio - -• **SeriesStudio** - -#### Defined in - -[generated-client/models/item-fields.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L55) - -___ - -### ServiceName - -• **ServiceName** - -#### Defined in - -[generated-client/models/item-fields.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L66) - -___ - -### Settings - -• **Settings** - -#### Defined in - -[generated-client/models/item-fields.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L52) - -___ - -### SortName - -• **SortName** - -#### Defined in - -[generated-client/models/item-fields.ts:56](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L56) - -___ - -### SpecialEpisodeNumbers - -• **SpecialEpisodeNumbers** - -#### Defined in - -[generated-client/models/item-fields.ts:57](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L57) - -___ - -### SpecialFeatureCount - -• **SpecialFeatureCount** - -#### Defined in - -[generated-client/models/item-fields.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L84) - -___ - -### Studios - -• **Studios** - -#### Defined in - -[generated-client/models/item-fields.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L58) - -___ - -### SyncInfo - -• **SyncInfo** - -#### Defined in - -[generated-client/models/item-fields.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L60) - -___ - -### Taglines - -• **Taglines** - -#### Defined in - -[generated-client/models/item-fields.ts:61](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L61) - -___ - -### Tags - -• **Tags** - -#### Defined in - -[generated-client/models/item-fields.ts:62](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L62) - -___ - -### ThemeSongIds - -• **ThemeSongIds** - -#### Defined in - -[generated-client/models/item-fields.ts:67](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L67) - -___ - -### ThemeVideoIds - -• **ThemeVideoIds** - -#### Defined in - -[generated-client/models/item-fields.ts:68](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L68) - -___ - -### Width - -• **Width** - -#### Defined in - -[generated-client/models/item-fields.ts:79](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-fields.ts#L79) diff --git a/docs/enums/generated_client.ItemFilter.md b/docs/enums/generated_client.ItemFilter.md deleted file mode 100644 index 56a6c3560..000000000 --- a/docs/enums/generated_client.ItemFilter.md +++ /dev/null @@ -1,113 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemFilter - -# Enumeration: ItemFilter - -[generated-client](../modules/generated_client.md).ItemFilter - -Enum ItemFilter. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Dislikes](generated_client.ItemFilter.md#dislikes) -- [IsFavorite](generated_client.ItemFilter.md#isfavorite) -- [IsFavoriteOrLikes](generated_client.ItemFilter.md#isfavoriteorlikes) -- [IsFolder](generated_client.ItemFilter.md#isfolder) -- [IsNotFolder](generated_client.ItemFilter.md#isnotfolder) -- [IsPlayed](generated_client.ItemFilter.md#isplayed) -- [IsResumable](generated_client.ItemFilter.md#isresumable) -- [IsUnplayed](generated_client.ItemFilter.md#isunplayed) -- [Likes](generated_client.ItemFilter.md#likes) - -## Enumeration Members - -### Dislikes - -• **Dislikes** - -#### Defined in - -[generated-client/models/item-filter.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-filter.ts#L31) - -___ - -### IsFavorite - -• **IsFavorite** - -#### Defined in - -[generated-client/models/item-filter.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-filter.ts#L28) - -___ - -### IsFavoriteOrLikes - -• **IsFavoriteOrLikes** - -#### Defined in - -[generated-client/models/item-filter.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-filter.ts#L32) - -___ - -### IsFolder - -• **IsFolder** - -#### Defined in - -[generated-client/models/item-filter.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-filter.ts#L24) - -___ - -### IsNotFolder - -• **IsNotFolder** - -#### Defined in - -[generated-client/models/item-filter.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-filter.ts#L25) - -___ - -### IsPlayed - -• **IsPlayed** - -#### Defined in - -[generated-client/models/item-filter.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-filter.ts#L27) - -___ - -### IsResumable - -• **IsResumable** - -#### Defined in - -[generated-client/models/item-filter.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-filter.ts#L29) - -___ - -### IsUnplayed - -• **IsUnplayed** - -#### Defined in - -[generated-client/models/item-filter.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-filter.ts#L26) - -___ - -### Likes - -• **Likes** - -#### Defined in - -[generated-client/models/item-filter.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-filter.ts#L30) diff --git a/docs/enums/generated_client.KeepUntil.md b/docs/enums/generated_client.KeepUntil.md deleted file mode 100644 index 42d2070cd..000000000 --- a/docs/enums/generated_client.KeepUntil.md +++ /dev/null @@ -1,56 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / KeepUntil - -# Enumeration: KeepUntil - -[generated-client](../modules/generated_client.md).KeepUntil - -**`export`** - -## Table of contents - -### Enumeration Members - -- [UntilDate](generated_client.KeepUntil.md#untildate) -- [UntilDeleted](generated_client.KeepUntil.md#untildeleted) -- [UntilSpaceNeeded](generated_client.KeepUntil.md#untilspaceneeded) -- [UntilWatched](generated_client.KeepUntil.md#untilwatched) - -## Enumeration Members - -### UntilDate - -• **UntilDate** - -#### Defined in - -[generated-client/models/keep-until.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/keep-until.ts#L27) - -___ - -### UntilDeleted - -• **UntilDeleted** - -#### Defined in - -[generated-client/models/keep-until.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/keep-until.ts#L24) - -___ - -### UntilSpaceNeeded - -• **UntilSpaceNeeded** - -#### Defined in - -[generated-client/models/keep-until.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/keep-until.ts#L25) - -___ - -### UntilWatched - -• **UntilWatched** - -#### Defined in - -[generated-client/models/keep-until.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/keep-until.ts#L26) diff --git a/docs/enums/generated_client.LiveTvServiceStatus.md b/docs/enums/generated_client.LiveTvServiceStatus.md deleted file mode 100644 index 3b023a1bb..000000000 --- a/docs/enums/generated_client.LiveTvServiceStatus.md +++ /dev/null @@ -1,34 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvServiceStatus - -# Enumeration: LiveTvServiceStatus - -[generated-client](../modules/generated_client.md).LiveTvServiceStatus - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Ok](generated_client.LiveTvServiceStatus.md#ok) -- [Unavailable](generated_client.LiveTvServiceStatus.md#unavailable) - -## Enumeration Members - -### Ok - -• **Ok** - -#### Defined in - -[generated-client/models/live-tv-service-status.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-service-status.ts#L24) - -___ - -### Unavailable - -• **Unavailable** - -#### Defined in - -[generated-client/models/live-tv-service-status.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-service-status.ts#L25) diff --git a/docs/enums/generated_client.LocationType.md b/docs/enums/generated_client.LocationType.md deleted file mode 100644 index 30838316c..000000000 --- a/docs/enums/generated_client.LocationType.md +++ /dev/null @@ -1,58 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LocationType - -# Enumeration: LocationType - -[generated-client](../modules/generated_client.md).LocationType - -Enum LocationType. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [FileSystem](generated_client.LocationType.md#filesystem) -- [Offline](generated_client.LocationType.md#offline) -- [Remote](generated_client.LocationType.md#remote) -- [Virtual](generated_client.LocationType.md#virtual) - -## Enumeration Members - -### FileSystem - -• **FileSystem** - -#### Defined in - -[generated-client/models/location-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/location-type.ts#L24) - -___ - -### Offline - -• **Offline** - -#### Defined in - -[generated-client/models/location-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/location-type.ts#L27) - -___ - -### Remote - -• **Remote** - -#### Defined in - -[generated-client/models/location-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/location-type.ts#L25) - -___ - -### Virtual - -• **Virtual** - -#### Defined in - -[generated-client/models/location-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/location-type.ts#L26) diff --git a/docs/enums/generated_client.LogLevel.md b/docs/enums/generated_client.LogLevel.md deleted file mode 100644 index 901726c07..000000000 --- a/docs/enums/generated_client.LogLevel.md +++ /dev/null @@ -1,89 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LogLevel - -# Enumeration: LogLevel - -[generated-client](../modules/generated_client.md).LogLevel - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Critical](generated_client.LogLevel.md#critical) -- [Debug](generated_client.LogLevel.md#debug) -- [Error](generated_client.LogLevel.md#error) -- [Information](generated_client.LogLevel.md#information) -- [None](generated_client.LogLevel.md#none) -- [Trace](generated_client.LogLevel.md#trace) -- [Warning](generated_client.LogLevel.md#warning) - -## Enumeration Members - -### Critical - -• **Critical** - -#### Defined in - -[generated-client/models/log-level.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/log-level.ts#L29) - -___ - -### Debug - -• **Debug** - -#### Defined in - -[generated-client/models/log-level.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/log-level.ts#L25) - -___ - -### Error - -• **Error** - -#### Defined in - -[generated-client/models/log-level.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/log-level.ts#L28) - -___ - -### Information - -• **Information** - -#### Defined in - -[generated-client/models/log-level.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/log-level.ts#L26) - -___ - -### None - -• **None** - -#### Defined in - -[generated-client/models/log-level.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/log-level.ts#L30) - -___ - -### Trace - -• **Trace** - -#### Defined in - -[generated-client/models/log-level.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/log-level.ts#L24) - -___ - -### Warning - -• **Warning** - -#### Defined in - -[generated-client/models/log-level.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/log-level.ts#L27) diff --git a/docs/enums/generated_client.MediaProtocol.md b/docs/enums/generated_client.MediaProtocol.md deleted file mode 100644 index 58186e433..000000000 --- a/docs/enums/generated_client.MediaProtocol.md +++ /dev/null @@ -1,89 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaProtocol - -# Enumeration: MediaProtocol - -[generated-client](../modules/generated_client.md).MediaProtocol - -**`export`** - -## Table of contents - -### Enumeration Members - -- [File](generated_client.MediaProtocol.md#file) -- [Ftp](generated_client.MediaProtocol.md#ftp) -- [Http](generated_client.MediaProtocol.md#http) -- [Rtmp](generated_client.MediaProtocol.md#rtmp) -- [Rtp](generated_client.MediaProtocol.md#rtp) -- [Rtsp](generated_client.MediaProtocol.md#rtsp) -- [Udp](generated_client.MediaProtocol.md#udp) - -## Enumeration Members - -### File - -• **File** - -#### Defined in - -[generated-client/models/media-protocol.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-protocol.ts#L24) - -___ - -### Ftp - -• **Ftp** - -#### Defined in - -[generated-client/models/media-protocol.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-protocol.ts#L30) - -___ - -### Http - -• **Http** - -#### Defined in - -[generated-client/models/media-protocol.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-protocol.ts#L25) - -___ - -### Rtmp - -• **Rtmp** - -#### Defined in - -[generated-client/models/media-protocol.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-protocol.ts#L26) - -___ - -### Rtp - -• **Rtp** - -#### Defined in - -[generated-client/models/media-protocol.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-protocol.ts#L29) - -___ - -### Rtsp - -• **Rtsp** - -#### Defined in - -[generated-client/models/media-protocol.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-protocol.ts#L27) - -___ - -### Udp - -• **Udp** - -#### Defined in - -[generated-client/models/media-protocol.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-protocol.ts#L28) diff --git a/docs/enums/generated_client.MediaSourceType.md b/docs/enums/generated_client.MediaSourceType.md deleted file mode 100644 index 0a0de30dc..000000000 --- a/docs/enums/generated_client.MediaSourceType.md +++ /dev/null @@ -1,45 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaSourceType - -# Enumeration: MediaSourceType - -[generated-client](../modules/generated_client.md).MediaSourceType - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Default](generated_client.MediaSourceType.md#default) -- [Grouping](generated_client.MediaSourceType.md#grouping) -- [Placeholder](generated_client.MediaSourceType.md#placeholder) - -## Enumeration Members - -### Default - -• **Default** - -#### Defined in - -[generated-client/models/media-source-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-type.ts#L24) - -___ - -### Grouping - -• **Grouping** - -#### Defined in - -[generated-client/models/media-source-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-type.ts#L25) - -___ - -### Placeholder - -• **Placeholder** - -#### Defined in - -[generated-client/models/media-source-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-type.ts#L26) diff --git a/docs/enums/generated_client.MediaStreamType.md b/docs/enums/generated_client.MediaStreamType.md deleted file mode 100644 index b7708ee5b..000000000 --- a/docs/enums/generated_client.MediaStreamType.md +++ /dev/null @@ -1,58 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaStreamType - -# Enumeration: MediaStreamType - -[generated-client](../modules/generated_client.md).MediaStreamType - -Enum MediaStreamType. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Audio](generated_client.MediaStreamType.md#audio) -- [EmbeddedImage](generated_client.MediaStreamType.md#embeddedimage) -- [Subtitle](generated_client.MediaStreamType.md#subtitle) -- [Video](generated_client.MediaStreamType.md#video) - -## Enumeration Members - -### Audio - -• **Audio** - -#### Defined in - -[generated-client/models/media-stream-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream-type.ts#L24) - -___ - -### EmbeddedImage - -• **EmbeddedImage** - -#### Defined in - -[generated-client/models/media-stream-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream-type.ts#L27) - -___ - -### Subtitle - -• **Subtitle** - -#### Defined in - -[generated-client/models/media-stream-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream-type.ts#L26) - -___ - -### Video - -• **Video** - -#### Defined in - -[generated-client/models/media-stream-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream-type.ts#L25) diff --git a/docs/enums/generated_client.MetadataField.md b/docs/enums/generated_client.MetadataField.md deleted file mode 100644 index 06521f376..000000000 --- a/docs/enums/generated_client.MetadataField.md +++ /dev/null @@ -1,113 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MetadataField - -# Enumeration: MetadataField - -[generated-client](../modules/generated_client.md).MetadataField - -Enum MetadataFields. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Cast](generated_client.MetadataField.md#cast) -- [Genres](generated_client.MetadataField.md#genres) -- [Name](generated_client.MetadataField.md#name) -- [OfficialRating](generated_client.MetadataField.md#officialrating) -- [Overview](generated_client.MetadataField.md#overview) -- [ProductionLocations](generated_client.MetadataField.md#productionlocations) -- [Runtime](generated_client.MetadataField.md#runtime) -- [Studios](generated_client.MetadataField.md#studios) -- [Tags](generated_client.MetadataField.md#tags) - -## Enumeration Members - -### Cast - -• **Cast** - -#### Defined in - -[generated-client/models/metadata-field.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-field.ts#L24) - -___ - -### Genres - -• **Genres** - -#### Defined in - -[generated-client/models/metadata-field.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-field.ts#L25) - -___ - -### Name - -• **Name** - -#### Defined in - -[generated-client/models/metadata-field.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-field.ts#L29) - -___ - -### OfficialRating - -• **OfficialRating** - -#### Defined in - -[generated-client/models/metadata-field.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-field.ts#L32) - -___ - -### Overview - -• **Overview** - -#### Defined in - -[generated-client/models/metadata-field.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-field.ts#L30) - -___ - -### ProductionLocations - -• **ProductionLocations** - -#### Defined in - -[generated-client/models/metadata-field.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-field.ts#L26) - -___ - -### Runtime - -• **Runtime** - -#### Defined in - -[generated-client/models/metadata-field.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-field.ts#L31) - -___ - -### Studios - -• **Studios** - -#### Defined in - -[generated-client/models/metadata-field.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-field.ts#L27) - -___ - -### Tags - -• **Tags** - -#### Defined in - -[generated-client/models/metadata-field.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-field.ts#L28) diff --git a/docs/enums/generated_client.MetadataRefreshMode.md b/docs/enums/generated_client.MetadataRefreshMode.md deleted file mode 100644 index e1fe856b1..000000000 --- a/docs/enums/generated_client.MetadataRefreshMode.md +++ /dev/null @@ -1,56 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MetadataRefreshMode - -# Enumeration: MetadataRefreshMode - -[generated-client](../modules/generated_client.md).MetadataRefreshMode - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Default](generated_client.MetadataRefreshMode.md#default) -- [FullRefresh](generated_client.MetadataRefreshMode.md#fullrefresh) -- [None](generated_client.MetadataRefreshMode.md#none) -- [ValidationOnly](generated_client.MetadataRefreshMode.md#validationonly) - -## Enumeration Members - -### Default - -• **Default** - -#### Defined in - -[generated-client/models/metadata-refresh-mode.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-refresh-mode.ts#L26) - -___ - -### FullRefresh - -• **FullRefresh** - -#### Defined in - -[generated-client/models/metadata-refresh-mode.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-refresh-mode.ts#L27) - -___ - -### None - -• **None** - -#### Defined in - -[generated-client/models/metadata-refresh-mode.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-refresh-mode.ts#L24) - -___ - -### ValidationOnly - -• **ValidationOnly** - -#### Defined in - -[generated-client/models/metadata-refresh-mode.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-refresh-mode.ts#L25) diff --git a/docs/enums/generated_client.NotificationLevel.md b/docs/enums/generated_client.NotificationLevel.md deleted file mode 100644 index b22dd3c6d..000000000 --- a/docs/enums/generated_client.NotificationLevel.md +++ /dev/null @@ -1,45 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationLevel - -# Enumeration: NotificationLevel - -[generated-client](../modules/generated_client.md).NotificationLevel - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Error](generated_client.NotificationLevel.md#error) -- [Normal](generated_client.NotificationLevel.md#normal) -- [Warning](generated_client.NotificationLevel.md#warning) - -## Enumeration Members - -### Error - -• **Error** - -#### Defined in - -[generated-client/models/notification-level.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-level.ts#L26) - -___ - -### Normal - -• **Normal** - -#### Defined in - -[generated-client/models/notification-level.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-level.ts#L24) - -___ - -### Warning - -• **Warning** - -#### Defined in - -[generated-client/models/notification-level.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-level.ts#L25) diff --git a/docs/enums/generated_client.PlayAccess.md b/docs/enums/generated_client.PlayAccess.md deleted file mode 100644 index 014c523d2..000000000 --- a/docs/enums/generated_client.PlayAccess.md +++ /dev/null @@ -1,34 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlayAccess - -# Enumeration: PlayAccess - -[generated-client](../modules/generated_client.md).PlayAccess - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Full](generated_client.PlayAccess.md#full) -- [None](generated_client.PlayAccess.md#none) - -## Enumeration Members - -### Full - -• **Full** - -#### Defined in - -[generated-client/models/play-access.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-access.ts#L24) - -___ - -### None - -• **None** - -#### Defined in - -[generated-client/models/play-access.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-access.ts#L25) diff --git a/docs/enums/generated_client.PlayCommand.md b/docs/enums/generated_client.PlayCommand.md deleted file mode 100644 index f08b985b1..000000000 --- a/docs/enums/generated_client.PlayCommand.md +++ /dev/null @@ -1,69 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlayCommand - -# Enumeration: PlayCommand - -[generated-client](../modules/generated_client.md).PlayCommand - -Enum PlayCommand. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [PlayInstantMix](generated_client.PlayCommand.md#playinstantmix) -- [PlayLast](generated_client.PlayCommand.md#playlast) -- [PlayNext](generated_client.PlayCommand.md#playnext) -- [PlayNow](generated_client.PlayCommand.md#playnow) -- [PlayShuffle](generated_client.PlayCommand.md#playshuffle) - -## Enumeration Members - -### PlayInstantMix - -• **PlayInstantMix** - -#### Defined in - -[generated-client/models/play-command.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-command.ts#L27) - -___ - -### PlayLast - -• **PlayLast** - -#### Defined in - -[generated-client/models/play-command.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-command.ts#L26) - -___ - -### PlayNext - -• **PlayNext** - -#### Defined in - -[generated-client/models/play-command.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-command.ts#L25) - -___ - -### PlayNow - -• **PlayNow** - -#### Defined in - -[generated-client/models/play-command.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-command.ts#L24) - -___ - -### PlayShuffle - -• **PlayShuffle** - -#### Defined in - -[generated-client/models/play-command.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-command.ts#L28) diff --git a/docs/enums/generated_client.PlayMethod.md b/docs/enums/generated_client.PlayMethod.md deleted file mode 100644 index a321e76bc..000000000 --- a/docs/enums/generated_client.PlayMethod.md +++ /dev/null @@ -1,45 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlayMethod - -# Enumeration: PlayMethod - -[generated-client](../modules/generated_client.md).PlayMethod - -**`export`** - -## Table of contents - -### Enumeration Members - -- [DirectPlay](generated_client.PlayMethod.md#directplay) -- [DirectStream](generated_client.PlayMethod.md#directstream) -- [Transcode](generated_client.PlayMethod.md#transcode) - -## Enumeration Members - -### DirectPlay - -• **DirectPlay** - -#### Defined in - -[generated-client/models/play-method.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-method.ts#L26) - -___ - -### DirectStream - -• **DirectStream** - -#### Defined in - -[generated-client/models/play-method.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-method.ts#L25) - -___ - -### Transcode - -• **Transcode** - -#### Defined in - -[generated-client/models/play-method.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-method.ts#L24) diff --git a/docs/enums/generated_client.PlaybackErrorCode.md b/docs/enums/generated_client.PlaybackErrorCode.md deleted file mode 100644 index d670610f7..000000000 --- a/docs/enums/generated_client.PlaybackErrorCode.md +++ /dev/null @@ -1,45 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaybackErrorCode - -# Enumeration: PlaybackErrorCode - -[generated-client](../modules/generated_client.md).PlaybackErrorCode - -**`export`** - -## Table of contents - -### Enumeration Members - -- [NoCompatibleStream](generated_client.PlaybackErrorCode.md#nocompatiblestream) -- [NotAllowed](generated_client.PlaybackErrorCode.md#notallowed) -- [RateLimitExceeded](generated_client.PlaybackErrorCode.md#ratelimitexceeded) - -## Enumeration Members - -### NoCompatibleStream - -• **NoCompatibleStream** - -#### Defined in - -[generated-client/models/playback-error-code.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-error-code.ts#L25) - -___ - -### NotAllowed - -• **NotAllowed** - -#### Defined in - -[generated-client/models/playback-error-code.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-error-code.ts#L24) - -___ - -### RateLimitExceeded - -• **RateLimitExceeded** - -#### Defined in - -[generated-client/models/playback-error-code.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-error-code.ts#L26) diff --git a/docs/enums/generated_client.PlaystateCommand.md b/docs/enums/generated_client.PlaystateCommand.md deleted file mode 100644 index 4f6be7f5a..000000000 --- a/docs/enums/generated_client.PlaystateCommand.md +++ /dev/null @@ -1,113 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateCommand - -# Enumeration: PlaystateCommand - -[generated-client](../modules/generated_client.md).PlaystateCommand - -Enum PlaystateCommand. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [FastForward](generated_client.PlaystateCommand.md#fastforward) -- [NextTrack](generated_client.PlaystateCommand.md#nexttrack) -- [Pause](generated_client.PlaystateCommand.md#pause) -- [PlayPause](generated_client.PlaystateCommand.md#playpause) -- [PreviousTrack](generated_client.PlaystateCommand.md#previoustrack) -- [Rewind](generated_client.PlaystateCommand.md#rewind) -- [Seek](generated_client.PlaystateCommand.md#seek) -- [Stop](generated_client.PlaystateCommand.md#stop) -- [Unpause](generated_client.PlaystateCommand.md#unpause) - -## Enumeration Members - -### FastForward - -• **FastForward** - -#### Defined in - -[generated-client/models/playstate-command.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playstate-command.ts#L31) - -___ - -### NextTrack - -• **NextTrack** - -#### Defined in - -[generated-client/models/playstate-command.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playstate-command.ts#L27) - -___ - -### Pause - -• **Pause** - -#### Defined in - -[generated-client/models/playstate-command.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playstate-command.ts#L25) - -___ - -### PlayPause - -• **PlayPause** - -#### Defined in - -[generated-client/models/playstate-command.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playstate-command.ts#L32) - -___ - -### PreviousTrack - -• **PreviousTrack** - -#### Defined in - -[generated-client/models/playstate-command.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playstate-command.ts#L28) - -___ - -### Rewind - -• **Rewind** - -#### Defined in - -[generated-client/models/playstate-command.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playstate-command.ts#L30) - -___ - -### Seek - -• **Seek** - -#### Defined in - -[generated-client/models/playstate-command.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playstate-command.ts#L29) - -___ - -### Stop - -• **Stop** - -#### Defined in - -[generated-client/models/playstate-command.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playstate-command.ts#L24) - -___ - -### Unpause - -• **Unpause** - -#### Defined in - -[generated-client/models/playstate-command.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playstate-command.ts#L26) diff --git a/docs/enums/generated_client.PluginStatus.md b/docs/enums/generated_client.PluginStatus.md deleted file mode 100644 index 3e24f28f5..000000000 --- a/docs/enums/generated_client.PluginStatus.md +++ /dev/null @@ -1,91 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PluginStatus - -# Enumeration: PluginStatus - -[generated-client](../modules/generated_client.md).PluginStatus - -Plugin load status. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Active](generated_client.PluginStatus.md#active) -- [Deleted](generated_client.PluginStatus.md#deleted) -- [Disabled](generated_client.PluginStatus.md#disabled) -- [Malfunctioned](generated_client.PluginStatus.md#malfunctioned) -- [NotSupported](generated_client.PluginStatus.md#notsupported) -- [Restart](generated_client.PluginStatus.md#restart) -- [Superceded](generated_client.PluginStatus.md#superceded) - -## Enumeration Members - -### Active - -• **Active** - -#### Defined in - -[generated-client/models/plugin-status.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-status.ts#L24) - -___ - -### Deleted - -• **Deleted** - -#### Defined in - -[generated-client/models/plugin-status.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-status.ts#L26) - -___ - -### Disabled - -• **Disabled** - -#### Defined in - -[generated-client/models/plugin-status.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-status.ts#L30) - -___ - -### Malfunctioned - -• **Malfunctioned** - -#### Defined in - -[generated-client/models/plugin-status.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-status.ts#L28) - -___ - -### NotSupported - -• **NotSupported** - -#### Defined in - -[generated-client/models/plugin-status.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-status.ts#L29) - -___ - -### Restart - -• **Restart** - -#### Defined in - -[generated-client/models/plugin-status.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-status.ts#L25) - -___ - -### Superceded - -• **Superceded** - -#### Defined in - -[generated-client/models/plugin-status.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-status.ts#L27) diff --git a/docs/enums/generated_client.ProfileConditionType.md b/docs/enums/generated_client.ProfileConditionType.md deleted file mode 100644 index 397827aaf..000000000 --- a/docs/enums/generated_client.ProfileConditionType.md +++ /dev/null @@ -1,67 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ProfileConditionType - -# Enumeration: ProfileConditionType - -[generated-client](../modules/generated_client.md).ProfileConditionType - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Equals](generated_client.ProfileConditionType.md#equals) -- [EqualsAny](generated_client.ProfileConditionType.md#equalsany) -- [GreaterThanEqual](generated_client.ProfileConditionType.md#greaterthanequal) -- [LessThanEqual](generated_client.ProfileConditionType.md#lessthanequal) -- [NotEquals](generated_client.ProfileConditionType.md#notequals) - -## Enumeration Members - -### Equals - -• **Equals** - -#### Defined in - -[generated-client/models/profile-condition-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-type.ts#L24) - -___ - -### EqualsAny - -• **EqualsAny** - -#### Defined in - -[generated-client/models/profile-condition-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-type.ts#L28) - -___ - -### GreaterThanEqual - -• **GreaterThanEqual** - -#### Defined in - -[generated-client/models/profile-condition-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-type.ts#L27) - -___ - -### LessThanEqual - -• **LessThanEqual** - -#### Defined in - -[generated-client/models/profile-condition-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-type.ts#L26) - -___ - -### NotEquals - -• **NotEquals** - -#### Defined in - -[generated-client/models/profile-condition-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-type.ts#L25) diff --git a/docs/enums/generated_client.ProfileConditionValue.md b/docs/enums/generated_client.ProfileConditionValue.md deleted file mode 100644 index 6e0ae4189..000000000 --- a/docs/enums/generated_client.ProfileConditionValue.md +++ /dev/null @@ -1,276 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ProfileConditionValue - -# Enumeration: ProfileConditionValue - -[generated-client](../modules/generated_client.md).ProfileConditionValue - -**`export`** - -## Table of contents - -### Enumeration Members - -- [AudioBitDepth](generated_client.ProfileConditionValue.md#audiobitdepth) -- [AudioBitrate](generated_client.ProfileConditionValue.md#audiobitrate) -- [AudioChannels](generated_client.ProfileConditionValue.md#audiochannels) -- [AudioProfile](generated_client.ProfileConditionValue.md#audioprofile) -- [AudioSampleRate](generated_client.ProfileConditionValue.md#audiosamplerate) -- [Has64BitOffsets](generated_client.ProfileConditionValue.md#has64bitoffsets) -- [Height](generated_client.ProfileConditionValue.md#height) -- [IsAnamorphic](generated_client.ProfileConditionValue.md#isanamorphic) -- [IsAvc](generated_client.ProfileConditionValue.md#isavc) -- [IsInterlaced](generated_client.ProfileConditionValue.md#isinterlaced) -- [IsSecondaryAudio](generated_client.ProfileConditionValue.md#issecondaryaudio) -- [NumAudioStreams](generated_client.ProfileConditionValue.md#numaudiostreams) -- [NumVideoStreams](generated_client.ProfileConditionValue.md#numvideostreams) -- [PacketLength](generated_client.ProfileConditionValue.md#packetlength) -- [RefFrames](generated_client.ProfileConditionValue.md#refframes) -- [VideoBitDepth](generated_client.ProfileConditionValue.md#videobitdepth) -- [VideoBitrate](generated_client.ProfileConditionValue.md#videobitrate) -- [VideoCodecTag](generated_client.ProfileConditionValue.md#videocodectag) -- [VideoFramerate](generated_client.ProfileConditionValue.md#videoframerate) -- [VideoLevel](generated_client.ProfileConditionValue.md#videolevel) -- [VideoProfile](generated_client.ProfileConditionValue.md#videoprofile) -- [VideoRangeType](generated_client.ProfileConditionValue.md#videorangetype) -- [VideoTimestamp](generated_client.ProfileConditionValue.md#videotimestamp) -- [Width](generated_client.ProfileConditionValue.md#width) - -## Enumeration Members - -### AudioBitDepth - -• **AudioBitDepth** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L46) - -___ - -### AudioBitrate - -• **AudioBitrate** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L25) - -___ - -### AudioChannels - -• **AudioChannels** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L24) - -___ - -### AudioProfile - -• **AudioProfile** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L26) - -___ - -### AudioSampleRate - -• **AudioSampleRate** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L45) - -___ - -### Has64BitOffsets - -• **Has64BitOffsets** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L29) - -___ - -### Height - -• **Height** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L28) - -___ - -### IsAnamorphic - -• **IsAnamorphic** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L37) - -___ - -### IsAvc - -• **IsAvc** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L43) - -___ - -### IsInterlaced - -• **IsInterlaced** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:44](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L44) - -___ - -### IsSecondaryAudio - -• **IsSecondaryAudio** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L41) - -___ - -### NumAudioStreams - -• **NumAudioStreams** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L39) - -___ - -### NumVideoStreams - -• **NumVideoStreams** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L40) - -___ - -### PacketLength - -• **PacketLength** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L30) - -___ - -### RefFrames - -• **RefFrames** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:38](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L38) - -___ - -### VideoBitDepth - -• **VideoBitDepth** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L31) - -___ - -### VideoBitrate - -• **VideoBitrate** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L32) - -___ - -### VideoCodecTag - -• **VideoCodecTag** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L42) - -___ - -### VideoFramerate - -• **VideoFramerate** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L33) - -___ - -### VideoLevel - -• **VideoLevel** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L34) - -___ - -### VideoProfile - -• **VideoProfile** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L35) - -___ - -### VideoRangeType - -• **VideoRangeType** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L47) - -___ - -### VideoTimestamp - -• **VideoTimestamp** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L36) - -___ - -### Width - -• **Width** - -#### Defined in - -[generated-client/models/profile-condition-value.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition-value.ts#L27) diff --git a/docs/enums/generated_client.ProgramAudio.md b/docs/enums/generated_client.ProgramAudio.md deleted file mode 100644 index 8ef33c7d5..000000000 --- a/docs/enums/generated_client.ProgramAudio.md +++ /dev/null @@ -1,78 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ProgramAudio - -# Enumeration: ProgramAudio - -[generated-client](../modules/generated_client.md).ProgramAudio - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Atmos](generated_client.ProgramAudio.md#atmos) -- [Dolby](generated_client.ProgramAudio.md#dolby) -- [DolbyDigital](generated_client.ProgramAudio.md#dolbydigital) -- [Mono](generated_client.ProgramAudio.md#mono) -- [Stereo](generated_client.ProgramAudio.md#stereo) -- [Thx](generated_client.ProgramAudio.md#thx) - -## Enumeration Members - -### Atmos - -• **Atmos** - -#### Defined in - -[generated-client/models/program-audio.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/program-audio.ts#L29) - -___ - -### Dolby - -• **Dolby** - -#### Defined in - -[generated-client/models/program-audio.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/program-audio.ts#L26) - -___ - -### DolbyDigital - -• **DolbyDigital** - -#### Defined in - -[generated-client/models/program-audio.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/program-audio.ts#L27) - -___ - -### Mono - -• **Mono** - -#### Defined in - -[generated-client/models/program-audio.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/program-audio.ts#L24) - -___ - -### Stereo - -• **Stereo** - -#### Defined in - -[generated-client/models/program-audio.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/program-audio.ts#L25) - -___ - -### Thx - -• **Thx** - -#### Defined in - -[generated-client/models/program-audio.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/program-audio.ts#L28) diff --git a/docs/enums/generated_client.RatingType.md b/docs/enums/generated_client.RatingType.md deleted file mode 100644 index 9653a3a11..000000000 --- a/docs/enums/generated_client.RatingType.md +++ /dev/null @@ -1,34 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RatingType - -# Enumeration: RatingType - -[generated-client](../modules/generated_client.md).RatingType - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Likes](generated_client.RatingType.md#likes) -- [Score](generated_client.RatingType.md#score) - -## Enumeration Members - -### Likes - -• **Likes** - -#### Defined in - -[generated-client/models/rating-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/rating-type.ts#L25) - -___ - -### Score - -• **Score** - -#### Defined in - -[generated-client/models/rating-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/rating-type.ts#L24) diff --git a/docs/enums/generated_client.RecommendationType.md b/docs/enums/generated_client.RecommendationType.md deleted file mode 100644 index f9d5b6c2f..000000000 --- a/docs/enums/generated_client.RecommendationType.md +++ /dev/null @@ -1,78 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RecommendationType - -# Enumeration: RecommendationType - -[generated-client](../modules/generated_client.md).RecommendationType - -**`export`** - -## Table of contents - -### Enumeration Members - -- [HasActorFromRecentlyPlayed](generated_client.RecommendationType.md#hasactorfromrecentlyplayed) -- [HasDirectorFromRecentlyPlayed](generated_client.RecommendationType.md#hasdirectorfromrecentlyplayed) -- [HasLikedActor](generated_client.RecommendationType.md#haslikedactor) -- [HasLikedDirector](generated_client.RecommendationType.md#haslikeddirector) -- [SimilarToLikedItem](generated_client.RecommendationType.md#similartolikeditem) -- [SimilarToRecentlyPlayed](generated_client.RecommendationType.md#similartorecentlyplayed) - -## Enumeration Members - -### HasActorFromRecentlyPlayed - -• **HasActorFromRecentlyPlayed** - -#### Defined in - -[generated-client/models/recommendation-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recommendation-type.ts#L27) - -___ - -### HasDirectorFromRecentlyPlayed - -• **HasDirectorFromRecentlyPlayed** - -#### Defined in - -[generated-client/models/recommendation-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recommendation-type.ts#L26) - -___ - -### HasLikedActor - -• **HasLikedActor** - -#### Defined in - -[generated-client/models/recommendation-type.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recommendation-type.ts#L29) - -___ - -### HasLikedDirector - -• **HasLikedDirector** - -#### Defined in - -[generated-client/models/recommendation-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recommendation-type.ts#L28) - -___ - -### SimilarToLikedItem - -• **SimilarToLikedItem** - -#### Defined in - -[generated-client/models/recommendation-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recommendation-type.ts#L25) - -___ - -### SimilarToRecentlyPlayed - -• **SimilarToRecentlyPlayed** - -#### Defined in - -[generated-client/models/recommendation-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recommendation-type.ts#L24) diff --git a/docs/enums/generated_client.RecordingStatus.md b/docs/enums/generated_client.RecordingStatus.md deleted file mode 100644 index 5becdce0b..000000000 --- a/docs/enums/generated_client.RecordingStatus.md +++ /dev/null @@ -1,89 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RecordingStatus - -# Enumeration: RecordingStatus - -[generated-client](../modules/generated_client.md).RecordingStatus - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Cancelled](generated_client.RecordingStatus.md#cancelled) -- [Completed](generated_client.RecordingStatus.md#completed) -- [ConflictedNotOk](generated_client.RecordingStatus.md#conflictednotok) -- [ConflictedOk](generated_client.RecordingStatus.md#conflictedok) -- [Error](generated_client.RecordingStatus.md#error) -- [InProgress](generated_client.RecordingStatus.md#inprogress) -- [New](generated_client.RecordingStatus.md#new) - -## Enumeration Members - -### Cancelled - -• **Cancelled** - -#### Defined in - -[generated-client/models/recording-status.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recording-status.ts#L27) - -___ - -### Completed - -• **Completed** - -#### Defined in - -[generated-client/models/recording-status.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recording-status.ts#L26) - -___ - -### ConflictedNotOk - -• **ConflictedNotOk** - -#### Defined in - -[generated-client/models/recording-status.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recording-status.ts#L29) - -___ - -### ConflictedOk - -• **ConflictedOk** - -#### Defined in - -[generated-client/models/recording-status.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recording-status.ts#L28) - -___ - -### Error - -• **Error** - -#### Defined in - -[generated-client/models/recording-status.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recording-status.ts#L30) - -___ - -### InProgress - -• **InProgress** - -#### Defined in - -[generated-client/models/recording-status.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recording-status.ts#L25) - -___ - -### New - -• **New** - -#### Defined in - -[generated-client/models/recording-status.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recording-status.ts#L24) diff --git a/docs/enums/generated_client.RepeatMode.md b/docs/enums/generated_client.RepeatMode.md deleted file mode 100644 index 694ba17f6..000000000 --- a/docs/enums/generated_client.RepeatMode.md +++ /dev/null @@ -1,45 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RepeatMode - -# Enumeration: RepeatMode - -[generated-client](../modules/generated_client.md).RepeatMode - -**`export`** - -## Table of contents - -### Enumeration Members - -- [RepeatAll](generated_client.RepeatMode.md#repeatall) -- [RepeatNone](generated_client.RepeatMode.md#repeatnone) -- [RepeatOne](generated_client.RepeatMode.md#repeatone) - -## Enumeration Members - -### RepeatAll - -• **RepeatAll** - -#### Defined in - -[generated-client/models/repeat-mode.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/repeat-mode.ts#L25) - -___ - -### RepeatNone - -• **RepeatNone** - -#### Defined in - -[generated-client/models/repeat-mode.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/repeat-mode.ts#L24) - -___ - -### RepeatOne - -• **RepeatOne** - -#### Defined in - -[generated-client/models/repeat-mode.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/repeat-mode.ts#L26) diff --git a/docs/enums/generated_client.ScrollDirection.md b/docs/enums/generated_client.ScrollDirection.md deleted file mode 100644 index 5d5994b69..000000000 --- a/docs/enums/generated_client.ScrollDirection.md +++ /dev/null @@ -1,36 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ScrollDirection - -# Enumeration: ScrollDirection - -[generated-client](../modules/generated_client.md).ScrollDirection - -An enum representing the axis that should be scrolled. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Horizontal](generated_client.ScrollDirection.md#horizontal) -- [Vertical](generated_client.ScrollDirection.md#vertical) - -## Enumeration Members - -### Horizontal - -• **Horizontal** - -#### Defined in - -[generated-client/models/scroll-direction.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/scroll-direction.ts#L24) - -___ - -### Vertical - -• **Vertical** - -#### Defined in - -[generated-client/models/scroll-direction.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/scroll-direction.ts#L25) diff --git a/docs/enums/generated_client.SendCommandType.md b/docs/enums/generated_client.SendCommandType.md deleted file mode 100644 index 364c2f5d1..000000000 --- a/docs/enums/generated_client.SendCommandType.md +++ /dev/null @@ -1,58 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SendCommandType - -# Enumeration: SendCommandType - -[generated-client](../modules/generated_client.md).SendCommandType - -Enum SendCommandType. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Pause](generated_client.SendCommandType.md#pause) -- [Seek](generated_client.SendCommandType.md#seek) -- [Stop](generated_client.SendCommandType.md#stop) -- [Unpause](generated_client.SendCommandType.md#unpause) - -## Enumeration Members - -### Pause - -• **Pause** - -#### Defined in - -[generated-client/models/send-command-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-command-type.ts#L25) - -___ - -### Seek - -• **Seek** - -#### Defined in - -[generated-client/models/send-command-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-command-type.ts#L27) - -___ - -### Stop - -• **Stop** - -#### Defined in - -[generated-client/models/send-command-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-command-type.ts#L26) - -___ - -### Unpause - -• **Unpause** - -#### Defined in - -[generated-client/models/send-command-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-command-type.ts#L24) diff --git a/docs/enums/generated_client.SendToUserType.md b/docs/enums/generated_client.SendToUserType.md deleted file mode 100644 index 31f0b4b71..000000000 --- a/docs/enums/generated_client.SendToUserType.md +++ /dev/null @@ -1,45 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SendToUserType - -# Enumeration: SendToUserType - -[generated-client](../modules/generated_client.md).SendToUserType - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Admins](generated_client.SendToUserType.md#admins) -- [All](generated_client.SendToUserType.md#all) -- [Custom](generated_client.SendToUserType.md#custom) - -## Enumeration Members - -### Admins - -• **Admins** - -#### Defined in - -[generated-client/models/send-to-user-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-to-user-type.ts#L25) - -___ - -### All - -• **All** - -#### Defined in - -[generated-client/models/send-to-user-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-to-user-type.ts#L24) - -___ - -### Custom - -• **Custom** - -#### Defined in - -[generated-client/models/send-to-user-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-to-user-type.ts#L26) diff --git a/docs/enums/generated_client.SeriesStatus.md b/docs/enums/generated_client.SeriesStatus.md deleted file mode 100644 index b04c279bc..000000000 --- a/docs/enums/generated_client.SeriesStatus.md +++ /dev/null @@ -1,36 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SeriesStatus - -# Enumeration: SeriesStatus - -[generated-client](../modules/generated_client.md).SeriesStatus - -Enum SeriesStatus. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Continuing](generated_client.SeriesStatus.md#continuing) -- [Ended](generated_client.SeriesStatus.md#ended) - -## Enumeration Members - -### Continuing - -• **Continuing** - -#### Defined in - -[generated-client/models/series-status.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-status.ts#L24) - -___ - -### Ended - -• **Ended** - -#### Defined in - -[generated-client/models/series-status.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-status.ts#L25) diff --git a/docs/enums/generated_client.SessionMessageType.md b/docs/enums/generated_client.SessionMessageType.md deleted file mode 100644 index 6a0584c88..000000000 --- a/docs/enums/generated_client.SessionMessageType.md +++ /dev/null @@ -1,388 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionMessageType - -# Enumeration: SessionMessageType - -[generated-client](../modules/generated_client.md).SessionMessageType - -The different kinds of messages that are used in the WebSocket api. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [ActivityLogEntry](generated_client.SessionMessageType.md#activitylogentry) -- [ActivityLogEntryStart](generated_client.SessionMessageType.md#activitylogentrystart) -- [ActivityLogEntryStop](generated_client.SessionMessageType.md#activitylogentrystop) -- [ForceKeepAlive](generated_client.SessionMessageType.md#forcekeepalive) -- [GeneralCommand](generated_client.SessionMessageType.md#generalcommand) -- [KeepAlive](generated_client.SessionMessageType.md#keepalive) -- [LibraryChanged](generated_client.SessionMessageType.md#librarychanged) -- [PackageInstallationCancelled](generated_client.SessionMessageType.md#packageinstallationcancelled) -- [PackageInstallationCompleted](generated_client.SessionMessageType.md#packageinstallationcompleted) -- [PackageInstallationFailed](generated_client.SessionMessageType.md#packageinstallationfailed) -- [PackageInstalling](generated_client.SessionMessageType.md#packageinstalling) -- [PackageUninstalled](generated_client.SessionMessageType.md#packageuninstalled) -- [Play](generated_client.SessionMessageType.md#play) -- [Playstate](generated_client.SessionMessageType.md#playstate) -- [RefreshProgress](generated_client.SessionMessageType.md#refreshprogress) -- [RestartRequired](generated_client.SessionMessageType.md#restartrequired) -- [ScheduledTaskEnded](generated_client.SessionMessageType.md#scheduledtaskended) -- [ScheduledTasksInfo](generated_client.SessionMessageType.md#scheduledtasksinfo) -- [ScheduledTasksInfoStart](generated_client.SessionMessageType.md#scheduledtasksinfostart) -- [ScheduledTasksInfoStop](generated_client.SessionMessageType.md#scheduledtasksinfostop) -- [SeriesTimerCancelled](generated_client.SessionMessageType.md#seriestimercancelled) -- [SeriesTimerCreated](generated_client.SessionMessageType.md#seriestimercreated) -- [ServerRestarting](generated_client.SessionMessageType.md#serverrestarting) -- [ServerShuttingDown](generated_client.SessionMessageType.md#servershuttingdown) -- [Sessions](generated_client.SessionMessageType.md#sessions) -- [SessionsStart](generated_client.SessionMessageType.md#sessionsstart) -- [SessionsStop](generated_client.SessionMessageType.md#sessionsstop) -- [SyncPlayCommand](generated_client.SessionMessageType.md#syncplaycommand) -- [SyncPlayGroupUpdate](generated_client.SessionMessageType.md#syncplaygroupupdate) -- [TimerCancelled](generated_client.SessionMessageType.md#timercancelled) -- [TimerCreated](generated_client.SessionMessageType.md#timercreated) -- [UserDataChanged](generated_client.SessionMessageType.md#userdatachanged) -- [UserDeleted](generated_client.SessionMessageType.md#userdeleted) -- [UserUpdated](generated_client.SessionMessageType.md#userupdated) - -## Enumeration Members - -### ActivityLogEntry - -• **ActivityLogEntry** - -#### Defined in - -[generated-client/models/session-message-type.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L49) - -___ - -### ActivityLogEntryStart - -• **ActivityLogEntryStart** - -#### Defined in - -[generated-client/models/session-message-type.ts:51](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L51) - -___ - -### ActivityLogEntryStop - -• **ActivityLogEntryStop** - -#### Defined in - -[generated-client/models/session-message-type.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L52) - -___ - -### ForceKeepAlive - -• **ForceKeepAlive** - -#### Defined in - -[generated-client/models/session-message-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L24) - -___ - -### GeneralCommand - -• **GeneralCommand** - -#### Defined in - -[generated-client/models/session-message-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L25) - -___ - -### KeepAlive - -• **KeepAlive** - -#### Defined in - -[generated-client/models/session-message-type.ts:57](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L57) - -___ - -### LibraryChanged - -• **LibraryChanged** - -#### Defined in - -[generated-client/models/session-message-type.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L35) - -___ - -### PackageInstallationCancelled - -• **PackageInstallationCancelled** - -#### Defined in - -[generated-client/models/session-message-type.ts:44](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L44) - -___ - -### PackageInstallationCompleted - -• **PackageInstallationCompleted** - -#### Defined in - -[generated-client/models/session-message-type.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L46) - -___ - -### PackageInstallationFailed - -• **PackageInstallationFailed** - -#### Defined in - -[generated-client/models/session-message-type.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L45) - -___ - -### PackageInstalling - -• **PackageInstalling** - -#### Defined in - -[generated-client/models/session-message-type.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L47) - -___ - -### PackageUninstalled - -• **PackageUninstalled** - -#### Defined in - -[generated-client/models/session-message-type.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L48) - -___ - -### Play - -• **Play** - -#### Defined in - -[generated-client/models/session-message-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L28) - -___ - -### Playstate - -• **Playstate** - -#### Defined in - -[generated-client/models/session-message-type.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L31) - -___ - -### RefreshProgress - -• **RefreshProgress** - -#### Defined in - -[generated-client/models/session-message-type.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L42) - -___ - -### RestartRequired - -• **RestartRequired** - -#### Defined in - -[generated-client/models/session-message-type.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L32) - -___ - -### ScheduledTaskEnded - -• **ScheduledTaskEnded** - -#### Defined in - -[generated-client/models/session-message-type.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L43) - -___ - -### ScheduledTasksInfo - -• **ScheduledTasksInfo** - -#### Defined in - -[generated-client/models/session-message-type.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L50) - -___ - -### ScheduledTasksInfoStart - -• **ScheduledTasksInfoStart** - -#### Defined in - -[generated-client/models/session-message-type.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L55) - -___ - -### ScheduledTasksInfoStop - -• **ScheduledTasksInfoStop** - -#### Defined in - -[generated-client/models/session-message-type.ts:56](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L56) - -___ - -### SeriesTimerCancelled - -• **SeriesTimerCancelled** - -#### Defined in - -[generated-client/models/session-message-type.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L40) - -___ - -### SeriesTimerCreated - -• **SeriesTimerCreated** - -#### Defined in - -[generated-client/models/session-message-type.ts:38](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L38) - -___ - -### ServerRestarting - -• **ServerRestarting** - -#### Defined in - -[generated-client/models/session-message-type.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L34) - -___ - -### ServerShuttingDown - -• **ServerShuttingDown** - -#### Defined in - -[generated-client/models/session-message-type.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L33) - -___ - -### Sessions - -• **Sessions** - -#### Defined in - -[generated-client/models/session-message-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L27) - -___ - -### SessionsStart - -• **SessionsStart** - -#### Defined in - -[generated-client/models/session-message-type.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L53) - -___ - -### SessionsStop - -• **SessionsStop** - -#### Defined in - -[generated-client/models/session-message-type.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L54) - -___ - -### SyncPlayCommand - -• **SyncPlayCommand** - -#### Defined in - -[generated-client/models/session-message-type.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L29) - -___ - -### SyncPlayGroupUpdate - -• **SyncPlayGroupUpdate** - -#### Defined in - -[generated-client/models/session-message-type.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L30) - -___ - -### TimerCancelled - -• **TimerCancelled** - -#### Defined in - -[generated-client/models/session-message-type.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L41) - -___ - -### TimerCreated - -• **TimerCreated** - -#### Defined in - -[generated-client/models/session-message-type.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L39) - -___ - -### UserDataChanged - -• **UserDataChanged** - -#### Defined in - -[generated-client/models/session-message-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L26) - -___ - -### UserDeleted - -• **UserDeleted** - -#### Defined in - -[generated-client/models/session-message-type.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L36) - -___ - -### UserUpdated - -• **UserUpdated** - -#### Defined in - -[generated-client/models/session-message-type.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-message-type.ts#L37) diff --git a/docs/enums/generated_client.SortOrder.md b/docs/enums/generated_client.SortOrder.md deleted file mode 100644 index 34f98db57..000000000 --- a/docs/enums/generated_client.SortOrder.md +++ /dev/null @@ -1,36 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SortOrder - -# Enumeration: SortOrder - -[generated-client](../modules/generated_client.md).SortOrder - -An enum representing the sorting order. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Ascending](generated_client.SortOrder.md#ascending) -- [Descending](generated_client.SortOrder.md#descending) - -## Enumeration Members - -### Ascending - -• **Ascending** - -#### Defined in - -[generated-client/models/sort-order.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/sort-order.ts#L24) - -___ - -### Descending - -• **Descending** - -#### Defined in - -[generated-client/models/sort-order.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/sort-order.ts#L25) diff --git a/docs/enums/generated_client.SubtitleDeliveryMethod.md b/docs/enums/generated_client.SubtitleDeliveryMethod.md deleted file mode 100644 index d0670dc37..000000000 --- a/docs/enums/generated_client.SubtitleDeliveryMethod.md +++ /dev/null @@ -1,69 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleDeliveryMethod - -# Enumeration: SubtitleDeliveryMethod - -[generated-client](../modules/generated_client.md).SubtitleDeliveryMethod - -Delivery method to use during playback of a specific subtitle format. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Drop](generated_client.SubtitleDeliveryMethod.md#drop) -- [Embed](generated_client.SubtitleDeliveryMethod.md#embed) -- [Encode](generated_client.SubtitleDeliveryMethod.md#encode) -- [External](generated_client.SubtitleDeliveryMethod.md#external) -- [Hls](generated_client.SubtitleDeliveryMethod.md#hls) - -## Enumeration Members - -### Drop - -• **Drop** - -#### Defined in - -[generated-client/models/subtitle-delivery-method.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-delivery-method.ts#L28) - -___ - -### Embed - -• **Embed** - -#### Defined in - -[generated-client/models/subtitle-delivery-method.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-delivery-method.ts#L25) - -___ - -### Encode - -• **Encode** - -#### Defined in - -[generated-client/models/subtitle-delivery-method.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-delivery-method.ts#L24) - -___ - -### External - -• **External** - -#### Defined in - -[generated-client/models/subtitle-delivery-method.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-delivery-method.ts#L26) - -___ - -### Hls - -• **Hls** - -#### Defined in - -[generated-client/models/subtitle-delivery-method.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-delivery-method.ts#L27) diff --git a/docs/enums/generated_client.SubtitlePlaybackMode.md b/docs/enums/generated_client.SubtitlePlaybackMode.md deleted file mode 100644 index 2a80d391e..000000000 --- a/docs/enums/generated_client.SubtitlePlaybackMode.md +++ /dev/null @@ -1,69 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitlePlaybackMode - -# Enumeration: SubtitlePlaybackMode - -[generated-client](../modules/generated_client.md).SubtitlePlaybackMode - -An enum representing a subtitle playback mode. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Always](generated_client.SubtitlePlaybackMode.md#always) -- [Default](generated_client.SubtitlePlaybackMode.md#default) -- [None](generated_client.SubtitlePlaybackMode.md#none) -- [OnlyForced](generated_client.SubtitlePlaybackMode.md#onlyforced) -- [Smart](generated_client.SubtitlePlaybackMode.md#smart) - -## Enumeration Members - -### Always - -• **Always** - -#### Defined in - -[generated-client/models/subtitle-playback-mode.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-playback-mode.ts#L25) - -___ - -### Default - -• **Default** - -#### Defined in - -[generated-client/models/subtitle-playback-mode.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-playback-mode.ts#L24) - -___ - -### None - -• **None** - -#### Defined in - -[generated-client/models/subtitle-playback-mode.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-playback-mode.ts#L27) - -___ - -### OnlyForced - -• **OnlyForced** - -#### Defined in - -[generated-client/models/subtitle-playback-mode.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-playback-mode.ts#L26) - -___ - -### Smart - -• **Smart** - -#### Defined in - -[generated-client/models/subtitle-playback-mode.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-playback-mode.ts#L28) diff --git a/docs/enums/generated_client.SyncPlayUserAccessType.md b/docs/enums/generated_client.SyncPlayUserAccessType.md deleted file mode 100644 index 7e0832ea8..000000000 --- a/docs/enums/generated_client.SyncPlayUserAccessType.md +++ /dev/null @@ -1,47 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayUserAccessType - -# Enumeration: SyncPlayUserAccessType - -[generated-client](../modules/generated_client.md).SyncPlayUserAccessType - -Enum SyncPlayUserAccessType. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [CreateAndJoinGroups](generated_client.SyncPlayUserAccessType.md#createandjoingroups) -- [JoinGroups](generated_client.SyncPlayUserAccessType.md#joingroups) -- [None](generated_client.SyncPlayUserAccessType.md#none) - -## Enumeration Members - -### CreateAndJoinGroups - -• **CreateAndJoinGroups** - -#### Defined in - -[generated-client/models/sync-play-user-access-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/sync-play-user-access-type.ts#L24) - -___ - -### JoinGroups - -• **JoinGroups** - -#### Defined in - -[generated-client/models/sync-play-user-access-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/sync-play-user-access-type.ts#L25) - -___ - -### None - -• **None** - -#### Defined in - -[generated-client/models/sync-play-user-access-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/sync-play-user-access-type.ts#L26) diff --git a/docs/enums/generated_client.TaskCompletionStatus.md b/docs/enums/generated_client.TaskCompletionStatus.md deleted file mode 100644 index 9a28ce8ce..000000000 --- a/docs/enums/generated_client.TaskCompletionStatus.md +++ /dev/null @@ -1,58 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TaskCompletionStatus - -# Enumeration: TaskCompletionStatus - -[generated-client](../modules/generated_client.md).TaskCompletionStatus - -Enum TaskCompletionStatus. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Aborted](generated_client.TaskCompletionStatus.md#aborted) -- [Cancelled](generated_client.TaskCompletionStatus.md#cancelled) -- [Completed](generated_client.TaskCompletionStatus.md#completed) -- [Failed](generated_client.TaskCompletionStatus.md#failed) - -## Enumeration Members - -### Aborted - -• **Aborted** - -#### Defined in - -[generated-client/models/task-completion-status.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-completion-status.ts#L27) - -___ - -### Cancelled - -• **Cancelled** - -#### Defined in - -[generated-client/models/task-completion-status.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-completion-status.ts#L26) - -___ - -### Completed - -• **Completed** - -#### Defined in - -[generated-client/models/task-completion-status.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-completion-status.ts#L24) - -___ - -### Failed - -• **Failed** - -#### Defined in - -[generated-client/models/task-completion-status.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-completion-status.ts#L25) diff --git a/docs/enums/generated_client.TaskState.md b/docs/enums/generated_client.TaskState.md deleted file mode 100644 index db5525001..000000000 --- a/docs/enums/generated_client.TaskState.md +++ /dev/null @@ -1,47 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TaskState - -# Enumeration: TaskState - -[generated-client](../modules/generated_client.md).TaskState - -Enum TaskState. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Cancelling](generated_client.TaskState.md#cancelling) -- [Idle](generated_client.TaskState.md#idle) -- [Running](generated_client.TaskState.md#running) - -## Enumeration Members - -### Cancelling - -• **Cancelling** - -#### Defined in - -[generated-client/models/task-state.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-state.ts#L25) - -___ - -### Idle - -• **Idle** - -#### Defined in - -[generated-client/models/task-state.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-state.ts#L24) - -___ - -### Running - -• **Running** - -#### Defined in - -[generated-client/models/task-state.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-state.ts#L26) diff --git a/docs/enums/generated_client.TranscodeSeekInfo.md b/docs/enums/generated_client.TranscodeSeekInfo.md deleted file mode 100644 index f3b3b232e..000000000 --- a/docs/enums/generated_client.TranscodeSeekInfo.md +++ /dev/null @@ -1,34 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TranscodeSeekInfo - -# Enumeration: TranscodeSeekInfo - -[generated-client](../modules/generated_client.md).TranscodeSeekInfo - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Auto](generated_client.TranscodeSeekInfo.md#auto) -- [Bytes](generated_client.TranscodeSeekInfo.md#bytes) - -## Enumeration Members - -### Auto - -• **Auto** - -#### Defined in - -[generated-client/models/transcode-seek-info.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcode-seek-info.ts#L24) - -___ - -### Bytes - -• **Bytes** - -#### Defined in - -[generated-client/models/transcode-seek-info.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcode-seek-info.ts#L25) diff --git a/docs/enums/generated_client.TranscodingInfoTranscodeReasonsEnum.md b/docs/enums/generated_client.TranscodingInfoTranscodeReasonsEnum.md deleted file mode 100644 index f4d73d116..000000000 --- a/docs/enums/generated_client.TranscodingInfoTranscodeReasonsEnum.md +++ /dev/null @@ -1,287 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TranscodingInfoTranscodeReasonsEnum - -# Enumeration: TranscodingInfoTranscodeReasonsEnum - -[generated-client](../modules/generated_client.md).TranscodingInfoTranscodeReasonsEnum - -**`export`** - -## Table of contents - -### Enumeration Members - -- [AnamorphicVideoNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#anamorphicvideonotsupported) -- [AudioBitDepthNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#audiobitdepthnotsupported) -- [AudioBitrateNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#audiobitratenotsupported) -- [AudioChannelsNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#audiochannelsnotsupported) -- [AudioCodecNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#audiocodecnotsupported) -- [AudioIsExternal](generated_client.TranscodingInfoTranscodeReasonsEnum.md#audioisexternal) -- [AudioProfileNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#audioprofilenotsupported) -- [AudioSampleRateNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#audiosampleratenotsupported) -- [ContainerBitrateExceedsLimit](generated_client.TranscodingInfoTranscodeReasonsEnum.md#containerbitrateexceedslimit) -- [ContainerNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#containernotsupported) -- [DirectPlayError](generated_client.TranscodingInfoTranscodeReasonsEnum.md#directplayerror) -- [InterlacedVideoNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#interlacedvideonotsupported) -- [RefFramesNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#refframesnotsupported) -- [SecondaryAudioNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#secondaryaudionotsupported) -- [SubtitleCodecNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#subtitlecodecnotsupported) -- [UnknownAudioStreamInfo](generated_client.TranscodingInfoTranscodeReasonsEnum.md#unknownaudiostreaminfo) -- [UnknownVideoStreamInfo](generated_client.TranscodingInfoTranscodeReasonsEnum.md#unknownvideostreaminfo) -- [VideoBitDepthNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#videobitdepthnotsupported) -- [VideoBitrateNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#videobitratenotsupported) -- [VideoCodecNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#videocodecnotsupported) -- [VideoFramerateNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#videoframeratenotsupported) -- [VideoLevelNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#videolevelnotsupported) -- [VideoProfileNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#videoprofilenotsupported) -- [VideoRangeTypeNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#videorangetypenotsupported) -- [VideoResolutionNotSupported](generated_client.TranscodingInfoTranscodeReasonsEnum.md#videoresolutionnotsupported) - -## Enumeration Members - -### AnamorphicVideoNotSupported - -• **AnamorphicVideoNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:121](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L121) - -___ - -### AudioBitDepthNotSupported - -• **AudioBitDepthNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:126](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L126) - -___ - -### AudioBitrateNotSupported - -• **AudioBitrateNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:129](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L129) - -___ - -### AudioChannelsNotSupported - -• **AudioChannelsNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:123](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L123) - -___ - -### AudioCodecNotSupported - -• **AudioCodecNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:111](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L111) - -___ - -### AudioIsExternal - -• **AudioIsExternal** - -#### Defined in - -[generated-client/models/transcoding-info.ts:113](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L113) - -___ - -### AudioProfileNotSupported - -• **AudioProfileNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:124](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L124) - -___ - -### AudioSampleRateNotSupported - -• **AudioSampleRateNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:125](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L125) - -___ - -### ContainerBitrateExceedsLimit - -• **ContainerBitrateExceedsLimit** - -#### Defined in - -[generated-client/models/transcoding-info.ts:127](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L127) - -___ - -### ContainerNotSupported - -• **ContainerNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:109](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L109) - -___ - -### DirectPlayError - -• **DirectPlayError** - -#### Defined in - -[generated-client/models/transcoding-info.ts:132](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L132) - -___ - -### InterlacedVideoNotSupported - -• **InterlacedVideoNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:122](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L122) - -___ - -### RefFramesNotSupported - -• **RefFramesNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:120](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L120) - -___ - -### SecondaryAudioNotSupported - -• **SecondaryAudioNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:114](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L114) - -___ - -### SubtitleCodecNotSupported - -• **SubtitleCodecNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:112](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L112) - -___ - -### UnknownAudioStreamInfo - -• **UnknownAudioStreamInfo** - -#### Defined in - -[generated-client/models/transcoding-info.ts:131](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L131) - -___ - -### UnknownVideoStreamInfo - -• **UnknownVideoStreamInfo** - -#### Defined in - -[generated-client/models/transcoding-info.ts:130](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L130) - -___ - -### VideoBitDepthNotSupported - -• **VideoBitDepthNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:118](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L118) - -___ - -### VideoBitrateNotSupported - -• **VideoBitrateNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:128](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L128) - -___ - -### VideoCodecNotSupported - -• **VideoCodecNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:110](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L110) - -___ - -### VideoFramerateNotSupported - -• **VideoFramerateNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:119](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L119) - -___ - -### VideoLevelNotSupported - -• **VideoLevelNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:116](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L116) - -___ - -### VideoProfileNotSupported - -• **VideoProfileNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:115](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L115) - -___ - -### VideoRangeTypeNotSupported - -• **VideoRangeTypeNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:133](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L133) - -___ - -### VideoResolutionNotSupported - -• **VideoResolutionNotSupported** - -#### Defined in - -[generated-client/models/transcoding-info.ts:117](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L117) diff --git a/docs/enums/generated_client.TransportStreamTimestamp.md b/docs/enums/generated_client.TransportStreamTimestamp.md deleted file mode 100644 index ae5748589..000000000 --- a/docs/enums/generated_client.TransportStreamTimestamp.md +++ /dev/null @@ -1,45 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TransportStreamTimestamp - -# Enumeration: TransportStreamTimestamp - -[generated-client](../modules/generated_client.md).TransportStreamTimestamp - -**`export`** - -## Table of contents - -### Enumeration Members - -- [None](generated_client.TransportStreamTimestamp.md#none) -- [Valid](generated_client.TransportStreamTimestamp.md#valid) -- [Zero](generated_client.TransportStreamTimestamp.md#zero) - -## Enumeration Members - -### None - -• **None** - -#### Defined in - -[generated-client/models/transport-stream-timestamp.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transport-stream-timestamp.ts#L24) - -___ - -### Valid - -• **Valid** - -#### Defined in - -[generated-client/models/transport-stream-timestamp.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transport-stream-timestamp.ts#L26) - -___ - -### Zero - -• **Zero** - -#### Defined in - -[generated-client/models/transport-stream-timestamp.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transport-stream-timestamp.ts#L25) diff --git a/docs/enums/generated_client.UnratedItem.md b/docs/enums/generated_client.UnratedItem.md deleted file mode 100644 index 723bd0efd..000000000 --- a/docs/enums/generated_client.UnratedItem.md +++ /dev/null @@ -1,113 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UnratedItem - -# Enumeration: UnratedItem - -[generated-client](../modules/generated_client.md).UnratedItem - -An enum representing an unrated item. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [Book](generated_client.UnratedItem.md#book) -- [ChannelContent](generated_client.UnratedItem.md#channelcontent) -- [LiveTvChannel](generated_client.UnratedItem.md#livetvchannel) -- [LiveTvProgram](generated_client.UnratedItem.md#livetvprogram) -- [Movie](generated_client.UnratedItem.md#movie) -- [Music](generated_client.UnratedItem.md#music) -- [Other](generated_client.UnratedItem.md#other) -- [Series](generated_client.UnratedItem.md#series) -- [Trailer](generated_client.UnratedItem.md#trailer) - -## Enumeration Members - -### Book - -• **Book** - -#### Defined in - -[generated-client/models/unrated-item.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/unrated-item.ts#L28) - -___ - -### ChannelContent - -• **ChannelContent** - -#### Defined in - -[generated-client/models/unrated-item.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/unrated-item.ts#L31) - -___ - -### LiveTvChannel - -• **LiveTvChannel** - -#### Defined in - -[generated-client/models/unrated-item.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/unrated-item.ts#L29) - -___ - -### LiveTvProgram - -• **LiveTvProgram** - -#### Defined in - -[generated-client/models/unrated-item.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/unrated-item.ts#L30) - -___ - -### Movie - -• **Movie** - -#### Defined in - -[generated-client/models/unrated-item.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/unrated-item.ts#L24) - -___ - -### Music - -• **Music** - -#### Defined in - -[generated-client/models/unrated-item.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/unrated-item.ts#L27) - -___ - -### Other - -• **Other** - -#### Defined in - -[generated-client/models/unrated-item.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/unrated-item.ts#L32) - -___ - -### Series - -• **Series** - -#### Defined in - -[generated-client/models/unrated-item.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/unrated-item.ts#L26) - -___ - -### Trailer - -• **Trailer** - -#### Defined in - -[generated-client/models/unrated-item.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/unrated-item.ts#L25) diff --git a/docs/enums/generated_client.Video3DFormat.md b/docs/enums/generated_client.Video3DFormat.md deleted file mode 100644 index 750e613b0..000000000 --- a/docs/enums/generated_client.Video3DFormat.md +++ /dev/null @@ -1,67 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / Video3DFormat - -# Enumeration: Video3DFormat - -[generated-client](../modules/generated_client.md).Video3DFormat - -**`export`** - -## Table of contents - -### Enumeration Members - -- [FullSideBySide](generated_client.Video3DFormat.md#fullsidebyside) -- [FullTopAndBottom](generated_client.Video3DFormat.md#fulltopandbottom) -- [HalfSideBySide](generated_client.Video3DFormat.md#halfsidebyside) -- [HalfTopAndBottom](generated_client.Video3DFormat.md#halftopandbottom) -- [Mvc](generated_client.Video3DFormat.md#mvc) - -## Enumeration Members - -### FullSideBySide - -• **FullSideBySide** - -#### Defined in - -[generated-client/models/video3-dformat.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/video3-dformat.ts#L25) - -___ - -### FullTopAndBottom - -• **FullTopAndBottom** - -#### Defined in - -[generated-client/models/video3-dformat.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/video3-dformat.ts#L26) - -___ - -### HalfSideBySide - -• **HalfSideBySide** - -#### Defined in - -[generated-client/models/video3-dformat.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/video3-dformat.ts#L24) - -___ - -### HalfTopAndBottom - -• **HalfTopAndBottom** - -#### Defined in - -[generated-client/models/video3-dformat.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/video3-dformat.ts#L27) - -___ - -### Mvc - -• **Mvc** - -#### Defined in - -[generated-client/models/video3-dformat.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/video3-dformat.ts#L28) diff --git a/docs/enums/generated_client.VideoType.md b/docs/enums/generated_client.VideoType.md deleted file mode 100644 index 5131480e7..000000000 --- a/docs/enums/generated_client.VideoType.md +++ /dev/null @@ -1,58 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideoType - -# Enumeration: VideoType - -[generated-client](../modules/generated_client.md).VideoType - -Enum VideoType. - -**`export`** - -## Table of contents - -### Enumeration Members - -- [BluRay](generated_client.VideoType.md#bluray) -- [Dvd](generated_client.VideoType.md#dvd) -- [Iso](generated_client.VideoType.md#iso) -- [VideoFile](generated_client.VideoType.md#videofile) - -## Enumeration Members - -### BluRay - -• **BluRay** - -#### Defined in - -[generated-client/models/video-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/video-type.ts#L27) - -___ - -### Dvd - -• **Dvd** - -#### Defined in - -[generated-client/models/video-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/video-type.ts#L26) - -___ - -### Iso - -• **Iso** - -#### Defined in - -[generated-client/models/video-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/video-type.ts#L25) - -___ - -### VideoFile - -• **VideoFile** - -#### Defined in - -[generated-client/models/video-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/video-type.ts#L24) diff --git a/docs/enums/index.RecommendedServerInfoScore.md b/docs/enums/index.RecommendedServerInfoScore.md deleted file mode 100644 index a0b735a25..000000000 --- a/docs/enums/index.RecommendedServerInfoScore.md +++ /dev/null @@ -1,56 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / RecommendedServerInfoScore - -# Enumeration: RecommendedServerInfoScore - -[index](../modules/index.md).RecommendedServerInfoScore - -Possible score values for recommended servers. - -## Table of contents - -### Enumeration Members - -- [BAD](index.RecommendedServerInfoScore.md#bad) -- [GOOD](index.RecommendedServerInfoScore.md#good) -- [GREAT](index.RecommendedServerInfoScore.md#great) -- [OK](index.RecommendedServerInfoScore.md#ok) - -## Enumeration Members - -### BAD - -• **BAD** - -#### Defined in - -[models/recommended-server-info.ts:16](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-info.ts#L16) - -___ - -### GOOD - -• **GOOD** - -#### Defined in - -[models/recommended-server-info.ts:14](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-info.ts#L14) - -___ - -### GREAT - -• **GREAT** - -#### Defined in - -[models/recommended-server-info.ts:13](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-info.ts#L13) - -___ - -### OK - -• **OK** - -#### Defined in - -[models/recommended-server-info.ts:15](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-info.ts#L15) diff --git a/docs/interfaces/generated_client.AccessSchedule.md b/docs/interfaces/generated_client.AccessSchedule.md deleted file mode 100644 index 6122c5019..000000000 --- a/docs/interfaces/generated_client.AccessSchedule.md +++ /dev/null @@ -1,89 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AccessSchedule - -# Interface: AccessSchedule - -[generated-client](../modules/generated_client.md).AccessSchedule - -An entity representing a user\'s access schedule. - -**`export`** - -**`interface`** AccessSchedule - -## Table of contents - -### Properties - -- [DayOfWeek](generated_client.AccessSchedule.md#dayofweek) -- [EndHour](generated_client.AccessSchedule.md#endhour) -- [Id](generated_client.AccessSchedule.md#id) -- [StartHour](generated_client.AccessSchedule.md#starthour) -- [UserId](generated_client.AccessSchedule.md#userid) - -## Properties - -### DayOfWeek - -• `Optional` **DayOfWeek**: [`DynamicDayOfWeek`](../enums/generated_client.DynamicDayOfWeek.md) - -**`memberof`** AccessSchedule - -#### Defined in - -[generated-client/models/access-schedule.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/access-schedule.ts#L41) - -___ - -### EndHour - -• `Optional` **EndHour**: `number` - -Gets or sets the end hour. - -**`memberof`** AccessSchedule - -#### Defined in - -[generated-client/models/access-schedule.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/access-schedule.ts#L53) - -___ - -### Id - -• `Optional` **Id**: `number` - -Gets the id of this instance. - -**`memberof`** AccessSchedule - -#### Defined in - -[generated-client/models/access-schedule.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/access-schedule.ts#L29) - -___ - -### StartHour - -• `Optional` **StartHour**: `number` - -Gets or sets the start hour. - -**`memberof`** AccessSchedule - -#### Defined in - -[generated-client/models/access-schedule.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/access-schedule.ts#L47) - -___ - -### UserId - -• `Optional` **UserId**: `string` - -Gets the id of the associated user. - -**`memberof`** AccessSchedule - -#### Defined in - -[generated-client/models/access-schedule.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/access-schedule.ts#L35) diff --git a/docs/interfaces/generated_client.ActivityLogApiGetLogEntriesRequest.md b/docs/interfaces/generated_client.ActivityLogApiGetLogEntriesRequest.md deleted file mode 100644 index e9436021c..000000000 --- a/docs/interfaces/generated_client.ActivityLogApiGetLogEntriesRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ActivityLogApiGetLogEntriesRequest - -# Interface: ActivityLogApiGetLogEntriesRequest - -[generated-client](../modules/generated_client.md).ActivityLogApiGetLogEntriesRequest - -Request parameters for getLogEntries operation in ActivityLogApi. - -**`export`** - -**`interface`** ActivityLogApiGetLogEntriesRequest - -## Table of contents - -### Properties - -- [hasUserId](generated_client.ActivityLogApiGetLogEntriesRequest.md#hasuserid) -- [limit](generated_client.ActivityLogApiGetLogEntriesRequest.md#limit) -- [minDate](generated_client.ActivityLogApiGetLogEntriesRequest.md#mindate) -- [startIndex](generated_client.ActivityLogApiGetLogEntriesRequest.md#startindex) - -## Properties - -### hasUserId - -• `Optional` `Readonly` **hasUserId**: `boolean` - -Optional. Filter log entries if it has user id, or not. - -**`memberof`** ActivityLogApiGetLogEntries - -#### Defined in - -[generated-client/api/activity-log-api.ts:168](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/activity-log-api.ts#L168) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** ActivityLogApiGetLogEntries - -#### Defined in - -[generated-client/api/activity-log-api.ts:154](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/activity-log-api.ts#L154) - -___ - -### minDate - -• `Optional` `Readonly` **minDate**: `string` - -Optional. The minimum date. Format = ISO. - -**`memberof`** ActivityLogApiGetLogEntries - -#### Defined in - -[generated-client/api/activity-log-api.ts:161](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/activity-log-api.ts#L161) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** ActivityLogApiGetLogEntries - -#### Defined in - -[generated-client/api/activity-log-api.ts:147](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/activity-log-api.ts#L147) diff --git a/docs/interfaces/generated_client.ActivityLogEntry.md b/docs/interfaces/generated_client.ActivityLogEntry.md deleted file mode 100644 index f4e14bc05..000000000 --- a/docs/interfaces/generated_client.ActivityLogEntry.md +++ /dev/null @@ -1,166 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ActivityLogEntry - -# Interface: ActivityLogEntry - -[generated-client](../modules/generated_client.md).ActivityLogEntry - -An activity log entry. - -**`export`** - -**`interface`** ActivityLogEntry - -## Table of contents - -### Properties - -- [Date](generated_client.ActivityLogEntry.md#date) -- [Id](generated_client.ActivityLogEntry.md#id) -- [ItemId](generated_client.ActivityLogEntry.md#itemid) -- [Name](generated_client.ActivityLogEntry.md#name) -- [Overview](generated_client.ActivityLogEntry.md#overview) -- [Severity](generated_client.ActivityLogEntry.md#severity) -- [ShortOverview](generated_client.ActivityLogEntry.md#shortoverview) -- [Type](generated_client.ActivityLogEntry.md#type) -- [UserId](generated_client.ActivityLogEntry.md#userid) -- [UserPrimaryImageTag](generated_client.ActivityLogEntry.md#userprimaryimagetag) - -## Properties - -### Date - -• `Optional` **Date**: `string` - -Gets or sets the date. - -**`memberof`** ActivityLogEntry - -#### Defined in - -[generated-client/models/activity-log-entry.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry.ts#L65) - -___ - -### Id - -• `Optional` **Id**: `number` - -Gets or sets the identifier. - -**`memberof`** ActivityLogEntry - -#### Defined in - -[generated-client/models/activity-log-entry.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry.ts#L29) - -___ - -### ItemId - -• `Optional` **ItemId**: ``null`` \| `string` - -Gets or sets the item identifier. - -**`memberof`** ActivityLogEntry - -#### Defined in - -[generated-client/models/activity-log-entry.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry.ts#L59) - -___ - -### Name - -• `Optional` **Name**: `string` - -Gets or sets the name. - -**`memberof`** ActivityLogEntry - -#### Defined in - -[generated-client/models/activity-log-entry.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry.ts#L35) - -___ - -### Overview - -• `Optional` **Overview**: ``null`` \| `string` - -Gets or sets the overview. - -**`memberof`** ActivityLogEntry - -#### Defined in - -[generated-client/models/activity-log-entry.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry.ts#L41) - -___ - -### Severity - -• `Optional` **Severity**: [`LogLevel`](../enums/generated_client.LogLevel.md) - -**`memberof`** ActivityLogEntry - -#### Defined in - -[generated-client/models/activity-log-entry.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry.ts#L84) - -___ - -### ShortOverview - -• `Optional` **ShortOverview**: ``null`` \| `string` - -Gets or sets the short overview. - -**`memberof`** ActivityLogEntry - -#### Defined in - -[generated-client/models/activity-log-entry.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry.ts#L47) - -___ - -### Type - -• `Optional` **Type**: `string` - -Gets or sets the type. - -**`memberof`** ActivityLogEntry - -#### Defined in - -[generated-client/models/activity-log-entry.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry.ts#L53) - -___ - -### UserId - -• `Optional` **UserId**: `string` - -Gets or sets the user identifier. - -**`memberof`** ActivityLogEntry - -#### Defined in - -[generated-client/models/activity-log-entry.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry.ts#L71) - -___ - -### UserPrimaryImageTag - -• `Optional` **UserPrimaryImageTag**: ``null`` \| `string` - -Gets or sets the user primary image tag. - -**`memberof`** ActivityLogEntry - -**`deprecated`** - -#### Defined in - -[generated-client/models/activity-log-entry.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry.ts#L78) diff --git a/docs/interfaces/generated_client.ActivityLogEntryQueryResult.md b/docs/interfaces/generated_client.ActivityLogEntryQueryResult.md deleted file mode 100644 index e55b9ff48..000000000 --- a/docs/interfaces/generated_client.ActivityLogEntryQueryResult.md +++ /dev/null @@ -1,59 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ActivityLogEntryQueryResult - -# Interface: ActivityLogEntryQueryResult - -[generated-client](../modules/generated_client.md).ActivityLogEntryQueryResult - -**`export`** - -**`interface`** ActivityLogEntryQueryResult - -## Table of contents - -### Properties - -- [Items](generated_client.ActivityLogEntryQueryResult.md#items) -- [StartIndex](generated_client.ActivityLogEntryQueryResult.md#startindex) -- [TotalRecordCount](generated_client.ActivityLogEntryQueryResult.md#totalrecordcount) - -## Properties - -### Items - -• `Optional` **Items**: ``null`` \| [`ActivityLogEntry`](generated_client.ActivityLogEntry.md)[] - -Gets or sets the items. - -**`memberof`** ActivityLogEntryQueryResult - -#### Defined in - -[generated-client/models/activity-log-entry-query-result.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry-query-result.ts#L29) - -___ - -### StartIndex - -• `Optional` **StartIndex**: `number` - -Gets or sets the index of the first record in Items. - -**`memberof`** ActivityLogEntryQueryResult - -#### Defined in - -[generated-client/models/activity-log-entry-query-result.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry-query-result.ts#L41) - -___ - -### TotalRecordCount - -• `Optional` **TotalRecordCount**: `number` - -Gets or sets the total number of records available. - -**`memberof`** ActivityLogEntryQueryResult - -#### Defined in - -[generated-client/models/activity-log-entry-query-result.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/activity-log-entry-query-result.ts#L35) diff --git a/docs/interfaces/generated_client.AddVirtualFolderDto.md b/docs/interfaces/generated_client.AddVirtualFolderDto.md deleted file mode 100644 index c1701679e..000000000 --- a/docs/interfaces/generated_client.AddVirtualFolderDto.md +++ /dev/null @@ -1,29 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AddVirtualFolderDto - -# Interface: AddVirtualFolderDto - -[generated-client](../modules/generated_client.md).AddVirtualFolderDto - -Add virtual folder dto. - -**`export`** - -**`interface`** AddVirtualFolderDto - -## Table of contents - -### Properties - -- [LibraryOptions](generated_client.AddVirtualFolderDto.md#libraryoptions) - -## Properties - -### LibraryOptions - -• `Optional` **LibraryOptions**: [`LibraryOptions`](generated_client.LibraryOptions.md) - -**`memberof`** AddVirtualFolderDto - -#### Defined in - -[generated-client/models/add-virtual-folder-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/add-virtual-folder-dto.ts#L29) diff --git a/docs/interfaces/generated_client.AdminNotificationDto.md b/docs/interfaces/generated_client.AdminNotificationDto.md deleted file mode 100644 index f89302307..000000000 --- a/docs/interfaces/generated_client.AdminNotificationDto.md +++ /dev/null @@ -1,74 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AdminNotificationDto - -# Interface: AdminNotificationDto - -[generated-client](../modules/generated_client.md).AdminNotificationDto - -The admin notification dto. - -**`export`** - -**`interface`** AdminNotificationDto - -## Table of contents - -### Properties - -- [Description](generated_client.AdminNotificationDto.md#description) -- [Name](generated_client.AdminNotificationDto.md#name) -- [NotificationLevel](generated_client.AdminNotificationDto.md#notificationlevel) -- [Url](generated_client.AdminNotificationDto.md#url) - -## Properties - -### Description - -• `Optional` **Description**: ``null`` \| `string` - -Gets or sets the notification description. - -**`memberof`** AdminNotificationDto - -#### Defined in - -[generated-client/models/admin-notification-dto.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/admin-notification-dto.ts#L35) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the notification name. - -**`memberof`** AdminNotificationDto - -#### Defined in - -[generated-client/models/admin-notification-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/admin-notification-dto.ts#L29) - -___ - -### NotificationLevel - -• `Optional` **NotificationLevel**: [`NotificationLevel`](../enums/generated_client.NotificationLevel.md) - -**`memberof`** AdminNotificationDto - -#### Defined in - -[generated-client/models/admin-notification-dto.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/admin-notification-dto.ts#L41) - -___ - -### Url - -• `Optional` **Url**: ``null`` \| `string` - -Gets or sets the notification url. - -**`memberof`** AdminNotificationDto - -#### Defined in - -[generated-client/models/admin-notification-dto.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/admin-notification-dto.ts#L47) diff --git a/docs/interfaces/generated_client.AlbumInfo.md b/docs/interfaces/generated_client.AlbumInfo.md deleted file mode 100644 index 5db777460..000000000 --- a/docs/interfaces/generated_client.AlbumInfo.md +++ /dev/null @@ -1,218 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AlbumInfo - -# Interface: AlbumInfo - -[generated-client](../modules/generated_client.md).AlbumInfo - -**`export`** - -**`interface`** AlbumInfo - -## Table of contents - -### Properties - -- [AlbumArtists](generated_client.AlbumInfo.md#albumartists) -- [ArtistProviderIds](generated_client.AlbumInfo.md#artistproviderids) -- [IndexNumber](generated_client.AlbumInfo.md#indexnumber) -- [IsAutomated](generated_client.AlbumInfo.md#isautomated) -- [MetadataCountryCode](generated_client.AlbumInfo.md#metadatacountrycode) -- [MetadataLanguage](generated_client.AlbumInfo.md#metadatalanguage) -- [Name](generated_client.AlbumInfo.md#name) -- [OriginalTitle](generated_client.AlbumInfo.md#originaltitle) -- [ParentIndexNumber](generated_client.AlbumInfo.md#parentindexnumber) -- [Path](generated_client.AlbumInfo.md#path) -- [PremiereDate](generated_client.AlbumInfo.md#premieredate) -- [ProviderIds](generated_client.AlbumInfo.md#providerids) -- [SongInfos](generated_client.AlbumInfo.md#songinfos) -- [Year](generated_client.AlbumInfo.md#year) - -## Properties - -### AlbumArtists - -• `Optional` **AlbumArtists**: `string`[] - -Gets or sets the album artist. - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:95](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L95) - -___ - -### ArtistProviderIds - -• `Optional` **ArtistProviderIds**: `Object` - -Gets or sets the artist provider ids. - -**`memberof`** AlbumInfo - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/album-info.ts:101](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L101) - -___ - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L71) - -___ - -### IsAutomated - -• `Optional` **IsAutomated**: `boolean` - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:89](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L89) - -___ - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: ``null`` \| `string` - -Gets or sets the metadata country code. - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L53) - -___ - -### MetadataLanguage - -• `Optional` **MetadataLanguage**: ``null`` \| `string` - -Gets or sets the metadata language. - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L47) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L29) - -___ - -### OriginalTitle - -• `Optional` **OriginalTitle**: ``null`` \| `string` - -Gets or sets the original title. - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L35) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L77) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L41) - -___ - -### PremiereDate - -• `Optional` **PremiereDate**: ``null`` \| `string` - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:83](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L83) - -___ - -### ProviderIds - -• `Optional` **ProviderIds**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the provider ids. - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L59) - -___ - -### SongInfos - -• `Optional` **SongInfos**: [`SongInfo`](generated_client.SongInfo.md)[] - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:107](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L107) - -___ - -### Year - -• `Optional` **Year**: ``null`` \| `number` - -Gets or sets the year. - -**`memberof`** AlbumInfo - -#### Defined in - -[generated-client/models/album-info.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info.ts#L65) diff --git a/docs/interfaces/generated_client.AlbumInfoRemoteSearchQuery.md b/docs/interfaces/generated_client.AlbumInfoRemoteSearchQuery.md deleted file mode 100644 index d8e0082d6..000000000 --- a/docs/interfaces/generated_client.AlbumInfoRemoteSearchQuery.md +++ /dev/null @@ -1,70 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AlbumInfoRemoteSearchQuery - -# Interface: AlbumInfoRemoteSearchQuery - -[generated-client](../modules/generated_client.md).AlbumInfoRemoteSearchQuery - -**`export`** - -**`interface`** AlbumInfoRemoteSearchQuery - -## Table of contents - -### Properties - -- [IncludeDisabledProviders](generated_client.AlbumInfoRemoteSearchQuery.md#includedisabledproviders) -- [ItemId](generated_client.AlbumInfoRemoteSearchQuery.md#itemid) -- [SearchInfo](generated_client.AlbumInfoRemoteSearchQuery.md#searchinfo) -- [SearchProviderName](generated_client.AlbumInfoRemoteSearchQuery.md#searchprovidername) - -## Properties - -### IncludeDisabledProviders - -• `Optional` **IncludeDisabledProviders**: `boolean` - -Gets or sets a value indicating whether disabled providers should be included. - -**`memberof`** AlbumInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/album-info-remote-search-query.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info-remote-search-query.ts#L47) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -**`memberof`** AlbumInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/album-info-remote-search-query.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info-remote-search-query.ts#L35) - -___ - -### SearchInfo - -• `Optional` **SearchInfo**: [`AlbumInfo`](generated_client.AlbumInfo.md) - -**`memberof`** AlbumInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/album-info-remote-search-query.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info-remote-search-query.ts#L29) - -___ - -### SearchProviderName - -• `Optional` **SearchProviderName**: ``null`` \| `string` - -Gets or sets the provider name to search within if set. - -**`memberof`** AlbumInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/album-info-remote-search-query.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/album-info-remote-search-query.ts#L41) diff --git a/docs/interfaces/generated_client.AllThemeMediaResult.md b/docs/interfaces/generated_client.AllThemeMediaResult.md deleted file mode 100644 index 942dceccf..000000000 --- a/docs/interfaces/generated_client.AllThemeMediaResult.md +++ /dev/null @@ -1,53 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AllThemeMediaResult - -# Interface: AllThemeMediaResult - -[generated-client](../modules/generated_client.md).AllThemeMediaResult - -**`export`** - -**`interface`** AllThemeMediaResult - -## Table of contents - -### Properties - -- [SoundtrackSongsResult](generated_client.AllThemeMediaResult.md#soundtracksongsresult) -- [ThemeSongsResult](generated_client.AllThemeMediaResult.md#themesongsresult) -- [ThemeVideosResult](generated_client.AllThemeMediaResult.md#themevideosresult) - -## Properties - -### SoundtrackSongsResult - -• `Optional` **SoundtrackSongsResult**: [`ThemeMediaResult`](generated_client.ThemeMediaResult.md) - -**`memberof`** AllThemeMediaResult - -#### Defined in - -[generated-client/models/all-theme-media-result.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/all-theme-media-result.ts#L41) - -___ - -### ThemeSongsResult - -• `Optional` **ThemeSongsResult**: [`ThemeMediaResult`](generated_client.ThemeMediaResult.md) - -**`memberof`** AllThemeMediaResult - -#### Defined in - -[generated-client/models/all-theme-media-result.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/all-theme-media-result.ts#L35) - -___ - -### ThemeVideosResult - -• `Optional` **ThemeVideosResult**: [`ThemeMediaResult`](generated_client.ThemeMediaResult.md) - -**`memberof`** AllThemeMediaResult - -#### Defined in - -[generated-client/models/all-theme-media-result.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/all-theme-media-result.ts#L29) diff --git a/docs/interfaces/generated_client.ApiKeyApiCreateKeyRequest.md b/docs/interfaces/generated_client.ApiKeyApiCreateKeyRequest.md deleted file mode 100644 index 51b53be9f..000000000 --- a/docs/interfaces/generated_client.ApiKeyApiCreateKeyRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ApiKeyApiCreateKeyRequest - -# Interface: ApiKeyApiCreateKeyRequest - -[generated-client](../modules/generated_client.md).ApiKeyApiCreateKeyRequest - -Request parameters for createKey operation in ApiKeyApi. - -**`export`** - -**`interface`** ApiKeyApiCreateKeyRequest - -## Table of contents - -### Properties - -- [app](generated_client.ApiKeyApiCreateKeyRequest.md#app) - -## Properties - -### app - -• `Readonly` **app**: `string` - -Name of the app using the authentication key. - -**`memberof`** ApiKeyApiCreateKey - -#### Defined in - -[generated-client/api/api-key-api.ts:236](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L236) diff --git a/docs/interfaces/generated_client.ApiKeyApiRevokeKeyRequest.md b/docs/interfaces/generated_client.ApiKeyApiRevokeKeyRequest.md deleted file mode 100644 index 67063758c..000000000 --- a/docs/interfaces/generated_client.ApiKeyApiRevokeKeyRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ApiKeyApiRevokeKeyRequest - -# Interface: ApiKeyApiRevokeKeyRequest - -[generated-client](../modules/generated_client.md).ApiKeyApiRevokeKeyRequest - -Request parameters for revokeKey operation in ApiKeyApi. - -**`export`** - -**`interface`** ApiKeyApiRevokeKeyRequest - -## Table of contents - -### Properties - -- [key](generated_client.ApiKeyApiRevokeKeyRequest.md#key) - -## Properties - -### key - -• `Readonly` **key**: `string` - -The access token to delete. - -**`memberof`** ApiKeyApiRevokeKey - -#### Defined in - -[generated-client/api/api-key-api.ts:250](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L250) diff --git a/docs/interfaces/generated_client.ArtistInfo.md b/docs/interfaces/generated_client.ArtistInfo.md deleted file mode 100644 index 3353e6a41..000000000 --- a/docs/interfaces/generated_client.ArtistInfo.md +++ /dev/null @@ -1,184 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ArtistInfo - -# Interface: ArtistInfo - -[generated-client](../modules/generated_client.md).ArtistInfo - -**`export`** - -**`interface`** ArtistInfo - -## Table of contents - -### Properties - -- [IndexNumber](generated_client.ArtistInfo.md#indexnumber) -- [IsAutomated](generated_client.ArtistInfo.md#isautomated) -- [MetadataCountryCode](generated_client.ArtistInfo.md#metadatacountrycode) -- [MetadataLanguage](generated_client.ArtistInfo.md#metadatalanguage) -- [Name](generated_client.ArtistInfo.md#name) -- [OriginalTitle](generated_client.ArtistInfo.md#originaltitle) -- [ParentIndexNumber](generated_client.ArtistInfo.md#parentindexnumber) -- [Path](generated_client.ArtistInfo.md#path) -- [PremiereDate](generated_client.ArtistInfo.md#premieredate) -- [ProviderIds](generated_client.ArtistInfo.md#providerids) -- [SongInfos](generated_client.ArtistInfo.md#songinfos) -- [Year](generated_client.ArtistInfo.md#year) - -## Properties - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -**`memberof`** ArtistInfo - -#### Defined in - -[generated-client/models/artist-info.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info.ts#L71) - -___ - -### IsAutomated - -• `Optional` **IsAutomated**: `boolean` - -**`memberof`** ArtistInfo - -#### Defined in - -[generated-client/models/artist-info.ts:89](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info.ts#L89) - -___ - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: ``null`` \| `string` - -Gets or sets the metadata country code. - -**`memberof`** ArtistInfo - -#### Defined in - -[generated-client/models/artist-info.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info.ts#L53) - -___ - -### MetadataLanguage - -• `Optional` **MetadataLanguage**: ``null`` \| `string` - -Gets or sets the metadata language. - -**`memberof`** ArtistInfo - -#### Defined in - -[generated-client/models/artist-info.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info.ts#L47) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** ArtistInfo - -#### Defined in - -[generated-client/models/artist-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info.ts#L29) - -___ - -### OriginalTitle - -• `Optional` **OriginalTitle**: ``null`` \| `string` - -Gets or sets the original title. - -**`memberof`** ArtistInfo - -#### Defined in - -[generated-client/models/artist-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info.ts#L35) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -**`memberof`** ArtistInfo - -#### Defined in - -[generated-client/models/artist-info.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info.ts#L77) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** ArtistInfo - -#### Defined in - -[generated-client/models/artist-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info.ts#L41) - -___ - -### PremiereDate - -• `Optional` **PremiereDate**: ``null`` \| `string` - -**`memberof`** ArtistInfo - -#### Defined in - -[generated-client/models/artist-info.ts:83](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info.ts#L83) - -___ - -### ProviderIds - -• `Optional` **ProviderIds**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the provider ids. - -**`memberof`** ArtistInfo - -#### Defined in - -[generated-client/models/artist-info.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info.ts#L59) - -___ - -### SongInfos - -• `Optional` **SongInfos**: [`SongInfo`](generated_client.SongInfo.md)[] - -**`memberof`** ArtistInfo - -#### Defined in - -[generated-client/models/artist-info.ts:95](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info.ts#L95) - -___ - -### Year - -• `Optional` **Year**: ``null`` \| `number` - -Gets or sets the year. - -**`memberof`** ArtistInfo - -#### Defined in - -[generated-client/models/artist-info.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info.ts#L65) diff --git a/docs/interfaces/generated_client.ArtistInfoRemoteSearchQuery.md b/docs/interfaces/generated_client.ArtistInfoRemoteSearchQuery.md deleted file mode 100644 index 11fae8f2a..000000000 --- a/docs/interfaces/generated_client.ArtistInfoRemoteSearchQuery.md +++ /dev/null @@ -1,70 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ArtistInfoRemoteSearchQuery - -# Interface: ArtistInfoRemoteSearchQuery - -[generated-client](../modules/generated_client.md).ArtistInfoRemoteSearchQuery - -**`export`** - -**`interface`** ArtistInfoRemoteSearchQuery - -## Table of contents - -### Properties - -- [IncludeDisabledProviders](generated_client.ArtistInfoRemoteSearchQuery.md#includedisabledproviders) -- [ItemId](generated_client.ArtistInfoRemoteSearchQuery.md#itemid) -- [SearchInfo](generated_client.ArtistInfoRemoteSearchQuery.md#searchinfo) -- [SearchProviderName](generated_client.ArtistInfoRemoteSearchQuery.md#searchprovidername) - -## Properties - -### IncludeDisabledProviders - -• `Optional` **IncludeDisabledProviders**: `boolean` - -Gets or sets a value indicating whether disabled providers should be included. - -**`memberof`** ArtistInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/artist-info-remote-search-query.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info-remote-search-query.ts#L47) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -**`memberof`** ArtistInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/artist-info-remote-search-query.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info-remote-search-query.ts#L35) - -___ - -### SearchInfo - -• `Optional` **SearchInfo**: [`ArtistInfo`](generated_client.ArtistInfo.md) - -**`memberof`** ArtistInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/artist-info-remote-search-query.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info-remote-search-query.ts#L29) - -___ - -### SearchProviderName - -• `Optional` **SearchProviderName**: ``null`` \| `string` - -Gets or sets the provider name to search within if set. - -**`memberof`** ArtistInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/artist-info-remote-search-query.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/artist-info-remote-search-query.ts#L41) diff --git a/docs/interfaces/generated_client.ArtistsApiGetAlbumArtistsRequest.md b/docs/interfaces/generated_client.ArtistsApiGetAlbumArtistsRequest.md deleted file mode 100644 index 32ffec1fc..000000000 --- a/docs/interfaces/generated_client.ArtistsApiGetAlbumArtistsRequest.md +++ /dev/null @@ -1,496 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ArtistsApiGetAlbumArtistsRequest - -# Interface: ArtistsApiGetAlbumArtistsRequest - -[generated-client](../modules/generated_client.md).ArtistsApiGetAlbumArtistsRequest - -Request parameters for getAlbumArtists operation in ArtistsApi. - -**`export`** - -**`interface`** ArtistsApiGetAlbumArtistsRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.ArtistsApiGetAlbumArtistsRequest.md#enableimagetypes) -- [enableImages](generated_client.ArtistsApiGetAlbumArtistsRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.ArtistsApiGetAlbumArtistsRequest.md#enabletotalrecordcount) -- [enableUserData](generated_client.ArtistsApiGetAlbumArtistsRequest.md#enableuserdata) -- [excludeItemTypes](generated_client.ArtistsApiGetAlbumArtistsRequest.md#excludeitemtypes) -- [fields](generated_client.ArtistsApiGetAlbumArtistsRequest.md#fields) -- [filters](generated_client.ArtistsApiGetAlbumArtistsRequest.md#filters) -- [genreIds](generated_client.ArtistsApiGetAlbumArtistsRequest.md#genreids) -- [genres](generated_client.ArtistsApiGetAlbumArtistsRequest.md#genres) -- [imageTypeLimit](generated_client.ArtistsApiGetAlbumArtistsRequest.md#imagetypelimit) -- [includeItemTypes](generated_client.ArtistsApiGetAlbumArtistsRequest.md#includeitemtypes) -- [isFavorite](generated_client.ArtistsApiGetAlbumArtistsRequest.md#isfavorite) -- [limit](generated_client.ArtistsApiGetAlbumArtistsRequest.md#limit) -- [mediaTypes](generated_client.ArtistsApiGetAlbumArtistsRequest.md#mediatypes) -- [minCommunityRating](generated_client.ArtistsApiGetAlbumArtistsRequest.md#mincommunityrating) -- [nameLessThan](generated_client.ArtistsApiGetAlbumArtistsRequest.md#namelessthan) -- [nameStartsWith](generated_client.ArtistsApiGetAlbumArtistsRequest.md#namestartswith) -- [nameStartsWithOrGreater](generated_client.ArtistsApiGetAlbumArtistsRequest.md#namestartswithorgreater) -- [officialRatings](generated_client.ArtistsApiGetAlbumArtistsRequest.md#officialratings) -- [parentId](generated_client.ArtistsApiGetAlbumArtistsRequest.md#parentid) -- [person](generated_client.ArtistsApiGetAlbumArtistsRequest.md#person) -- [personIds](generated_client.ArtistsApiGetAlbumArtistsRequest.md#personids) -- [personTypes](generated_client.ArtistsApiGetAlbumArtistsRequest.md#persontypes) -- [searchTerm](generated_client.ArtistsApiGetAlbumArtistsRequest.md#searchterm) -- [sortBy](generated_client.ArtistsApiGetAlbumArtistsRequest.md#sortby) -- [sortOrder](generated_client.ArtistsApiGetAlbumArtistsRequest.md#sortorder) -- [startIndex](generated_client.ArtistsApiGetAlbumArtistsRequest.md#startindex) -- [studioIds](generated_client.ArtistsApiGetAlbumArtistsRequest.md#studioids) -- [studios](generated_client.ArtistsApiGetAlbumArtistsRequest.md#studios) -- [tags](generated_client.ArtistsApiGetAlbumArtistsRequest.md#tags) -- [userId](generated_client.ArtistsApiGetAlbumArtistsRequest.md#userid) -- [years](generated_client.ArtistsApiGetAlbumArtistsRequest.md#years) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:820](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L820) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional, include image information in output. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:904](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L904) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Total record count. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:911](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L911) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional, include user data. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:806](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L806) - -___ - -### excludeItemTypes - -• `Optional` `Readonly` **excludeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:736](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L736) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:729](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L729) - -___ - -### filters - -• `Optional` `Readonly` **filters**: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[] - -Optional. Specify additional filters to apply. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:750](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L750) - -___ - -### genreIds - -• `Optional` `Readonly` **genreIds**: `string`[] - -Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:778](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L778) - -___ - -### genres - -• `Optional` `Readonly` **genres**: `string`[] - -Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:771](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L771) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional, the max number of images to return, per image type. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:813](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L813) - -___ - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:743](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L743) - -___ - -### isFavorite - -• `Optional` `Readonly` **isFavorite**: `boolean` - -Optional filter by items that are marked as favorite, or not. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:757](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L757) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:708](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L708) - -___ - -### mediaTypes - -• `Optional` `Readonly` **mediaTypes**: `string`[] - -Optional filter by MediaType. Allows multiple, comma delimited. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:764](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L764) - -___ - -### minCommunityRating - -• `Optional` `Readonly` **minCommunityRating**: `number` - -Optional filter by minimum community rating. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:694](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L694) - -___ - -### nameLessThan - -• `Optional` `Readonly` **nameLessThan**: `string` - -Optional filter by items whose name is equally or lesser than a given input string. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:883](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L883) - -___ - -### nameStartsWith - -• `Optional` `Readonly` **nameStartsWith**: `string` - -Optional filter by items whose name is sorted equally than a given input string. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:876](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L876) - -___ - -### nameStartsWithOrGreater - -• `Optional` `Readonly` **nameStartsWithOrGreater**: `string` - -Optional filter by items whose name is sorted equally or greater than a given input string. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:869](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L869) - -___ - -### officialRatings - -• `Optional` `Readonly` **officialRatings**: `string`[] - -Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:785](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L785) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:722](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L722) - -___ - -### person - -• `Optional` `Readonly` **person**: `string` - -Optional. If specified, results will be filtered to include only those containing the specified person. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:827](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L827) - -___ - -### personIds - -• `Optional` `Readonly` **personIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified person ids. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:834](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L834) - -___ - -### personTypes - -• `Optional` `Readonly` **personTypes**: `string`[] - -Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:841](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L841) - -___ - -### searchTerm - -• `Optional` `Readonly` **searchTerm**: `string` - -Optional. Search term. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:715](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L715) - -___ - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string`[] - -Optional. Specify one or more sort orders, comma delimited. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:890](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L890) - -___ - -### sortOrder - -• `Optional` `Readonly` **sortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md)[] - -Sort Order - Ascending,Descending. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:897](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L897) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:701](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L701) - -___ - -### studioIds - -• `Optional` `Readonly` **studioIds**: `string`[] - -Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:855](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L855) - -___ - -### studios - -• `Optional` `Readonly` **studios**: `string`[] - -Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:848](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L848) - -___ - -### tags - -• `Optional` `Readonly` **tags**: `string`[] - -Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:792](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L792) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -User id. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:862](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L862) - -___ - -### years - -• `Optional` `Readonly` **years**: `number`[] - -Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. - -**`memberof`** ArtistsApiGetAlbumArtists - -#### Defined in - -[generated-client/api/artists-api.ts:799](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L799) diff --git a/docs/interfaces/generated_client.ArtistsApiGetArtistByNameRequest.md b/docs/interfaces/generated_client.ArtistsApiGetArtistByNameRequest.md deleted file mode 100644 index 0c9af478a..000000000 --- a/docs/interfaces/generated_client.ArtistsApiGetArtistByNameRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ArtistsApiGetArtistByNameRequest - -# Interface: ArtistsApiGetArtistByNameRequest - -[generated-client](../modules/generated_client.md).ArtistsApiGetArtistByNameRequest - -Request parameters for getArtistByName operation in ArtistsApi. - -**`export`** - -**`interface`** ArtistsApiGetArtistByNameRequest - -## Table of contents - -### Properties - -- [name](generated_client.ArtistsApiGetArtistByNameRequest.md#name) -- [userId](generated_client.ArtistsApiGetArtistByNameRequest.md#userid) - -## Properties - -### name - -• `Readonly` **name**: `string` - -Studio name. - -**`memberof`** ArtistsApiGetArtistByName - -#### Defined in - -[generated-client/api/artists-api.ts:925](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L925) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** ArtistsApiGetArtistByName - -#### Defined in - -[generated-client/api/artists-api.ts:932](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L932) diff --git a/docs/interfaces/generated_client.ArtistsApiGetArtistsRequest.md b/docs/interfaces/generated_client.ArtistsApiGetArtistsRequest.md deleted file mode 100644 index 13c2919cb..000000000 --- a/docs/interfaces/generated_client.ArtistsApiGetArtistsRequest.md +++ /dev/null @@ -1,496 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ArtistsApiGetArtistsRequest - -# Interface: ArtistsApiGetArtistsRequest - -[generated-client](../modules/generated_client.md).ArtistsApiGetArtistsRequest - -Request parameters for getArtists operation in ArtistsApi. - -**`export`** - -**`interface`** ArtistsApiGetArtistsRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.ArtistsApiGetArtistsRequest.md#enableimagetypes) -- [enableImages](generated_client.ArtistsApiGetArtistsRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.ArtistsApiGetArtistsRequest.md#enabletotalrecordcount) -- [enableUserData](generated_client.ArtistsApiGetArtistsRequest.md#enableuserdata) -- [excludeItemTypes](generated_client.ArtistsApiGetArtistsRequest.md#excludeitemtypes) -- [fields](generated_client.ArtistsApiGetArtistsRequest.md#fields) -- [filters](generated_client.ArtistsApiGetArtistsRequest.md#filters) -- [genreIds](generated_client.ArtistsApiGetArtistsRequest.md#genreids) -- [genres](generated_client.ArtistsApiGetArtistsRequest.md#genres) -- [imageTypeLimit](generated_client.ArtistsApiGetArtistsRequest.md#imagetypelimit) -- [includeItemTypes](generated_client.ArtistsApiGetArtistsRequest.md#includeitemtypes) -- [isFavorite](generated_client.ArtistsApiGetArtistsRequest.md#isfavorite) -- [limit](generated_client.ArtistsApiGetArtistsRequest.md#limit) -- [mediaTypes](generated_client.ArtistsApiGetArtistsRequest.md#mediatypes) -- [minCommunityRating](generated_client.ArtistsApiGetArtistsRequest.md#mincommunityrating) -- [nameLessThan](generated_client.ArtistsApiGetArtistsRequest.md#namelessthan) -- [nameStartsWith](generated_client.ArtistsApiGetArtistsRequest.md#namestartswith) -- [nameStartsWithOrGreater](generated_client.ArtistsApiGetArtistsRequest.md#namestartswithorgreater) -- [officialRatings](generated_client.ArtistsApiGetArtistsRequest.md#officialratings) -- [parentId](generated_client.ArtistsApiGetArtistsRequest.md#parentid) -- [person](generated_client.ArtistsApiGetArtistsRequest.md#person) -- [personIds](generated_client.ArtistsApiGetArtistsRequest.md#personids) -- [personTypes](generated_client.ArtistsApiGetArtistsRequest.md#persontypes) -- [searchTerm](generated_client.ArtistsApiGetArtistsRequest.md#searchterm) -- [sortBy](generated_client.ArtistsApiGetArtistsRequest.md#sortby) -- [sortOrder](generated_client.ArtistsApiGetArtistsRequest.md#sortorder) -- [startIndex](generated_client.ArtistsApiGetArtistsRequest.md#startindex) -- [studioIds](generated_client.ArtistsApiGetArtistsRequest.md#studioids) -- [studios](generated_client.ArtistsApiGetArtistsRequest.md#studios) -- [tags](generated_client.ArtistsApiGetArtistsRequest.md#tags) -- [userId](generated_client.ArtistsApiGetArtistsRequest.md#userid) -- [years](generated_client.ArtistsApiGetArtistsRequest.md#years) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1072](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1072) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional, include image information in output. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1156](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1156) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Total record count. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1163](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1163) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional, include user data. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1058](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1058) - -___ - -### excludeItemTypes - -• `Optional` `Readonly` **excludeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:988](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L988) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:981](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L981) - -___ - -### filters - -• `Optional` `Readonly` **filters**: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[] - -Optional. Specify additional filters to apply. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1002](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1002) - -___ - -### genreIds - -• `Optional` `Readonly` **genreIds**: `string`[] - -Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1030](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1030) - -___ - -### genres - -• `Optional` `Readonly` **genres**: `string`[] - -Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1023](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1023) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional, the max number of images to return, per image type. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1065](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1065) - -___ - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:995](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L995) - -___ - -### isFavorite - -• `Optional` `Readonly` **isFavorite**: `boolean` - -Optional filter by items that are marked as favorite, or not. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1009](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1009) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:960](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L960) - -___ - -### mediaTypes - -• `Optional` `Readonly` **mediaTypes**: `string`[] - -Optional filter by MediaType. Allows multiple, comma delimited. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1016](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1016) - -___ - -### minCommunityRating - -• `Optional` `Readonly` **minCommunityRating**: `number` - -Optional filter by minimum community rating. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:946](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L946) - -___ - -### nameLessThan - -• `Optional` `Readonly` **nameLessThan**: `string` - -Optional filter by items whose name is equally or lesser than a given input string. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1135](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1135) - -___ - -### nameStartsWith - -• `Optional` `Readonly` **nameStartsWith**: `string` - -Optional filter by items whose name is sorted equally than a given input string. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1128](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1128) - -___ - -### nameStartsWithOrGreater - -• `Optional` `Readonly` **nameStartsWithOrGreater**: `string` - -Optional filter by items whose name is sorted equally or greater than a given input string. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1121](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1121) - -___ - -### officialRatings - -• `Optional` `Readonly` **officialRatings**: `string`[] - -Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1037](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1037) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:974](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L974) - -___ - -### person - -• `Optional` `Readonly` **person**: `string` - -Optional. If specified, results will be filtered to include only those containing the specified person. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1079](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1079) - -___ - -### personIds - -• `Optional` `Readonly` **personIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified person ids. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1086](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1086) - -___ - -### personTypes - -• `Optional` `Readonly` **personTypes**: `string`[] - -Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1093](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1093) - -___ - -### searchTerm - -• `Optional` `Readonly` **searchTerm**: `string` - -Optional. Search term. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:967](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L967) - -___ - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string`[] - -Optional. Specify one or more sort orders, comma delimited. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1142](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1142) - -___ - -### sortOrder - -• `Optional` `Readonly` **sortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md)[] - -Sort Order - Ascending,Descending. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1149](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1149) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:953](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L953) - -___ - -### studioIds - -• `Optional` `Readonly` **studioIds**: `string`[] - -Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1107](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1107) - -___ - -### studios - -• `Optional` `Readonly` **studios**: `string`[] - -Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1100](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1100) - -___ - -### tags - -• `Optional` `Readonly` **tags**: `string`[] - -Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1044](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1044) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -User id. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1114](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1114) - -___ - -### years - -• `Optional` `Readonly` **years**: `number`[] - -Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. - -**`memberof`** ArtistsApiGetArtists - -#### Defined in - -[generated-client/api/artists-api.ts:1051](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1051) diff --git a/docs/interfaces/generated_client.AudioApiGetAudioStreamByContainerRequest.md b/docs/interfaces/generated_client.AudioApiGetAudioStreamByContainerRequest.md deleted file mode 100644 index 88b9f12dd..000000000 --- a/docs/interfaces/generated_client.AudioApiGetAudioStreamByContainerRequest.md +++ /dev/null @@ -1,755 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AudioApiGetAudioStreamByContainerRequest - -# Interface: AudioApiGetAudioStreamByContainerRequest - -[generated-client](../modules/generated_client.md).AudioApiGetAudioStreamByContainerRequest - -Request parameters for getAudioStreamByContainer operation in AudioApi. - -**`export`** - -**`interface`** AudioApiGetAudioStreamByContainerRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.AudioApiGetAudioStreamByContainerRequest.md#_static) -- [allowAudioStreamCopy](generated_client.AudioApiGetAudioStreamByContainerRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.AudioApiGetAudioStreamByContainerRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.AudioApiGetAudioStreamByContainerRequest.md#audiobitrate) -- [audioChannels](generated_client.AudioApiGetAudioStreamByContainerRequest.md#audiochannels) -- [audioCodec](generated_client.AudioApiGetAudioStreamByContainerRequest.md#audiocodec) -- [audioSampleRate](generated_client.AudioApiGetAudioStreamByContainerRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.AudioApiGetAudioStreamByContainerRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.AudioApiGetAudioStreamByContainerRequest.md#breakonnonkeyframes) -- [container](generated_client.AudioApiGetAudioStreamByContainerRequest.md#container) -- [context](generated_client.AudioApiGetAudioStreamByContainerRequest.md#context) -- [copyTimestamps](generated_client.AudioApiGetAudioStreamByContainerRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.AudioApiGetAudioStreamByContainerRequest.md#cpucorelimit) -- [deInterlace](generated_client.AudioApiGetAudioStreamByContainerRequest.md#deinterlace) -- [deviceId](generated_client.AudioApiGetAudioStreamByContainerRequest.md#deviceid) -- [deviceProfileId](generated_client.AudioApiGetAudioStreamByContainerRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.AudioApiGetAudioStreamByContainerRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.AudioApiGetAudioStreamByContainerRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.AudioApiGetAudioStreamByContainerRequest.md#framerate) -- [height](generated_client.AudioApiGetAudioStreamByContainerRequest.md#height) -- [itemId](generated_client.AudioApiGetAudioStreamByContainerRequest.md#itemid) -- [level](generated_client.AudioApiGetAudioStreamByContainerRequest.md#level) -- [liveStreamId](generated_client.AudioApiGetAudioStreamByContainerRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.AudioApiGetAudioStreamByContainerRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.AudioApiGetAudioStreamByContainerRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.AudioApiGetAudioStreamByContainerRequest.md#maxframerate) -- [maxRefFrames](generated_client.AudioApiGetAudioStreamByContainerRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.AudioApiGetAudioStreamByContainerRequest.md#maxvideobitdepth) -- [mediaSourceId](generated_client.AudioApiGetAudioStreamByContainerRequest.md#mediasourceid) -- [minSegments](generated_client.AudioApiGetAudioStreamByContainerRequest.md#minsegments) -- [params](generated_client.AudioApiGetAudioStreamByContainerRequest.md#params) -- [playSessionId](generated_client.AudioApiGetAudioStreamByContainerRequest.md#playsessionid) -- [profile](generated_client.AudioApiGetAudioStreamByContainerRequest.md#profile) -- [requireAvc](generated_client.AudioApiGetAudioStreamByContainerRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.AudioApiGetAudioStreamByContainerRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.AudioApiGetAudioStreamByContainerRequest.md#segmentcontainer) -- [segmentLength](generated_client.AudioApiGetAudioStreamByContainerRequest.md#segmentlength) -- [startTimeTicks](generated_client.AudioApiGetAudioStreamByContainerRequest.md#starttimeticks) -- [streamOptions](generated_client.AudioApiGetAudioStreamByContainerRequest.md#streamoptions) -- [subtitleCodec](generated_client.AudioApiGetAudioStreamByContainerRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.AudioApiGetAudioStreamByContainerRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.AudioApiGetAudioStreamByContainerRequest.md#subtitlestreamindex) -- [tag](generated_client.AudioApiGetAudioStreamByContainerRequest.md#tag) -- [transcodeReasons](generated_client.AudioApiGetAudioStreamByContainerRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.AudioApiGetAudioStreamByContainerRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.AudioApiGetAudioStreamByContainerRequest.md#videobitrate) -- [videoCodec](generated_client.AudioApiGetAudioStreamByContainerRequest.md#videocodec) -- [videoStreamIndex](generated_client.AudioApiGetAudioStreamByContainerRequest.md#videostreamindex) -- [width](generated_client.AudioApiGetAudioStreamByContainerRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:1993](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1993) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2084](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2084) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2077](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2077) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2112](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2112) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2119](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2119) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2063](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2063) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2098](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2098) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2294](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2294) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2091](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2091) - -___ - -### container - -• `Readonly` **container**: `string` - -The audio container. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:1986](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1986) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2308](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2308) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2161](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2161) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2252](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2252) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2231](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2231) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2056](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2056) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2014](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2014) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2070](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2070) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2266](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2266) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2147](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2147) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2182](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2182) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:1979](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1979) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2140](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2140) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2259](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2259) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2105](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2105) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2126](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2126) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2154](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2154) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2210](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2210) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2217](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2217) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2049](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2049) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2042](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2042) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2000](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2000) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2021](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2021) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2133](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2133) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2224](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2224) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamporphic stream. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2238](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2238) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2028](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2028) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment lenght. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2035](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2035) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2168](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2168) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/audio-api.ts:2315](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2315) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2280](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2280) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2203](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2203) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2196](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2196) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2007](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2007) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2287](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2287) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2245](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2245) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2189](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2189) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2273](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2273) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2301](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2301) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** AudioApiGetAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2175](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2175) diff --git a/docs/interfaces/generated_client.AudioApiGetAudioStreamRequest.md b/docs/interfaces/generated_client.AudioApiGetAudioStreamRequest.md deleted file mode 100644 index 8b5d52f72..000000000 --- a/docs/interfaces/generated_client.AudioApiGetAudioStreamRequest.md +++ /dev/null @@ -1,755 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AudioApiGetAudioStreamRequest - -# Interface: AudioApiGetAudioStreamRequest - -[generated-client](../modules/generated_client.md).AudioApiGetAudioStreamRequest - -Request parameters for getAudioStream operation in AudioApi. - -**`export`** - -**`interface`** AudioApiGetAudioStreamRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.AudioApiGetAudioStreamRequest.md#_static) -- [allowAudioStreamCopy](generated_client.AudioApiGetAudioStreamRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.AudioApiGetAudioStreamRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.AudioApiGetAudioStreamRequest.md#audiobitrate) -- [audioChannels](generated_client.AudioApiGetAudioStreamRequest.md#audiochannels) -- [audioCodec](generated_client.AudioApiGetAudioStreamRequest.md#audiocodec) -- [audioSampleRate](generated_client.AudioApiGetAudioStreamRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.AudioApiGetAudioStreamRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.AudioApiGetAudioStreamRequest.md#breakonnonkeyframes) -- [container](generated_client.AudioApiGetAudioStreamRequest.md#container) -- [context](generated_client.AudioApiGetAudioStreamRequest.md#context) -- [copyTimestamps](generated_client.AudioApiGetAudioStreamRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.AudioApiGetAudioStreamRequest.md#cpucorelimit) -- [deInterlace](generated_client.AudioApiGetAudioStreamRequest.md#deinterlace) -- [deviceId](generated_client.AudioApiGetAudioStreamRequest.md#deviceid) -- [deviceProfileId](generated_client.AudioApiGetAudioStreamRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.AudioApiGetAudioStreamRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.AudioApiGetAudioStreamRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.AudioApiGetAudioStreamRequest.md#framerate) -- [height](generated_client.AudioApiGetAudioStreamRequest.md#height) -- [itemId](generated_client.AudioApiGetAudioStreamRequest.md#itemid) -- [level](generated_client.AudioApiGetAudioStreamRequest.md#level) -- [liveStreamId](generated_client.AudioApiGetAudioStreamRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.AudioApiGetAudioStreamRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.AudioApiGetAudioStreamRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.AudioApiGetAudioStreamRequest.md#maxframerate) -- [maxRefFrames](generated_client.AudioApiGetAudioStreamRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.AudioApiGetAudioStreamRequest.md#maxvideobitdepth) -- [mediaSourceId](generated_client.AudioApiGetAudioStreamRequest.md#mediasourceid) -- [minSegments](generated_client.AudioApiGetAudioStreamRequest.md#minsegments) -- [params](generated_client.AudioApiGetAudioStreamRequest.md#params) -- [playSessionId](generated_client.AudioApiGetAudioStreamRequest.md#playsessionid) -- [profile](generated_client.AudioApiGetAudioStreamRequest.md#profile) -- [requireAvc](generated_client.AudioApiGetAudioStreamRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.AudioApiGetAudioStreamRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.AudioApiGetAudioStreamRequest.md#segmentcontainer) -- [segmentLength](generated_client.AudioApiGetAudioStreamRequest.md#segmentlength) -- [startTimeTicks](generated_client.AudioApiGetAudioStreamRequest.md#starttimeticks) -- [streamOptions](generated_client.AudioApiGetAudioStreamRequest.md#streamoptions) -- [subtitleCodec](generated_client.AudioApiGetAudioStreamRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.AudioApiGetAudioStreamRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.AudioApiGetAudioStreamRequest.md#subtitlestreamindex) -- [tag](generated_client.AudioApiGetAudioStreamRequest.md#tag) -- [transcodeReasons](generated_client.AudioApiGetAudioStreamRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.AudioApiGetAudioStreamRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.AudioApiGetAudioStreamRequest.md#videobitrate) -- [videoCodec](generated_client.AudioApiGetAudioStreamRequest.md#videocodec) -- [videoStreamIndex](generated_client.AudioApiGetAudioStreamRequest.md#videostreamindex) -- [width](generated_client.AudioApiGetAudioStreamRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1643](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1643) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1734](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1734) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1727](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1727) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1762](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1762) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1769](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1769) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1713](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1713) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1748](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1748) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1944](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1944) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1741](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1741) - -___ - -### container - -• `Optional` `Readonly` **container**: `string` - -The audio container. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1636](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1636) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1958](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1958) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1811](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1811) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1902](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1902) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1881](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1881) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1706](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1706) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1664](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1664) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1720](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1720) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1916](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1916) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1797](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1797) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1832](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1832) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1629](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1629) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1790](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1790) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1909](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1909) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1755](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1755) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1776](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1776) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1804](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1804) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1860](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1860) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1867](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1867) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1699](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1699) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1692](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1692) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1650](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1650) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1671](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1671) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1783](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1783) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1874](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1874) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1888](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1888) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1678](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1678) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1685](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1685) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1818](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1818) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** AudioApiGetAudioStream - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/audio-api.ts:1965](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1965) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1930](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1930) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1853](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1853) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1846](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1846) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1657](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1657) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1937](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1937) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1895](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1895) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1839](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1839) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1923](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1923) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1951](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1951) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** AudioApiGetAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:1825](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1825) diff --git a/docs/interfaces/generated_client.AudioApiHeadAudioStreamByContainerRequest.md b/docs/interfaces/generated_client.AudioApiHeadAudioStreamByContainerRequest.md deleted file mode 100644 index be21a50f7..000000000 --- a/docs/interfaces/generated_client.AudioApiHeadAudioStreamByContainerRequest.md +++ /dev/null @@ -1,755 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AudioApiHeadAudioStreamByContainerRequest - -# Interface: AudioApiHeadAudioStreamByContainerRequest - -[generated-client](../modules/generated_client.md).AudioApiHeadAudioStreamByContainerRequest - -Request parameters for headAudioStreamByContainer operation in AudioApi. - -**`export`** - -**`interface`** AudioApiHeadAudioStreamByContainerRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#_static) -- [allowAudioStreamCopy](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#audiobitrate) -- [audioChannels](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#audiochannels) -- [audioCodec](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#audiocodec) -- [audioSampleRate](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#breakonnonkeyframes) -- [container](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#container) -- [context](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#context) -- [copyTimestamps](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#cpucorelimit) -- [deInterlace](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#deinterlace) -- [deviceId](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#deviceid) -- [deviceProfileId](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#framerate) -- [height](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#height) -- [itemId](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#itemid) -- [level](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#level) -- [liveStreamId](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#maxframerate) -- [maxRefFrames](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#maxvideobitdepth) -- [mediaSourceId](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#mediasourceid) -- [minSegments](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#minsegments) -- [params](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#params) -- [playSessionId](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#playsessionid) -- [profile](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#profile) -- [requireAvc](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#segmentcontainer) -- [segmentLength](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#segmentlength) -- [startTimeTicks](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#starttimeticks) -- [streamOptions](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#streamoptions) -- [subtitleCodec](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#subtitlestreamindex) -- [tag](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#tag) -- [transcodeReasons](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#videobitrate) -- [videoCodec](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#videocodec) -- [videoStreamIndex](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#videostreamindex) -- [width](generated_client.AudioApiHeadAudioStreamByContainerRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2693](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2693) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2784](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2784) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2777](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2777) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2812](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2812) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2819](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2819) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2763](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2763) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2798](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2798) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2994](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2994) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2791](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2791) - -___ - -### container - -• `Readonly` **container**: `string` - -The audio container. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2686](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2686) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:3008](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3008) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2861](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2861) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2952](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2952) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2931](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2931) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2756](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2756) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2714](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2714) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2770](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2770) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2966](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2966) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2847](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2847) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2882](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2882) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2679](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2679) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2840](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2840) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2959](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2959) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2805](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2805) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2826](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2826) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2854](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2854) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2910](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2910) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2917](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2917) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2749](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2749) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2742](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2742) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2700](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2700) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2721](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2721) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2833](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2833) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2924](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2924) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamporphic stream. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2938](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2938) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2728](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2728) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment lenght. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2735](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2735) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2868](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2868) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/audio-api.ts:3015](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3015) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2980](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2980) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2903](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2903) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2896](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2896) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2707](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2707) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2987](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2987) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2945](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2945) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2889](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2889) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2973](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2973) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:3001](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3001) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** AudioApiHeadAudioStreamByContainer - -#### Defined in - -[generated-client/api/audio-api.ts:2875](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2875) diff --git a/docs/interfaces/generated_client.AudioApiHeadAudioStreamRequest.md b/docs/interfaces/generated_client.AudioApiHeadAudioStreamRequest.md deleted file mode 100644 index 8982f6e51..000000000 --- a/docs/interfaces/generated_client.AudioApiHeadAudioStreamRequest.md +++ /dev/null @@ -1,755 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AudioApiHeadAudioStreamRequest - -# Interface: AudioApiHeadAudioStreamRequest - -[generated-client](../modules/generated_client.md).AudioApiHeadAudioStreamRequest - -Request parameters for headAudioStream operation in AudioApi. - -**`export`** - -**`interface`** AudioApiHeadAudioStreamRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.AudioApiHeadAudioStreamRequest.md#_static) -- [allowAudioStreamCopy](generated_client.AudioApiHeadAudioStreamRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.AudioApiHeadAudioStreamRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.AudioApiHeadAudioStreamRequest.md#audiobitrate) -- [audioChannels](generated_client.AudioApiHeadAudioStreamRequest.md#audiochannels) -- [audioCodec](generated_client.AudioApiHeadAudioStreamRequest.md#audiocodec) -- [audioSampleRate](generated_client.AudioApiHeadAudioStreamRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.AudioApiHeadAudioStreamRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.AudioApiHeadAudioStreamRequest.md#breakonnonkeyframes) -- [container](generated_client.AudioApiHeadAudioStreamRequest.md#container) -- [context](generated_client.AudioApiHeadAudioStreamRequest.md#context) -- [copyTimestamps](generated_client.AudioApiHeadAudioStreamRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.AudioApiHeadAudioStreamRequest.md#cpucorelimit) -- [deInterlace](generated_client.AudioApiHeadAudioStreamRequest.md#deinterlace) -- [deviceId](generated_client.AudioApiHeadAudioStreamRequest.md#deviceid) -- [deviceProfileId](generated_client.AudioApiHeadAudioStreamRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.AudioApiHeadAudioStreamRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.AudioApiHeadAudioStreamRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.AudioApiHeadAudioStreamRequest.md#framerate) -- [height](generated_client.AudioApiHeadAudioStreamRequest.md#height) -- [itemId](generated_client.AudioApiHeadAudioStreamRequest.md#itemid) -- [level](generated_client.AudioApiHeadAudioStreamRequest.md#level) -- [liveStreamId](generated_client.AudioApiHeadAudioStreamRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.AudioApiHeadAudioStreamRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.AudioApiHeadAudioStreamRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.AudioApiHeadAudioStreamRequest.md#maxframerate) -- [maxRefFrames](generated_client.AudioApiHeadAudioStreamRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.AudioApiHeadAudioStreamRequest.md#maxvideobitdepth) -- [mediaSourceId](generated_client.AudioApiHeadAudioStreamRequest.md#mediasourceid) -- [minSegments](generated_client.AudioApiHeadAudioStreamRequest.md#minsegments) -- [params](generated_client.AudioApiHeadAudioStreamRequest.md#params) -- [playSessionId](generated_client.AudioApiHeadAudioStreamRequest.md#playsessionid) -- [profile](generated_client.AudioApiHeadAudioStreamRequest.md#profile) -- [requireAvc](generated_client.AudioApiHeadAudioStreamRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.AudioApiHeadAudioStreamRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.AudioApiHeadAudioStreamRequest.md#segmentcontainer) -- [segmentLength](generated_client.AudioApiHeadAudioStreamRequest.md#segmentlength) -- [startTimeTicks](generated_client.AudioApiHeadAudioStreamRequest.md#starttimeticks) -- [streamOptions](generated_client.AudioApiHeadAudioStreamRequest.md#streamoptions) -- [subtitleCodec](generated_client.AudioApiHeadAudioStreamRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.AudioApiHeadAudioStreamRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.AudioApiHeadAudioStreamRequest.md#subtitlestreamindex) -- [tag](generated_client.AudioApiHeadAudioStreamRequest.md#tag) -- [transcodeReasons](generated_client.AudioApiHeadAudioStreamRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.AudioApiHeadAudioStreamRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.AudioApiHeadAudioStreamRequest.md#videobitrate) -- [videoCodec](generated_client.AudioApiHeadAudioStreamRequest.md#videocodec) -- [videoStreamIndex](generated_client.AudioApiHeadAudioStreamRequest.md#videostreamindex) -- [width](generated_client.AudioApiHeadAudioStreamRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2343](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2343) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2434](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2434) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2427](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2427) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2462](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2462) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2469](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2469) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2413](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2413) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2448](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2448) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2644](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2644) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2441](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2441) - -___ - -### container - -• `Optional` `Readonly` **container**: `string` - -The audio container. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2336](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2336) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2658](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2658) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2511](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2511) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2602](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2602) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2581](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2581) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2406](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2406) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2364](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2364) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2420](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2420) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2616](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2616) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2497](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2497) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2532](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2532) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2329](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2329) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2490](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2490) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2609](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2609) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2455](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2455) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2476](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2476) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2504](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2504) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2560](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2560) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2567](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2567) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2399](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2399) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2392](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2392) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2350](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2350) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2371](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2371) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2483](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2483) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2574](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2574) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2588](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2588) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2378](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2378) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2385](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2385) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2518](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2518) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** AudioApiHeadAudioStream - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/audio-api.ts:2665](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2665) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2630](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2630) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2553](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2553) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2546](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2546) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2357](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2357) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2637](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2637) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2595](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2595) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2539](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2539) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2623](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2623) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2651](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2651) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** AudioApiHeadAudioStream - -#### Defined in - -[generated-client/api/audio-api.ts:2525](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L2525) diff --git a/docs/interfaces/generated_client.AuthenticateUserByName.md b/docs/interfaces/generated_client.AuthenticateUserByName.md deleted file mode 100644 index 9bb4b6656..000000000 --- a/docs/interfaces/generated_client.AuthenticateUserByName.md +++ /dev/null @@ -1,63 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AuthenticateUserByName - -# Interface: AuthenticateUserByName - -[generated-client](../modules/generated_client.md).AuthenticateUserByName - -The authenticate user by name request body. - -**`export`** - -**`interface`** AuthenticateUserByName - -## Table of contents - -### Properties - -- [Password](generated_client.AuthenticateUserByName.md#password) -- [Pw](generated_client.AuthenticateUserByName.md#pw) -- [Username](generated_client.AuthenticateUserByName.md#username) - -## Properties - -### Password - -• `Optional` **Password**: ``null`` \| `string` - -Gets or sets the sha1-hashed password. - -**`memberof`** AuthenticateUserByName - -**`deprecated`** - -#### Defined in - -[generated-client/models/authenticate-user-by-name.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authenticate-user-by-name.ts#L41) - -___ - -### Pw - -• `Optional` **Pw**: ``null`` \| `string` - -Gets or sets the plain text password. - -**`memberof`** AuthenticateUserByName - -#### Defined in - -[generated-client/models/authenticate-user-by-name.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authenticate-user-by-name.ts#L34) - -___ - -### Username - -• `Optional` **Username**: ``null`` \| `string` - -Gets or sets the username. - -**`memberof`** AuthenticateUserByName - -#### Defined in - -[generated-client/models/authenticate-user-by-name.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authenticate-user-by-name.ts#L28) diff --git a/docs/interfaces/generated_client.AuthenticationInfo.md b/docs/interfaces/generated_client.AuthenticationInfo.md deleted file mode 100644 index 486d5960f..000000000 --- a/docs/interfaces/generated_client.AuthenticationInfo.md +++ /dev/null @@ -1,190 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AuthenticationInfo - -# Interface: AuthenticationInfo - -[generated-client](../modules/generated_client.md).AuthenticationInfo - -**`export`** - -**`interface`** AuthenticationInfo - -## Table of contents - -### Properties - -- [AccessToken](generated_client.AuthenticationInfo.md#accesstoken) -- [AppName](generated_client.AuthenticationInfo.md#appname) -- [AppVersion](generated_client.AuthenticationInfo.md#appversion) -- [DateCreated](generated_client.AuthenticationInfo.md#datecreated) -- [DateLastActivity](generated_client.AuthenticationInfo.md#datelastactivity) -- [DateRevoked](generated_client.AuthenticationInfo.md#daterevoked) -- [DeviceId](generated_client.AuthenticationInfo.md#deviceid) -- [DeviceName](generated_client.AuthenticationInfo.md#devicename) -- [Id](generated_client.AuthenticationInfo.md#id) -- [IsActive](generated_client.AuthenticationInfo.md#isactive) -- [UserId](generated_client.AuthenticationInfo.md#userid) -- [UserName](generated_client.AuthenticationInfo.md#username) - -## Properties - -### AccessToken - -• `Optional` **AccessToken**: ``null`` \| `string` - -Gets or sets the access token. - -**`memberof`** AuthenticationInfo - -#### Defined in - -[generated-client/models/authentication-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info.ts#L34) - -___ - -### AppName - -• `Optional` **AppName**: ``null`` \| `string` - -Gets or sets the name of the application. - -**`memberof`** AuthenticationInfo - -#### Defined in - -[generated-client/models/authentication-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info.ts#L46) - -___ - -### AppVersion - -• `Optional` **AppVersion**: ``null`` \| `string` - -Gets or sets the application version. - -**`memberof`** AuthenticationInfo - -#### Defined in - -[generated-client/models/authentication-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info.ts#L52) - -___ - -### DateCreated - -• `Optional` **DateCreated**: `string` - -Gets or sets the date created. - -**`memberof`** AuthenticationInfo - -#### Defined in - -[generated-client/models/authentication-info.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info.ts#L76) - -___ - -### DateLastActivity - -• `Optional` **DateLastActivity**: `string` - -**`memberof`** AuthenticationInfo - -#### Defined in - -[generated-client/models/authentication-info.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info.ts#L88) - -___ - -### DateRevoked - -• `Optional` **DateRevoked**: ``null`` \| `string` - -Gets or sets the date revoked. - -**`memberof`** AuthenticationInfo - -#### Defined in - -[generated-client/models/authentication-info.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info.ts#L82) - -___ - -### DeviceId - -• `Optional` **DeviceId**: ``null`` \| `string` - -Gets or sets the device identifier. - -**`memberof`** AuthenticationInfo - -#### Defined in - -[generated-client/models/authentication-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info.ts#L40) - -___ - -### DeviceName - -• `Optional` **DeviceName**: ``null`` \| `string` - -Gets or sets the name of the device. - -**`memberof`** AuthenticationInfo - -#### Defined in - -[generated-client/models/authentication-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info.ts#L58) - -___ - -### Id - -• `Optional` **Id**: `number` - -Gets or sets the identifier. - -**`memberof`** AuthenticationInfo - -#### Defined in - -[generated-client/models/authentication-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info.ts#L28) - -___ - -### IsActive - -• `Optional` **IsActive**: `boolean` - -Gets or sets a value indicating whether this instance is active. - -**`memberof`** AuthenticationInfo - -#### Defined in - -[generated-client/models/authentication-info.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info.ts#L70) - -___ - -### UserId - -• `Optional` **UserId**: `string` - -Gets or sets the user identifier. - -**`memberof`** AuthenticationInfo - -#### Defined in - -[generated-client/models/authentication-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info.ts#L64) - -___ - -### UserName - -• `Optional` **UserName**: ``null`` \| `string` - -**`memberof`** AuthenticationInfo - -#### Defined in - -[generated-client/models/authentication-info.ts:94](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info.ts#L94) diff --git a/docs/interfaces/generated_client.AuthenticationInfoQueryResult.md b/docs/interfaces/generated_client.AuthenticationInfoQueryResult.md deleted file mode 100644 index 24dc8a97d..000000000 --- a/docs/interfaces/generated_client.AuthenticationInfoQueryResult.md +++ /dev/null @@ -1,59 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AuthenticationInfoQueryResult - -# Interface: AuthenticationInfoQueryResult - -[generated-client](../modules/generated_client.md).AuthenticationInfoQueryResult - -**`export`** - -**`interface`** AuthenticationInfoQueryResult - -## Table of contents - -### Properties - -- [Items](generated_client.AuthenticationInfoQueryResult.md#items) -- [StartIndex](generated_client.AuthenticationInfoQueryResult.md#startindex) -- [TotalRecordCount](generated_client.AuthenticationInfoQueryResult.md#totalrecordcount) - -## Properties - -### Items - -• `Optional` **Items**: ``null`` \| [`AuthenticationInfo`](generated_client.AuthenticationInfo.md)[] - -Gets or sets the items. - -**`memberof`** AuthenticationInfoQueryResult - -#### Defined in - -[generated-client/models/authentication-info-query-result.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info-query-result.ts#L29) - -___ - -### StartIndex - -• `Optional` **StartIndex**: `number` - -Gets or sets the index of the first record in Items. - -**`memberof`** AuthenticationInfoQueryResult - -#### Defined in - -[generated-client/models/authentication-info-query-result.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info-query-result.ts#L41) - -___ - -### TotalRecordCount - -• `Optional` **TotalRecordCount**: `number` - -Gets or sets the total number of records available. - -**`memberof`** AuthenticationInfoQueryResult - -#### Defined in - -[generated-client/models/authentication-info-query-result.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-info-query-result.ts#L35) diff --git a/docs/interfaces/generated_client.AuthenticationResult.md b/docs/interfaces/generated_client.AuthenticationResult.md deleted file mode 100644 index f852d9e93..000000000 --- a/docs/interfaces/generated_client.AuthenticationResult.md +++ /dev/null @@ -1,66 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AuthenticationResult - -# Interface: AuthenticationResult - -[generated-client](../modules/generated_client.md).AuthenticationResult - -**`export`** - -**`interface`** AuthenticationResult - -## Table of contents - -### Properties - -- [AccessToken](generated_client.AuthenticationResult.md#accesstoken) -- [ServerId](generated_client.AuthenticationResult.md#serverid) -- [SessionInfo](generated_client.AuthenticationResult.md#sessioninfo) -- [User](generated_client.AuthenticationResult.md#user) - -## Properties - -### AccessToken - -• `Optional` **AccessToken**: ``null`` \| `string` - -**`memberof`** AuthenticationResult - -#### Defined in - -[generated-client/models/authentication-result.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-result.ts#L42) - -___ - -### ServerId - -• `Optional` **ServerId**: ``null`` \| `string` - -**`memberof`** AuthenticationResult - -#### Defined in - -[generated-client/models/authentication-result.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-result.ts#L48) - -___ - -### SessionInfo - -• `Optional` **SessionInfo**: [`SessionInfo`](generated_client.SessionInfo.md) - -**`memberof`** AuthenticationResult - -#### Defined in - -[generated-client/models/authentication-result.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-result.ts#L36) - -___ - -### User - -• `Optional` **User**: [`UserDto`](generated_client.UserDto.md) - -**`memberof`** AuthenticationResult - -#### Defined in - -[generated-client/models/authentication-result.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/authentication-result.ts#L30) diff --git a/docs/interfaces/generated_client.BaseItem.md b/docs/interfaces/generated_client.BaseItem.md deleted file mode 100644 index 59e941898..000000000 --- a/docs/interfaces/generated_client.BaseItem.md +++ /dev/null @@ -1,161 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BaseItem - -# Interface: BaseItem - -[generated-client](../modules/generated_client.md).BaseItem - -Class BaseItem. - -**`export`** - -**`interface`** BaseItem - -## Table of contents - -### Properties - -- [Container](generated_client.BaseItem.md#container) -- [DateLastSaved](generated_client.BaseItem.md#datelastsaved) -- [ExtraIds](generated_client.BaseItem.md#extraids) -- [Height](generated_client.BaseItem.md#height) -- [IsHD](generated_client.BaseItem.md#ishd) -- [IsShortcut](generated_client.BaseItem.md#isshortcut) -- [RemoteTrailers](generated_client.BaseItem.md#remotetrailers) -- [ShortcutPath](generated_client.BaseItem.md#shortcutpath) -- [Size](generated_client.BaseItem.md#size) -- [SupportsExternalTransfer](generated_client.BaseItem.md#supportsexternaltransfer) -- [Width](generated_client.BaseItem.md#width) - -## Properties - -### Container - -• `Optional` **Container**: ``null`` \| `string` - -**`memberof`** BaseItem - -#### Defined in - -[generated-client/models/base-item.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item.ts#L35) - -___ - -### DateLastSaved - -• `Optional` **DateLastSaved**: `string` - -**`memberof`** BaseItem - -#### Defined in - -[generated-client/models/base-item.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item.ts#L77) - -___ - -### ExtraIds - -• `Optional` **ExtraIds**: ``null`` \| `string`[] - -**`memberof`** BaseItem - -#### Defined in - -[generated-client/models/base-item.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item.ts#L71) - -___ - -### Height - -• `Optional` **Height**: `number` - -**`memberof`** BaseItem - -#### Defined in - -[generated-client/models/base-item.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item.ts#L65) - -___ - -### IsHD - -• `Optional` **IsHD**: `boolean` - -**`memberof`** BaseItem - -#### Defined in - -[generated-client/models/base-item.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item.ts#L41) - -___ - -### IsShortcut - -• `Optional` **IsShortcut**: `boolean` - -**`memberof`** BaseItem - -#### Defined in - -[generated-client/models/base-item.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item.ts#L47) - -___ - -### RemoteTrailers - -• `Optional` **RemoteTrailers**: ``null`` \| [`MediaUrl`](generated_client.MediaUrl.md)[] - -Gets or sets the remote trailers. - -**`memberof`** BaseItem - -#### Defined in - -[generated-client/models/base-item.ts:83](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item.ts#L83) - -___ - -### ShortcutPath - -• `Optional` **ShortcutPath**: ``null`` \| `string` - -**`memberof`** BaseItem - -#### Defined in - -[generated-client/models/base-item.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item.ts#L53) - -___ - -### Size - -• `Optional` **Size**: ``null`` \| `number` - -**`memberof`** BaseItem - -#### Defined in - -[generated-client/models/base-item.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item.ts#L29) - -___ - -### SupportsExternalTransfer - -• `Optional` **SupportsExternalTransfer**: `boolean` - -**`memberof`** BaseItem - -#### Defined in - -[generated-client/models/base-item.ts:89](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item.ts#L89) - -___ - -### Width - -• `Optional` **Width**: `number` - -**`memberof`** BaseItem - -#### Defined in - -[generated-client/models/base-item.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item.ts#L59) diff --git a/docs/interfaces/generated_client.BaseItemDto.md b/docs/interfaces/generated_client.BaseItemDto.md deleted file mode 100644 index b092a2d9f..000000000 --- a/docs/interfaces/generated_client.BaseItemDto.md +++ /dev/null @@ -1,2189 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BaseItemDto - -# Interface: BaseItemDto - -[generated-client](../modules/generated_client.md).BaseItemDto - -This is strictly used as a data transfer object from the api layer. This holds information about a BaseItem in a format that is convenient for the client. - -**`export`** - -**`interface`** BaseItemDto - -## Table of contents - -### Properties - -- [AirDays](generated_client.BaseItemDto.md#airdays) -- [AirTime](generated_client.BaseItemDto.md#airtime) -- [AirsAfterSeasonNumber](generated_client.BaseItemDto.md#airsafterseasonnumber) -- [AirsBeforeEpisodeNumber](generated_client.BaseItemDto.md#airsbeforeepisodenumber) -- [AirsBeforeSeasonNumber](generated_client.BaseItemDto.md#airsbeforeseasonnumber) -- [Album](generated_client.BaseItemDto.md#album) -- [AlbumArtist](generated_client.BaseItemDto.md#albumartist) -- [AlbumArtists](generated_client.BaseItemDto.md#albumartists) -- [AlbumCount](generated_client.BaseItemDto.md#albumcount) -- [AlbumId](generated_client.BaseItemDto.md#albumid) -- [AlbumPrimaryImageTag](generated_client.BaseItemDto.md#albumprimaryimagetag) -- [Altitude](generated_client.BaseItemDto.md#altitude) -- [Aperture](generated_client.BaseItemDto.md#aperture) -- [ArtistCount](generated_client.BaseItemDto.md#artistcount) -- [ArtistItems](generated_client.BaseItemDto.md#artistitems) -- [Artists](generated_client.BaseItemDto.md#artists) -- [AspectRatio](generated_client.BaseItemDto.md#aspectratio) -- [Audio](generated_client.BaseItemDto.md#audio) -- [BackdropImageTags](generated_client.BaseItemDto.md#backdropimagetags) -- [CameraMake](generated_client.BaseItemDto.md#cameramake) -- [CameraModel](generated_client.BaseItemDto.md#cameramodel) -- [CanDelete](generated_client.BaseItemDto.md#candelete) -- [CanDownload](generated_client.BaseItemDto.md#candownload) -- [ChannelId](generated_client.BaseItemDto.md#channelid) -- [ChannelName](generated_client.BaseItemDto.md#channelname) -- [ChannelNumber](generated_client.BaseItemDto.md#channelnumber) -- [ChannelPrimaryImageTag](generated_client.BaseItemDto.md#channelprimaryimagetag) -- [ChannelType](generated_client.BaseItemDto.md#channeltype) -- [Chapters](generated_client.BaseItemDto.md#chapters) -- [ChildCount](generated_client.BaseItemDto.md#childcount) -- [CollectionType](generated_client.BaseItemDto.md#collectiontype) -- [CommunityRating](generated_client.BaseItemDto.md#communityrating) -- [CompletionPercentage](generated_client.BaseItemDto.md#completionpercentage) -- [Container](generated_client.BaseItemDto.md#container) -- [CriticRating](generated_client.BaseItemDto.md#criticrating) -- [CumulativeRunTimeTicks](generated_client.BaseItemDto.md#cumulativeruntimeticks) -- [CurrentProgram](generated_client.BaseItemDto.md#currentprogram) -- [CustomRating](generated_client.BaseItemDto.md#customrating) -- [DateCreated](generated_client.BaseItemDto.md#datecreated) -- [DateLastMediaAdded](generated_client.BaseItemDto.md#datelastmediaadded) -- [DisplayOrder](generated_client.BaseItemDto.md#displayorder) -- [DisplayPreferencesId](generated_client.BaseItemDto.md#displaypreferencesid) -- [EnableMediaSourceDisplay](generated_client.BaseItemDto.md#enablemediasourcedisplay) -- [EndDate](generated_client.BaseItemDto.md#enddate) -- [EpisodeCount](generated_client.BaseItemDto.md#episodecount) -- [EpisodeTitle](generated_client.BaseItemDto.md#episodetitle) -- [Etag](generated_client.BaseItemDto.md#etag) -- [ExposureTime](generated_client.BaseItemDto.md#exposuretime) -- [ExternalUrls](generated_client.BaseItemDto.md#externalurls) -- [ExtraType](generated_client.BaseItemDto.md#extratype) -- [FocalLength](generated_client.BaseItemDto.md#focallength) -- [ForcedSortName](generated_client.BaseItemDto.md#forcedsortname) -- [GenreItems](generated_client.BaseItemDto.md#genreitems) -- [Genres](generated_client.BaseItemDto.md#genres) -- [HasSubtitles](generated_client.BaseItemDto.md#hassubtitles) -- [Height](generated_client.BaseItemDto.md#height) -- [Id](generated_client.BaseItemDto.md#id) -- [ImageBlurHashes](generated_client.BaseItemDto.md#imageblurhashes) -- [ImageOrientation](generated_client.BaseItemDto.md#imageorientation) -- [ImageTags](generated_client.BaseItemDto.md#imagetags) -- [IndexNumber](generated_client.BaseItemDto.md#indexnumber) -- [IndexNumberEnd](generated_client.BaseItemDto.md#indexnumberend) -- [IsFolder](generated_client.BaseItemDto.md#isfolder) -- [IsHD](generated_client.BaseItemDto.md#ishd) -- [IsKids](generated_client.BaseItemDto.md#iskids) -- [IsLive](generated_client.BaseItemDto.md#islive) -- [IsMovie](generated_client.BaseItemDto.md#ismovie) -- [IsNews](generated_client.BaseItemDto.md#isnews) -- [IsPlaceHolder](generated_client.BaseItemDto.md#isplaceholder) -- [IsPremiere](generated_client.BaseItemDto.md#ispremiere) -- [IsRepeat](generated_client.BaseItemDto.md#isrepeat) -- [IsSeries](generated_client.BaseItemDto.md#isseries) -- [IsSports](generated_client.BaseItemDto.md#issports) -- [IsoSpeedRating](generated_client.BaseItemDto.md#isospeedrating) -- [IsoType](generated_client.BaseItemDto.md#isotype) -- [Latitude](generated_client.BaseItemDto.md#latitude) -- [LocalTrailerCount](generated_client.BaseItemDto.md#localtrailercount) -- [LocationType](generated_client.BaseItemDto.md#locationtype) -- [LockData](generated_client.BaseItemDto.md#lockdata) -- [LockedFields](generated_client.BaseItemDto.md#lockedfields) -- [Longitude](generated_client.BaseItemDto.md#longitude) -- [MediaSourceCount](generated_client.BaseItemDto.md#mediasourcecount) -- [MediaSources](generated_client.BaseItemDto.md#mediasources) -- [MediaStreams](generated_client.BaseItemDto.md#mediastreams) -- [MediaType](generated_client.BaseItemDto.md#mediatype) -- [MovieCount](generated_client.BaseItemDto.md#moviecount) -- [MusicVideoCount](generated_client.BaseItemDto.md#musicvideocount) -- [Name](generated_client.BaseItemDto.md#name) -- [Number](generated_client.BaseItemDto.md#number) -- [OfficialRating](generated_client.BaseItemDto.md#officialrating) -- [OriginalTitle](generated_client.BaseItemDto.md#originaltitle) -- [Overview](generated_client.BaseItemDto.md#overview) -- [ParentArtImageTag](generated_client.BaseItemDto.md#parentartimagetag) -- [ParentArtItemId](generated_client.BaseItemDto.md#parentartitemid) -- [ParentBackdropImageTags](generated_client.BaseItemDto.md#parentbackdropimagetags) -- [ParentBackdropItemId](generated_client.BaseItemDto.md#parentbackdropitemid) -- [ParentId](generated_client.BaseItemDto.md#parentid) -- [ParentIndexNumber](generated_client.BaseItemDto.md#parentindexnumber) -- [ParentLogoImageTag](generated_client.BaseItemDto.md#parentlogoimagetag) -- [ParentLogoItemId](generated_client.BaseItemDto.md#parentlogoitemid) -- [ParentPrimaryImageItemId](generated_client.BaseItemDto.md#parentprimaryimageitemid) -- [ParentPrimaryImageTag](generated_client.BaseItemDto.md#parentprimaryimagetag) -- [ParentThumbImageTag](generated_client.BaseItemDto.md#parentthumbimagetag) -- [ParentThumbItemId](generated_client.BaseItemDto.md#parentthumbitemid) -- [PartCount](generated_client.BaseItemDto.md#partcount) -- [Path](generated_client.BaseItemDto.md#path) -- [People](generated_client.BaseItemDto.md#people) -- [PlayAccess](generated_client.BaseItemDto.md#playaccess) -- [PlaylistItemId](generated_client.BaseItemDto.md#playlistitemid) -- [PreferredMetadataCountryCode](generated_client.BaseItemDto.md#preferredmetadatacountrycode) -- [PreferredMetadataLanguage](generated_client.BaseItemDto.md#preferredmetadatalanguage) -- [PremiereDate](generated_client.BaseItemDto.md#premieredate) -- [PrimaryImageAspectRatio](generated_client.BaseItemDto.md#primaryimageaspectratio) -- [ProductionLocations](generated_client.BaseItemDto.md#productionlocations) -- [ProductionYear](generated_client.BaseItemDto.md#productionyear) -- [ProgramCount](generated_client.BaseItemDto.md#programcount) -- [ProgramId](generated_client.BaseItemDto.md#programid) -- [ProviderIds](generated_client.BaseItemDto.md#providerids) -- [RecursiveItemCount](generated_client.BaseItemDto.md#recursiveitemcount) -- [RemoteTrailers](generated_client.BaseItemDto.md#remotetrailers) -- [RunTimeTicks](generated_client.BaseItemDto.md#runtimeticks) -- [ScreenshotImageTags](generated_client.BaseItemDto.md#screenshotimagetags) -- [SeasonId](generated_client.BaseItemDto.md#seasonid) -- [SeasonName](generated_client.BaseItemDto.md#seasonname) -- [SeriesCount](generated_client.BaseItemDto.md#seriescount) -- [SeriesId](generated_client.BaseItemDto.md#seriesid) -- [SeriesName](generated_client.BaseItemDto.md#seriesname) -- [SeriesPrimaryImageTag](generated_client.BaseItemDto.md#seriesprimaryimagetag) -- [SeriesStudio](generated_client.BaseItemDto.md#seriesstudio) -- [SeriesThumbImageTag](generated_client.BaseItemDto.md#seriesthumbimagetag) -- [SeriesTimerId](generated_client.BaseItemDto.md#seriestimerid) -- [ServerId](generated_client.BaseItemDto.md#serverid) -- [ShutterSpeed](generated_client.BaseItemDto.md#shutterspeed) -- [Software](generated_client.BaseItemDto.md#software) -- [SongCount](generated_client.BaseItemDto.md#songcount) -- [SortName](generated_client.BaseItemDto.md#sortname) -- [SourceType](generated_client.BaseItemDto.md#sourcetype) -- [SpecialFeatureCount](generated_client.BaseItemDto.md#specialfeaturecount) -- [StartDate](generated_client.BaseItemDto.md#startdate) -- [Status](generated_client.BaseItemDto.md#status) -- [Studios](generated_client.BaseItemDto.md#studios) -- [SupportsSync](generated_client.BaseItemDto.md#supportssync) -- [Taglines](generated_client.BaseItemDto.md#taglines) -- [Tags](generated_client.BaseItemDto.md#tags) -- [TimerId](generated_client.BaseItemDto.md#timerid) -- [TrailerCount](generated_client.BaseItemDto.md#trailercount) -- [Type](generated_client.BaseItemDto.md#type) -- [UserData](generated_client.BaseItemDto.md#userdata) -- [Video3DFormat](generated_client.BaseItemDto.md#video3dformat) -- [VideoType](generated_client.BaseItemDto.md#videotype) -- [Width](generated_client.BaseItemDto.md#width) - -## Properties - -### AirDays - -• `Optional` **AirDays**: ``null`` \| [`DayOfWeek`](../enums/generated_client.DayOfWeek.md)[] - -Gets or sets the air days. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:480](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L480) - -___ - -### AirTime - -• `Optional` **AirTime**: ``null`` \| `string` - -Gets or sets the air time. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:474](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L474) - -___ - -### AirsAfterSeasonNumber - -• `Optional` **AirsAfterSeasonNumber**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:114](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L114) - -___ - -### AirsBeforeEpisodeNumber - -• `Optional` **AirsBeforeEpisodeNumber**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:120](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L120) - -___ - -### AirsBeforeSeasonNumber - -• `Optional` **AirsBeforeSeasonNumber**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:108](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L108) - -___ - -### Album - -• `Optional` **Album**: ``null`` \| `string` - -Gets or sets the album. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:510](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L510) - -___ - -### AlbumArtist - -• `Optional` **AlbumArtist**: ``null`` \| `string` - -Gets or sets the album artist. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:546](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L546) - -___ - -### AlbumArtists - -• `Optional` **AlbumArtists**: ``null`` \| [`NameGuidPair`](generated_client.NameGuidPair.md)[] - -Gets or sets the album artists. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:552](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L552) - -___ - -### AlbumCount - -• `Optional` **AlbumCount**: ``null`` \| `number` - -Gets or sets the album count. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:738](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L738) - -___ - -### AlbumId - -• `Optional` **AlbumId**: ``null`` \| `string` - -Gets or sets the album id. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:528](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L528) - -___ - -### AlbumPrimaryImageTag - -• `Optional` **AlbumPrimaryImageTag**: ``null`` \| `string` - -Gets or sets the album image tag. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:534](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L534) - -___ - -### Altitude - -• `Optional` **Altitude**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:834](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L834) - -___ - -### Aperture - -• `Optional` **Aperture**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:810](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L810) - -___ - -### ArtistCount - -• `Optional` **ArtistCount**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:744](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L744) - -___ - -### ArtistItems - -• `Optional` **ArtistItems**: ``null`` \| [`NameGuidPair`](generated_client.NameGuidPair.md)[] - -Gets or sets the artist items. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:504](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L504) - -___ - -### Artists - -• `Optional` **Artists**: ``null`` \| `string`[] - -Gets or sets the artists. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:498](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L498) - -___ - -### AspectRatio - -• `Optional` **AspectRatio**: ``null`` \| `string` - -Gets or sets the aspect ratio. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:294](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L294) - -___ - -### Audio - -• `Optional` **Audio**: [`ProgramAudio`](../enums/generated_client.ProgramAudio.md) - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:894](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L894) - -___ - -### BackdropImageTags - -• `Optional` **BackdropImageTags**: ``null`` \| `string`[] - -Gets or sets the backdrop image tags. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:594](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L594) - -___ - -### CameraMake - -• `Optional` **CameraMake**: ``null`` \| `string` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:774](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L774) - -___ - -### CameraModel - -• `Optional` **CameraModel**: ``null`` \| `string` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:780](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L780) - -___ - -### CanDelete - -• `Optional` **CanDelete**: ``null`` \| `boolean` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:126](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L126) - -___ - -### CanDownload - -• `Optional` **CanDownload**: ``null`` \| `boolean` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:132](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L132) - -___ - -### ChannelId - -• `Optional` **ChannelId**: ``null`` \| `string` - -Gets or sets the channel identifier. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:240](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L240) - -___ - -### ChannelName - -• `Optional` **ChannelName**: ``null`` \| `string` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:246](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L246) - -___ - -### ChannelNumber - -• `Optional` **ChannelNumber**: ``null`` \| `string` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:318](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L318) - -___ - -### ChannelPrimaryImageTag - -• `Optional` **ChannelPrimaryImageTag**: ``null`` \| `string` - -Gets or sets the channel primary image tag. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:858](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L858) - -___ - -### ChannelType - -• `Optional` **ChannelType**: [`ChannelType`](../enums/generated_client.ChannelType.md) - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:888](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L888) - -___ - -### Chapters - -• `Optional` **Chapters**: ``null`` \| [`ChapterInfo`](generated_client.ChapterInfo.md)[] - -Gets or sets the chapters. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:666](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L666) - -___ - -### ChildCount - -• `Optional` **ChildCount**: ``null`` \| `number` - -Gets or sets the child count. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:432](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L432) - -___ - -### CollectionType - -• `Optional` **CollectionType**: ``null`` \| `string` - -Gets or sets the type of the collection. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:516](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L516) - -___ - -### CommunityRating - -• `Optional` **CommunityRating**: ``null`` \| `number` - -Gets or sets the community rating. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:270](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L270) - -___ - -### CompletionPercentage - -• `Optional` **CompletionPercentage**: ``null`` \| `number` - -Gets or sets the completion percentage. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:870](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L870) - -___ - -### Container - -• `Optional` **Container**: ``null`` \| `string` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:162](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L162) - -___ - -### CriticRating - -• `Optional` **CriticRating**: ``null`` \| `number` - -Gets or sets the critic rating. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:204](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L204) - -___ - -### CumulativeRunTimeTicks - -• `Optional` **CumulativeRunTimeTicks**: ``null`` \| `number` - -Gets or sets the cumulative run time ticks. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:276](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L276) - -___ - -### CurrentProgram - -• `Optional` **CurrentProgram**: [`BaseItemDto`](generated_client.BaseItemDto.md) - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:948](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L948) - -___ - -### CustomRating - -• `Optional` **CustomRating**: ``null`` \| `string` - -Gets or sets the custom rating. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:234](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L234) - -___ - -### DateCreated - -• `Optional` **DateCreated**: ``null`` \| `string` - -Gets or sets the date created. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:90](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L90) - -___ - -### DateLastMediaAdded - -• `Optional` **DateLastMediaAdded**: ``null`` \| `string` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:96](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L96) - -___ - -### DisplayOrder - -• `Optional` **DisplayOrder**: ``null`` \| `string` - -Gets or sets the display order. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:522](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L522) - -___ - -### DisplayPreferencesId - -• `Optional` **DisplayPreferencesId**: ``null`` \| `string` - -Gets or sets the display preferences id. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:462](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L462) - -___ - -### EnableMediaSourceDisplay - -• `Optional` **EnableMediaSourceDisplay**: ``null`` \| `boolean` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:222](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L222) - -___ - -### EndDate - -• `Optional` **EndDate**: ``null`` \| `string` - -Gets or sets the end date. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:690](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L690) - -___ - -### EpisodeCount - -• `Optional` **EpisodeCount**: ``null`` \| `number` - -Gets or sets the episode count. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:726](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L726) - -___ - -### EpisodeTitle - -• `Optional` **EpisodeTitle**: ``null`` \| `string` - -Gets or sets the episode title. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:882](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L882) - -___ - -### Etag - -• `Optional` **Etag**: ``null`` \| `string` - -Gets or sets the etag. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L72) - -___ - -### ExposureTime - -• `Optional` **ExposureTime**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:792](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L792) - -___ - -### ExternalUrls - -• `Optional` **ExternalUrls**: ``null`` \| [`ExternalUrl`](generated_client.ExternalUrl.md)[] - -Gets or sets the external urls. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:192](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L192) - -___ - -### ExtraType - -• `Optional` **ExtraType**: ``null`` \| `string` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:102](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L102) - -___ - -### FocalLength - -• `Optional` **FocalLength**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:798](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L798) - -___ - -### ForcedSortName - -• `Optional` **ForcedSortName**: ``null`` \| `string` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:174](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L174) - -___ - -### GenreItems - -• `Optional` **GenreItems**: ``null`` \| [`NameGuidPair`](generated_client.NameGuidPair.md)[] - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:390](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L390) - -___ - -### Genres - -• `Optional` **Genres**: ``null`` \| `string`[] - -Gets or sets the genres. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:264](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L264) - -___ - -### HasSubtitles - -• `Optional` **HasSubtitles**: ``null`` \| `boolean` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:138](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L138) - -___ - -### Height - -• `Optional` **Height**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:768](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L768) - -___ - -### Id - -• `Optional` **Id**: `string` - -Gets or sets the id. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L66) - -___ - -### ImageBlurHashes - -• `Optional` **ImageBlurHashes**: ``null`` \| [`BaseItemDtoImageBlurHashes`](generated_client.BaseItemDtoImageBlurHashes.md) - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:630](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L630) - -___ - -### ImageOrientation - -• `Optional` **ImageOrientation**: [`ImageOrientation`](../enums/generated_client.ImageOrientation.md) - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:804](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L804) - -___ - -### ImageTags - -• `Optional` **ImageTags**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the image tags. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:588](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L588) - -___ - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -Gets or sets the index number. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:324](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L324) - -___ - -### IndexNumberEnd - -• `Optional` **IndexNumberEnd**: ``null`` \| `number` - -Gets or sets the index number end. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:330](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L330) - -___ - -### IsFolder - -• `Optional` **IsFolder**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this instance is folder. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:360](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L360) - -___ - -### IsHD - -• `Optional` **IsHD**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this instance is HD. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:354](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L354) - -___ - -### IsKids - -• `Optional` **IsKids**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this instance is kids. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:930](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L930) - -___ - -### IsLive - -• `Optional` **IsLive**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this instance is live. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:918](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L918) - -___ - -### IsMovie - -• `Optional` **IsMovie**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this instance is movie. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:900](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L900) - -___ - -### IsNews - -• `Optional` **IsNews**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this instance is news. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:924](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L924) - -___ - -### IsPlaceHolder - -• `Optional` **IsPlaceHolder**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this instance is place holder. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:306](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L306) - -___ - -### IsPremiere - -• `Optional` **IsPremiere**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this instance is premiere. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:936](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L936) - -___ - -### IsRepeat - -• `Optional` **IsRepeat**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this instance is repeat. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:876](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L876) - -___ - -### IsSeries - -• `Optional` **IsSeries**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this instance is series. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:912](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L912) - -___ - -### IsSports - -• `Optional` **IsSports**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this instance is sports. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:906](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L906) - -___ - -### IsoSpeedRating - -• `Optional` **IsoSpeedRating**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:840](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L840) - -___ - -### IsoType - -• `Optional` **IsoType**: [`IsoType`](../enums/generated_client.IsoType.md) - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:678](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L678) - -___ - -### Latitude - -• `Optional` **Latitude**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:822](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L822) - -___ - -### LocalTrailerCount - -• `Optional` **LocalTrailerCount**: ``null`` \| `number` - -Gets or sets the local trailer count. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:414](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L414) - -___ - -### LocationType - -• `Optional` **LocationType**: [`LocationType`](../enums/generated_client.LocationType.md) - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:672](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L672) - -___ - -### LockData - -• `Optional` **LockData**: ``null`` \| `boolean` - -Gets or sets a value indicating whether [enable internet providers]. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:756](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L756) - -___ - -### LockedFields - -• `Optional` **LockedFields**: ``null`` \| [`MetadataField`](../enums/generated_client.MetadataField.md)[] - -Gets or sets the locked fields. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:696](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L696) - -___ - -### Longitude - -• `Optional` **Longitude**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:828](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L828) - -___ - -### MediaSourceCount - -• `Optional` **MediaSourceCount**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:582](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L582) - -___ - -### MediaSources - -• `Optional` **MediaSources**: ``null`` \| [`MediaSourceInfo`](generated_client.MediaSourceInfo.md)[] - -Gets or sets the media versions. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:198](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L198) - -___ - -### MediaStreams - -• `Optional` **MediaStreams**: ``null`` \| [`MediaStream`](generated_client.MediaStream.md)[] - -Gets or sets the media streams. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:564](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L564) - -___ - -### MediaType - -• `Optional` **MediaType**: ``null`` \| `string` - -Gets or sets the type of the media. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:684](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L684) - -___ - -### MovieCount - -• `Optional` **MovieCount**: ``null`` \| `number` - -Gets or sets the movie count. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:708](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L708) - -___ - -### MusicVideoCount - -• `Optional` **MusicVideoCount**: ``null`` \| `number` - -Gets or sets the music video count. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:750](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L750) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L48) - -___ - -### Number - -• `Optional` **Number**: ``null`` \| `string` - -Gets or sets the number. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:312](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L312) - -___ - -### OfficialRating - -• `Optional` **OfficialRating**: ``null`` \| `string` - -Gets or sets the official rating. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:228](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L228) - -___ - -### OriginalTitle - -• `Optional` **OriginalTitle**: ``null`` \| `string` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L54) - -___ - -### Overview - -• `Optional` **Overview**: ``null`` \| `string` - -Gets or sets the overview. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:252](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L252) - -___ - -### ParentArtImageTag - -• `Optional` **ParentArtImageTag**: ``null`` \| `string` - -Gets or sets the parent art image tag. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:618](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L618) - -___ - -### ParentArtItemId - -• `Optional` **ParentArtItemId**: ``null`` \| `string` - -Gets or sets wether the item has fan art, this will hold the Id of the Parent that has one. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:612](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L612) - -___ - -### ParentBackdropImageTags - -• `Optional` **ParentBackdropImageTags**: ``null`` \| `string`[] - -Gets or sets the parent backdrop image tags. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:408](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L408) - -___ - -### ParentBackdropItemId - -• `Optional` **ParentBackdropItemId**: ``null`` \| `string` - -Gets or sets wether the item has any backdrops, this will hold the Id of the Parent that has one. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:402](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L402) - -___ - -### ParentId - -• `Optional` **ParentId**: ``null`` \| `string` - -Gets or sets the parent id. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:366](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L366) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -Gets or sets the parent index number. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:336](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L336) - -___ - -### ParentLogoImageTag - -• `Optional` **ParentLogoImageTag**: ``null`` \| `string` - -Gets or sets the parent logo image tag. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:606](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L606) - -___ - -### ParentLogoItemId - -• `Optional` **ParentLogoItemId**: ``null`` \| `string` - -Gets or sets wether the item has a logo, this will hold the Id of the Parent that has one. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:396](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L396) - -___ - -### ParentPrimaryImageItemId - -• `Optional` **ParentPrimaryImageItemId**: ``null`` \| `string` - -Gets or sets the parent primary image item identifier. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:654](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L654) - -___ - -### ParentPrimaryImageTag - -• `Optional` **ParentPrimaryImageTag**: ``null`` \| `string` - -Gets or sets the parent primary image tag. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:660](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L660) - -___ - -### ParentThumbImageTag - -• `Optional` **ParentThumbImageTag**: ``null`` \| `string` - -Gets or sets the parent thumb image tag. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:648](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L648) - -___ - -### ParentThumbItemId - -• `Optional` **ParentThumbItemId**: ``null`` \| `string` - -Gets or sets the parent thumb item id. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:642](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L642) - -___ - -### PartCount - -• `Optional` **PartCount**: ``null`` \| `number` - -Gets or sets the part count. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:576](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L576) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:216](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L216) - -___ - -### People - -• `Optional` **People**: ``null`` \| [`BaseItemPerson`](generated_client.BaseItemPerson.md)[] - -Gets or sets the people. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:378](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L378) - -___ - -### PlayAccess - -• `Optional` **PlayAccess**: [`PlayAccess`](../enums/generated_client.PlayAccess.md) - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:288](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L288) - -___ - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: ``null`` \| `string` - -Gets or sets the playlist item identifier. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L84) - -___ - -### PreferredMetadataCountryCode - -• `Optional` **PreferredMetadataCountryCode**: ``null`` \| `string` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:150](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L150) - -___ - -### PreferredMetadataLanguage - -• `Optional` **PreferredMetadataLanguage**: ``null`` \| `string` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:144](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L144) - -___ - -### PremiereDate - -• `Optional` **PremiereDate**: ``null`` \| `string` - -Gets or sets the premiere date. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:186](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L186) - -___ - -### PrimaryImageAspectRatio - -• `Optional` **PrimaryImageAspectRatio**: ``null`` \| `number` - -Gets or sets the primary image aspect ratio, after image enhancements. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:492](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L492) - -___ - -### ProductionLocations - -• `Optional` **ProductionLocations**: ``null`` \| `string`[] - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:210](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L210) - -___ - -### ProductionYear - -• `Optional` **ProductionYear**: ``null`` \| `number` - -Gets or sets the production year. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:300](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L300) - -___ - -### ProgramCount - -• `Optional` **ProgramCount**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:720](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L720) - -___ - -### ProgramId - -• `Optional` **ProgramId**: ``null`` \| `string` - -Gets or sets the program identifier. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:852](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L852) - -___ - -### ProviderIds - -• `Optional` **ProviderIds**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the provider ids. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:348](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L348) - -___ - -### RecursiveItemCount - -• `Optional` **RecursiveItemCount**: ``null`` \| `number` - -Gets or sets the recursive item count. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:426](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L426) - -___ - -### RemoteTrailers - -• `Optional` **RemoteTrailers**: ``null`` \| [`MediaUrl`](generated_client.MediaUrl.md)[] - -Gets or sets the trailer urls. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:342](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L342) - -___ - -### RunTimeTicks - -• `Optional` **RunTimeTicks**: ``null`` \| `number` - -Gets or sets the run time ticks. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:282](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L282) - -___ - -### ScreenshotImageTags - -• `Optional` **ScreenshotImageTags**: ``null`` \| `string`[] - -Gets or sets the screenshot image tags. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:600](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L600) - -___ - -### SeasonId - -• `Optional` **SeasonId**: ``null`` \| `string` - -Gets or sets the season identifier. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:450](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L450) - -___ - -### SeasonName - -• `Optional` **SeasonName**: ``null`` \| `string` - -Gets or sets the name of the season. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:558](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L558) - -___ - -### SeriesCount - -• `Optional` **SeriesCount**: ``null`` \| `number` - -Gets or sets the series count. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:714](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L714) - -___ - -### SeriesId - -• `Optional` **SeriesId**: ``null`` \| `string` - -Gets or sets the series id. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:444](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L444) - -___ - -### SeriesName - -• `Optional` **SeriesName**: ``null`` \| `string` - -Gets or sets the name of the series. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:438](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L438) - -___ - -### SeriesPrimaryImageTag - -• `Optional` **SeriesPrimaryImageTag**: ``null`` \| `string` - -Gets or sets the series primary image tag. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:540](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L540) - -___ - -### SeriesStudio - -• `Optional` **SeriesStudio**: ``null`` \| `string` - -Gets or sets the series studio. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:636](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L636) - -___ - -### SeriesThumbImageTag - -• `Optional` **SeriesThumbImageTag**: ``null`` \| `string` - -Gets or sets the series thumb image tag. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:624](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L624) - -___ - -### SeriesTimerId - -• `Optional` **SeriesTimerId**: ``null`` \| `string` - -Gets or sets the series timer identifier. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:846](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L846) - -___ - -### ServerId - -• `Optional` **ServerId**: ``null`` \| `string` - -Gets or sets the server identifier. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L60) - -___ - -### ShutterSpeed - -• `Optional` **ShutterSpeed**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:816](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L816) - -___ - -### Software - -• `Optional` **Software**: ``null`` \| `string` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:786](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L786) - -___ - -### SongCount - -• `Optional` **SongCount**: ``null`` \| `number` - -Gets or sets the song count. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:732](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L732) - -___ - -### SortName - -• `Optional` **SortName**: ``null`` \| `string` - -Gets or sets the name of the sort. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:168](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L168) - -___ - -### SourceType - -• `Optional` **SourceType**: ``null`` \| `string` - -Gets or sets the type of the source. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L78) - -___ - -### SpecialFeatureCount - -• `Optional` **SpecialFeatureCount**: ``null`` \| `number` - -Gets or sets the special feature count. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:456](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L456) - -___ - -### StartDate - -• `Optional` **StartDate**: ``null`` \| `string` - -Gets or sets the start date of the recording, in UTC. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:864](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L864) - -___ - -### Status - -• `Optional` **Status**: ``null`` \| `string` - -Gets or sets the status. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:468](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L468) - -___ - -### Studios - -• `Optional` **Studios**: ``null`` \| [`NameGuidPair`](generated_client.NameGuidPair.md)[] - -Gets or sets the studios. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:384](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L384) - -___ - -### SupportsSync - -• `Optional` **SupportsSync**: ``null`` \| `boolean` - -Gets or sets a value indicating whether [supports synchronize]. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:156](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L156) - -___ - -### Taglines - -• `Optional` **Taglines**: ``null`` \| `string`[] - -Gets or sets the taglines. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:258](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L258) - -___ - -### Tags - -• `Optional` **Tags**: ``null`` \| `string`[] - -Gets or sets the tags. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:486](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L486) - -___ - -### TimerId - -• `Optional` **TimerId**: ``null`` \| `string` - -Gets or sets the timer identifier. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:942](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L942) - -___ - -### TrailerCount - -• `Optional` **TrailerCount**: ``null`` \| `number` - -Gets or sets the trailer count. - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:702](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L702) - -___ - -### Type - -• `Optional` **Type**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md) - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:372](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L372) - -___ - -### UserData - -• `Optional` **UserData**: [`UserItemDataDto`](generated_client.UserItemDataDto.md) - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:420](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L420) - -___ - -### Video3DFormat - -• `Optional` **Video3DFormat**: [`Video3DFormat`](../enums/generated_client.Video3DFormat.md) - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:180](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L180) - -___ - -### VideoType - -• `Optional` **VideoType**: [`VideoType`](../enums/generated_client.VideoType.md) - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:570](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L570) - -___ - -### Width - -• `Optional` **Width**: ``null`` \| `number` - -**`memberof`** BaseItemDto - -#### Defined in - -[generated-client/models/base-item-dto.ts:762](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto.ts#L762) diff --git a/docs/interfaces/generated_client.BaseItemDtoImageBlurHashes.md b/docs/interfaces/generated_client.BaseItemDtoImageBlurHashes.md deleted file mode 100644 index 6a304d032..000000000 --- a/docs/interfaces/generated_client.BaseItemDtoImageBlurHashes.md +++ /dev/null @@ -1,237 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BaseItemDtoImageBlurHashes - -# Interface: BaseItemDtoImageBlurHashes - -[generated-client](../modules/generated_client.md).BaseItemDtoImageBlurHashes - -Gets or sets the blurhashes for the image tags. Maps image type to dictionary mapping image tag to blurhash value. - -**`export`** - -**`interface`** BaseItemDtoImageBlurHashes - -## Table of contents - -### Properties - -- [Art](generated_client.BaseItemDtoImageBlurHashes.md#art) -- [Backdrop](generated_client.BaseItemDtoImageBlurHashes.md#backdrop) -- [Banner](generated_client.BaseItemDtoImageBlurHashes.md#banner) -- [Box](generated_client.BaseItemDtoImageBlurHashes.md#box) -- [BoxRear](generated_client.BaseItemDtoImageBlurHashes.md#boxrear) -- [Chapter](generated_client.BaseItemDtoImageBlurHashes.md#chapter) -- [Disc](generated_client.BaseItemDtoImageBlurHashes.md#disc) -- [Logo](generated_client.BaseItemDtoImageBlurHashes.md#logo) -- [Menu](generated_client.BaseItemDtoImageBlurHashes.md#menu) -- [Primary](generated_client.BaseItemDtoImageBlurHashes.md#primary) -- [Profile](generated_client.BaseItemDtoImageBlurHashes.md#profile) -- [Screenshot](generated_client.BaseItemDtoImageBlurHashes.md#screenshot) -- [Thumb](generated_client.BaseItemDtoImageBlurHashes.md#thumb) - -## Properties - -### Art - -• `Optional` **Art**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L34) - -___ - -### Backdrop - -• `Optional` **Backdrop**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L40) - -___ - -### Banner - -• `Optional` **Banner**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L46) - -___ - -### Box - -• `Optional` **Box**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L70) - -___ - -### BoxRear - -• `Optional` **BoxRear**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:94](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L94) - -___ - -### Chapter - -• `Optional` **Chapter**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L88) - -___ - -### Disc - -• `Optional` **Disc**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L64) - -___ - -### Logo - -• `Optional` **Logo**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L52) - -___ - -### Menu - -• `Optional` **Menu**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L82) - -___ - -### Primary - -• `Optional` **Primary**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L28) - -___ - -### Profile - -• `Optional` **Profile**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:100](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L100) - -___ - -### Screenshot - -• `Optional` **Screenshot**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L76) - -___ - -### Thumb - -• `Optional` **Thumb**: `Object` - -**`memberof`** BaseItemDtoImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-dto-image-blur-hashes.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-image-blur-hashes.ts#L58) diff --git a/docs/interfaces/generated_client.BaseItemDtoQueryResult.md b/docs/interfaces/generated_client.BaseItemDtoQueryResult.md deleted file mode 100644 index 8cc0657ec..000000000 --- a/docs/interfaces/generated_client.BaseItemDtoQueryResult.md +++ /dev/null @@ -1,59 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BaseItemDtoQueryResult - -# Interface: BaseItemDtoQueryResult - -[generated-client](../modules/generated_client.md).BaseItemDtoQueryResult - -**`export`** - -**`interface`** BaseItemDtoQueryResult - -## Table of contents - -### Properties - -- [Items](generated_client.BaseItemDtoQueryResult.md#items) -- [StartIndex](generated_client.BaseItemDtoQueryResult.md#startindex) -- [TotalRecordCount](generated_client.BaseItemDtoQueryResult.md#totalrecordcount) - -## Properties - -### Items - -• `Optional` **Items**: ``null`` \| [`BaseItemDto`](generated_client.BaseItemDto.md)[] - -Gets or sets the items. - -**`memberof`** BaseItemDtoQueryResult - -#### Defined in - -[generated-client/models/base-item-dto-query-result.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-query-result.ts#L29) - -___ - -### StartIndex - -• `Optional` **StartIndex**: `number` - -Gets or sets the index of the first record in Items. - -**`memberof`** BaseItemDtoQueryResult - -#### Defined in - -[generated-client/models/base-item-dto-query-result.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-query-result.ts#L41) - -___ - -### TotalRecordCount - -• `Optional` **TotalRecordCount**: `number` - -Gets or sets the total number of records available. - -**`memberof`** BaseItemDtoQueryResult - -#### Defined in - -[generated-client/models/base-item-dto-query-result.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-dto-query-result.ts#L35) diff --git a/docs/interfaces/generated_client.BaseItemPerson.md b/docs/interfaces/generated_client.BaseItemPerson.md deleted file mode 100644 index fcae1bccd..000000000 --- a/docs/interfaces/generated_client.BaseItemPerson.md +++ /dev/null @@ -1,104 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BaseItemPerson - -# Interface: BaseItemPerson - -[generated-client](../modules/generated_client.md).BaseItemPerson - -This is used by the api to get information about a Person within a BaseItem. - -**`export`** - -**`interface`** BaseItemPerson - -## Table of contents - -### Properties - -- [Id](generated_client.BaseItemPerson.md#id) -- [ImageBlurHashes](generated_client.BaseItemPerson.md#imageblurhashes) -- [Name](generated_client.BaseItemPerson.md#name) -- [PrimaryImageTag](generated_client.BaseItemPerson.md#primaryimagetag) -- [Role](generated_client.BaseItemPerson.md#role) -- [Type](generated_client.BaseItemPerson.md#type) - -## Properties - -### Id - -• `Optional` **Id**: `string` - -Gets or sets the identifier. - -**`memberof`** BaseItemPerson - -#### Defined in - -[generated-client/models/base-item-person.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person.ts#L35) - -___ - -### ImageBlurHashes - -• `Optional` **ImageBlurHashes**: ``null`` \| [`BaseItemPersonImageBlurHashes`](generated_client.BaseItemPersonImageBlurHashes.md) - -**`memberof`** BaseItemPerson - -#### Defined in - -[generated-client/models/base-item-person.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person.ts#L59) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** BaseItemPerson - -#### Defined in - -[generated-client/models/base-item-person.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person.ts#L29) - -___ - -### PrimaryImageTag - -• `Optional` **PrimaryImageTag**: ``null`` \| `string` - -Gets or sets the primary image tag. - -**`memberof`** BaseItemPerson - -#### Defined in - -[generated-client/models/base-item-person.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person.ts#L53) - -___ - -### Role - -• `Optional` **Role**: ``null`` \| `string` - -Gets or sets the role. - -**`memberof`** BaseItemPerson - -#### Defined in - -[generated-client/models/base-item-person.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person.ts#L41) - -___ - -### Type - -• `Optional` **Type**: ``null`` \| `string` - -Gets or sets the type. - -**`memberof`** BaseItemPerson - -#### Defined in - -[generated-client/models/base-item-person.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person.ts#L47) diff --git a/docs/interfaces/generated_client.BaseItemPersonImageBlurHashes.md b/docs/interfaces/generated_client.BaseItemPersonImageBlurHashes.md deleted file mode 100644 index 94e8c9745..000000000 --- a/docs/interfaces/generated_client.BaseItemPersonImageBlurHashes.md +++ /dev/null @@ -1,237 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BaseItemPersonImageBlurHashes - -# Interface: BaseItemPersonImageBlurHashes - -[generated-client](../modules/generated_client.md).BaseItemPersonImageBlurHashes - -Gets or sets the primary image blurhash. - -**`export`** - -**`interface`** BaseItemPersonImageBlurHashes - -## Table of contents - -### Properties - -- [Art](generated_client.BaseItemPersonImageBlurHashes.md#art) -- [Backdrop](generated_client.BaseItemPersonImageBlurHashes.md#backdrop) -- [Banner](generated_client.BaseItemPersonImageBlurHashes.md#banner) -- [Box](generated_client.BaseItemPersonImageBlurHashes.md#box) -- [BoxRear](generated_client.BaseItemPersonImageBlurHashes.md#boxrear) -- [Chapter](generated_client.BaseItemPersonImageBlurHashes.md#chapter) -- [Disc](generated_client.BaseItemPersonImageBlurHashes.md#disc) -- [Logo](generated_client.BaseItemPersonImageBlurHashes.md#logo) -- [Menu](generated_client.BaseItemPersonImageBlurHashes.md#menu) -- [Primary](generated_client.BaseItemPersonImageBlurHashes.md#primary) -- [Profile](generated_client.BaseItemPersonImageBlurHashes.md#profile) -- [Screenshot](generated_client.BaseItemPersonImageBlurHashes.md#screenshot) -- [Thumb](generated_client.BaseItemPersonImageBlurHashes.md#thumb) - -## Properties - -### Art - -• `Optional` **Art**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L34) - -___ - -### Backdrop - -• `Optional` **Backdrop**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L40) - -___ - -### Banner - -• `Optional` **Banner**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L46) - -___ - -### Box - -• `Optional` **Box**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L70) - -___ - -### BoxRear - -• `Optional` **BoxRear**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:94](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L94) - -___ - -### Chapter - -• `Optional` **Chapter**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L88) - -___ - -### Disc - -• `Optional` **Disc**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L64) - -___ - -### Logo - -• `Optional` **Logo**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L52) - -___ - -### Menu - -• `Optional` **Menu**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L82) - -___ - -### Primary - -• `Optional` **Primary**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L28) - -___ - -### Profile - -• `Optional` **Profile**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:100](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L100) - -___ - -### Screenshot - -• `Optional` **Screenshot**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L76) - -___ - -### Thumb - -• `Optional` **Thumb**: `Object` - -**`memberof`** BaseItemPersonImageBlurHashes - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/base-item-person-image-blur-hashes.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-person-image-blur-hashes.ts#L58) diff --git a/docs/interfaces/generated_client.BookInfo.md b/docs/interfaces/generated_client.BookInfo.md deleted file mode 100644 index 6176929ed..000000000 --- a/docs/interfaces/generated_client.BookInfo.md +++ /dev/null @@ -1,184 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BookInfo - -# Interface: BookInfo - -[generated-client](../modules/generated_client.md).BookInfo - -**`export`** - -**`interface`** BookInfo - -## Table of contents - -### Properties - -- [IndexNumber](generated_client.BookInfo.md#indexnumber) -- [IsAutomated](generated_client.BookInfo.md#isautomated) -- [MetadataCountryCode](generated_client.BookInfo.md#metadatacountrycode) -- [MetadataLanguage](generated_client.BookInfo.md#metadatalanguage) -- [Name](generated_client.BookInfo.md#name) -- [OriginalTitle](generated_client.BookInfo.md#originaltitle) -- [ParentIndexNumber](generated_client.BookInfo.md#parentindexnumber) -- [Path](generated_client.BookInfo.md#path) -- [PremiereDate](generated_client.BookInfo.md#premieredate) -- [ProviderIds](generated_client.BookInfo.md#providerids) -- [SeriesName](generated_client.BookInfo.md#seriesname) -- [Year](generated_client.BookInfo.md#year) - -## Properties - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -**`memberof`** BookInfo - -#### Defined in - -[generated-client/models/book-info.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info.ts#L70) - -___ - -### IsAutomated - -• `Optional` **IsAutomated**: `boolean` - -**`memberof`** BookInfo - -#### Defined in - -[generated-client/models/book-info.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info.ts#L88) - -___ - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: ``null`` \| `string` - -Gets or sets the metadata country code. - -**`memberof`** BookInfo - -#### Defined in - -[generated-client/models/book-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info.ts#L52) - -___ - -### MetadataLanguage - -• `Optional` **MetadataLanguage**: ``null`` \| `string` - -Gets or sets the metadata language. - -**`memberof`** BookInfo - -#### Defined in - -[generated-client/models/book-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info.ts#L46) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** BookInfo - -#### Defined in - -[generated-client/models/book-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info.ts#L28) - -___ - -### OriginalTitle - -• `Optional` **OriginalTitle**: ``null`` \| `string` - -Gets or sets the original title. - -**`memberof`** BookInfo - -#### Defined in - -[generated-client/models/book-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info.ts#L34) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -**`memberof`** BookInfo - -#### Defined in - -[generated-client/models/book-info.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info.ts#L76) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** BookInfo - -#### Defined in - -[generated-client/models/book-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info.ts#L40) - -___ - -### PremiereDate - -• `Optional` **PremiereDate**: ``null`` \| `string` - -**`memberof`** BookInfo - -#### Defined in - -[generated-client/models/book-info.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info.ts#L82) - -___ - -### ProviderIds - -• `Optional` **ProviderIds**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the provider ids. - -**`memberof`** BookInfo - -#### Defined in - -[generated-client/models/book-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info.ts#L58) - -___ - -### SeriesName - -• `Optional` **SeriesName**: ``null`` \| `string` - -**`memberof`** BookInfo - -#### Defined in - -[generated-client/models/book-info.ts:94](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info.ts#L94) - -___ - -### Year - -• `Optional` **Year**: ``null`` \| `number` - -Gets or sets the year. - -**`memberof`** BookInfo - -#### Defined in - -[generated-client/models/book-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info.ts#L64) diff --git a/docs/interfaces/generated_client.BookInfoRemoteSearchQuery.md b/docs/interfaces/generated_client.BookInfoRemoteSearchQuery.md deleted file mode 100644 index bb1a92f80..000000000 --- a/docs/interfaces/generated_client.BookInfoRemoteSearchQuery.md +++ /dev/null @@ -1,70 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BookInfoRemoteSearchQuery - -# Interface: BookInfoRemoteSearchQuery - -[generated-client](../modules/generated_client.md).BookInfoRemoteSearchQuery - -**`export`** - -**`interface`** BookInfoRemoteSearchQuery - -## Table of contents - -### Properties - -- [IncludeDisabledProviders](generated_client.BookInfoRemoteSearchQuery.md#includedisabledproviders) -- [ItemId](generated_client.BookInfoRemoteSearchQuery.md#itemid) -- [SearchInfo](generated_client.BookInfoRemoteSearchQuery.md#searchinfo) -- [SearchProviderName](generated_client.BookInfoRemoteSearchQuery.md#searchprovidername) - -## Properties - -### IncludeDisabledProviders - -• `Optional` **IncludeDisabledProviders**: `boolean` - -Gets or sets a value indicating whether disabled providers should be included. - -**`memberof`** BookInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/book-info-remote-search-query.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info-remote-search-query.ts#L47) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -**`memberof`** BookInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/book-info-remote-search-query.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info-remote-search-query.ts#L35) - -___ - -### SearchInfo - -• `Optional` **SearchInfo**: [`BookInfo`](generated_client.BookInfo.md) - -**`memberof`** BookInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/book-info-remote-search-query.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info-remote-search-query.ts#L29) - -___ - -### SearchProviderName - -• `Optional` **SearchProviderName**: ``null`` \| `string` - -Gets or sets the provider name to search within if set. - -**`memberof`** BookInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/book-info-remote-search-query.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/book-info-remote-search-query.ts#L41) diff --git a/docs/interfaces/generated_client.BoxSetInfo.md b/docs/interfaces/generated_client.BoxSetInfo.md deleted file mode 100644 index c0322b90a..000000000 --- a/docs/interfaces/generated_client.BoxSetInfo.md +++ /dev/null @@ -1,171 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BoxSetInfo - -# Interface: BoxSetInfo - -[generated-client](../modules/generated_client.md).BoxSetInfo - -**`export`** - -**`interface`** BoxSetInfo - -## Table of contents - -### Properties - -- [IndexNumber](generated_client.BoxSetInfo.md#indexnumber) -- [IsAutomated](generated_client.BoxSetInfo.md#isautomated) -- [MetadataCountryCode](generated_client.BoxSetInfo.md#metadatacountrycode) -- [MetadataLanguage](generated_client.BoxSetInfo.md#metadatalanguage) -- [Name](generated_client.BoxSetInfo.md#name) -- [OriginalTitle](generated_client.BoxSetInfo.md#originaltitle) -- [ParentIndexNumber](generated_client.BoxSetInfo.md#parentindexnumber) -- [Path](generated_client.BoxSetInfo.md#path) -- [PremiereDate](generated_client.BoxSetInfo.md#premieredate) -- [ProviderIds](generated_client.BoxSetInfo.md#providerids) -- [Year](generated_client.BoxSetInfo.md#year) - -## Properties - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -**`memberof`** BoxSetInfo - -#### Defined in - -[generated-client/models/box-set-info.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info.ts#L70) - -___ - -### IsAutomated - -• `Optional` **IsAutomated**: `boolean` - -**`memberof`** BoxSetInfo - -#### Defined in - -[generated-client/models/box-set-info.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info.ts#L88) - -___ - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: ``null`` \| `string` - -Gets or sets the metadata country code. - -**`memberof`** BoxSetInfo - -#### Defined in - -[generated-client/models/box-set-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info.ts#L52) - -___ - -### MetadataLanguage - -• `Optional` **MetadataLanguage**: ``null`` \| `string` - -Gets or sets the metadata language. - -**`memberof`** BoxSetInfo - -#### Defined in - -[generated-client/models/box-set-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info.ts#L46) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** BoxSetInfo - -#### Defined in - -[generated-client/models/box-set-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info.ts#L28) - -___ - -### OriginalTitle - -• `Optional` **OriginalTitle**: ``null`` \| `string` - -Gets or sets the original title. - -**`memberof`** BoxSetInfo - -#### Defined in - -[generated-client/models/box-set-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info.ts#L34) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -**`memberof`** BoxSetInfo - -#### Defined in - -[generated-client/models/box-set-info.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info.ts#L76) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** BoxSetInfo - -#### Defined in - -[generated-client/models/box-set-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info.ts#L40) - -___ - -### PremiereDate - -• `Optional` **PremiereDate**: ``null`` \| `string` - -**`memberof`** BoxSetInfo - -#### Defined in - -[generated-client/models/box-set-info.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info.ts#L82) - -___ - -### ProviderIds - -• `Optional` **ProviderIds**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the provider ids. - -**`memberof`** BoxSetInfo - -#### Defined in - -[generated-client/models/box-set-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info.ts#L58) - -___ - -### Year - -• `Optional` **Year**: ``null`` \| `number` - -Gets or sets the year. - -**`memberof`** BoxSetInfo - -#### Defined in - -[generated-client/models/box-set-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info.ts#L64) diff --git a/docs/interfaces/generated_client.BoxSetInfoRemoteSearchQuery.md b/docs/interfaces/generated_client.BoxSetInfoRemoteSearchQuery.md deleted file mode 100644 index 6ebd5f143..000000000 --- a/docs/interfaces/generated_client.BoxSetInfoRemoteSearchQuery.md +++ /dev/null @@ -1,70 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BoxSetInfoRemoteSearchQuery - -# Interface: BoxSetInfoRemoteSearchQuery - -[generated-client](../modules/generated_client.md).BoxSetInfoRemoteSearchQuery - -**`export`** - -**`interface`** BoxSetInfoRemoteSearchQuery - -## Table of contents - -### Properties - -- [IncludeDisabledProviders](generated_client.BoxSetInfoRemoteSearchQuery.md#includedisabledproviders) -- [ItemId](generated_client.BoxSetInfoRemoteSearchQuery.md#itemid) -- [SearchInfo](generated_client.BoxSetInfoRemoteSearchQuery.md#searchinfo) -- [SearchProviderName](generated_client.BoxSetInfoRemoteSearchQuery.md#searchprovidername) - -## Properties - -### IncludeDisabledProviders - -• `Optional` **IncludeDisabledProviders**: `boolean` - -Gets or sets a value indicating whether disabled providers should be included. - -**`memberof`** BoxSetInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/box-set-info-remote-search-query.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info-remote-search-query.ts#L47) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -**`memberof`** BoxSetInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/box-set-info-remote-search-query.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info-remote-search-query.ts#L35) - -___ - -### SearchInfo - -• `Optional` **SearchInfo**: [`BoxSetInfo`](generated_client.BoxSetInfo.md) - -**`memberof`** BoxSetInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/box-set-info-remote-search-query.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info-remote-search-query.ts#L29) - -___ - -### SearchProviderName - -• `Optional` **SearchProviderName**: ``null`` \| `string` - -Gets or sets the provider name to search within if set. - -**`memberof`** BoxSetInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/box-set-info-remote-search-query.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/box-set-info-remote-search-query.ts#L41) diff --git a/docs/interfaces/generated_client.BrandingOptions.md b/docs/interfaces/generated_client.BrandingOptions.md deleted file mode 100644 index 785d5cf3a..000000000 --- a/docs/interfaces/generated_client.BrandingOptions.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BrandingOptions - -# Interface: BrandingOptions - -[generated-client](../modules/generated_client.md).BrandingOptions - -The branding options. - -**`export`** - -**`interface`** BrandingOptions - -## Table of contents - -### Properties - -- [CustomCss](generated_client.BrandingOptions.md#customcss) -- [LoginDisclaimer](generated_client.BrandingOptions.md#logindisclaimer) -- [SplashscreenEnabled](generated_client.BrandingOptions.md#splashscreenenabled) - -## Properties - -### CustomCss - -• `Optional` **CustomCss**: ``null`` \| `string` - -Gets or sets the custom CSS. - -**`memberof`** BrandingOptions - -#### Defined in - -[generated-client/models/branding-options.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/branding-options.ts#L34) - -___ - -### LoginDisclaimer - -• `Optional` **LoginDisclaimer**: ``null`` \| `string` - -Gets or sets the login disclaimer. - -**`memberof`** BrandingOptions - -#### Defined in - -[generated-client/models/branding-options.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/branding-options.ts#L28) - -___ - -### SplashscreenEnabled - -• `Optional` **SplashscreenEnabled**: `boolean` - -Gets or sets a value indicating whether to enable the splashscreen. - -**`memberof`** BrandingOptions - -#### Defined in - -[generated-client/models/branding-options.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/branding-options.ts#L40) diff --git a/docs/interfaces/generated_client.BufferRequestDto.md b/docs/interfaces/generated_client.BufferRequestDto.md deleted file mode 100644 index a574dda19..000000000 --- a/docs/interfaces/generated_client.BufferRequestDto.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BufferRequestDto - -# Interface: BufferRequestDto - -[generated-client](../modules/generated_client.md).BufferRequestDto - -Class BufferRequestDto. - -**`export`** - -**`interface`** BufferRequestDto - -## Table of contents - -### Properties - -- [IsPlaying](generated_client.BufferRequestDto.md#isplaying) -- [PlaylistItemId](generated_client.BufferRequestDto.md#playlistitemid) -- [PositionTicks](generated_client.BufferRequestDto.md#positionticks) -- [When](generated_client.BufferRequestDto.md#when) - -## Properties - -### IsPlaying - -• `Optional` **IsPlaying**: `boolean` - -Gets or sets a value indicating whether the client playback is unpaused. - -**`memberof`** BufferRequestDto - -#### Defined in - -[generated-client/models/buffer-request-dto.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/buffer-request-dto.ts#L40) - -___ - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: `string` - -Gets or sets the playlist item identifier of the playing item. - -**`memberof`** BufferRequestDto - -#### Defined in - -[generated-client/models/buffer-request-dto.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/buffer-request-dto.ts#L46) - -___ - -### PositionTicks - -• `Optional` **PositionTicks**: `number` - -Gets or sets the position ticks. - -**`memberof`** BufferRequestDto - -#### Defined in - -[generated-client/models/buffer-request-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/buffer-request-dto.ts#L34) - -___ - -### When - -• `Optional` **When**: `string` - -Gets or sets when the request has been made by the client. - -**`memberof`** BufferRequestDto - -#### Defined in - -[generated-client/models/buffer-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/buffer-request-dto.ts#L28) diff --git a/docs/interfaces/generated_client.ChannelFeatures.md b/docs/interfaces/generated_client.ChannelFeatures.md deleted file mode 100644 index af5f0d646..000000000 --- a/docs/interfaces/generated_client.ChannelFeatures.md +++ /dev/null @@ -1,194 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelFeatures - -# Interface: ChannelFeatures - -[generated-client](../modules/generated_client.md).ChannelFeatures - -**`export`** - -**`interface`** ChannelFeatures - -## Table of contents - -### Properties - -- [AutoRefreshLevels](generated_client.ChannelFeatures.md#autorefreshlevels) -- [CanFilter](generated_client.ChannelFeatures.md#canfilter) -- [CanSearch](generated_client.ChannelFeatures.md#cansearch) -- [ContentTypes](generated_client.ChannelFeatures.md#contenttypes) -- [DefaultSortFields](generated_client.ChannelFeatures.md#defaultsortfields) -- [Id](generated_client.ChannelFeatures.md#id) -- [MaxPageSize](generated_client.ChannelFeatures.md#maxpagesize) -- [MediaTypes](generated_client.ChannelFeatures.md#mediatypes) -- [Name](generated_client.ChannelFeatures.md#name) -- [SupportsContentDownloading](generated_client.ChannelFeatures.md#supportscontentdownloading) -- [SupportsLatestMedia](generated_client.ChannelFeatures.md#supportslatestmedia) -- [SupportsSortOrderToggle](generated_client.ChannelFeatures.md#supportssortordertoggle) - -## Properties - -### AutoRefreshLevels - -• `Optional` **AutoRefreshLevels**: ``null`` \| `number` - -Gets or sets the automatic refresh levels. - -**`memberof`** ChannelFeatures - -#### Defined in - -[generated-client/models/channel-features.ts:67](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-features.ts#L67) - -___ - -### CanFilter - -• `Optional` **CanFilter**: `boolean` - -Gets or sets a value indicating whether this instance can filter. - -**`memberof`** ChannelFeatures - -#### Defined in - -[generated-client/models/channel-features.ts:91](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-features.ts#L91) - -___ - -### CanSearch - -• `Optional` **CanSearch**: `boolean` - -Gets or sets a value indicating whether this instance can search. - -**`memberof`** ChannelFeatures - -#### Defined in - -[generated-client/models/channel-features.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-features.ts#L43) - -___ - -### ContentTypes - -• `Optional` **ContentTypes**: [`ChannelMediaContentType`](../enums/generated_client.ChannelMediaContentType.md)[] - -Gets or sets the content types. - -**`memberof`** ChannelFeatures - -#### Defined in - -[generated-client/models/channel-features.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-features.ts#L55) - -___ - -### DefaultSortFields - -• `Optional` **DefaultSortFields**: [`ChannelItemSortField`](../enums/generated_client.ChannelItemSortField.md)[] - -Gets or sets the default sort orders. - -**`memberof`** ChannelFeatures - -#### Defined in - -[generated-client/models/channel-features.ts:73](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-features.ts#L73) - -___ - -### Id - -• `Optional` **Id**: `string` - -Gets or sets the identifier. - -**`memberof`** ChannelFeatures - -#### Defined in - -[generated-client/models/channel-features.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-features.ts#L37) - -___ - -### MaxPageSize - -• `Optional` **MaxPageSize**: ``null`` \| `number` - -Gets or sets the maximum number of records the channel allows retrieving at a time. - -**`memberof`** ChannelFeatures - -#### Defined in - -[generated-client/models/channel-features.ts:61](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-features.ts#L61) - -___ - -### MediaTypes - -• `Optional` **MediaTypes**: [`ChannelMediaType`](../enums/generated_client.ChannelMediaType.md)[] - -Gets or sets the media types. - -**`memberof`** ChannelFeatures - -#### Defined in - -[generated-client/models/channel-features.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-features.ts#L49) - -___ - -### Name - -• `Optional` **Name**: `string` - -Gets or sets the name. - -**`memberof`** ChannelFeatures - -#### Defined in - -[generated-client/models/channel-features.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-features.ts#L31) - -___ - -### SupportsContentDownloading - -• `Optional` **SupportsContentDownloading**: `boolean` - -Gets or sets a value indicating whether [supports content downloading]. - -**`memberof`** ChannelFeatures - -#### Defined in - -[generated-client/models/channel-features.ts:97](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-features.ts#L97) - -___ - -### SupportsLatestMedia - -• `Optional` **SupportsLatestMedia**: `boolean` - -Gets or sets a value indicating whether [supports latest media]. - -**`memberof`** ChannelFeatures - -#### Defined in - -[generated-client/models/channel-features.ts:85](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-features.ts#L85) - -___ - -### SupportsSortOrderToggle - -• `Optional` **SupportsSortOrderToggle**: `boolean` - -Gets or sets a value indicating whether a sort ascending/descending toggle is supported. - -**`memberof`** ChannelFeatures - -#### Defined in - -[generated-client/models/channel-features.ts:79](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-features.ts#L79) diff --git a/docs/interfaces/generated_client.ChannelMappingOptionsDto.md b/docs/interfaces/generated_client.ChannelMappingOptionsDto.md deleted file mode 100644 index 5d3436e55..000000000 --- a/docs/interfaces/generated_client.ChannelMappingOptionsDto.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelMappingOptionsDto - -# Interface: ChannelMappingOptionsDto - -[generated-client](../modules/generated_client.md).ChannelMappingOptionsDto - -Channel mapping options dto. - -**`export`** - -**`interface`** ChannelMappingOptionsDto - -## Table of contents - -### Properties - -- [Mappings](generated_client.ChannelMappingOptionsDto.md#mappings) -- [ProviderChannels](generated_client.ChannelMappingOptionsDto.md#providerchannels) -- [ProviderName](generated_client.ChannelMappingOptionsDto.md#providername) -- [TunerChannels](generated_client.ChannelMappingOptionsDto.md#tunerchannels) - -## Properties - -### Mappings - -• `Optional` **Mappings**: [`NameValuePair`](generated_client.NameValuePair.md)[] - -Gets or sets list of mappings. - -**`memberof`** ChannelMappingOptionsDto - -#### Defined in - -[generated-client/models/channel-mapping-options-dto.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-mapping-options-dto.ts#L43) - -___ - -### ProviderChannels - -• `Optional` **ProviderChannels**: [`NameIdPair`](generated_client.NameIdPair.md)[] - -Gets or sets list of provider channels. - -**`memberof`** ChannelMappingOptionsDto - -#### Defined in - -[generated-client/models/channel-mapping-options-dto.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-mapping-options-dto.ts#L37) - -___ - -### ProviderName - -• `Optional` **ProviderName**: ``null`` \| `string` - -Gets or sets provider name. - -**`memberof`** ChannelMappingOptionsDto - -#### Defined in - -[generated-client/models/channel-mapping-options-dto.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-mapping-options-dto.ts#L49) - -___ - -### TunerChannels - -• `Optional` **TunerChannels**: [`TunerChannelMapping`](generated_client.TunerChannelMapping.md)[] - -Gets or sets list of tuner channels. - -**`memberof`** ChannelMappingOptionsDto - -#### Defined in - -[generated-client/models/channel-mapping-options-dto.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-mapping-options-dto.ts#L31) diff --git a/docs/interfaces/generated_client.ChannelsApiGetChannelFeaturesRequest.md b/docs/interfaces/generated_client.ChannelsApiGetChannelFeaturesRequest.md deleted file mode 100644 index 668ffe203..000000000 --- a/docs/interfaces/generated_client.ChannelsApiGetChannelFeaturesRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelsApiGetChannelFeaturesRequest - -# Interface: ChannelsApiGetChannelFeaturesRequest - -[generated-client](../modules/generated_client.md).ChannelsApiGetChannelFeaturesRequest - -Request parameters for getChannelFeatures operation in ChannelsApi. - -**`export`** - -**`interface`** ChannelsApiGetChannelFeaturesRequest - -## Table of contents - -### Properties - -- [channelId](generated_client.ChannelsApiGetChannelFeaturesRequest.md#channelid) - -## Properties - -### channelId - -• `Readonly` **channelId**: `string` - -Channel id. - -**`memberof`** ChannelsApiGetChannelFeatures - -#### Defined in - -[generated-client/api/channels-api.ts:485](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L485) diff --git a/docs/interfaces/generated_client.ChannelsApiGetChannelItemsRequest.md b/docs/interfaces/generated_client.ChannelsApiGetChannelItemsRequest.md deleted file mode 100644 index fc0659a45..000000000 --- a/docs/interfaces/generated_client.ChannelsApiGetChannelItemsRequest.md +++ /dev/null @@ -1,151 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelsApiGetChannelItemsRequest - -# Interface: ChannelsApiGetChannelItemsRequest - -[generated-client](../modules/generated_client.md).ChannelsApiGetChannelItemsRequest - -Request parameters for getChannelItems operation in ChannelsApi. - -**`export`** - -**`interface`** ChannelsApiGetChannelItemsRequest - -## Table of contents - -### Properties - -- [channelId](generated_client.ChannelsApiGetChannelItemsRequest.md#channelid) -- [fields](generated_client.ChannelsApiGetChannelItemsRequest.md#fields) -- [filters](generated_client.ChannelsApiGetChannelItemsRequest.md#filters) -- [folderId](generated_client.ChannelsApiGetChannelItemsRequest.md#folderid) -- [limit](generated_client.ChannelsApiGetChannelItemsRequest.md#limit) -- [sortBy](generated_client.ChannelsApiGetChannelItemsRequest.md#sortby) -- [sortOrder](generated_client.ChannelsApiGetChannelItemsRequest.md#sortorder) -- [startIndex](generated_client.ChannelsApiGetChannelItemsRequest.md#startindex) -- [userId](generated_client.ChannelsApiGetChannelItemsRequest.md#userid) - -## Properties - -### channelId - -• `Readonly` **channelId**: `string` - -Channel Id. - -**`memberof`** ChannelsApiGetChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:499](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L499) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** ChannelsApiGetChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:555](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L555) - -___ - -### filters - -• `Optional` `Readonly` **filters**: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[] - -Optional. Specify additional filters to apply. - -**`memberof`** ChannelsApiGetChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:541](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L541) - -___ - -### folderId - -• `Optional` `Readonly` **folderId**: `string` - -Optional. Folder Id. - -**`memberof`** ChannelsApiGetChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:506](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L506) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** ChannelsApiGetChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:527](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L527) - -___ - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string`[] - -Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. - -**`memberof`** ChannelsApiGetChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:548](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L548) - -___ - -### sortOrder - -• `Optional` `Readonly` **sortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md)[] - -Optional. Sort Order - Ascending,Descending. - -**`memberof`** ChannelsApiGetChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:534](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L534) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** ChannelsApiGetChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:520](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L520) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. User Id. - -**`memberof`** ChannelsApiGetChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:513](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L513) diff --git a/docs/interfaces/generated_client.ChannelsApiGetChannelsRequest.md b/docs/interfaces/generated_client.ChannelsApiGetChannelsRequest.md deleted file mode 100644 index ededc90c1..000000000 --- a/docs/interfaces/generated_client.ChannelsApiGetChannelsRequest.md +++ /dev/null @@ -1,106 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelsApiGetChannelsRequest - -# Interface: ChannelsApiGetChannelsRequest - -[generated-client](../modules/generated_client.md).ChannelsApiGetChannelsRequest - -Request parameters for getChannels operation in ChannelsApi. - -**`export`** - -**`interface`** ChannelsApiGetChannelsRequest - -## Table of contents - -### Properties - -- [isFavorite](generated_client.ChannelsApiGetChannelsRequest.md#isfavorite) -- [limit](generated_client.ChannelsApiGetChannelsRequest.md#limit) -- [startIndex](generated_client.ChannelsApiGetChannelsRequest.md#startindex) -- [supportsLatestItems](generated_client.ChannelsApiGetChannelsRequest.md#supportslatestitems) -- [supportsMediaDeletion](generated_client.ChannelsApiGetChannelsRequest.md#supportsmediadeletion) -- [userId](generated_client.ChannelsApiGetChannelsRequest.md#userid) - -## Properties - -### isFavorite - -• `Optional` `Readonly` **isFavorite**: `boolean` - -Optional. Filter by channels that are favorite. - -**`memberof`** ChannelsApiGetChannels - -#### Defined in - -[generated-client/api/channels-api.ts:604](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L604) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** ChannelsApiGetChannels - -#### Defined in - -[generated-client/api/channels-api.ts:583](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L583) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** ChannelsApiGetChannels - -#### Defined in - -[generated-client/api/channels-api.ts:576](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L576) - -___ - -### supportsLatestItems - -• `Optional` `Readonly` **supportsLatestItems**: `boolean` - -Optional. Filter by channels that support getting latest items. - -**`memberof`** ChannelsApiGetChannels - -#### Defined in - -[generated-client/api/channels-api.ts:590](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L590) - -___ - -### supportsMediaDeletion - -• `Optional` `Readonly` **supportsMediaDeletion**: `boolean` - -Optional. Filter by channels that support media deletion. - -**`memberof`** ChannelsApiGetChannels - -#### Defined in - -[generated-client/api/channels-api.ts:597](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L597) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -User Id to filter by. Use System.Guid.Empty to not filter by user. - -**`memberof`** ChannelsApiGetChannels - -#### Defined in - -[generated-client/api/channels-api.ts:569](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L569) diff --git a/docs/interfaces/generated_client.ChannelsApiGetLatestChannelItemsRequest.md b/docs/interfaces/generated_client.ChannelsApiGetLatestChannelItemsRequest.md deleted file mode 100644 index cac3ce8e9..000000000 --- a/docs/interfaces/generated_client.ChannelsApiGetLatestChannelItemsRequest.md +++ /dev/null @@ -1,106 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelsApiGetLatestChannelItemsRequest - -# Interface: ChannelsApiGetLatestChannelItemsRequest - -[generated-client](../modules/generated_client.md).ChannelsApiGetLatestChannelItemsRequest - -Request parameters for getLatestChannelItems operation in ChannelsApi. - -**`export`** - -**`interface`** ChannelsApiGetLatestChannelItemsRequest - -## Table of contents - -### Properties - -- [channelIds](generated_client.ChannelsApiGetLatestChannelItemsRequest.md#channelids) -- [fields](generated_client.ChannelsApiGetLatestChannelItemsRequest.md#fields) -- [filters](generated_client.ChannelsApiGetLatestChannelItemsRequest.md#filters) -- [limit](generated_client.ChannelsApiGetLatestChannelItemsRequest.md#limit) -- [startIndex](generated_client.ChannelsApiGetLatestChannelItemsRequest.md#startindex) -- [userId](generated_client.ChannelsApiGetLatestChannelItemsRequest.md#userid) - -## Properties - -### channelIds - -• `Optional` `Readonly` **channelIds**: `string`[] - -Optional. Specify one or more channel id\'s, comma delimited. - -**`memberof`** ChannelsApiGetLatestChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:653](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L653) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** ChannelsApiGetLatestChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:646](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L646) - -___ - -### filters - -• `Optional` `Readonly` **filters**: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[] - -Optional. Specify additional filters to apply. - -**`memberof`** ChannelsApiGetLatestChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:639](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L639) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** ChannelsApiGetLatestChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:632](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L632) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** ChannelsApiGetLatestChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:625](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L625) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. User Id. - -**`memberof`** ChannelsApiGetLatestChannelItems - -#### Defined in - -[generated-client/api/channels-api.ts:618](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L618) diff --git a/docs/interfaces/generated_client.ChapterInfo.md b/docs/interfaces/generated_client.ChapterInfo.md deleted file mode 100644 index b90de2a29..000000000 --- a/docs/interfaces/generated_client.ChapterInfo.md +++ /dev/null @@ -1,87 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChapterInfo - -# Interface: ChapterInfo - -[generated-client](../modules/generated_client.md).ChapterInfo - -Class ChapterInfo. - -**`export`** - -**`interface`** ChapterInfo - -## Table of contents - -### Properties - -- [ImageDateModified](generated_client.ChapterInfo.md#imagedatemodified) -- [ImagePath](generated_client.ChapterInfo.md#imagepath) -- [ImageTag](generated_client.ChapterInfo.md#imagetag) -- [Name](generated_client.ChapterInfo.md#name) -- [StartPositionTicks](generated_client.ChapterInfo.md#startpositionticks) - -## Properties - -### ImageDateModified - -• `Optional` **ImageDateModified**: `string` - -**`memberof`** ChapterInfo - -#### Defined in - -[generated-client/models/chapter-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/chapter-info.ts#L46) - -___ - -### ImagePath - -• `Optional` **ImagePath**: ``null`` \| `string` - -Gets or sets the image path. - -**`memberof`** ChapterInfo - -#### Defined in - -[generated-client/models/chapter-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/chapter-info.ts#L40) - -___ - -### ImageTag - -• `Optional` **ImageTag**: ``null`` \| `string` - -**`memberof`** ChapterInfo - -#### Defined in - -[generated-client/models/chapter-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/chapter-info.ts#L52) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** ChapterInfo - -#### Defined in - -[generated-client/models/chapter-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/chapter-info.ts#L34) - -___ - -### StartPositionTicks - -• `Optional` **StartPositionTicks**: `number` - -Gets or sets the start position ticks. - -**`memberof`** ChapterInfo - -#### Defined in - -[generated-client/models/chapter-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/chapter-info.ts#L28) diff --git a/docs/interfaces/generated_client.ClientCapabilities.md b/docs/interfaces/generated_client.ClientCapabilities.md deleted file mode 100644 index 227ba584b..000000000 --- a/docs/interfaces/generated_client.ClientCapabilities.md +++ /dev/null @@ -1,144 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ClientCapabilities - -# Interface: ClientCapabilities - -[generated-client](../modules/generated_client.md).ClientCapabilities - -**`export`** - -**`interface`** ClientCapabilities - -## Table of contents - -### Properties - -- [AppStoreUrl](generated_client.ClientCapabilities.md#appstoreurl) -- [DeviceProfile](generated_client.ClientCapabilities.md#deviceprofile) -- [IconUrl](generated_client.ClientCapabilities.md#iconurl) -- [MessageCallbackUrl](generated_client.ClientCapabilities.md#messagecallbackurl) -- [PlayableMediaTypes](generated_client.ClientCapabilities.md#playablemediatypes) -- [SupportedCommands](generated_client.ClientCapabilities.md#supportedcommands) -- [SupportsContentUploading](generated_client.ClientCapabilities.md#supportscontentuploading) -- [SupportsMediaControl](generated_client.ClientCapabilities.md#supportsmediacontrol) -- [SupportsPersistentIdentifier](generated_client.ClientCapabilities.md#supportspersistentidentifier) -- [SupportsSync](generated_client.ClientCapabilities.md#supportssync) - -## Properties - -### AppStoreUrl - -• `Optional` **AppStoreUrl**: ``null`` \| `string` - -**`memberof`** ClientCapabilities - -#### Defined in - -[generated-client/models/client-capabilities.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities.ts#L78) - -___ - -### DeviceProfile - -• `Optional` **DeviceProfile**: [`DeviceProfile`](generated_client.DeviceProfile.md) - -**`memberof`** ClientCapabilities - -#### Defined in - -[generated-client/models/client-capabilities.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities.ts#L72) - -___ - -### IconUrl - -• `Optional` **IconUrl**: ``null`` \| `string` - -**`memberof`** ClientCapabilities - -#### Defined in - -[generated-client/models/client-capabilities.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities.ts#L84) - -___ - -### MessageCallbackUrl - -• `Optional` **MessageCallbackUrl**: ``null`` \| `string` - -**`memberof`** ClientCapabilities - -#### Defined in - -[generated-client/models/client-capabilities.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities.ts#L54) - -___ - -### PlayableMediaTypes - -• `Optional` **PlayableMediaTypes**: ``null`` \| `string`[] - -**`memberof`** ClientCapabilities - -#### Defined in - -[generated-client/models/client-capabilities.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities.ts#L30) - -___ - -### SupportedCommands - -• `Optional` **SupportedCommands**: ``null`` \| [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md)[] - -**`memberof`** ClientCapabilities - -#### Defined in - -[generated-client/models/client-capabilities.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities.ts#L36) - -___ - -### SupportsContentUploading - -• `Optional` **SupportsContentUploading**: `boolean` - -**`memberof`** ClientCapabilities - -#### Defined in - -[generated-client/models/client-capabilities.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities.ts#L48) - -___ - -### SupportsMediaControl - -• `Optional` **SupportsMediaControl**: `boolean` - -**`memberof`** ClientCapabilities - -#### Defined in - -[generated-client/models/client-capabilities.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities.ts#L42) - -___ - -### SupportsPersistentIdentifier - -• `Optional` **SupportsPersistentIdentifier**: `boolean` - -**`memberof`** ClientCapabilities - -#### Defined in - -[generated-client/models/client-capabilities.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities.ts#L60) - -___ - -### SupportsSync - -• `Optional` **SupportsSync**: `boolean` - -**`memberof`** ClientCapabilities - -#### Defined in - -[generated-client/models/client-capabilities.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities.ts#L66) diff --git a/docs/interfaces/generated_client.ClientCapabilitiesDto.md b/docs/interfaces/generated_client.ClientCapabilitiesDto.md deleted file mode 100644 index d5102f6d6..000000000 --- a/docs/interfaces/generated_client.ClientCapabilitiesDto.md +++ /dev/null @@ -1,164 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ClientCapabilitiesDto - -# Interface: ClientCapabilitiesDto - -[generated-client](../modules/generated_client.md).ClientCapabilitiesDto - -Client capabilities dto. - -**`export`** - -**`interface`** ClientCapabilitiesDto - -## Table of contents - -### Properties - -- [AppStoreUrl](generated_client.ClientCapabilitiesDto.md#appstoreurl) -- [DeviceProfile](generated_client.ClientCapabilitiesDto.md#deviceprofile) -- [IconUrl](generated_client.ClientCapabilitiesDto.md#iconurl) -- [MessageCallbackUrl](generated_client.ClientCapabilitiesDto.md#messagecallbackurl) -- [PlayableMediaTypes](generated_client.ClientCapabilitiesDto.md#playablemediatypes) -- [SupportedCommands](generated_client.ClientCapabilitiesDto.md#supportedcommands) -- [SupportsContentUploading](generated_client.ClientCapabilitiesDto.md#supportscontentuploading) -- [SupportsMediaControl](generated_client.ClientCapabilitiesDto.md#supportsmediacontrol) -- [SupportsPersistentIdentifier](generated_client.ClientCapabilitiesDto.md#supportspersistentidentifier) -- [SupportsSync](generated_client.ClientCapabilitiesDto.md#supportssync) - -## Properties - -### AppStoreUrl - -• `Optional` **AppStoreUrl**: ``null`` \| `string` - -Gets or sets the app store url. - -**`memberof`** ClientCapabilitiesDto - -#### Defined in - -[generated-client/models/client-capabilities-dto.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities-dto.ts#L78) - -___ - -### DeviceProfile - -• `Optional` **DeviceProfile**: [`DeviceProfile`](generated_client.DeviceProfile.md) - -**`memberof`** ClientCapabilitiesDto - -#### Defined in - -[generated-client/models/client-capabilities-dto.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities-dto.ts#L72) - -___ - -### IconUrl - -• `Optional` **IconUrl**: ``null`` \| `string` - -Gets or sets the icon url. - -**`memberof`** ClientCapabilitiesDto - -#### Defined in - -[generated-client/models/client-capabilities-dto.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities-dto.ts#L84) - -___ - -### MessageCallbackUrl - -• `Optional` **MessageCallbackUrl**: ``null`` \| `string` - -Gets or sets the message callback url. - -**`memberof`** ClientCapabilitiesDto - -#### Defined in - -[generated-client/models/client-capabilities-dto.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities-dto.ts#L54) - -___ - -### PlayableMediaTypes - -• `Optional` **PlayableMediaTypes**: `string`[] - -Gets or sets the list of playable media types. - -**`memberof`** ClientCapabilitiesDto - -#### Defined in - -[generated-client/models/client-capabilities-dto.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities-dto.ts#L30) - -___ - -### SupportedCommands - -• `Optional` **SupportedCommands**: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md)[] - -Gets or sets the list of supported commands. - -**`memberof`** ClientCapabilitiesDto - -#### Defined in - -[generated-client/models/client-capabilities-dto.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities-dto.ts#L36) - -___ - -### SupportsContentUploading - -• `Optional` **SupportsContentUploading**: `boolean` - -Gets or sets a value indicating whether session supports content uploading. - -**`memberof`** ClientCapabilitiesDto - -#### Defined in - -[generated-client/models/client-capabilities-dto.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities-dto.ts#L48) - -___ - -### SupportsMediaControl - -• `Optional` **SupportsMediaControl**: `boolean` - -Gets or sets a value indicating whether session supports media control. - -**`memberof`** ClientCapabilitiesDto - -#### Defined in - -[generated-client/models/client-capabilities-dto.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities-dto.ts#L42) - -___ - -### SupportsPersistentIdentifier - -• `Optional` **SupportsPersistentIdentifier**: `boolean` - -Gets or sets a value indicating whether session supports a persistent identifier. - -**`memberof`** ClientCapabilitiesDto - -#### Defined in - -[generated-client/models/client-capabilities-dto.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities-dto.ts#L60) - -___ - -### SupportsSync - -• `Optional` **SupportsSync**: `boolean` - -Gets or sets a value indicating whether session supports sync. - -**`memberof`** ClientCapabilitiesDto - -#### Defined in - -[generated-client/models/client-capabilities-dto.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-capabilities-dto.ts#L66) diff --git a/docs/interfaces/generated_client.ClientLogApiLogFileRequest.md b/docs/interfaces/generated_client.ClientLogApiLogFileRequest.md deleted file mode 100644 index 8ffcd1707..000000000 --- a/docs/interfaces/generated_client.ClientLogApiLogFileRequest.md +++ /dev/null @@ -1,29 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ClientLogApiLogFileRequest - -# Interface: ClientLogApiLogFileRequest - -[generated-client](../modules/generated_client.md).ClientLogApiLogFileRequest - -Request parameters for logFile operation in ClientLogApi. - -**`export`** - -**`interface`** ClientLogApiLogFileRequest - -## Table of contents - -### Properties - -- [body](generated_client.ClientLogApiLogFileRequest.md#body) - -## Properties - -### body - -• `Optional` `Readonly` **body**: `any` - -**`memberof`** ClientLogApiLogFile - -#### Defined in - -[generated-client/api/client-log-api.ts:125](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/client-log-api.ts#L125) diff --git a/docs/interfaces/generated_client.ClientLogDocumentResponseDto.md b/docs/interfaces/generated_client.ClientLogDocumentResponseDto.md deleted file mode 100644 index 343464a78..000000000 --- a/docs/interfaces/generated_client.ClientLogDocumentResponseDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ClientLogDocumentResponseDto - -# Interface: ClientLogDocumentResponseDto - -[generated-client](../modules/generated_client.md).ClientLogDocumentResponseDto - -Client log document response dto. - -**`export`** - -**`interface`** ClientLogDocumentResponseDto - -## Table of contents - -### Properties - -- [FileName](generated_client.ClientLogDocumentResponseDto.md#filename) - -## Properties - -### FileName - -• `Optional` **FileName**: `string` - -Gets the resulting filename. - -**`memberof`** ClientLogDocumentResponseDto - -#### Defined in - -[generated-client/models/client-log-document-response-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/client-log-document-response-dto.ts#L28) diff --git a/docs/interfaces/generated_client.CodecProfile.md b/docs/interfaces/generated_client.CodecProfile.md deleted file mode 100644 index a2cb3b45a..000000000 --- a/docs/interfaces/generated_client.CodecProfile.md +++ /dev/null @@ -1,79 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CodecProfile - -# Interface: CodecProfile - -[generated-client](../modules/generated_client.md).CodecProfile - -**`export`** - -**`interface`** CodecProfile - -## Table of contents - -### Properties - -- [ApplyConditions](generated_client.CodecProfile.md#applyconditions) -- [Codec](generated_client.CodecProfile.md#codec) -- [Conditions](generated_client.CodecProfile.md#conditions) -- [Container](generated_client.CodecProfile.md#container) -- [Type](generated_client.CodecProfile.md#type) - -## Properties - -### ApplyConditions - -• `Optional` **ApplyConditions**: ``null`` \| [`ProfileCondition`](generated_client.ProfileCondition.md)[] - -**`memberof`** CodecProfile - -#### Defined in - -[generated-client/models/codec-profile.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/codec-profile.ts#L42) - -___ - -### Codec - -• `Optional` **Codec**: ``null`` \| `string` - -**`memberof`** CodecProfile - -#### Defined in - -[generated-client/models/codec-profile.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/codec-profile.ts#L48) - -___ - -### Conditions - -• `Optional` **Conditions**: ``null`` \| [`ProfileCondition`](generated_client.ProfileCondition.md)[] - -**`memberof`** CodecProfile - -#### Defined in - -[generated-client/models/codec-profile.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/codec-profile.ts#L36) - -___ - -### Container - -• `Optional` **Container**: ``null`` \| `string` - -**`memberof`** CodecProfile - -#### Defined in - -[generated-client/models/codec-profile.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/codec-profile.ts#L54) - -___ - -### Type - -• `Optional` **Type**: [`CodecType`](../enums/generated_client.CodecType.md) - -**`memberof`** CodecProfile - -#### Defined in - -[generated-client/models/codec-profile.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/codec-profile.ts#L30) diff --git a/docs/interfaces/generated_client.CollectionApiAddToCollectionRequest.md b/docs/interfaces/generated_client.CollectionApiAddToCollectionRequest.md deleted file mode 100644 index cfce0f69c..000000000 --- a/docs/interfaces/generated_client.CollectionApiAddToCollectionRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CollectionApiAddToCollectionRequest - -# Interface: CollectionApiAddToCollectionRequest - -[generated-client](../modules/generated_client.md).CollectionApiAddToCollectionRequest - -Request parameters for addToCollection operation in CollectionApi. - -**`export`** - -**`interface`** CollectionApiAddToCollectionRequest - -## Table of contents - -### Properties - -- [collectionId](generated_client.CollectionApiAddToCollectionRequest.md#collectionid) -- [ids](generated_client.CollectionApiAddToCollectionRequest.md#ids) - -## Properties - -### collectionId - -• `Readonly` **collectionId**: `string` - -The collection id. - -**`memberof`** CollectionApiAddToCollection - -#### Defined in - -[generated-client/api/collection-api.ts:279](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L279) - -___ - -### ids - -• `Readonly` **ids**: `string`[] - -Item ids, comma delimited. - -**`memberof`** CollectionApiAddToCollection - -#### Defined in - -[generated-client/api/collection-api.ts:286](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L286) diff --git a/docs/interfaces/generated_client.CollectionApiCreateCollectionRequest.md b/docs/interfaces/generated_client.CollectionApiCreateCollectionRequest.md deleted file mode 100644 index 9ed2477bd..000000000 --- a/docs/interfaces/generated_client.CollectionApiCreateCollectionRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CollectionApiCreateCollectionRequest - -# Interface: CollectionApiCreateCollectionRequest - -[generated-client](../modules/generated_client.md).CollectionApiCreateCollectionRequest - -Request parameters for createCollection operation in CollectionApi. - -**`export`** - -**`interface`** CollectionApiCreateCollectionRequest - -## Table of contents - -### Properties - -- [ids](generated_client.CollectionApiCreateCollectionRequest.md#ids) -- [isLocked](generated_client.CollectionApiCreateCollectionRequest.md#islocked) -- [name](generated_client.CollectionApiCreateCollectionRequest.md#name) -- [parentId](generated_client.CollectionApiCreateCollectionRequest.md#parentid) - -## Properties - -### ids - -• `Optional` `Readonly` **ids**: `string`[] - -Item Ids to add to the collection. - -**`memberof`** CollectionApiCreateCollection - -#### Defined in - -[generated-client/api/collection-api.ts:307](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L307) - -___ - -### isLocked - -• `Optional` `Readonly` **isLocked**: `boolean` - -Whether or not to lock the new collection. - -**`memberof`** CollectionApiCreateCollection - -#### Defined in - -[generated-client/api/collection-api.ts:321](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L321) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -The name of the collection. - -**`memberof`** CollectionApiCreateCollection - -#### Defined in - -[generated-client/api/collection-api.ts:300](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L300) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Optional. Create the collection within a specific folder. - -**`memberof`** CollectionApiCreateCollection - -#### Defined in - -[generated-client/api/collection-api.ts:314](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L314) diff --git a/docs/interfaces/generated_client.CollectionApiRemoveFromCollectionRequest.md b/docs/interfaces/generated_client.CollectionApiRemoveFromCollectionRequest.md deleted file mode 100644 index 4e8197566..000000000 --- a/docs/interfaces/generated_client.CollectionApiRemoveFromCollectionRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CollectionApiRemoveFromCollectionRequest - -# Interface: CollectionApiRemoveFromCollectionRequest - -[generated-client](../modules/generated_client.md).CollectionApiRemoveFromCollectionRequest - -Request parameters for removeFromCollection operation in CollectionApi. - -**`export`** - -**`interface`** CollectionApiRemoveFromCollectionRequest - -## Table of contents - -### Properties - -- [collectionId](generated_client.CollectionApiRemoveFromCollectionRequest.md#collectionid) -- [ids](generated_client.CollectionApiRemoveFromCollectionRequest.md#ids) - -## Properties - -### collectionId - -• `Readonly` **collectionId**: `string` - -The collection id. - -**`memberof`** CollectionApiRemoveFromCollection - -#### Defined in - -[generated-client/api/collection-api.ts:335](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L335) - -___ - -### ids - -• `Readonly` **ids**: `string`[] - -Item ids, comma delimited. - -**`memberof`** CollectionApiRemoveFromCollection - -#### Defined in - -[generated-client/api/collection-api.ts:342](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L342) diff --git a/docs/interfaces/generated_client.CollectionCreationResult.md b/docs/interfaces/generated_client.CollectionCreationResult.md deleted file mode 100644 index 75ea2a54e..000000000 --- a/docs/interfaces/generated_client.CollectionCreationResult.md +++ /dev/null @@ -1,27 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CollectionCreationResult - -# Interface: CollectionCreationResult - -[generated-client](../modules/generated_client.md).CollectionCreationResult - -**`export`** - -**`interface`** CollectionCreationResult - -## Table of contents - -### Properties - -- [Id](generated_client.CollectionCreationResult.md#id) - -## Properties - -### Id - -• `Optional` **Id**: `string` - -**`memberof`** CollectionCreationResult - -#### Defined in - -[generated-client/models/collection-creation-result.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-creation-result.ts#L28) diff --git a/docs/interfaces/generated_client.ConfigImageTypes.md b/docs/interfaces/generated_client.ConfigImageTypes.md deleted file mode 100644 index 290a73047..000000000 --- a/docs/interfaces/generated_client.ConfigImageTypes.md +++ /dev/null @@ -1,105 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ConfigImageTypes - -# Interface: ConfigImageTypes - -[generated-client](../modules/generated_client.md).ConfigImageTypes - -**`export`** - -**`interface`** ConfigImageTypes - -## Table of contents - -### Properties - -- [BackdropSizes](generated_client.ConfigImageTypes.md#backdropsizes) -- [BaseUrl](generated_client.ConfigImageTypes.md#baseurl) -- [LogoSizes](generated_client.ConfigImageTypes.md#logosizes) -- [PosterSizes](generated_client.ConfigImageTypes.md#postersizes) -- [ProfileSizes](generated_client.ConfigImageTypes.md#profilesizes) -- [SecureBaseUrl](generated_client.ConfigImageTypes.md#securebaseurl) -- [StillSizes](generated_client.ConfigImageTypes.md#stillsizes) - -## Properties - -### BackdropSizes - -• `Optional` **BackdropSizes**: ``null`` \| `string`[] - -**`memberof`** ConfigImageTypes - -#### Defined in - -[generated-client/models/config-image-types.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/config-image-types.ts#L28) - -___ - -### BaseUrl - -• `Optional` **BaseUrl**: ``null`` \| `string` - -**`memberof`** ConfigImageTypes - -#### Defined in - -[generated-client/models/config-image-types.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/config-image-types.ts#L34) - -___ - -### LogoSizes - -• `Optional` **LogoSizes**: ``null`` \| `string`[] - -**`memberof`** ConfigImageTypes - -#### Defined in - -[generated-client/models/config-image-types.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/config-image-types.ts#L40) - -___ - -### PosterSizes - -• `Optional` **PosterSizes**: ``null`` \| `string`[] - -**`memberof`** ConfigImageTypes - -#### Defined in - -[generated-client/models/config-image-types.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/config-image-types.ts#L46) - -___ - -### ProfileSizes - -• `Optional` **ProfileSizes**: ``null`` \| `string`[] - -**`memberof`** ConfigImageTypes - -#### Defined in - -[generated-client/models/config-image-types.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/config-image-types.ts#L52) - -___ - -### SecureBaseUrl - -• `Optional` **SecureBaseUrl**: ``null`` \| `string` - -**`memberof`** ConfigImageTypes - -#### Defined in - -[generated-client/models/config-image-types.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/config-image-types.ts#L58) - -___ - -### StillSizes - -• `Optional` **StillSizes**: ``null`` \| `string`[] - -**`memberof`** ConfigImageTypes - -#### Defined in - -[generated-client/models/config-image-types.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/config-image-types.ts#L64) diff --git a/docs/interfaces/generated_client.ConfigurationApiGetNamedConfigurationRequest.md b/docs/interfaces/generated_client.ConfigurationApiGetNamedConfigurationRequest.md deleted file mode 100644 index 03250b299..000000000 --- a/docs/interfaces/generated_client.ConfigurationApiGetNamedConfigurationRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ConfigurationApiGetNamedConfigurationRequest - -# Interface: ConfigurationApiGetNamedConfigurationRequest - -[generated-client](../modules/generated_client.md).ConfigurationApiGetNamedConfigurationRequest - -Request parameters for getNamedConfiguration operation in ConfigurationApi. - -**`export`** - -**`interface`** ConfigurationApiGetNamedConfigurationRequest - -## Table of contents - -### Properties - -- [key](generated_client.ConfigurationApiGetNamedConfigurationRequest.md#key) - -## Properties - -### key - -• `Readonly` **key**: `string` - -Configuration key. - -**`memberof`** ConfigurationApiGetNamedConfiguration - -#### Defined in - -[generated-client/api/configuration-api.ts:417](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L417) diff --git a/docs/interfaces/generated_client.ConfigurationApiUpdateConfigurationRequest.md b/docs/interfaces/generated_client.ConfigurationApiUpdateConfigurationRequest.md deleted file mode 100644 index 5e3d9a3a2..000000000 --- a/docs/interfaces/generated_client.ConfigurationApiUpdateConfigurationRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ConfigurationApiUpdateConfigurationRequest - -# Interface: ConfigurationApiUpdateConfigurationRequest - -[generated-client](../modules/generated_client.md).ConfigurationApiUpdateConfigurationRequest - -Request parameters for updateConfiguration operation in ConfigurationApi. - -**`export`** - -**`interface`** ConfigurationApiUpdateConfigurationRequest - -## Table of contents - -### Properties - -- [serverConfiguration](generated_client.ConfigurationApiUpdateConfigurationRequest.md#serverconfiguration) - -## Properties - -### serverConfiguration - -• `Readonly` **serverConfiguration**: [`ServerConfiguration`](generated_client.ServerConfiguration.md) - -Configuration. - -**`memberof`** ConfigurationApiUpdateConfiguration - -#### Defined in - -[generated-client/api/configuration-api.ts:431](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L431) diff --git a/docs/interfaces/generated_client.ConfigurationApiUpdateMediaEncoderPathRequest.md b/docs/interfaces/generated_client.ConfigurationApiUpdateMediaEncoderPathRequest.md deleted file mode 100644 index e529135d3..000000000 --- a/docs/interfaces/generated_client.ConfigurationApiUpdateMediaEncoderPathRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ConfigurationApiUpdateMediaEncoderPathRequest - -# Interface: ConfigurationApiUpdateMediaEncoderPathRequest - -[generated-client](../modules/generated_client.md).ConfigurationApiUpdateMediaEncoderPathRequest - -Request parameters for updateMediaEncoderPath operation in ConfigurationApi. - -**`export`** - -**`interface`** ConfigurationApiUpdateMediaEncoderPathRequest - -## Table of contents - -### Properties - -- [mediaEncoderPathDto](generated_client.ConfigurationApiUpdateMediaEncoderPathRequest.md#mediaencoderpathdto) - -## Properties - -### mediaEncoderPathDto - -• `Readonly` **mediaEncoderPathDto**: [`MediaEncoderPathDto`](generated_client.MediaEncoderPathDto.md) - -Media encoder path form body. - -**`memberof`** ConfigurationApiUpdateMediaEncoderPath - -#### Defined in - -[generated-client/api/configuration-api.ts:445](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L445) diff --git a/docs/interfaces/generated_client.ConfigurationApiUpdateNamedConfigurationRequest.md b/docs/interfaces/generated_client.ConfigurationApiUpdateNamedConfigurationRequest.md deleted file mode 100644 index a769d0755..000000000 --- a/docs/interfaces/generated_client.ConfigurationApiUpdateNamedConfigurationRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ConfigurationApiUpdateNamedConfigurationRequest - -# Interface: ConfigurationApiUpdateNamedConfigurationRequest - -[generated-client](../modules/generated_client.md).ConfigurationApiUpdateNamedConfigurationRequest - -Request parameters for updateNamedConfiguration operation in ConfigurationApi. - -**`export`** - -**`interface`** ConfigurationApiUpdateNamedConfigurationRequest - -## Table of contents - -### Properties - -- [body](generated_client.ConfigurationApiUpdateNamedConfigurationRequest.md#body) -- [key](generated_client.ConfigurationApiUpdateNamedConfigurationRequest.md#key) - -## Properties - -### body - -• `Readonly` **body**: `any` - -Configuration. - -**`memberof`** ConfigurationApiUpdateNamedConfiguration - -#### Defined in - -[generated-client/api/configuration-api.ts:466](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L466) - -___ - -### key - -• `Readonly` **key**: `string` - -Configuration key. - -**`memberof`** ConfigurationApiUpdateNamedConfiguration - -#### Defined in - -[generated-client/api/configuration-api.ts:459](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L459) diff --git a/docs/interfaces/generated_client.ConfigurationPageInfo.md b/docs/interfaces/generated_client.ConfigurationPageInfo.md deleted file mode 100644 index b94ee84f7..000000000 --- a/docs/interfaces/generated_client.ConfigurationPageInfo.md +++ /dev/null @@ -1,106 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ConfigurationPageInfo - -# Interface: ConfigurationPageInfo - -[generated-client](../modules/generated_client.md).ConfigurationPageInfo - -The configuration page info. - -**`export`** - -**`interface`** ConfigurationPageInfo - -## Table of contents - -### Properties - -- [DisplayName](generated_client.ConfigurationPageInfo.md#displayname) -- [EnableInMainMenu](generated_client.ConfigurationPageInfo.md#enableinmainmenu) -- [MenuIcon](generated_client.ConfigurationPageInfo.md#menuicon) -- [MenuSection](generated_client.ConfigurationPageInfo.md#menusection) -- [Name](generated_client.ConfigurationPageInfo.md#name) -- [PluginId](generated_client.ConfigurationPageInfo.md#pluginid) - -## Properties - -### DisplayName - -• `Optional` **DisplayName**: ``null`` \| `string` - -Gets or sets the display name. - -**`memberof`** ConfigurationPageInfo - -#### Defined in - -[generated-client/models/configuration-page-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/configuration-page-info.ts#L52) - -___ - -### EnableInMainMenu - -• `Optional` **EnableInMainMenu**: `boolean` - -Gets or sets a value indicating whether the configurations page is enabled in the main menu. - -**`memberof`** ConfigurationPageInfo - -#### Defined in - -[generated-client/models/configuration-page-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/configuration-page-info.ts#L34) - -___ - -### MenuIcon - -• `Optional` **MenuIcon**: ``null`` \| `string` - -Gets or sets the menu icon. - -**`memberof`** ConfigurationPageInfo - -#### Defined in - -[generated-client/models/configuration-page-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/configuration-page-info.ts#L46) - -___ - -### MenuSection - -• `Optional` **MenuSection**: ``null`` \| `string` - -Gets or sets the menu section. - -**`memberof`** ConfigurationPageInfo - -#### Defined in - -[generated-client/models/configuration-page-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/configuration-page-info.ts#L40) - -___ - -### Name - -• `Optional` **Name**: `string` - -Gets or sets the name. - -**`memberof`** ConfigurationPageInfo - -#### Defined in - -[generated-client/models/configuration-page-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/configuration-page-info.ts#L28) - -___ - -### PluginId - -• `Optional` **PluginId**: ``null`` \| `string` - -Gets or sets the plugin id. - -**`memberof`** ConfigurationPageInfo - -#### Defined in - -[generated-client/models/configuration-page-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/configuration-page-info.ts#L58) diff --git a/docs/interfaces/generated_client.ConfigurationParameters.md b/docs/interfaces/generated_client.ConfigurationParameters.md deleted file mode 100644 index e2afa58a2..000000000 --- a/docs/interfaces/generated_client.ConfigurationParameters.md +++ /dev/null @@ -1,100 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ConfigurationParameters - -# Interface: ConfigurationParameters - -[generated-client](../modules/generated_client.md).ConfigurationParameters - -Jellyfin API -No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - -The version of the OpenAPI document: 10.8.1 - -NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -https://openapi-generator.tech -Do not edit the class manually. - -## Table of contents - -### Properties - -- [accessToken](generated_client.ConfigurationParameters.md#accesstoken) -- [apiKey](generated_client.ConfigurationParameters.md#apikey) -- [baseOptions](generated_client.ConfigurationParameters.md#baseoptions) -- [basePath](generated_client.ConfigurationParameters.md#basepath) -- [formDataCtor](generated_client.ConfigurationParameters.md#formdatactor) -- [password](generated_client.ConfigurationParameters.md#password) -- [username](generated_client.ConfigurationParameters.md#username) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` \| `Promise`<`string`\> \| (`name?`: `string`, `scopes?`: `string`[]) => `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `Promise`<`string`\> - -#### Defined in - -[generated-client/configuration.ts:20](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L20) - -___ - -### apiKey - -• `Optional` **apiKey**: `string` \| `Promise`<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`<`string`\> - -#### Defined in - -[generated-client/configuration.ts:17](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L17) - -___ - -### baseOptions - -• `Optional` **baseOptions**: `any` - -#### Defined in - -[generated-client/configuration.ts:22](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L22) - -___ - -### basePath - -• `Optional` **basePath**: `string` - -#### Defined in - -[generated-client/configuration.ts:21](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L21) - -___ - -### formDataCtor - -• `Optional` **formDataCtor**: () => `any` - -#### Type declaration - -• **new ConfigurationParameters**() - -#### Defined in - -[generated-client/configuration.ts:23](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L23) - -___ - -### password - -• `Optional` **password**: `string` - -#### Defined in - -[generated-client/configuration.ts:19](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L19) - -___ - -### username - -• `Optional` **username**: `string` - -#### Defined in - -[generated-client/configuration.ts:18](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L18) diff --git a/docs/interfaces/generated_client.ContainerProfile.md b/docs/interfaces/generated_client.ContainerProfile.md deleted file mode 100644 index 6cdabd3c6..000000000 --- a/docs/interfaces/generated_client.ContainerProfile.md +++ /dev/null @@ -1,53 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ContainerProfile - -# Interface: ContainerProfile - -[generated-client](../modules/generated_client.md).ContainerProfile - -**`export`** - -**`interface`** ContainerProfile - -## Table of contents - -### Properties - -- [Conditions](generated_client.ContainerProfile.md#conditions) -- [Container](generated_client.ContainerProfile.md#container) -- [Type](generated_client.ContainerProfile.md#type) - -## Properties - -### Conditions - -• `Optional` **Conditions**: ``null`` \| [`ProfileCondition`](generated_client.ProfileCondition.md)[] - -**`memberof`** ContainerProfile - -#### Defined in - -[generated-client/models/container-profile.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/container-profile.ts#L36) - -___ - -### Container - -• `Optional` **Container**: `string` - -**`memberof`** ContainerProfile - -#### Defined in - -[generated-client/models/container-profile.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/container-profile.ts#L42) - -___ - -### Type - -• `Optional` **Type**: [`DlnaProfileType`](../enums/generated_client.DlnaProfileType.md) - -**`memberof`** ContainerProfile - -#### Defined in - -[generated-client/models/container-profile.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/container-profile.ts#L30) diff --git a/docs/interfaces/generated_client.ControlResponse.md b/docs/interfaces/generated_client.ControlResponse.md deleted file mode 100644 index f963643af..000000000 --- a/docs/interfaces/generated_client.ControlResponse.md +++ /dev/null @@ -1,57 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ControlResponse - -# Interface: ControlResponse - -[generated-client](../modules/generated_client.md).ControlResponse - -**`export`** - -**`interface`** ControlResponse - -## Table of contents - -### Properties - -- [Headers](generated_client.ControlResponse.md#headers) -- [IsSuccessful](generated_client.ControlResponse.md#issuccessful) -- [Xml](generated_client.ControlResponse.md#xml) - -## Properties - -### Headers - -• `Optional` **Headers**: `Object` - -**`memberof`** ControlResponse - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/control-response.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/control-response.ts#L28) - -___ - -### IsSuccessful - -• `Optional` **IsSuccessful**: `boolean` - -**`memberof`** ControlResponse - -#### Defined in - -[generated-client/models/control-response.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/control-response.ts#L40) - -___ - -### Xml - -• `Optional` **Xml**: `string` - -**`memberof`** ControlResponse - -#### Defined in - -[generated-client/models/control-response.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/control-response.ts#L34) diff --git a/docs/interfaces/generated_client.CountryInfo.md b/docs/interfaces/generated_client.CountryInfo.md deleted file mode 100644 index 0551ed946..000000000 --- a/docs/interfaces/generated_client.CountryInfo.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CountryInfo - -# Interface: CountryInfo - -[generated-client](../modules/generated_client.md).CountryInfo - -Class CountryInfo. - -**`export`** - -**`interface`** CountryInfo - -## Table of contents - -### Properties - -- [DisplayName](generated_client.CountryInfo.md#displayname) -- [Name](generated_client.CountryInfo.md#name) -- [ThreeLetterISORegionName](generated_client.CountryInfo.md#threeletterisoregionname) -- [TwoLetterISORegionName](generated_client.CountryInfo.md#twoletterisoregionname) - -## Properties - -### DisplayName - -• `Optional` **DisplayName**: ``null`` \| `string` - -Gets or sets the display name. - -**`memberof`** CountryInfo - -#### Defined in - -[generated-client/models/country-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/country-info.ts#L34) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** CountryInfo - -#### Defined in - -[generated-client/models/country-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/country-info.ts#L28) - -___ - -### ThreeLetterISORegionName - -• `Optional` **ThreeLetterISORegionName**: ``null`` \| `string` - -Gets or sets the name of the three letter ISO region. - -**`memberof`** CountryInfo - -#### Defined in - -[generated-client/models/country-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/country-info.ts#L46) - -___ - -### TwoLetterISORegionName - -• `Optional` **TwoLetterISORegionName**: ``null`` \| `string` - -Gets or sets the name of the two letter ISO region. - -**`memberof`** CountryInfo - -#### Defined in - -[generated-client/models/country-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/country-info.ts#L40) diff --git a/docs/interfaces/generated_client.CreatePlaylistDto.md b/docs/interfaces/generated_client.CreatePlaylistDto.md deleted file mode 100644 index 6d0b2418a..000000000 --- a/docs/interfaces/generated_client.CreatePlaylistDto.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CreatePlaylistDto - -# Interface: CreatePlaylistDto - -[generated-client](../modules/generated_client.md).CreatePlaylistDto - -Create new playlist dto. - -**`export`** - -**`interface`** CreatePlaylistDto - -## Table of contents - -### Properties - -- [Ids](generated_client.CreatePlaylistDto.md#ids) -- [MediaType](generated_client.CreatePlaylistDto.md#mediatype) -- [Name](generated_client.CreatePlaylistDto.md#name) -- [UserId](generated_client.CreatePlaylistDto.md#userid) - -## Properties - -### Ids - -• `Optional` **Ids**: `string`[] - -Gets or sets item ids to add to the playlist. - -**`memberof`** CreatePlaylistDto - -#### Defined in - -[generated-client/models/create-playlist-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/create-playlist-dto.ts#L34) - -___ - -### MediaType - -• `Optional` **MediaType**: ``null`` \| `string` - -Gets or sets the media type. - -**`memberof`** CreatePlaylistDto - -#### Defined in - -[generated-client/models/create-playlist-dto.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/create-playlist-dto.ts#L46) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name of the new playlist. - -**`memberof`** CreatePlaylistDto - -#### Defined in - -[generated-client/models/create-playlist-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/create-playlist-dto.ts#L28) - -___ - -### UserId - -• `Optional` **UserId**: ``null`` \| `string` - -Gets or sets the user id. - -**`memberof`** CreatePlaylistDto - -#### Defined in - -[generated-client/models/create-playlist-dto.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/create-playlist-dto.ts#L40) diff --git a/docs/interfaces/generated_client.CreateUserByName.md b/docs/interfaces/generated_client.CreateUserByName.md deleted file mode 100644 index 67730b2f4..000000000 --- a/docs/interfaces/generated_client.CreateUserByName.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CreateUserByName - -# Interface: CreateUserByName - -[generated-client](../modules/generated_client.md).CreateUserByName - -The create user by name request body. - -**`export`** - -**`interface`** CreateUserByName - -## Table of contents - -### Properties - -- [Name](generated_client.CreateUserByName.md#name) -- [Password](generated_client.CreateUserByName.md#password) - -## Properties - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the username. - -**`memberof`** CreateUserByName - -#### Defined in - -[generated-client/models/create-user-by-name.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/create-user-by-name.ts#L28) - -___ - -### Password - -• `Optional` **Password**: ``null`` \| `string` - -Gets or sets the password. - -**`memberof`** CreateUserByName - -#### Defined in - -[generated-client/models/create-user-by-name.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/create-user-by-name.ts#L34) diff --git a/docs/interfaces/generated_client.CultureDto.md b/docs/interfaces/generated_client.CultureDto.md deleted file mode 100644 index 3333048f5..000000000 --- a/docs/interfaces/generated_client.CultureDto.md +++ /dev/null @@ -1,89 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CultureDto - -# Interface: CultureDto - -[generated-client](../modules/generated_client.md).CultureDto - -Class CultureDto. - -**`export`** - -**`interface`** CultureDto - -## Table of contents - -### Properties - -- [DisplayName](generated_client.CultureDto.md#displayname) -- [Name](generated_client.CultureDto.md#name) -- [ThreeLetterISOLanguageName](generated_client.CultureDto.md#threeletterisolanguagename) -- [ThreeLetterISOLanguageNames](generated_client.CultureDto.md#threeletterisolanguagenames) -- [TwoLetterISOLanguageName](generated_client.CultureDto.md#twoletterisolanguagename) - -## Properties - -### DisplayName - -• `Optional` **DisplayName**: `string` - -Gets the display name. - -**`memberof`** CultureDto - -#### Defined in - -[generated-client/models/culture-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/culture-dto.ts#L34) - -___ - -### Name - -• `Optional` **Name**: `string` - -Gets the name. - -**`memberof`** CultureDto - -#### Defined in - -[generated-client/models/culture-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/culture-dto.ts#L28) - -___ - -### ThreeLetterISOLanguageName - -• `Optional` **ThreeLetterISOLanguageName**: ``null`` \| `string` - -Gets the name of the three letter ISO language. - -**`memberof`** CultureDto - -#### Defined in - -[generated-client/models/culture-dto.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/culture-dto.ts#L46) - -___ - -### ThreeLetterISOLanguageNames - -• `Optional` **ThreeLetterISOLanguageNames**: `string`[] - -**`memberof`** CultureDto - -#### Defined in - -[generated-client/models/culture-dto.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/culture-dto.ts#L52) - -___ - -### TwoLetterISOLanguageName - -• `Optional` **TwoLetterISOLanguageName**: `string` - -Gets the name of the two letter ISO language. - -**`memberof`** CultureDto - -#### Defined in - -[generated-client/models/culture-dto.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/culture-dto.ts#L40) diff --git a/docs/interfaces/generated_client.DashboardApiGetConfigurationPagesRequest.md b/docs/interfaces/generated_client.DashboardApiGetConfigurationPagesRequest.md deleted file mode 100644 index baf8685a1..000000000 --- a/docs/interfaces/generated_client.DashboardApiGetConfigurationPagesRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DashboardApiGetConfigurationPagesRequest - -# Interface: DashboardApiGetConfigurationPagesRequest - -[generated-client](../modules/generated_client.md).DashboardApiGetConfigurationPagesRequest - -Request parameters for getConfigurationPages operation in DashboardApi. - -**`export`** - -**`interface`** DashboardApiGetConfigurationPagesRequest - -## Table of contents - -### Properties - -- [enableInMainMenu](generated_client.DashboardApiGetConfigurationPagesRequest.md#enableinmainmenu) - -## Properties - -### enableInMainMenu - -• `Optional` `Readonly` **enableInMainMenu**: `boolean` - -Whether to enable in the main menu. - -**`memberof`** DashboardApiGetConfigurationPages - -#### Defined in - -[generated-client/api/dashboard-api.ts:182](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dashboard-api.ts#L182) diff --git a/docs/interfaces/generated_client.DashboardApiGetDashboardConfigurationPageRequest.md b/docs/interfaces/generated_client.DashboardApiGetDashboardConfigurationPageRequest.md deleted file mode 100644 index ca39aede2..000000000 --- a/docs/interfaces/generated_client.DashboardApiGetDashboardConfigurationPageRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DashboardApiGetDashboardConfigurationPageRequest - -# Interface: DashboardApiGetDashboardConfigurationPageRequest - -[generated-client](../modules/generated_client.md).DashboardApiGetDashboardConfigurationPageRequest - -Request parameters for getDashboardConfigurationPage operation in DashboardApi. - -**`export`** - -**`interface`** DashboardApiGetDashboardConfigurationPageRequest - -## Table of contents - -### Properties - -- [name](generated_client.DashboardApiGetDashboardConfigurationPageRequest.md#name) - -## Properties - -### name - -• `Optional` `Readonly` **name**: `string` - -The name of the page. - -**`memberof`** DashboardApiGetDashboardConfigurationPage - -#### Defined in - -[generated-client/api/dashboard-api.ts:196](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dashboard-api.ts#L196) diff --git a/docs/interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md b/docs/interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md deleted file mode 100644 index 7cbf32dd2..000000000 --- a/docs/interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DefaultDirectoryBrowserInfoDto - -# Interface: DefaultDirectoryBrowserInfoDto - -[generated-client](../modules/generated_client.md).DefaultDirectoryBrowserInfoDto - -Default directory browser info. - -**`export`** - -**`interface`** DefaultDirectoryBrowserInfoDto - -## Table of contents - -### Properties - -- [Path](generated_client.DefaultDirectoryBrowserInfoDto.md#path) - -## Properties - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** DefaultDirectoryBrowserInfoDto - -#### Defined in - -[generated-client/models/default-directory-browser-info-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/default-directory-browser-info-dto.ts#L28) diff --git a/docs/interfaces/generated_client.DeviceIdentification.md b/docs/interfaces/generated_client.DeviceIdentification.md deleted file mode 100644 index 7171619c9..000000000 --- a/docs/interfaces/generated_client.DeviceIdentification.md +++ /dev/null @@ -1,149 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DeviceIdentification - -# Interface: DeviceIdentification - -[generated-client](../modules/generated_client.md).DeviceIdentification - -**`export`** - -**`interface`** DeviceIdentification - -## Table of contents - -### Properties - -- [FriendlyName](generated_client.DeviceIdentification.md#friendlyname) -- [Headers](generated_client.DeviceIdentification.md#headers) -- [Manufacturer](generated_client.DeviceIdentification.md#manufacturer) -- [ManufacturerUrl](generated_client.DeviceIdentification.md#manufacturerurl) -- [ModelDescription](generated_client.DeviceIdentification.md#modeldescription) -- [ModelName](generated_client.DeviceIdentification.md#modelname) -- [ModelNumber](generated_client.DeviceIdentification.md#modelnumber) -- [ModelUrl](generated_client.DeviceIdentification.md#modelurl) -- [SerialNumber](generated_client.DeviceIdentification.md#serialnumber) - -## Properties - -### FriendlyName - -• `Optional` **FriendlyName**: `string` - -Gets or sets the name of the friendly. - -**`memberof`** DeviceIdentification - -#### Defined in - -[generated-client/models/device-identification.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-identification.ts#L29) - -___ - -### Headers - -• `Optional` **Headers**: [`HttpHeaderInfo`](generated_client.HttpHeaderInfo.md)[] - -Gets or sets the headers. - -**`memberof`** DeviceIdentification - -#### Defined in - -[generated-client/models/device-identification.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-identification.ts#L77) - -___ - -### Manufacturer - -• `Optional` **Manufacturer**: `string` - -Gets or sets the manufacturer. - -**`memberof`** DeviceIdentification - -#### Defined in - -[generated-client/models/device-identification.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-identification.ts#L65) - -___ - -### ManufacturerUrl - -• `Optional` **ManufacturerUrl**: `string` - -Gets or sets the manufacturer URL. - -**`memberof`** DeviceIdentification - -#### Defined in - -[generated-client/models/device-identification.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-identification.ts#L71) - -___ - -### ModelDescription - -• `Optional` **ModelDescription**: `string` - -Gets or sets the model description. - -**`memberof`** DeviceIdentification - -#### Defined in - -[generated-client/models/device-identification.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-identification.ts#L53) - -___ - -### ModelName - -• `Optional` **ModelName**: `string` - -Gets or sets the name of the model. - -**`memberof`** DeviceIdentification - -#### Defined in - -[generated-client/models/device-identification.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-identification.ts#L47) - -___ - -### ModelNumber - -• `Optional` **ModelNumber**: `string` - -Gets or sets the model number. - -**`memberof`** DeviceIdentification - -#### Defined in - -[generated-client/models/device-identification.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-identification.ts#L35) - -___ - -### ModelUrl - -• `Optional` **ModelUrl**: `string` - -Gets or sets the model URL. - -**`memberof`** DeviceIdentification - -#### Defined in - -[generated-client/models/device-identification.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-identification.ts#L59) - -___ - -### SerialNumber - -• `Optional` **SerialNumber**: `string` - -Gets or sets the serial number. - -**`memberof`** DeviceIdentification - -#### Defined in - -[generated-client/models/device-identification.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-identification.ts#L41) diff --git a/docs/interfaces/generated_client.DeviceInfo.md b/docs/interfaces/generated_client.DeviceInfo.md deleted file mode 100644 index 2b945bfc6..000000000 --- a/docs/interfaces/generated_client.DeviceInfo.md +++ /dev/null @@ -1,158 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DeviceInfo - -# Interface: DeviceInfo - -[generated-client](../modules/generated_client.md).DeviceInfo - -**`export`** - -**`interface`** DeviceInfo - -## Table of contents - -### Properties - -- [AccessToken](generated_client.DeviceInfo.md#accesstoken) -- [AppName](generated_client.DeviceInfo.md#appname) -- [AppVersion](generated_client.DeviceInfo.md#appversion) -- [Capabilities](generated_client.DeviceInfo.md#capabilities) -- [DateLastActivity](generated_client.DeviceInfo.md#datelastactivity) -- [IconUrl](generated_client.DeviceInfo.md#iconurl) -- [Id](generated_client.DeviceInfo.md#id) -- [LastUserId](generated_client.DeviceInfo.md#lastuserid) -- [LastUserName](generated_client.DeviceInfo.md#lastusername) -- [Name](generated_client.DeviceInfo.md#name) - -## Properties - -### AccessToken - -• `Optional` **AccessToken**: ``null`` \| `string` - -Gets or sets the access token. - -**`memberof`** DeviceInfo - -#### Defined in - -[generated-client/models/device-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info.ts#L35) - -___ - -### AppName - -• `Optional` **AppName**: ``null`` \| `string` - -Gets or sets the name of the application. - -**`memberof`** DeviceInfo - -#### Defined in - -[generated-client/models/device-info.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info.ts#L53) - -___ - -### AppVersion - -• `Optional` **AppVersion**: ``null`` \| `string` - -Gets or sets the application version. - -**`memberof`** DeviceInfo - -#### Defined in - -[generated-client/models/device-info.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info.ts#L59) - -___ - -### Capabilities - -• `Optional` **Capabilities**: [`ClientCapabilities`](generated_client.ClientCapabilities.md) - -**`memberof`** DeviceInfo - -#### Defined in - -[generated-client/models/device-info.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info.ts#L77) - -___ - -### DateLastActivity - -• `Optional` **DateLastActivity**: `string` - -Gets or sets the date last modified. - -**`memberof`** DeviceInfo - -#### Defined in - -[generated-client/models/device-info.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info.ts#L71) - -___ - -### IconUrl - -• `Optional` **IconUrl**: ``null`` \| `string` - -**`memberof`** DeviceInfo - -#### Defined in - -[generated-client/models/device-info.ts:83](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info.ts#L83) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets the identifier. - -**`memberof`** DeviceInfo - -#### Defined in - -[generated-client/models/device-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info.ts#L41) - -___ - -### LastUserId - -• `Optional` **LastUserId**: `string` - -Gets or sets the last user identifier. - -**`memberof`** DeviceInfo - -#### Defined in - -[generated-client/models/device-info.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info.ts#L65) - -___ - -### LastUserName - -• `Optional` **LastUserName**: ``null`` \| `string` - -Gets or sets the last name of the user. - -**`memberof`** DeviceInfo - -#### Defined in - -[generated-client/models/device-info.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info.ts#L47) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -**`memberof`** DeviceInfo - -#### Defined in - -[generated-client/models/device-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info.ts#L29) diff --git a/docs/interfaces/generated_client.DeviceInfoQueryResult.md b/docs/interfaces/generated_client.DeviceInfoQueryResult.md deleted file mode 100644 index ea7eb54e4..000000000 --- a/docs/interfaces/generated_client.DeviceInfoQueryResult.md +++ /dev/null @@ -1,59 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DeviceInfoQueryResult - -# Interface: DeviceInfoQueryResult - -[generated-client](../modules/generated_client.md).DeviceInfoQueryResult - -**`export`** - -**`interface`** DeviceInfoQueryResult - -## Table of contents - -### Properties - -- [Items](generated_client.DeviceInfoQueryResult.md#items) -- [StartIndex](generated_client.DeviceInfoQueryResult.md#startindex) -- [TotalRecordCount](generated_client.DeviceInfoQueryResult.md#totalrecordcount) - -## Properties - -### Items - -• `Optional` **Items**: ``null`` \| [`DeviceInfo`](generated_client.DeviceInfo.md)[] - -Gets or sets the items. - -**`memberof`** DeviceInfoQueryResult - -#### Defined in - -[generated-client/models/device-info-query-result.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info-query-result.ts#L29) - -___ - -### StartIndex - -• `Optional` **StartIndex**: `number` - -Gets or sets the index of the first record in Items. - -**`memberof`** DeviceInfoQueryResult - -#### Defined in - -[generated-client/models/device-info-query-result.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info-query-result.ts#L41) - -___ - -### TotalRecordCount - -• `Optional` **TotalRecordCount**: `number` - -Gets or sets the total number of records available. - -**`memberof`** DeviceInfoQueryResult - -#### Defined in - -[generated-client/models/device-info-query-result.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-info-query-result.ts#L35) diff --git a/docs/interfaces/generated_client.DeviceOptions.md b/docs/interfaces/generated_client.DeviceOptions.md deleted file mode 100644 index 9f1b66754..000000000 --- a/docs/interfaces/generated_client.DeviceOptions.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DeviceOptions - -# Interface: DeviceOptions - -[generated-client](../modules/generated_client.md).DeviceOptions - -An entity representing custom options for a device. - -**`export`** - -**`interface`** DeviceOptions - -## Table of contents - -### Properties - -- [CustomName](generated_client.DeviceOptions.md#customname) -- [DeviceId](generated_client.DeviceOptions.md#deviceid) -- [Id](generated_client.DeviceOptions.md#id) - -## Properties - -### CustomName - -• `Optional` **CustomName**: ``null`` \| `string` - -Gets or sets the custom name. - -**`memberof`** DeviceOptions - -#### Defined in - -[generated-client/models/device-options.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-options.ts#L40) - -___ - -### DeviceId - -• `Optional` **DeviceId**: `string` - -Gets the device id. - -**`memberof`** DeviceOptions - -#### Defined in - -[generated-client/models/device-options.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-options.ts#L34) - -___ - -### Id - -• `Optional` **Id**: `number` - -Gets the id. - -**`memberof`** DeviceOptions - -#### Defined in - -[generated-client/models/device-options.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-options.ts#L28) diff --git a/docs/interfaces/generated_client.DeviceOptionsDto.md b/docs/interfaces/generated_client.DeviceOptionsDto.md deleted file mode 100644 index eb9d4331e..000000000 --- a/docs/interfaces/generated_client.DeviceOptionsDto.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DeviceOptionsDto - -# Interface: DeviceOptionsDto - -[generated-client](../modules/generated_client.md).DeviceOptionsDto - -A dto representing custom options for a device. - -**`export`** - -**`interface`** DeviceOptionsDto - -## Table of contents - -### Properties - -- [CustomName](generated_client.DeviceOptionsDto.md#customname) -- [DeviceId](generated_client.DeviceOptionsDto.md#deviceid) -- [Id](generated_client.DeviceOptionsDto.md#id) - -## Properties - -### CustomName - -• `Optional` **CustomName**: ``null`` \| `string` - -Gets or sets the custom name. - -**`memberof`** DeviceOptionsDto - -#### Defined in - -[generated-client/models/device-options-dto.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-options-dto.ts#L40) - -___ - -### DeviceId - -• `Optional` **DeviceId**: ``null`` \| `string` - -Gets or sets the device id. - -**`memberof`** DeviceOptionsDto - -#### Defined in - -[generated-client/models/device-options-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-options-dto.ts#L34) - -___ - -### Id - -• `Optional` **Id**: `number` - -Gets or sets the id. - -**`memberof`** DeviceOptionsDto - -#### Defined in - -[generated-client/models/device-options-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-options-dto.ts#L28) diff --git a/docs/interfaces/generated_client.DeviceProfile.md b/docs/interfaces/generated_client.DeviceProfile.md deleted file mode 100644 index b3856c677..000000000 --- a/docs/interfaces/generated_client.DeviceProfile.md +++ /dev/null @@ -1,599 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DeviceProfile - -# Interface: DeviceProfile - -[generated-client](../modules/generated_client.md).DeviceProfile - -A MediaBrowser.Model.Dlna.DeviceProfile represents a set of metadata which determines which content a certain device is able to play.
Specifically, it defines the supported containers and codecs (video and/or audio, including codec profiles and levels) the device is able to direct play (without transcoding or remuxing), as well as which containers/codecs to transcode to in case it isn\'t. - -**`export`** - -**`interface`** DeviceProfile - -## Table of contents - -### Properties - -- [AlbumArtPn](generated_client.DeviceProfile.md#albumartpn) -- [CodecProfiles](generated_client.DeviceProfile.md#codecprofiles) -- [ContainerProfiles](generated_client.DeviceProfile.md#containerprofiles) -- [DirectPlayProfiles](generated_client.DeviceProfile.md#directplayprofiles) -- [EnableAlbumArtInDidl](generated_client.DeviceProfile.md#enablealbumartindidl) -- [EnableMSMediaReceiverRegistrar](generated_client.DeviceProfile.md#enablemsmediareceiverregistrar) -- [EnableSingleAlbumArtLimit](generated_client.DeviceProfile.md#enablesinglealbumartlimit) -- [EnableSingleSubtitleLimit](generated_client.DeviceProfile.md#enablesinglesubtitlelimit) -- [FriendlyName](generated_client.DeviceProfile.md#friendlyname) -- [Id](generated_client.DeviceProfile.md#id) -- [Identification](generated_client.DeviceProfile.md#identification) -- [IgnoreTranscodeByteRangeRequests](generated_client.DeviceProfile.md#ignoretranscodebyterangerequests) -- [Manufacturer](generated_client.DeviceProfile.md#manufacturer) -- [ManufacturerUrl](generated_client.DeviceProfile.md#manufacturerurl) -- [MaxAlbumArtHeight](generated_client.DeviceProfile.md#maxalbumartheight) -- [MaxAlbumArtWidth](generated_client.DeviceProfile.md#maxalbumartwidth) -- [MaxIconHeight](generated_client.DeviceProfile.md#maxiconheight) -- [MaxIconWidth](generated_client.DeviceProfile.md#maxiconwidth) -- [MaxStaticBitrate](generated_client.DeviceProfile.md#maxstaticbitrate) -- [MaxStaticMusicBitrate](generated_client.DeviceProfile.md#maxstaticmusicbitrate) -- [MaxStreamingBitrate](generated_client.DeviceProfile.md#maxstreamingbitrate) -- [ModelDescription](generated_client.DeviceProfile.md#modeldescription) -- [ModelName](generated_client.DeviceProfile.md#modelname) -- [ModelNumber](generated_client.DeviceProfile.md#modelnumber) -- [ModelUrl](generated_client.DeviceProfile.md#modelurl) -- [MusicStreamingTranscodingBitrate](generated_client.DeviceProfile.md#musicstreamingtranscodingbitrate) -- [Name](generated_client.DeviceProfile.md#name) -- [ProtocolInfo](generated_client.DeviceProfile.md#protocolinfo) -- [RequiresPlainFolders](generated_client.DeviceProfile.md#requiresplainfolders) -- [RequiresPlainVideoItems](generated_client.DeviceProfile.md#requiresplainvideoitems) -- [ResponseProfiles](generated_client.DeviceProfile.md#responseprofiles) -- [SerialNumber](generated_client.DeviceProfile.md#serialnumber) -- [SonyAggregationFlags](generated_client.DeviceProfile.md#sonyaggregationflags) -- [SubtitleProfiles](generated_client.DeviceProfile.md#subtitleprofiles) -- [SupportedMediaTypes](generated_client.DeviceProfile.md#supportedmediatypes) -- [TimelineOffsetSeconds](generated_client.DeviceProfile.md#timelineoffsetseconds) -- [TranscodingProfiles](generated_client.DeviceProfile.md#transcodingprofiles) -- [UserId](generated_client.DeviceProfile.md#userid) -- [XmlRootAttributes](generated_client.DeviceProfile.md#xmlrootattributes) - -## Properties - -### AlbumArtPn - -• `Optional` **AlbumArtPn**: ``null`` \| `string` - -Gets or sets the AlbumArtPn. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:132](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L132) - -___ - -### CodecProfiles - -• `Optional` **CodecProfiles**: [`CodecProfile`](generated_client.CodecProfile.md)[] - -Gets or sets the codec profiles. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:252](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L252) - -___ - -### ContainerProfiles - -• `Optional` **ContainerProfiles**: [`ContainerProfile`](generated_client.ContainerProfile.md)[] - -Gets or sets the container profiles. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:246](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L246) - -___ - -### DirectPlayProfiles - -• `Optional` **DirectPlayProfiles**: [`DirectPlayProfile`](generated_client.DirectPlayProfile.md)[] - -Gets or sets the direct play profiles. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:234](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L234) - -___ - -### EnableAlbumArtInDidl - -• `Optional` **EnableAlbumArtInDidl**: `boolean` - -Gets or sets a value indicating whether EnableAlbumArtInDidl. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:102](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L102) - -___ - -### EnableMSMediaReceiverRegistrar - -• `Optional` **EnableMSMediaReceiverRegistrar**: `boolean` - -Gets or sets a value indicating whether EnableMSMediaReceiverRegistrar. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:216](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L216) - -___ - -### EnableSingleAlbumArtLimit - -• `Optional` **EnableSingleAlbumArtLimit**: `boolean` - -Gets or sets a value indicating whether EnableSingleAlbumArtLimit. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:108](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L108) - -___ - -### EnableSingleSubtitleLimit - -• `Optional` **EnableSingleSubtitleLimit**: `boolean` - -Gets or sets a value indicating whether EnableSingleSubtitleLimit. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:114](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L114) - -___ - -### FriendlyName - -• `Optional` **FriendlyName**: ``null`` \| `string` - -Gets or sets the friendly name of the device profile, which can be shown to users. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L54) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets the Id. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L42) - -___ - -### Identification - -• `Optional` **Identification**: [`DeviceIdentification`](generated_client.DeviceIdentification.md) - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L48) - -___ - -### IgnoreTranscodeByteRangeRequests - -• `Optional` **IgnoreTranscodeByteRangeRequests**: `boolean` - -Gets or sets a value indicating whether IgnoreTranscodeByteRangeRequests. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:222](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L222) - -___ - -### Manufacturer - -• `Optional` **Manufacturer**: ``null`` \| `string` - -Gets or sets the manufacturer of the device which this profile represents. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L60) - -___ - -### ManufacturerUrl - -• `Optional` **ManufacturerUrl**: ``null`` \| `string` - -Gets or sets an url for the manufacturer of the device which this profile represents. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L66) - -___ - -### MaxAlbumArtHeight - -• `Optional` **MaxAlbumArtHeight**: ``null`` \| `number` - -Gets or sets the MaxAlbumArtHeight. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:144](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L144) - -___ - -### MaxAlbumArtWidth - -• `Optional` **MaxAlbumArtWidth**: ``null`` \| `number` - -Gets or sets the MaxAlbumArtWidth. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:138](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L138) - -___ - -### MaxIconHeight - -• `Optional` **MaxIconHeight**: ``null`` \| `number` - -Gets or sets the maximum allowed height of embedded icons. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:156](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L156) - -___ - -### MaxIconWidth - -• `Optional` **MaxIconWidth**: ``null`` \| `number` - -Gets or sets the maximum allowed width of embedded icons. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:150](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L150) - -___ - -### MaxStaticBitrate - -• `Optional` **MaxStaticBitrate**: ``null`` \| `number` - -Gets or sets the maximum allowed bitrate for statically streamed content (= direct played files). - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:168](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L168) - -___ - -### MaxStaticMusicBitrate - -• `Optional` **MaxStaticMusicBitrate**: ``null`` \| `number` - -Gets or sets the maximum allowed bitrate for statically streamed (= direct played) music files. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:180](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L180) - -___ - -### MaxStreamingBitrate - -• `Optional` **MaxStreamingBitrate**: ``null`` \| `number` - -Gets or sets the maximum allowed bitrate for all streamed content. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:162](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L162) - -___ - -### ModelDescription - -• `Optional` **ModelDescription**: ``null`` \| `string` - -Gets or sets the model description of the device which this profile represents. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L78) - -___ - -### ModelName - -• `Optional` **ModelName**: ``null`` \| `string` - -Gets or sets the model name of the device which this profile represents. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L72) - -___ - -### ModelNumber - -• `Optional` **ModelNumber**: ``null`` \| `string` - -Gets or sets the model number of the device which this profile represents. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L84) - -___ - -### ModelUrl - -• `Optional` **ModelUrl**: ``null`` \| `string` - -Gets or sets the ModelUrl. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:90](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L90) - -___ - -### MusicStreamingTranscodingBitrate - -• `Optional` **MusicStreamingTranscodingBitrate**: ``null`` \| `number` - -Gets or sets the maximum allowed bitrate for transcoded music streams. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:174](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L174) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name of this device profile. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L36) - -___ - -### ProtocolInfo - -• `Optional` **ProtocolInfo**: ``null`` \| `string` - -Gets or sets the ProtocolInfo. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:192](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L192) - -___ - -### RequiresPlainFolders - -• `Optional` **RequiresPlainFolders**: `boolean` - -Gets or sets a value indicating whether RequiresPlainFolders. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:210](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L210) - -___ - -### RequiresPlainVideoItems - -• `Optional` **RequiresPlainVideoItems**: `boolean` - -Gets or sets a value indicating whether RequiresPlainVideoItems. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:204](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L204) - -___ - -### ResponseProfiles - -• `Optional` **ResponseProfiles**: [`ResponseProfile`](generated_client.ResponseProfile.md)[] - -Gets or sets the ResponseProfiles. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:258](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L258) - -___ - -### SerialNumber - -• `Optional` **SerialNumber**: ``null`` \| `string` - -Gets or sets the serial number of the device which this profile represents. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:96](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L96) - -___ - -### SonyAggregationFlags - -• `Optional` **SonyAggregationFlags**: ``null`` \| `string` - -Gets or sets the content of the aggregationFlags element in the urn:schemas-sonycom:av namespace. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:186](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L186) - -___ - -### SubtitleProfiles - -• `Optional` **SubtitleProfiles**: [`SubtitleProfile`](generated_client.SubtitleProfile.md)[] - -Gets or sets the subtitle profiles. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:264](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L264) - -___ - -### SupportedMediaTypes - -• `Optional` **SupportedMediaTypes**: `string` - -Gets or sets the SupportedMediaTypes. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:120](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L120) - -___ - -### TimelineOffsetSeconds - -• `Optional` **TimelineOffsetSeconds**: `number` - -Gets or sets the TimelineOffsetSeconds. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:198](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L198) - -___ - -### TranscodingProfiles - -• `Optional` **TranscodingProfiles**: [`TranscodingProfile`](generated_client.TranscodingProfile.md)[] - -Gets or sets the transcoding profiles. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:240](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L240) - -___ - -### UserId - -• `Optional` **UserId**: ``null`` \| `string` - -Gets or sets the UserId. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:126](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L126) - -___ - -### XmlRootAttributes - -• `Optional` **XmlRootAttributes**: [`XmlAttribute`](generated_client.XmlAttribute.md)[] - -Gets or sets the XmlRootAttributes. - -**`memberof`** DeviceProfile - -#### Defined in - -[generated-client/models/device-profile.ts:228](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile.ts#L228) diff --git a/docs/interfaces/generated_client.DeviceProfileInfo.md b/docs/interfaces/generated_client.DeviceProfileInfo.md deleted file mode 100644 index 03723d6fd..000000000 --- a/docs/interfaces/generated_client.DeviceProfileInfo.md +++ /dev/null @@ -1,57 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DeviceProfileInfo - -# Interface: DeviceProfileInfo - -[generated-client](../modules/generated_client.md).DeviceProfileInfo - -**`export`** - -**`interface`** DeviceProfileInfo - -## Table of contents - -### Properties - -- [Id](generated_client.DeviceProfileInfo.md#id) -- [Name](generated_client.DeviceProfileInfo.md#name) -- [Type](generated_client.DeviceProfileInfo.md#type) - -## Properties - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets the identifier. - -**`memberof`** DeviceProfileInfo - -#### Defined in - -[generated-client/models/device-profile-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile-info.ts#L29) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** DeviceProfileInfo - -#### Defined in - -[generated-client/models/device-profile-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile-info.ts#L35) - -___ - -### Type - -• `Optional` **Type**: [`DeviceProfileType`](../enums/generated_client.DeviceProfileType.md) - -**`memberof`** DeviceProfileInfo - -#### Defined in - -[generated-client/models/device-profile-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile-info.ts#L41) diff --git a/docs/interfaces/generated_client.DevicesApiDeleteDeviceRequest.md b/docs/interfaces/generated_client.DevicesApiDeleteDeviceRequest.md deleted file mode 100644 index 994214ac3..000000000 --- a/docs/interfaces/generated_client.DevicesApiDeleteDeviceRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DevicesApiDeleteDeviceRequest - -# Interface: DevicesApiDeleteDeviceRequest - -[generated-client](../modules/generated_client.md).DevicesApiDeleteDeviceRequest - -Request parameters for deleteDevice operation in DevicesApi. - -**`export`** - -**`interface`** DevicesApiDeleteDeviceRequest - -## Table of contents - -### Properties - -- [id](generated_client.DevicesApiDeleteDeviceRequest.md#id) - -## Properties - -### id - -• `Readonly` **id**: `string` - -Device Id. - -**`memberof`** DevicesApiDeleteDevice - -#### Defined in - -[generated-client/api/devices-api.ts:391](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L391) diff --git a/docs/interfaces/generated_client.DevicesApiGetDeviceInfoRequest.md b/docs/interfaces/generated_client.DevicesApiGetDeviceInfoRequest.md deleted file mode 100644 index 6331ec65c..000000000 --- a/docs/interfaces/generated_client.DevicesApiGetDeviceInfoRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DevicesApiGetDeviceInfoRequest - -# Interface: DevicesApiGetDeviceInfoRequest - -[generated-client](../modules/generated_client.md).DevicesApiGetDeviceInfoRequest - -Request parameters for getDeviceInfo operation in DevicesApi. - -**`export`** - -**`interface`** DevicesApiGetDeviceInfoRequest - -## Table of contents - -### Properties - -- [id](generated_client.DevicesApiGetDeviceInfoRequest.md#id) - -## Properties - -### id - -• `Readonly` **id**: `string` - -Device Id. - -**`memberof`** DevicesApiGetDeviceInfo - -#### Defined in - -[generated-client/api/devices-api.ts:405](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L405) diff --git a/docs/interfaces/generated_client.DevicesApiGetDeviceOptionsRequest.md b/docs/interfaces/generated_client.DevicesApiGetDeviceOptionsRequest.md deleted file mode 100644 index 2cc155e9d..000000000 --- a/docs/interfaces/generated_client.DevicesApiGetDeviceOptionsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DevicesApiGetDeviceOptionsRequest - -# Interface: DevicesApiGetDeviceOptionsRequest - -[generated-client](../modules/generated_client.md).DevicesApiGetDeviceOptionsRequest - -Request parameters for getDeviceOptions operation in DevicesApi. - -**`export`** - -**`interface`** DevicesApiGetDeviceOptionsRequest - -## Table of contents - -### Properties - -- [id](generated_client.DevicesApiGetDeviceOptionsRequest.md#id) - -## Properties - -### id - -• `Readonly` **id**: `string` - -Device Id. - -**`memberof`** DevicesApiGetDeviceOptions - -#### Defined in - -[generated-client/api/devices-api.ts:419](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L419) diff --git a/docs/interfaces/generated_client.DevicesApiGetDevicesRequest.md b/docs/interfaces/generated_client.DevicesApiGetDevicesRequest.md deleted file mode 100644 index 0003d7a4d..000000000 --- a/docs/interfaces/generated_client.DevicesApiGetDevicesRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DevicesApiGetDevicesRequest - -# Interface: DevicesApiGetDevicesRequest - -[generated-client](../modules/generated_client.md).DevicesApiGetDevicesRequest - -Request parameters for getDevices operation in DevicesApi. - -**`export`** - -**`interface`** DevicesApiGetDevicesRequest - -## Table of contents - -### Properties - -- [supportsSync](generated_client.DevicesApiGetDevicesRequest.md#supportssync) -- [userId](generated_client.DevicesApiGetDevicesRequest.md#userid) - -## Properties - -### supportsSync - -• `Optional` `Readonly` **supportsSync**: `boolean` - -Gets or sets a value indicating whether [supports synchronize]. - -**`memberof`** DevicesApiGetDevices - -#### Defined in - -[generated-client/api/devices-api.ts:433](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L433) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Gets or sets the user identifier. - -**`memberof`** DevicesApiGetDevices - -#### Defined in - -[generated-client/api/devices-api.ts:440](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L440) diff --git a/docs/interfaces/generated_client.DevicesApiUpdateDeviceOptionsRequest.md b/docs/interfaces/generated_client.DevicesApiUpdateDeviceOptionsRequest.md deleted file mode 100644 index ee68745a4..000000000 --- a/docs/interfaces/generated_client.DevicesApiUpdateDeviceOptionsRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DevicesApiUpdateDeviceOptionsRequest - -# Interface: DevicesApiUpdateDeviceOptionsRequest - -[generated-client](../modules/generated_client.md).DevicesApiUpdateDeviceOptionsRequest - -Request parameters for updateDeviceOptions operation in DevicesApi. - -**`export`** - -**`interface`** DevicesApiUpdateDeviceOptionsRequest - -## Table of contents - -### Properties - -- [deviceOptionsDto](generated_client.DevicesApiUpdateDeviceOptionsRequest.md#deviceoptionsdto) -- [id](generated_client.DevicesApiUpdateDeviceOptionsRequest.md#id) - -## Properties - -### deviceOptionsDto - -• `Readonly` **deviceOptionsDto**: [`DeviceOptionsDto`](generated_client.DeviceOptionsDto.md) - -Device Options. - -**`memberof`** DevicesApiUpdateDeviceOptions - -#### Defined in - -[generated-client/api/devices-api.ts:461](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L461) - -___ - -### id - -• `Readonly` **id**: `string` - -Device Id. - -**`memberof`** DevicesApiUpdateDeviceOptions - -#### Defined in - -[generated-client/api/devices-api.ts:454](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L454) diff --git a/docs/interfaces/generated_client.DirectPlayProfile.md b/docs/interfaces/generated_client.DirectPlayProfile.md deleted file mode 100644 index 083744a35..000000000 --- a/docs/interfaces/generated_client.DirectPlayProfile.md +++ /dev/null @@ -1,66 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DirectPlayProfile - -# Interface: DirectPlayProfile - -[generated-client](../modules/generated_client.md).DirectPlayProfile - -**`export`** - -**`interface`** DirectPlayProfile - -## Table of contents - -### Properties - -- [AudioCodec](generated_client.DirectPlayProfile.md#audiocodec) -- [Container](generated_client.DirectPlayProfile.md#container) -- [Type](generated_client.DirectPlayProfile.md#type) -- [VideoCodec](generated_client.DirectPlayProfile.md#videocodec) - -## Properties - -### AudioCodec - -• `Optional` **AudioCodec**: ``null`` \| `string` - -**`memberof`** DirectPlayProfile - -#### Defined in - -[generated-client/models/direct-play-profile.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/direct-play-profile.ts#L35) - -___ - -### Container - -• `Optional` **Container**: ``null`` \| `string` - -**`memberof`** DirectPlayProfile - -#### Defined in - -[generated-client/models/direct-play-profile.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/direct-play-profile.ts#L29) - -___ - -### Type - -• `Optional` **Type**: [`DlnaProfileType`](../enums/generated_client.DlnaProfileType.md) - -**`memberof`** DirectPlayProfile - -#### Defined in - -[generated-client/models/direct-play-profile.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/direct-play-profile.ts#L47) - -___ - -### VideoCodec - -• `Optional` **VideoCodec**: ``null`` \| `string` - -**`memberof`** DirectPlayProfile - -#### Defined in - -[generated-client/models/direct-play-profile.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/direct-play-profile.ts#L41) diff --git a/docs/interfaces/generated_client.DisplayPreferencesApiGetDisplayPreferencesRequest.md b/docs/interfaces/generated_client.DisplayPreferencesApiGetDisplayPreferencesRequest.md deleted file mode 100644 index fab31af68..000000000 --- a/docs/interfaces/generated_client.DisplayPreferencesApiGetDisplayPreferencesRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DisplayPreferencesApiGetDisplayPreferencesRequest - -# Interface: DisplayPreferencesApiGetDisplayPreferencesRequest - -[generated-client](../modules/generated_client.md).DisplayPreferencesApiGetDisplayPreferencesRequest - -Request parameters for getDisplayPreferences operation in DisplayPreferencesApi. - -**`export`** - -**`interface`** DisplayPreferencesApiGetDisplayPreferencesRequest - -## Table of contents - -### Properties - -- [client](generated_client.DisplayPreferencesApiGetDisplayPreferencesRequest.md#client) -- [displayPreferencesId](generated_client.DisplayPreferencesApiGetDisplayPreferencesRequest.md#displaypreferencesid) -- [userId](generated_client.DisplayPreferencesApiGetDisplayPreferencesRequest.md#userid) - -## Properties - -### client - -• `Readonly` **client**: `string` - -Client. - -**`memberof`** DisplayPreferencesApiGetDisplayPreferences - -#### Defined in - -[generated-client/api/display-preferences-api.ts:239](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L239) - -___ - -### displayPreferencesId - -• `Readonly` **displayPreferencesId**: `string` - -Display preferences id. - -**`memberof`** DisplayPreferencesApiGetDisplayPreferences - -#### Defined in - -[generated-client/api/display-preferences-api.ts:225](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L225) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** DisplayPreferencesApiGetDisplayPreferences - -#### Defined in - -[generated-client/api/display-preferences-api.ts:232](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L232) diff --git a/docs/interfaces/generated_client.DisplayPreferencesApiUpdateDisplayPreferencesRequest.md b/docs/interfaces/generated_client.DisplayPreferencesApiUpdateDisplayPreferencesRequest.md deleted file mode 100644 index aee570c62..000000000 --- a/docs/interfaces/generated_client.DisplayPreferencesApiUpdateDisplayPreferencesRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DisplayPreferencesApiUpdateDisplayPreferencesRequest - -# Interface: DisplayPreferencesApiUpdateDisplayPreferencesRequest - -[generated-client](../modules/generated_client.md).DisplayPreferencesApiUpdateDisplayPreferencesRequest - -Request parameters for updateDisplayPreferences operation in DisplayPreferencesApi. - -**`export`** - -**`interface`** DisplayPreferencesApiUpdateDisplayPreferencesRequest - -## Table of contents - -### Properties - -- [client](generated_client.DisplayPreferencesApiUpdateDisplayPreferencesRequest.md#client) -- [displayPreferencesDto](generated_client.DisplayPreferencesApiUpdateDisplayPreferencesRequest.md#displaypreferencesdto) -- [displayPreferencesId](generated_client.DisplayPreferencesApiUpdateDisplayPreferencesRequest.md#displaypreferencesid) -- [userId](generated_client.DisplayPreferencesApiUpdateDisplayPreferencesRequest.md#userid) - -## Properties - -### client - -• `Readonly` **client**: `string` - -Client. - -**`memberof`** DisplayPreferencesApiUpdateDisplayPreferences - -#### Defined in - -[generated-client/api/display-preferences-api.ts:267](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L267) - -___ - -### displayPreferencesDto - -• `Readonly` **displayPreferencesDto**: [`DisplayPreferencesDto`](generated_client.DisplayPreferencesDto.md) - -New Display Preferences object. - -**`memberof`** DisplayPreferencesApiUpdateDisplayPreferences - -#### Defined in - -[generated-client/api/display-preferences-api.ts:274](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L274) - -___ - -### displayPreferencesId - -• `Readonly` **displayPreferencesId**: `string` - -Display preferences id. - -**`memberof`** DisplayPreferencesApiUpdateDisplayPreferences - -#### Defined in - -[generated-client/api/display-preferences-api.ts:253](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L253) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User Id. - -**`memberof`** DisplayPreferencesApiUpdateDisplayPreferences - -#### Defined in - -[generated-client/api/display-preferences-api.ts:260](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L260) diff --git a/docs/interfaces/generated_client.DisplayPreferencesDto.md b/docs/interfaces/generated_client.DisplayPreferencesDto.md deleted file mode 100644 index 250e6f415..000000000 --- a/docs/interfaces/generated_client.DisplayPreferencesDto.md +++ /dev/null @@ -1,226 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DisplayPreferencesDto - -# Interface: DisplayPreferencesDto - -[generated-client](../modules/generated_client.md).DisplayPreferencesDto - -Defines the display preferences for any item that supports them (usually Folders). - -**`export`** - -**`interface`** DisplayPreferencesDto - -## Table of contents - -### Properties - -- [Client](generated_client.DisplayPreferencesDto.md#client) -- [CustomPrefs](generated_client.DisplayPreferencesDto.md#customprefs) -- [Id](generated_client.DisplayPreferencesDto.md#id) -- [IndexBy](generated_client.DisplayPreferencesDto.md#indexby) -- [PrimaryImageHeight](generated_client.DisplayPreferencesDto.md#primaryimageheight) -- [PrimaryImageWidth](generated_client.DisplayPreferencesDto.md#primaryimagewidth) -- [RememberIndexing](generated_client.DisplayPreferencesDto.md#rememberindexing) -- [RememberSorting](generated_client.DisplayPreferencesDto.md#remembersorting) -- [ScrollDirection](generated_client.DisplayPreferencesDto.md#scrolldirection) -- [ShowBackdrop](generated_client.DisplayPreferencesDto.md#showbackdrop) -- [ShowSidebar](generated_client.DisplayPreferencesDto.md#showsidebar) -- [SortBy](generated_client.DisplayPreferencesDto.md#sortby) -- [SortOrder](generated_client.DisplayPreferencesDto.md#sortorder) -- [ViewType](generated_client.DisplayPreferencesDto.md#viewtype) - -## Properties - -### Client - -• `Optional` **Client**: ``null`` \| `string` - -Gets or sets the client. - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:108](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L108) - -___ - -### CustomPrefs - -• `Optional` **CustomPrefs**: `Object` - -Gets or sets the custom prefs. - -**`memberof`** DisplayPreferencesDto - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L72) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets the user id. - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L30) - -___ - -### IndexBy - -• `Optional` **IndexBy**: ``null`` \| `string` - -Gets or sets the index by. - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L48) - -___ - -### PrimaryImageHeight - -• `Optional` **PrimaryImageHeight**: `number` - -Gets or sets the height of the primary image. - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L60) - -___ - -### PrimaryImageWidth - -• `Optional` **PrimaryImageWidth**: `number` - -Gets or sets the width of the primary image. - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L66) - -___ - -### RememberIndexing - -• `Optional` **RememberIndexing**: `boolean` - -Gets or sets a value indicating whether [remember indexing]. - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L54) - -___ - -### RememberSorting - -• `Optional` **RememberSorting**: `boolean` - -Gets or sets a value indicating whether [remember sorting]. - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:90](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L90) - -___ - -### ScrollDirection - -• `Optional` **ScrollDirection**: [`ScrollDirection`](../enums/generated_client.ScrollDirection.md) - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L78) - -___ - -### ShowBackdrop - -• `Optional` **ShowBackdrop**: `boolean` - -Gets or sets a value indicating whether to show backdrops on this item. - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L84) - -___ - -### ShowSidebar - -• `Optional` **ShowSidebar**: `boolean` - -Gets or sets a value indicating whether [show sidebar]. - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:102](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L102) - -___ - -### SortBy - -• `Optional` **SortBy**: ``null`` \| `string` - -Gets or sets the sort by. - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L42) - -___ - -### SortOrder - -• `Optional` **SortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md) - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:96](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L96) - -___ - -### ViewType - -• `Optional` **ViewType**: ``null`` \| `string` - -Gets or sets the type of the view. - -**`memberof`** DisplayPreferencesDto - -#### Defined in - -[generated-client/models/display-preferences-dto.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/display-preferences-dto.ts#L36) diff --git a/docs/interfaces/generated_client.DlnaApiCreateProfileRequest.md b/docs/interfaces/generated_client.DlnaApiCreateProfileRequest.md deleted file mode 100644 index d215dbaa8..000000000 --- a/docs/interfaces/generated_client.DlnaApiCreateProfileRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaApiCreateProfileRequest - -# Interface: DlnaApiCreateProfileRequest - -[generated-client](../modules/generated_client.md).DlnaApiCreateProfileRequest - -Request parameters for createProfile operation in DlnaApi. - -**`export`** - -**`interface`** DlnaApiCreateProfileRequest - -## Table of contents - -### Properties - -- [deviceProfile](generated_client.DlnaApiCreateProfileRequest.md#deviceprofile) - -## Properties - -### deviceProfile - -• `Optional` `Readonly` **deviceProfile**: [`DeviceProfile`](generated_client.DeviceProfile.md) - -Device profile. - -**`memberof`** DlnaApiCreateProfile - -#### Defined in - -[generated-client/api/dlna-api.ts:411](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L411) diff --git a/docs/interfaces/generated_client.DlnaApiDeleteProfileRequest.md b/docs/interfaces/generated_client.DlnaApiDeleteProfileRequest.md deleted file mode 100644 index 3b685743b..000000000 --- a/docs/interfaces/generated_client.DlnaApiDeleteProfileRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaApiDeleteProfileRequest - -# Interface: DlnaApiDeleteProfileRequest - -[generated-client](../modules/generated_client.md).DlnaApiDeleteProfileRequest - -Request parameters for deleteProfile operation in DlnaApi. - -**`export`** - -**`interface`** DlnaApiDeleteProfileRequest - -## Table of contents - -### Properties - -- [profileId](generated_client.DlnaApiDeleteProfileRequest.md#profileid) - -## Properties - -### profileId - -• `Readonly` **profileId**: `string` - -Profile id. - -**`memberof`** DlnaApiDeleteProfile - -#### Defined in - -[generated-client/api/dlna-api.ts:425](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L425) diff --git a/docs/interfaces/generated_client.DlnaApiGetProfileRequest.md b/docs/interfaces/generated_client.DlnaApiGetProfileRequest.md deleted file mode 100644 index 2b638752c..000000000 --- a/docs/interfaces/generated_client.DlnaApiGetProfileRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaApiGetProfileRequest - -# Interface: DlnaApiGetProfileRequest - -[generated-client](../modules/generated_client.md).DlnaApiGetProfileRequest - -Request parameters for getProfile operation in DlnaApi. - -**`export`** - -**`interface`** DlnaApiGetProfileRequest - -## Table of contents - -### Properties - -- [profileId](generated_client.DlnaApiGetProfileRequest.md#profileid) - -## Properties - -### profileId - -• `Readonly` **profileId**: `string` - -Profile Id. - -**`memberof`** DlnaApiGetProfile - -#### Defined in - -[generated-client/api/dlna-api.ts:439](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L439) diff --git a/docs/interfaces/generated_client.DlnaApiUpdateProfileRequest.md b/docs/interfaces/generated_client.DlnaApiUpdateProfileRequest.md deleted file mode 100644 index 6fcc49065..000000000 --- a/docs/interfaces/generated_client.DlnaApiUpdateProfileRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaApiUpdateProfileRequest - -# Interface: DlnaApiUpdateProfileRequest - -[generated-client](../modules/generated_client.md).DlnaApiUpdateProfileRequest - -Request parameters for updateProfile operation in DlnaApi. - -**`export`** - -**`interface`** DlnaApiUpdateProfileRequest - -## Table of contents - -### Properties - -- [deviceProfile](generated_client.DlnaApiUpdateProfileRequest.md#deviceprofile) -- [profileId](generated_client.DlnaApiUpdateProfileRequest.md#profileid) - -## Properties - -### deviceProfile - -• `Optional` `Readonly` **deviceProfile**: [`DeviceProfile`](generated_client.DeviceProfile.md) - -Device profile. - -**`memberof`** DlnaApiUpdateProfile - -#### Defined in - -[generated-client/api/dlna-api.ts:460](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L460) - -___ - -### profileId - -• `Readonly` **profileId**: `string` - -Profile id. - -**`memberof`** DlnaApiUpdateProfile - -#### Defined in - -[generated-client/api/dlna-api.ts:453](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L453) diff --git a/docs/interfaces/generated_client.DlnaOptions.md b/docs/interfaces/generated_client.DlnaOptions.md deleted file mode 100644 index c651afaf8..000000000 --- a/docs/interfaces/generated_client.DlnaOptions.md +++ /dev/null @@ -1,181 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaOptions - -# Interface: DlnaOptions - -[generated-client](../modules/generated_client.md).DlnaOptions - -The DlnaOptions class contains the user definable parameters for the dlna subsystems. - -**`export`** - -**`interface`** DlnaOptions - -## Table of contents - -### Properties - -- [AliveMessageIntervalSeconds](generated_client.DlnaOptions.md#alivemessageintervalseconds) -- [AutoCreatePlayToProfiles](generated_client.DlnaOptions.md#autocreateplaytoprofiles) -- [BlastAliveMessageIntervalSeconds](generated_client.DlnaOptions.md#blastalivemessageintervalseconds) -- [BlastAliveMessages](generated_client.DlnaOptions.md#blastalivemessages) -- [ClientDiscoveryIntervalSeconds](generated_client.DlnaOptions.md#clientdiscoveryintervalseconds) -- [DefaultUserId](generated_client.DlnaOptions.md#defaultuserid) -- [EnableDebugLog](generated_client.DlnaOptions.md#enabledebuglog) -- [EnablePlayTo](generated_client.DlnaOptions.md#enableplayto) -- [EnablePlayToTracing](generated_client.DlnaOptions.md#enableplaytotracing) -- [EnableServer](generated_client.DlnaOptions.md#enableserver) -- [SendOnlyMatchedHost](generated_client.DlnaOptions.md#sendonlymatchedhost) - -## Properties - -### AliveMessageIntervalSeconds - -• `Optional` **AliveMessageIntervalSeconds**: `number` - -Gets or sets the frequency at which ssdp alive notifications are transmitted. - -**`memberof`** DlnaOptions - -#### Defined in - -[generated-client/models/dlna-options.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-options.ts#L58) - -___ - -### AutoCreatePlayToProfiles - -• `Optional` **AutoCreatePlayToProfiles**: `boolean` - -Gets or sets a value indicating whether playTo device profiles should be created. - -**`memberof`** DlnaOptions - -#### Defined in - -[generated-client/models/dlna-options.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-options.ts#L76) - -___ - -### BlastAliveMessageIntervalSeconds - -• `Optional` **BlastAliveMessageIntervalSeconds**: `number` - -Gets or sets the frequency at which ssdp alive notifications are transmitted. MIGRATING - TO BE REMOVED ONCE WEB HAS BEEN ALTERED. - -**`memberof`** DlnaOptions - -#### Defined in - -[generated-client/models/dlna-options.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-options.ts#L64) - -___ - -### BlastAliveMessages - -• `Optional` **BlastAliveMessages**: `boolean` - -Gets or sets a value indicating whether to blast alive messages. - -**`memberof`** DlnaOptions - -#### Defined in - -[generated-client/models/dlna-options.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-options.ts#L82) - -___ - -### ClientDiscoveryIntervalSeconds - -• `Optional` **ClientDiscoveryIntervalSeconds**: `number` - -Gets or sets the ssdp client discovery interval time (in seconds). This is the time after which the server will send a ssdp search request. - -**`memberof`** DlnaOptions - -#### Defined in - -[generated-client/models/dlna-options.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-options.ts#L52) - -___ - -### DefaultUserId - -• `Optional` **DefaultUserId**: ``null`` \| `string` - -Gets or sets the default user account that the dlna server uses. - -**`memberof`** DlnaOptions - -#### Defined in - -[generated-client/models/dlna-options.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-options.ts#L70) - -___ - -### EnableDebugLog - -• `Optional` **EnableDebugLog**: `boolean` - -Gets or sets a value indicating whether detailed dlna server logs are sent to the console/log. If the setting \"Emby.Dlna\": \"Debug\" msut be set in logging.default.json for this property to work. - -**`memberof`** DlnaOptions - -#### Defined in - -[generated-client/models/dlna-options.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-options.ts#L40) - -___ - -### EnablePlayTo - -• `Optional` **EnablePlayTo**: `boolean` - -Gets or sets a value indicating whether gets or sets a value to indicate the status of the dlna playTo subsystem. - -**`memberof`** DlnaOptions - -#### Defined in - -[generated-client/models/dlna-options.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-options.ts#L28) - -___ - -### EnablePlayToTracing - -• `Optional` **EnablePlayToTracing**: `boolean` - -Gets or sets a value indicating whether whether detailed playTo debug logs are sent to the console/log. If the setting \"Emby.Dlna.PlayTo\": \"Debug\" msut be set in logging.default.json for this property to work. - -**`memberof`** DlnaOptions - -#### Defined in - -[generated-client/models/dlna-options.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-options.ts#L46) - -___ - -### EnableServer - -• `Optional` **EnableServer**: `boolean` - -Gets or sets a value indicating whether gets or sets a value to indicate the status of the dlna server subsystem. - -**`memberof`** DlnaOptions - -#### Defined in - -[generated-client/models/dlna-options.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-options.ts#L34) - -___ - -### SendOnlyMatchedHost - -• `Optional` **SendOnlyMatchedHost**: `boolean` - -gets or sets a value indicating whether to send only matched host. - -**`memberof`** DlnaOptions - -#### Defined in - -[generated-client/models/dlna-options.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-options.ts#L88) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetConnectionManager2Request.md b/docs/interfaces/generated_client.DlnaServerApiGetConnectionManager2Request.md deleted file mode 100644 index 9b452f27d..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetConnectionManager2Request.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetConnectionManager2Request - -# Interface: DlnaServerApiGetConnectionManager2Request - -[generated-client](../modules/generated_client.md).DlnaServerApiGetConnectionManager2Request - -Request parameters for getConnectionManager2 operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetConnectionManager2Request - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiGetConnectionManager2Request.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiGetConnectionManager2 - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1013](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1013) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetConnectionManager3Request.md b/docs/interfaces/generated_client.DlnaServerApiGetConnectionManager3Request.md deleted file mode 100644 index c8a2cfa1b..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetConnectionManager3Request.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetConnectionManager3Request - -# Interface: DlnaServerApiGetConnectionManager3Request - -[generated-client](../modules/generated_client.md).DlnaServerApiGetConnectionManager3Request - -Request parameters for getConnectionManager3 operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetConnectionManager3Request - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiGetConnectionManager3Request.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiGetConnectionManager3 - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1027](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1027) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetConnectionManagerRequest.md b/docs/interfaces/generated_client.DlnaServerApiGetConnectionManagerRequest.md deleted file mode 100644 index 34e48d0a8..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetConnectionManagerRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetConnectionManagerRequest - -# Interface: DlnaServerApiGetConnectionManagerRequest - -[generated-client](../modules/generated_client.md).DlnaServerApiGetConnectionManagerRequest - -Request parameters for getConnectionManager operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetConnectionManagerRequest - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiGetConnectionManagerRequest.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiGetConnectionManager - -#### Defined in - -[generated-client/api/dlna-server-api.ts:999](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L999) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetContentDirectory2Request.md b/docs/interfaces/generated_client.DlnaServerApiGetContentDirectory2Request.md deleted file mode 100644 index 12548553b..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetContentDirectory2Request.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetContentDirectory2Request - -# Interface: DlnaServerApiGetContentDirectory2Request - -[generated-client](../modules/generated_client.md).DlnaServerApiGetContentDirectory2Request - -Request parameters for getContentDirectory2 operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetContentDirectory2Request - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiGetContentDirectory2Request.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiGetContentDirectory2 - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1055](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1055) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetContentDirectory3Request.md b/docs/interfaces/generated_client.DlnaServerApiGetContentDirectory3Request.md deleted file mode 100644 index 23283d0cf..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetContentDirectory3Request.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetContentDirectory3Request - -# Interface: DlnaServerApiGetContentDirectory3Request - -[generated-client](../modules/generated_client.md).DlnaServerApiGetContentDirectory3Request - -Request parameters for getContentDirectory3 operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetContentDirectory3Request - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiGetContentDirectory3Request.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiGetContentDirectory3 - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1069](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1069) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetContentDirectoryRequest.md b/docs/interfaces/generated_client.DlnaServerApiGetContentDirectoryRequest.md deleted file mode 100644 index c06d888f6..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetContentDirectoryRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetContentDirectoryRequest - -# Interface: DlnaServerApiGetContentDirectoryRequest - -[generated-client](../modules/generated_client.md).DlnaServerApiGetContentDirectoryRequest - -Request parameters for getContentDirectory operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetContentDirectoryRequest - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiGetContentDirectoryRequest.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiGetContentDirectory - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1041](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1041) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetDescriptionXml2Request.md b/docs/interfaces/generated_client.DlnaServerApiGetDescriptionXml2Request.md deleted file mode 100644 index 7449a7832..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetDescriptionXml2Request.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetDescriptionXml2Request - -# Interface: DlnaServerApiGetDescriptionXml2Request - -[generated-client](../modules/generated_client.md).DlnaServerApiGetDescriptionXml2Request - -Request parameters for getDescriptionXml2 operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetDescriptionXml2Request - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiGetDescriptionXml2Request.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiGetDescriptionXml2 - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1097](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1097) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetDescriptionXmlRequest.md b/docs/interfaces/generated_client.DlnaServerApiGetDescriptionXmlRequest.md deleted file mode 100644 index 5d6b86ef6..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetDescriptionXmlRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetDescriptionXmlRequest - -# Interface: DlnaServerApiGetDescriptionXmlRequest - -[generated-client](../modules/generated_client.md).DlnaServerApiGetDescriptionXmlRequest - -Request parameters for getDescriptionXml operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetDescriptionXmlRequest - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiGetDescriptionXmlRequest.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiGetDescriptionXml - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1083](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1083) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetIconIdRequest.md b/docs/interfaces/generated_client.DlnaServerApiGetIconIdRequest.md deleted file mode 100644 index 204ee7896..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetIconIdRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetIconIdRequest - -# Interface: DlnaServerApiGetIconIdRequest - -[generated-client](../modules/generated_client.md).DlnaServerApiGetIconIdRequest - -Request parameters for getIconId operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetIconIdRequest - -## Table of contents - -### Properties - -- [fileName](generated_client.DlnaServerApiGetIconIdRequest.md#filename) -- [serverId](generated_client.DlnaServerApiGetIconIdRequest.md#serverid) - -## Properties - -### fileName - -• `Readonly` **fileName**: `string` - -The icon filename. - -**`memberof`** DlnaServerApiGetIconId - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1132](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1132) - -___ - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiGetIconId - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1125](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1125) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetIconRequest.md b/docs/interfaces/generated_client.DlnaServerApiGetIconRequest.md deleted file mode 100644 index 1cd08a785..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetIconRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetIconRequest - -# Interface: DlnaServerApiGetIconRequest - -[generated-client](../modules/generated_client.md).DlnaServerApiGetIconRequest - -Request parameters for getIcon operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetIconRequest - -## Table of contents - -### Properties - -- [fileName](generated_client.DlnaServerApiGetIconRequest.md#filename) - -## Properties - -### fileName - -• `Readonly` **fileName**: `string` - -The icon filename. - -**`memberof`** DlnaServerApiGetIcon - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1111](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1111) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar2Request.md b/docs/interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar2Request.md deleted file mode 100644 index ce13baec4..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar2Request.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetMediaReceiverRegistrar2Request - -# Interface: DlnaServerApiGetMediaReceiverRegistrar2Request - -[generated-client](../modules/generated_client.md).DlnaServerApiGetMediaReceiverRegistrar2Request - -Request parameters for getMediaReceiverRegistrar2 operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetMediaReceiverRegistrar2Request - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiGetMediaReceiverRegistrar2Request.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiGetMediaReceiverRegistrar2 - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1160](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1160) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar3Request.md b/docs/interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar3Request.md deleted file mode 100644 index 58c6694f7..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar3Request.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetMediaReceiverRegistrar3Request - -# Interface: DlnaServerApiGetMediaReceiverRegistrar3Request - -[generated-client](../modules/generated_client.md).DlnaServerApiGetMediaReceiverRegistrar3Request - -Request parameters for getMediaReceiverRegistrar3 operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetMediaReceiverRegistrar3Request - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiGetMediaReceiverRegistrar3Request.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiGetMediaReceiverRegistrar3 - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1174](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1174) diff --git a/docs/interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrarRequest.md b/docs/interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrarRequest.md deleted file mode 100644 index 51c6716fa..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrarRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiGetMediaReceiverRegistrarRequest - -# Interface: DlnaServerApiGetMediaReceiverRegistrarRequest - -[generated-client](../modules/generated_client.md).DlnaServerApiGetMediaReceiverRegistrarRequest - -Request parameters for getMediaReceiverRegistrar operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiGetMediaReceiverRegistrarRequest - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiGetMediaReceiverRegistrarRequest.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiGetMediaReceiverRegistrar - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1146](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1146) diff --git a/docs/interfaces/generated_client.DlnaServerApiProcessConnectionManagerControlRequestRequest.md b/docs/interfaces/generated_client.DlnaServerApiProcessConnectionManagerControlRequestRequest.md deleted file mode 100644 index 4916527d2..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiProcessConnectionManagerControlRequestRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiProcessConnectionManagerControlRequestRequest - -# Interface: DlnaServerApiProcessConnectionManagerControlRequestRequest - -[generated-client](../modules/generated_client.md).DlnaServerApiProcessConnectionManagerControlRequestRequest - -Request parameters for processConnectionManagerControlRequest operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiProcessConnectionManagerControlRequestRequest - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiProcessConnectionManagerControlRequestRequest.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiProcessConnectionManagerControlRequest - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1188](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1188) diff --git a/docs/interfaces/generated_client.DlnaServerApiProcessContentDirectoryControlRequestRequest.md b/docs/interfaces/generated_client.DlnaServerApiProcessContentDirectoryControlRequestRequest.md deleted file mode 100644 index 3f9084e01..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiProcessContentDirectoryControlRequestRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiProcessContentDirectoryControlRequestRequest - -# Interface: DlnaServerApiProcessContentDirectoryControlRequestRequest - -[generated-client](../modules/generated_client.md).DlnaServerApiProcessContentDirectoryControlRequestRequest - -Request parameters for processContentDirectoryControlRequest operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiProcessContentDirectoryControlRequestRequest - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiProcessContentDirectoryControlRequestRequest.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiProcessContentDirectoryControlRequest - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1202](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1202) diff --git a/docs/interfaces/generated_client.DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest.md b/docs/interfaces/generated_client.DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest.md deleted file mode 100644 index 088753fcd..000000000 --- a/docs/interfaces/generated_client.DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest - -# Interface: DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest - -[generated-client](../modules/generated_client.md).DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest - -Request parameters for processMediaReceiverRegistrarControlRequest operation in DlnaServerApi. - -**`export`** - -**`interface`** DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest - -## Table of contents - -### Properties - -- [serverId](generated_client.DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest.md#serverid) - -## Properties - -### serverId - -• `Readonly` **serverId**: `string` - -Server UUID. - -**`memberof`** DlnaServerApiProcessMediaReceiverRegistrarControlRequest - -#### Defined in - -[generated-client/api/dlna-server-api.ts:1216](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1216) diff --git a/docs/interfaces/generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md b/docs/interfaces/generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md deleted file mode 100644 index a8aa007b8..000000000 --- a/docs/interfaces/generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md +++ /dev/null @@ -1,830 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicHlsApiGetHlsAudioSegmentRequest - -# Interface: DynamicHlsApiGetHlsAudioSegmentRequest - -[generated-client](../modules/generated_client.md).DynamicHlsApiGetHlsAudioSegmentRequest - -Request parameters for getHlsAudioSegment operation in DynamicHlsApi. - -**`export`** - -**`interface`** DynamicHlsApiGetHlsAudioSegmentRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#_static) -- [actualSegmentLengthTicks](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#actualsegmentlengthticks) -- [allowAudioStreamCopy](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#audiobitrate) -- [audioChannels](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#audiochannels) -- [audioCodec](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#audiocodec) -- [audioSampleRate](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#breakonnonkeyframes) -- [container](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#container) -- [context](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#context) -- [copyTimestamps](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#cpucorelimit) -- [deInterlace](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#deinterlace) -- [deviceId](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#deviceid) -- [deviceProfileId](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#framerate) -- [height](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#height) -- [itemId](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#itemid) -- [level](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#level) -- [liveStreamId](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#maxframerate) -- [maxRefFrames](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#maxrefframes) -- [maxStreamingBitrate](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#maxstreamingbitrate) -- [maxVideoBitDepth](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#maxvideobitdepth) -- [mediaSourceId](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#mediasourceid) -- [minSegments](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#minsegments) -- [params](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#params) -- [playSessionId](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#playsessionid) -- [playlistId](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#playlistid) -- [profile](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#profile) -- [requireAvc](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#requirenonanamorphic) -- [runtimeTicks](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#runtimeticks) -- [segmentContainer](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#segmentcontainer) -- [segmentId](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#segmentid) -- [segmentLength](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#segmentlength) -- [startTimeTicks](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#starttimeticks) -- [streamOptions](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#streamoptions) -- [subtitleCodec](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#subtitlestreamindex) -- [tag](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#tag) -- [transcodeReasons](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#videobitrate) -- [videoCodec](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#videocodec) -- [videoStreamIndex](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#videostreamindex) -- [width](generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3812](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3812) - -___ - -### actualSegmentLengthTicks - -• `Readonly` **actualSegmentLengthTicks**: `number` - -The length of the requested segment in ticks. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3805](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3805) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3903](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3903) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3896](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3896) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3938](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3938) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3945](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3945) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3882](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3882) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3917](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3917) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4120](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4120) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3910](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3910) - -___ - -### container - -• `Readonly` **container**: `string` - -The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3791](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3791) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4134](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4134) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3987](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3987) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4078](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4078) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4057](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4057) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3875](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3875) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3833](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3833) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3889](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3889) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4092](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4092) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3973](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3973) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4008](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4008) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3770](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3770) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3966](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3966) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4085](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4085) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3924](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3924) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3952](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3952) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3980](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3980) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4036](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4036) - -___ - -### maxStreamingBitrate - -• `Optional` `Readonly` **maxStreamingBitrate**: `number` - -Optional. The maximum streaming bitrate. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3931](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3931) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4043](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4043) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3868](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3868) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3861](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3861) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3819](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3819) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3840](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3840) - -___ - -### playlistId - -• `Readonly` **playlistId**: `string` - -The playlist id. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3777](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3777) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3959](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3959) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4050](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4050) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4064](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4064) - -___ - -### runtimeTicks - -• `Readonly` **runtimeTicks**: `number` - -The position of the requested segment in ticks. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3798](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3798) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3847](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3847) - -___ - -### segmentId - -• `Readonly` **segmentId**: `number` - -The segment id. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3784](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3784) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3854](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3854) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3994](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3994) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4141](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4141) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4106](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4106) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4029](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4029) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4022](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4022) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3826](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3826) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4113](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4113) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4071](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4071) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4015](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4015) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vpx, wmv. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4099](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4099) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4127](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4127) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetHlsAudioSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4001](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4001) diff --git a/docs/interfaces/generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md b/docs/interfaces/generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md deleted file mode 100644 index 99e843d74..000000000 --- a/docs/interfaces/generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md +++ /dev/null @@ -1,845 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicHlsApiGetHlsVideoSegmentRequest - -# Interface: DynamicHlsApiGetHlsVideoSegmentRequest - -[generated-client](../modules/generated_client.md).DynamicHlsApiGetHlsVideoSegmentRequest - -Request parameters for getHlsVideoSegment operation in DynamicHlsApi. - -**`export`** - -**`interface`** DynamicHlsApiGetHlsVideoSegmentRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#_static) -- [actualSegmentLengthTicks](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#actualsegmentlengthticks) -- [allowAudioStreamCopy](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#audiobitrate) -- [audioChannels](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#audiochannels) -- [audioCodec](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#audiocodec) -- [audioSampleRate](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#breakonnonkeyframes) -- [container](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#container) -- [context](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#context) -- [copyTimestamps](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#cpucorelimit) -- [deInterlace](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#deinterlace) -- [deviceId](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#deviceid) -- [deviceProfileId](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#framerate) -- [height](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#height) -- [itemId](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#itemid) -- [level](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#level) -- [liveStreamId](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#maxframerate) -- [maxHeight](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#maxheight) -- [maxRefFrames](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#maxvideobitdepth) -- [maxWidth](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#maxwidth) -- [mediaSourceId](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#mediasourceid) -- [minSegments](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#minsegments) -- [params](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#params) -- [playSessionId](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#playsessionid) -- [playlistId](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#playlistid) -- [profile](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#profile) -- [requireAvc](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#requirenonanamorphic) -- [runtimeTicks](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#runtimeticks) -- [segmentContainer](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#segmentcontainer) -- [segmentId](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#segmentid) -- [segmentLength](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#segmentlength) -- [startTimeTicks](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#starttimeticks) -- [streamOptions](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#streamoptions) -- [subtitleCodec](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#subtitlestreamindex) -- [tag](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#tag) -- [transcodeReasons](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#videobitrate) -- [videoCodec](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#videocodec) -- [videoStreamIndex](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#videostreamindex) -- [width](generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4197](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4197) - -___ - -### actualSegmentLengthTicks - -• `Readonly` **actualSegmentLengthTicks**: `number` - -The length of the requested segment in ticks. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4190](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4190) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4288](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4288) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4281](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4281) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4316](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4316) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4323](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4323) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4267](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4267) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4302](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4302) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4512](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4512) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4295](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4295) - -___ - -### container - -• `Readonly` **container**: `string` - -The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4176](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4176) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4526](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4526) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4365](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4365) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4470](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4470) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4449](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4449) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4260](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4260) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4218](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4218) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4274](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4274) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4484](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4484) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4351](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4351) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4386](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4386) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4155](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4155) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4344](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4344) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4477](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4477) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4309](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4309) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4330](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4330) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4358](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4358) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -Optional. The maximum vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4400](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4400) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4428](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4428) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4435](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4435) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -Optional. The maximum horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4393](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4393) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4253](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4253) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4246](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4246) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4204](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4204) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4225](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4225) - -___ - -### playlistId - -• `Readonly` **playlistId**: `string` - -The playlist id. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4162](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4162) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4337](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4337) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4442](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4442) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4456](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4456) - -___ - -### runtimeTicks - -• `Readonly` **runtimeTicks**: `number` - -The position of the requested segment in ticks. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4183](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4183) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4232](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4232) - -___ - -### segmentId - -• `Readonly` **segmentId**: `number` - -The segment id. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4169](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4169) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The desired segment length. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4239](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4239) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4372](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4372) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4533](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4533) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4498](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4498) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4421](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4421) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4414](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4414) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4211](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4211) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4505](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4505) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4463](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4463) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4407](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4407) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4491](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4491) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4519](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4519) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetHlsVideoSegment - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4379](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4379) diff --git a/docs/interfaces/generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md b/docs/interfaces/generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md deleted file mode 100644 index 343cdbf40..000000000 --- a/docs/interfaces/generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md +++ /dev/null @@ -1,800 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicHlsApiGetLiveHlsStreamRequest - -# Interface: DynamicHlsApiGetLiveHlsStreamRequest - -[generated-client](../modules/generated_client.md).DynamicHlsApiGetLiveHlsStreamRequest - -Request parameters for getLiveHlsStream operation in DynamicHlsApi. - -**`export`** - -**`interface`** DynamicHlsApiGetLiveHlsStreamRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#_static) -- [allowAudioStreamCopy](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#audiobitrate) -- [audioChannels](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#audiochannels) -- [audioCodec](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#audiocodec) -- [audioSampleRate](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#breakonnonkeyframes) -- [container](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#container) -- [context](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#context) -- [copyTimestamps](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#cpucorelimit) -- [deInterlace](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#deinterlace) -- [deviceId](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#deviceid) -- [deviceProfileId](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#enablempegtsm2tsmode) -- [enableSubtitlesInManifest](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#enablesubtitlesinmanifest) -- [framerate](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#framerate) -- [height](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#height) -- [itemId](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#itemid) -- [level](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#level) -- [liveStreamId](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#maxframerate) -- [maxHeight](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#maxheight) -- [maxRefFrames](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#maxvideobitdepth) -- [maxWidth](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#maxwidth) -- [mediaSourceId](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#mediasourceid) -- [minSegments](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#minsegments) -- [params](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#params) -- [playSessionId](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#playsessionid) -- [profile](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#profile) -- [requireAvc](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#segmentcontainer) -- [segmentLength](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#segmentlength) -- [startTimeTicks](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#starttimeticks) -- [streamOptions](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#streamoptions) -- [subtitleCodec](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#subtitlestreamindex) -- [tag](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#tag) -- [transcodeReasons](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#videobitrate) -- [videoCodec](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#videocodec) -- [videoStreamIndex](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#videostreamindex) -- [width](generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4561](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4561) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4652](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4652) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4645](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4645) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4680](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4680) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4687](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4687) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4631](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4631) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4666](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4666) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4862](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4862) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4659](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4659) - -___ - -### container - -• `Optional` `Readonly` **container**: `string` - -The audio container. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4554](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4554) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4876](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4876) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4729](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4729) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4820](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4820) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4799](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4799) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4624](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4624) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4582](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4582) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4638](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4638) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4834](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4834) - -___ - -### enableSubtitlesInManifest - -• `Optional` `Readonly` **enableSubtitlesInManifest**: `boolean` - -Optional. Whether to enable subtitles in the manifest. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4904](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4904) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4715](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4715) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4750](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4750) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4547](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4547) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4708](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4708) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4827](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4827) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4673](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4673) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4694](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4694) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4722](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4722) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -Optional. The max height. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4897](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4897) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4778](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4778) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4785](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4785) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -Optional. The max width. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4890](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4890) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4617](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4617) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4610](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4610) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4568](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4568) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4589](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4589) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4701](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4701) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4792](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4792) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4806](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4806) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4596](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4596) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment lenght. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4603](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4603) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4736](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4736) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4883](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4883) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4848](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4848) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4771](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4771) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4764](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4764) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4575](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4575) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4855](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4855) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4813](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4813) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4757](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4757) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4841](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4841) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4869](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4869) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetLiveHlsStream - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4743](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4743) diff --git a/docs/interfaces/generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md b/docs/interfaces/generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md deleted file mode 100644 index e3377907a..000000000 --- a/docs/interfaces/generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md +++ /dev/null @@ -1,770 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicHlsApiGetMasterHlsAudioPlaylistRequest - -# Interface: DynamicHlsApiGetMasterHlsAudioPlaylistRequest - -[generated-client](../modules/generated_client.md).DynamicHlsApiGetMasterHlsAudioPlaylistRequest - -Request parameters for getMasterHlsAudioPlaylist operation in DynamicHlsApi. - -**`export`** - -**`interface`** DynamicHlsApiGetMasterHlsAudioPlaylistRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#_static) -- [allowAudioStreamCopy](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#audiobitrate) -- [audioChannels](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#audiochannels) -- [audioCodec](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#audiocodec) -- [audioSampleRate](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#breakonnonkeyframes) -- [context](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#context) -- [copyTimestamps](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#cpucorelimit) -- [deInterlace](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#deinterlace) -- [deviceId](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#deviceid) -- [deviceProfileId](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#deviceprofileid) -- [enableAdaptiveBitrateStreaming](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#enableadaptivebitratestreaming) -- [enableAutoStreamCopy](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#framerate) -- [height](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#height) -- [itemId](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#itemid) -- [level](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#level) -- [liveStreamId](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#maxframerate) -- [maxRefFrames](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#maxrefframes) -- [maxStreamingBitrate](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#maxstreamingbitrate) -- [maxVideoBitDepth](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#maxvideobitdepth) -- [mediaSourceId](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#mediasourceid) -- [minSegments](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#minsegments) -- [params](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#params) -- [playSessionId](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#playsessionid) -- [profile](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#profile) -- [requireAvc](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#segmentcontainer) -- [segmentLength](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#segmentlength) -- [startTimeTicks](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#starttimeticks) -- [streamOptions](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#streamoptions) -- [subtitleCodec](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#subtitlestreamindex) -- [tag](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#tag) -- [transcodeReasons](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#videobitrate) -- [videoCodec](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#videocodec) -- [videoStreamIndex](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#videostreamindex) -- [width](generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4932](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4932) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5016](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5016) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5009](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5009) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5051](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5051) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5058](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5058) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4995](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4995) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5030](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5030) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5233](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5233) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5023](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5023) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5247](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5247) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5100](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5100) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5191](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5191) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5170](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5170) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4988](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4988) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4953](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4953) - -___ - -### enableAdaptiveBitrateStreaming - -• `Optional` `Readonly` **enableAdaptiveBitrateStreaming**: `boolean` - -Enable adaptive bitrate streaming. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5261](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5261) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5002](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5002) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5205](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5205) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5086](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5086) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5121](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5121) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4918](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4918) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5079](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5079) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5198](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5198) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5037](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5037) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5065](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5065) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5093](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5093) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5149](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5149) - -___ - -### maxStreamingBitrate - -• `Optional` `Readonly` **maxStreamingBitrate**: `number` - -Optional. The maximum streaming bitrate. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5044](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5044) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5156](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5156) - -___ - -### mediaSourceId - -• `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4925](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4925) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4981](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4981) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4939](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4939) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4960](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4960) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5072](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5072) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5163](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5163) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5177](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5177) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4967](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4967) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4974](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4974) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5107](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5107) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5254](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5254) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5219](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5219) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5142](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5142) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5135](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5135) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:4946](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L4946) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5226](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5226) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5184](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5184) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5128](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5128) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5212](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5212) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5240](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5240) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5114](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5114) diff --git a/docs/interfaces/generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md b/docs/interfaces/generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md deleted file mode 100644 index 85641053e..000000000 --- a/docs/interfaces/generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md +++ /dev/null @@ -1,785 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicHlsApiGetMasterHlsVideoPlaylistRequest - -# Interface: DynamicHlsApiGetMasterHlsVideoPlaylistRequest - -[generated-client](../modules/generated_client.md).DynamicHlsApiGetMasterHlsVideoPlaylistRequest - -Request parameters for getMasterHlsVideoPlaylist operation in DynamicHlsApi. - -**`export`** - -**`interface`** DynamicHlsApiGetMasterHlsVideoPlaylistRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#_static) -- [allowAudioStreamCopy](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#audiobitrate) -- [audioChannels](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#audiochannels) -- [audioCodec](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#audiocodec) -- [audioSampleRate](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#breakonnonkeyframes) -- [context](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#context) -- [copyTimestamps](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#cpucorelimit) -- [deInterlace](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#deinterlace) -- [deviceId](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#deviceid) -- [deviceProfileId](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#deviceprofileid) -- [enableAdaptiveBitrateStreaming](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#enableadaptivebitratestreaming) -- [enableAutoStreamCopy](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#framerate) -- [height](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#height) -- [itemId](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#itemid) -- [level](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#level) -- [liveStreamId](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#maxframerate) -- [maxHeight](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#maxheight) -- [maxRefFrames](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#maxvideobitdepth) -- [maxWidth](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#maxwidth) -- [mediaSourceId](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#mediasourceid) -- [minSegments](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#minsegments) -- [params](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#params) -- [playSessionId](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#playsessionid) -- [profile](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#profile) -- [requireAvc](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#segmentcontainer) -- [segmentLength](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#segmentlength) -- [startTimeTicks](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#starttimeticks) -- [streamOptions](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#streamoptions) -- [subtitleCodec](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#subtitlestreamindex) -- [tag](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#tag) -- [transcodeReasons](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#videobitrate) -- [videoCodec](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#videocodec) -- [videoStreamIndex](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#videostreamindex) -- [width](generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5289](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5289) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5373](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5373) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5366](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5366) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5401](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5401) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5408](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5408) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5352](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5352) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5387](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5387) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5597](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5597) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5380](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5380) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5611](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5611) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5450](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5450) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5555](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5555) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5534](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5534) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5345](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5345) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5310](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5310) - -___ - -### enableAdaptiveBitrateStreaming - -• `Optional` `Readonly` **enableAdaptiveBitrateStreaming**: `boolean` - -Enable adaptive bitrate streaming. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5625](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5625) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5359](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5359) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5569](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5569) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5436](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5436) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5471](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5471) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5275](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5275) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5429](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5429) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5562](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5562) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5394](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5394) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5415](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5415) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5443](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5443) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -Optional. The maximum vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5485](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5485) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5513](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5513) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5520](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5520) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -Optional. The maximum horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5478](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5478) - -___ - -### mediaSourceId - -• `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5282](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5282) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5338](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5338) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5296](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5296) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5317](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5317) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5422](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5422) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5527](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5527) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5541](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5541) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5324](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5324) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5331](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5331) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5457](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5457) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5618](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5618) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5583](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5583) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5506](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5506) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5499](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5499) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5303](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5303) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5590](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5590) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5548](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5548) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5492](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5492) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5576](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5576) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5604](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5604) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5464](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5464) diff --git a/docs/interfaces/generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md b/docs/interfaces/generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md deleted file mode 100644 index 9cf5e22e5..000000000 --- a/docs/interfaces/generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md +++ /dev/null @@ -1,755 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicHlsApiGetVariantHlsAudioPlaylistRequest - -# Interface: DynamicHlsApiGetVariantHlsAudioPlaylistRequest - -[generated-client](../modules/generated_client.md).DynamicHlsApiGetVariantHlsAudioPlaylistRequest - -Request parameters for getVariantHlsAudioPlaylist operation in DynamicHlsApi. - -**`export`** - -**`interface`** DynamicHlsApiGetVariantHlsAudioPlaylistRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#_static) -- [allowAudioStreamCopy](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#audiobitrate) -- [audioChannels](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#audiochannels) -- [audioCodec](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#audiocodec) -- [audioSampleRate](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#breakonnonkeyframes) -- [context](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#context) -- [copyTimestamps](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#cpucorelimit) -- [deInterlace](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#deinterlace) -- [deviceId](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#deviceid) -- [deviceProfileId](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#framerate) -- [height](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#height) -- [itemId](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#itemid) -- [level](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#level) -- [liveStreamId](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#maxframerate) -- [maxRefFrames](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#maxrefframes) -- [maxStreamingBitrate](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#maxstreamingbitrate) -- [maxVideoBitDepth](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#maxvideobitdepth) -- [mediaSourceId](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#mediasourceid) -- [minSegments](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#minsegments) -- [params](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#params) -- [playSessionId](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#playsessionid) -- [profile](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#profile) -- [requireAvc](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#segmentcontainer) -- [segmentLength](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#segmentlength) -- [startTimeTicks](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#starttimeticks) -- [streamOptions](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#streamoptions) -- [subtitleCodec](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#subtitlestreamindex) -- [tag](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#tag) -- [transcodeReasons](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#videobitrate) -- [videoCodec](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#videocodec) -- [videoStreamIndex](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#videostreamindex) -- [width](generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5646](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5646) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5737](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5737) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5730](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5730) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5772](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5772) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5779](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5779) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5716](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5716) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5751](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5751) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5954](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5954) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5744](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5744) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5968](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5968) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5821](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5821) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5912](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5912) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5891](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5891) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5709](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5709) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5667](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5667) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5723](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5723) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5926](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5926) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5807](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5807) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5842](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5842) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5639](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5639) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5800](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5800) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5919](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5919) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5758](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5758) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5786](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5786) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5814](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5814) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5870](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5870) - -___ - -### maxStreamingBitrate - -• `Optional` `Readonly` **maxStreamingBitrate**: `number` - -Optional. The maximum streaming bitrate. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5765](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5765) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5877](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5877) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5702](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5702) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5695](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5695) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5653](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5653) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5674](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5674) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5793](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5793) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5884](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5884) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5898](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5898) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5681](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5681) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5688](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5688) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5828](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5828) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5975](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5975) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5940](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5940) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5863](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5863) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5856](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5856) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5660](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5660) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5947](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5947) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5905](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5905) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5849](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5849) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vpx, wmv. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5933](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5933) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5961](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5961) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetVariantHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5835](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5835) diff --git a/docs/interfaces/generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md b/docs/interfaces/generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md deleted file mode 100644 index 214f30ca1..000000000 --- a/docs/interfaces/generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md +++ /dev/null @@ -1,770 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicHlsApiGetVariantHlsVideoPlaylistRequest - -# Interface: DynamicHlsApiGetVariantHlsVideoPlaylistRequest - -[generated-client](../modules/generated_client.md).DynamicHlsApiGetVariantHlsVideoPlaylistRequest - -Request parameters for getVariantHlsVideoPlaylist operation in DynamicHlsApi. - -**`export`** - -**`interface`** DynamicHlsApiGetVariantHlsVideoPlaylistRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#_static) -- [allowAudioStreamCopy](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#audiobitrate) -- [audioChannels](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#audiochannels) -- [audioCodec](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#audiocodec) -- [audioSampleRate](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#breakonnonkeyframes) -- [context](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#context) -- [copyTimestamps](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#cpucorelimit) -- [deInterlace](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#deinterlace) -- [deviceId](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#deviceid) -- [deviceProfileId](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#framerate) -- [height](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#height) -- [itemId](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#itemid) -- [level](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#level) -- [liveStreamId](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#maxframerate) -- [maxHeight](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#maxheight) -- [maxRefFrames](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#maxvideobitdepth) -- [maxWidth](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#maxwidth) -- [mediaSourceId](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#mediasourceid) -- [minSegments](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#minsegments) -- [params](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#params) -- [playSessionId](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#playsessionid) -- [profile](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#profile) -- [requireAvc](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#segmentcontainer) -- [segmentLength](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#segmentlength) -- [startTimeTicks](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#starttimeticks) -- [streamOptions](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#streamoptions) -- [subtitleCodec](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#subtitlestreamindex) -- [tag](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#tag) -- [transcodeReasons](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#videobitrate) -- [videoCodec](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#videocodec) -- [videoStreamIndex](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#videostreamindex) -- [width](generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5996](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5996) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6087](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6087) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6080](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6080) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6115](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6115) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6122](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6122) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6066](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6066) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6101](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6101) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6311](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6311) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6094](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6094) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6325](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6325) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6164](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6164) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6269](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6269) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6248](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6248) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6059](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6059) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6017](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6017) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6073](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6073) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6283](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6283) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6150](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6150) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6185](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6185) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:5989](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L5989) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6143](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6143) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6276](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6276) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6108](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6108) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6129](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6129) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6157](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6157) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -Optional. The maximum vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6199](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6199) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6227](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6227) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6234](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6234) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -Optional. The maximum horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6192](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6192) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6052](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6052) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6045](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6045) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6003](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6003) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6024](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6024) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6136](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6136) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6241](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6241) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6255](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6255) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6031](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6031) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6038](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6038) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6171](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6171) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6332](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6332) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6297](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6297) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6220](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6220) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6213](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6213) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6010](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6010) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6304](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6304) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6262](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6262) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6206](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6206) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6290](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6290) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6318](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6318) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiGetVariantHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6178](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6178) diff --git a/docs/interfaces/generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md b/docs/interfaces/generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md deleted file mode 100644 index 91ab94ba8..000000000 --- a/docs/interfaces/generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md +++ /dev/null @@ -1,770 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicHlsApiHeadMasterHlsAudioPlaylistRequest - -# Interface: DynamicHlsApiHeadMasterHlsAudioPlaylistRequest - -[generated-client](../modules/generated_client.md).DynamicHlsApiHeadMasterHlsAudioPlaylistRequest - -Request parameters for headMasterHlsAudioPlaylist operation in DynamicHlsApi. - -**`export`** - -**`interface`** DynamicHlsApiHeadMasterHlsAudioPlaylistRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#_static) -- [allowAudioStreamCopy](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#audiobitrate) -- [audioChannels](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#audiochannels) -- [audioCodec](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#audiocodec) -- [audioSampleRate](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#breakonnonkeyframes) -- [context](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#context) -- [copyTimestamps](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#cpucorelimit) -- [deInterlace](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#deinterlace) -- [deviceId](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#deviceid) -- [deviceProfileId](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#deviceprofileid) -- [enableAdaptiveBitrateStreaming](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#enableadaptivebitratestreaming) -- [enableAutoStreamCopy](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#framerate) -- [height](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#height) -- [itemId](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#itemid) -- [level](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#level) -- [liveStreamId](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#maxframerate) -- [maxRefFrames](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#maxrefframes) -- [maxStreamingBitrate](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#maxstreamingbitrate) -- [maxVideoBitDepth](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#maxvideobitdepth) -- [mediaSourceId](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#mediasourceid) -- [minSegments](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#minsegments) -- [params](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#params) -- [playSessionId](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#playsessionid) -- [profile](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#profile) -- [requireAvc](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#segmentcontainer) -- [segmentLength](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#segmentlength) -- [startTimeTicks](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#starttimeticks) -- [streamOptions](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#streamoptions) -- [subtitleCodec](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#subtitlestreamindex) -- [tag](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#tag) -- [transcodeReasons](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#videobitrate) -- [videoCodec](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#videocodec) -- [videoStreamIndex](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#videostreamindex) -- [width](generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6360](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6360) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6444](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6444) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6437](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6437) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6479](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6479) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6486](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6486) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6423](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6423) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6458](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6458) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6661](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6661) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6451](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6451) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6675](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6675) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6528](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6528) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6619](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6619) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6598](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6598) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6416](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6416) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6381](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6381) - -___ - -### enableAdaptiveBitrateStreaming - -• `Optional` `Readonly` **enableAdaptiveBitrateStreaming**: `boolean` - -Enable adaptive bitrate streaming. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6689](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6689) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6430](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6430) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6633](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6633) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6514](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6514) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6549](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6549) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6346](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6346) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6507](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6507) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6626](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6626) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6465](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6465) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6493](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6493) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6521](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6521) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6577](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6577) - -___ - -### maxStreamingBitrate - -• `Optional` `Readonly` **maxStreamingBitrate**: `number` - -Optional. The maximum streaming bitrate. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6472](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6472) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6584](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6584) - -___ - -### mediaSourceId - -• `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6353](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6353) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6409](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6409) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6367](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6367) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6388](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6388) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6500](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6500) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6591](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6591) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6605](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6605) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6395](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6395) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6402](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6402) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6535](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6535) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6682](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6682) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6647](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6647) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6570](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6570) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6563](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6563) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6374](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6374) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6654](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6654) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6612](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6612) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6556](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6556) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6640](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6640) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6668](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6668) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiHeadMasterHlsAudioPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6542](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6542) diff --git a/docs/interfaces/generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md b/docs/interfaces/generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md deleted file mode 100644 index 35344c0c7..000000000 --- a/docs/interfaces/generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md +++ /dev/null @@ -1,785 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicHlsApiHeadMasterHlsVideoPlaylistRequest - -# Interface: DynamicHlsApiHeadMasterHlsVideoPlaylistRequest - -[generated-client](../modules/generated_client.md).DynamicHlsApiHeadMasterHlsVideoPlaylistRequest - -Request parameters for headMasterHlsVideoPlaylist operation in DynamicHlsApi. - -**`export`** - -**`interface`** DynamicHlsApiHeadMasterHlsVideoPlaylistRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#_static) -- [allowAudioStreamCopy](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#audiobitrate) -- [audioChannels](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#audiochannels) -- [audioCodec](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#audiocodec) -- [audioSampleRate](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#breakonnonkeyframes) -- [context](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#context) -- [copyTimestamps](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#cpucorelimit) -- [deInterlace](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#deinterlace) -- [deviceId](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#deviceid) -- [deviceProfileId](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#deviceprofileid) -- [enableAdaptiveBitrateStreaming](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#enableadaptivebitratestreaming) -- [enableAutoStreamCopy](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#framerate) -- [height](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#height) -- [itemId](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#itemid) -- [level](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#level) -- [liveStreamId](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#maxframerate) -- [maxHeight](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#maxheight) -- [maxRefFrames](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#maxvideobitdepth) -- [maxWidth](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#maxwidth) -- [mediaSourceId](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#mediasourceid) -- [minSegments](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#minsegments) -- [params](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#params) -- [playSessionId](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#playsessionid) -- [profile](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#profile) -- [requireAvc](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#segmentcontainer) -- [segmentLength](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#segmentlength) -- [startTimeTicks](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#starttimeticks) -- [streamOptions](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#streamoptions) -- [subtitleCodec](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#subtitlestreamindex) -- [tag](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#tag) -- [transcodeReasons](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#videobitrate) -- [videoCodec](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#videocodec) -- [videoStreamIndex](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#videostreamindex) -- [width](generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6717](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6717) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6801](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6801) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6794](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6794) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6829](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6829) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6836](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6836) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6780](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6780) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6815](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6815) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7025](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7025) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6808](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6808) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7039](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7039) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6878](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6878) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6983](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6983) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6962](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6962) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6773](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6773) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6738](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6738) - -___ - -### enableAdaptiveBitrateStreaming - -• `Optional` `Readonly` **enableAdaptiveBitrateStreaming**: `boolean` - -Enable adaptive bitrate streaming. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7053](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7053) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6787](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6787) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6997](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6997) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6864](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6864) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6899](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6899) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6703](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6703) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6857](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6857) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6990](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6990) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6822](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6822) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6843](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6843) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6871](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6871) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -Optional. The maximum vertical resolution of the encoded video. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6913](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6913) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6941](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6941) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6948](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6948) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -Optional. The maximum horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6906](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6906) - -___ - -### mediaSourceId - -• `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6710](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6710) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6766](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6766) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6724](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6724) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6745](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6745) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6850](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6850) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6955](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6955) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6969](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6969) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6752](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6752) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6759](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6759) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6885](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6885) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7046](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7046) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7011](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7011) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6934](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6934) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6927](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6927) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6731](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6731) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7018](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7018) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6976](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6976) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6920](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6920) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7004](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7004) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:7032](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7032) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** DynamicHlsApiHeadMasterHlsVideoPlaylist - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:6892](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L6892) diff --git a/docs/interfaces/generated_client.EncodingOptions.md b/docs/interfaces/generated_client.EncodingOptions.md deleted file mode 100644 index 0cec43141..000000000 --- a/docs/interfaces/generated_client.EncodingOptions.md +++ /dev/null @@ -1,512 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / EncodingOptions - -# Interface: EncodingOptions - -[generated-client](../modules/generated_client.md).EncodingOptions - -**`export`** - -**`interface`** EncodingOptions - -## Table of contents - -### Properties - -- [AllowHevcEncoding](generated_client.EncodingOptions.md#allowhevcencoding) -- [AllowOnDemandMetadataBasedKeyframeExtractionForExtensions](generated_client.EncodingOptions.md#allowondemandmetadatabasedkeyframeextractionforextensions) -- [DeinterlaceDoubleRate](generated_client.EncodingOptions.md#deinterlacedoublerate) -- [DeinterlaceMethod](generated_client.EncodingOptions.md#deinterlacemethod) -- [DownMixAudioBoost](generated_client.EncodingOptions.md#downmixaudioboost) -- [EnableDecodingColorDepth10Hevc](generated_client.EncodingOptions.md#enabledecodingcolordepth10hevc) -- [EnableDecodingColorDepth10Vp9](generated_client.EncodingOptions.md#enabledecodingcolordepth10vp9) -- [EnableEnhancedNvdecDecoder](generated_client.EncodingOptions.md#enableenhancednvdecdecoder) -- [EnableFallbackFont](generated_client.EncodingOptions.md#enablefallbackfont) -- [EnableHardwareEncoding](generated_client.EncodingOptions.md#enablehardwareencoding) -- [EnableIntelLowPowerH264HwEncoder](generated_client.EncodingOptions.md#enableintellowpowerh264hwencoder) -- [EnableIntelLowPowerHevcHwEncoder](generated_client.EncodingOptions.md#enableintellowpowerhevchwencoder) -- [EnableSubtitleExtraction](generated_client.EncodingOptions.md#enablesubtitleextraction) -- [EnableThrottling](generated_client.EncodingOptions.md#enablethrottling) -- [EnableTonemapping](generated_client.EncodingOptions.md#enabletonemapping) -- [EnableVppTonemapping](generated_client.EncodingOptions.md#enablevpptonemapping) -- [EncoderAppPath](generated_client.EncodingOptions.md#encoderapppath) -- [EncoderAppPathDisplay](generated_client.EncodingOptions.md#encoderapppathdisplay) -- [EncoderPreset](generated_client.EncodingOptions.md#encoderpreset) -- [EncodingThreadCount](generated_client.EncodingOptions.md#encodingthreadcount) -- [FallbackFontPath](generated_client.EncodingOptions.md#fallbackfontpath) -- [H264Crf](generated_client.EncodingOptions.md#h264crf) -- [H265Crf](generated_client.EncodingOptions.md#h265crf) -- [HardwareAccelerationType](generated_client.EncodingOptions.md#hardwareaccelerationtype) -- [HardwareDecodingCodecs](generated_client.EncodingOptions.md#hardwaredecodingcodecs) -- [MaxMuxingQueueSize](generated_client.EncodingOptions.md#maxmuxingqueuesize) -- [PreferSystemNativeHwDecoder](generated_client.EncodingOptions.md#prefersystemnativehwdecoder) -- [ThrottleDelaySeconds](generated_client.EncodingOptions.md#throttledelayseconds) -- [TonemappingAlgorithm](generated_client.EncodingOptions.md#tonemappingalgorithm) -- [TonemappingDesat](generated_client.EncodingOptions.md#tonemappingdesat) -- [TonemappingParam](generated_client.EncodingOptions.md#tonemappingparam) -- [TonemappingPeak](generated_client.EncodingOptions.md#tonemappingpeak) -- [TonemappingRange](generated_client.EncodingOptions.md#tonemappingrange) -- [TonemappingThreshold](generated_client.EncodingOptions.md#tonemappingthreshold) -- [TranscodingTempPath](generated_client.EncodingOptions.md#transcodingtemppath) -- [VaapiDevice](generated_client.EncodingOptions.md#vaapidevice) -- [VppTonemappingBrightness](generated_client.EncodingOptions.md#vpptonemappingbrightness) -- [VppTonemappingContrast](generated_client.EncodingOptions.md#vpptonemappingcontrast) - -## Properties - -### AllowHevcEncoding - -• `Optional` **AllowHevcEncoding**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:232](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L232) - -___ - -### AllowOnDemandMetadataBasedKeyframeExtractionForExtensions - -• `Optional` **AllowOnDemandMetadataBasedKeyframeExtractionForExtensions**: ``null`` \| `string`[] - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:250](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L250) - -___ - -### DeinterlaceDoubleRate - -• `Optional` **DeinterlaceDoubleRate**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:178](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L178) - -___ - -### DeinterlaceMethod - -• `Optional` **DeinterlaceMethod**: ``null`` \| `string` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:184](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L184) - -___ - -### DownMixAudioBoost - -• `Optional` **DownMixAudioBoost**: `number` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L52) - -___ - -### EnableDecodingColorDepth10Hevc - -• `Optional` **EnableDecodingColorDepth10Hevc**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:190](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L190) - -___ - -### EnableDecodingColorDepth10Vp9 - -• `Optional` **EnableDecodingColorDepth10Vp9**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:196](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L196) - -___ - -### EnableEnhancedNvdecDecoder - -• `Optional` **EnableEnhancedNvdecDecoder**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:202](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L202) - -___ - -### EnableFallbackFont - -• `Optional` **EnableFallbackFont**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L46) - -___ - -### EnableHardwareEncoding - -• `Optional` **EnableHardwareEncoding**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:226](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L226) - -___ - -### EnableIntelLowPowerH264HwEncoder - -• `Optional` **EnableIntelLowPowerH264HwEncoder**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:214](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L214) - -___ - -### EnableIntelLowPowerHevcHwEncoder - -• `Optional` **EnableIntelLowPowerHevcHwEncoder**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:220](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L220) - -___ - -### EnableSubtitleExtraction - -• `Optional` **EnableSubtitleExtraction**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:238](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L238) - -___ - -### EnableThrottling - -• `Optional` **EnableThrottling**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L64) - -___ - -### EnableTonemapping - -• `Optional` **EnableTonemapping**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:100](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L100) - -___ - -### EnableVppTonemapping - -• `Optional` **EnableVppTonemapping**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:106](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L106) - -___ - -### EncoderAppPath - -• `Optional` **EncoderAppPath**: ``null`` \| `string` - -Gets or sets the FFmpeg path as set by the user via the UI. - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L82) - -___ - -### EncoderAppPathDisplay - -• `Optional` **EncoderAppPathDisplay**: ``null`` \| `string` - -Gets or sets the current FFmpeg path being used by the system and displayed on the transcode page. - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L88) - -___ - -### EncoderPreset - -• `Optional` **EncoderPreset**: ``null`` \| `string` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:172](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L172) - -___ - -### EncodingThreadCount - -• `Optional` **EncodingThreadCount**: `number` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L28) - -___ - -### FallbackFontPath - -• `Optional` **FallbackFontPath**: ``null`` \| `string` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L40) - -___ - -### H264Crf - -• `Optional` **H264Crf**: `number` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:160](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L160) - -___ - -### H265Crf - -• `Optional` **H265Crf**: `number` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:166](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L166) - -___ - -### HardwareAccelerationType - -• `Optional` **HardwareAccelerationType**: ``null`` \| `string` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L76) - -___ - -### HardwareDecodingCodecs - -• `Optional` **HardwareDecodingCodecs**: ``null`` \| `string`[] - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:244](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L244) - -___ - -### MaxMuxingQueueSize - -• `Optional` **MaxMuxingQueueSize**: `number` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L58) - -___ - -### PreferSystemNativeHwDecoder - -• `Optional` **PreferSystemNativeHwDecoder**: `boolean` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:208](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L208) - -___ - -### ThrottleDelaySeconds - -• `Optional` **ThrottleDelaySeconds**: `number` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L70) - -___ - -### TonemappingAlgorithm - -• `Optional` **TonemappingAlgorithm**: ``null`` \| `string` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:112](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L112) - -___ - -### TonemappingDesat - -• `Optional` **TonemappingDesat**: `number` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:124](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L124) - -___ - -### TonemappingParam - -• `Optional` **TonemappingParam**: `number` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:142](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L142) - -___ - -### TonemappingPeak - -• `Optional` **TonemappingPeak**: `number` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:136](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L136) - -___ - -### TonemappingRange - -• `Optional` **TonemappingRange**: ``null`` \| `string` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:118](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L118) - -___ - -### TonemappingThreshold - -• `Optional` **TonemappingThreshold**: `number` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:130](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L130) - -___ - -### TranscodingTempPath - -• `Optional` **TranscodingTempPath**: ``null`` \| `string` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L34) - -___ - -### VaapiDevice - -• `Optional` **VaapiDevice**: ``null`` \| `string` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:94](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L94) - -___ - -### VppTonemappingBrightness - -• `Optional` **VppTonemappingBrightness**: `number` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:148](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L148) - -___ - -### VppTonemappingContrast - -• `Optional` **VppTonemappingContrast**: `number` - -**`memberof`** EncodingOptions - -#### Defined in - -[generated-client/models/encoding-options.ts:154](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-options.ts#L154) diff --git a/docs/interfaces/generated_client.EndPointInfo.md b/docs/interfaces/generated_client.EndPointInfo.md deleted file mode 100644 index 9d62fd5a0..000000000 --- a/docs/interfaces/generated_client.EndPointInfo.md +++ /dev/null @@ -1,40 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / EndPointInfo - -# Interface: EndPointInfo - -[generated-client](../modules/generated_client.md).EndPointInfo - -**`export`** - -**`interface`** EndPointInfo - -## Table of contents - -### Properties - -- [IsInNetwork](generated_client.EndPointInfo.md#isinnetwork) -- [IsLocal](generated_client.EndPointInfo.md#islocal) - -## Properties - -### IsInNetwork - -• `Optional` **IsInNetwork**: `boolean` - -**`memberof`** EndPointInfo - -#### Defined in - -[generated-client/models/end-point-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/end-point-info.ts#L34) - -___ - -### IsLocal - -• `Optional` **IsLocal**: `boolean` - -**`memberof`** EndPointInfo - -#### Defined in - -[generated-client/models/end-point-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/end-point-info.ts#L28) diff --git a/docs/interfaces/generated_client.EnvironmentApiGetDirectoryContentsRequest.md b/docs/interfaces/generated_client.EnvironmentApiGetDirectoryContentsRequest.md deleted file mode 100644 index 9d6d6df81..000000000 --- a/docs/interfaces/generated_client.EnvironmentApiGetDirectoryContentsRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / EnvironmentApiGetDirectoryContentsRequest - -# Interface: EnvironmentApiGetDirectoryContentsRequest - -[generated-client](../modules/generated_client.md).EnvironmentApiGetDirectoryContentsRequest - -Request parameters for getDirectoryContents operation in EnvironmentApi. - -**`export`** - -**`interface`** EnvironmentApiGetDirectoryContentsRequest - -## Table of contents - -### Properties - -- [includeDirectories](generated_client.EnvironmentApiGetDirectoryContentsRequest.md#includedirectories) -- [includeFiles](generated_client.EnvironmentApiGetDirectoryContentsRequest.md#includefiles) -- [path](generated_client.EnvironmentApiGetDirectoryContentsRequest.md#path) - -## Properties - -### includeDirectories - -• `Optional` `Readonly` **includeDirectories**: `boolean` - -An optional filter to include or exclude folders from the results. true/false. - -**`memberof`** EnvironmentApiGetDirectoryContents - -#### Defined in - -[generated-client/api/environment-api.ts:440](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L440) - -___ - -### includeFiles - -• `Optional` `Readonly` **includeFiles**: `boolean` - -An optional filter to include or exclude files from the results. true/false. - -**`memberof`** EnvironmentApiGetDirectoryContents - -#### Defined in - -[generated-client/api/environment-api.ts:433](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L433) - -___ - -### path - -• `Readonly` **path**: `string` - -The path. - -**`memberof`** EnvironmentApiGetDirectoryContents - -#### Defined in - -[generated-client/api/environment-api.ts:426](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L426) diff --git a/docs/interfaces/generated_client.EnvironmentApiGetParentPathRequest.md b/docs/interfaces/generated_client.EnvironmentApiGetParentPathRequest.md deleted file mode 100644 index 07fc199b2..000000000 --- a/docs/interfaces/generated_client.EnvironmentApiGetParentPathRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / EnvironmentApiGetParentPathRequest - -# Interface: EnvironmentApiGetParentPathRequest - -[generated-client](../modules/generated_client.md).EnvironmentApiGetParentPathRequest - -Request parameters for getParentPath operation in EnvironmentApi. - -**`export`** - -**`interface`** EnvironmentApiGetParentPathRequest - -## Table of contents - -### Properties - -- [path](generated_client.EnvironmentApiGetParentPathRequest.md#path) - -## Properties - -### path - -• `Readonly` **path**: `string` - -The path. - -**`memberof`** EnvironmentApiGetParentPath - -#### Defined in - -[generated-client/api/environment-api.ts:454](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L454) diff --git a/docs/interfaces/generated_client.EnvironmentApiValidatePathRequest.md b/docs/interfaces/generated_client.EnvironmentApiValidatePathRequest.md deleted file mode 100644 index ffa3e72cc..000000000 --- a/docs/interfaces/generated_client.EnvironmentApiValidatePathRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / EnvironmentApiValidatePathRequest - -# Interface: EnvironmentApiValidatePathRequest - -[generated-client](../modules/generated_client.md).EnvironmentApiValidatePathRequest - -Request parameters for validatePath operation in EnvironmentApi. - -**`export`** - -**`interface`** EnvironmentApiValidatePathRequest - -## Table of contents - -### Properties - -- [validatePathDto](generated_client.EnvironmentApiValidatePathRequest.md#validatepathdto) - -## Properties - -### validatePathDto - -• `Readonly` **validatePathDto**: [`ValidatePathDto`](generated_client.ValidatePathDto.md) - -Validate request object. - -**`memberof`** EnvironmentApiValidatePath - -#### Defined in - -[generated-client/api/environment-api.ts:468](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L468) diff --git a/docs/interfaces/generated_client.ExternalIdInfo.md b/docs/interfaces/generated_client.ExternalIdInfo.md deleted file mode 100644 index 0fcdb2cc3..000000000 --- a/docs/interfaces/generated_client.ExternalIdInfo.md +++ /dev/null @@ -1,74 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ExternalIdInfo - -# Interface: ExternalIdInfo - -[generated-client](../modules/generated_client.md).ExternalIdInfo - -Represents the external id information for serialization to the client. - -**`export`** - -**`interface`** ExternalIdInfo - -## Table of contents - -### Properties - -- [Key](generated_client.ExternalIdInfo.md#key) -- [Name](generated_client.ExternalIdInfo.md#name) -- [Type](generated_client.ExternalIdInfo.md#type) -- [UrlFormatString](generated_client.ExternalIdInfo.md#urlformatstring) - -## Properties - -### Key - -• `Optional` **Key**: `string` - -Gets or sets the unique key for this id. This key should be unique across all providers. - -**`memberof`** ExternalIdInfo - -#### Defined in - -[generated-client/models/external-id-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-info.ts#L35) - -___ - -### Name - -• `Optional` **Name**: `string` - -Gets or sets the display name of the external id provider (IE: IMDB, MusicBrainz, etc). - -**`memberof`** ExternalIdInfo - -#### Defined in - -[generated-client/models/external-id-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-info.ts#L29) - -___ - -### Type - -• `Optional` **Type**: [`ExternalIdMediaType`](../enums/generated_client.ExternalIdMediaType.md) - -**`memberof`** ExternalIdInfo - -#### Defined in - -[generated-client/models/external-id-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-info.ts#L41) - -___ - -### UrlFormatString - -• `Optional` **UrlFormatString**: ``null`` \| `string` - -Gets or sets the URL format string. - -**`memberof`** ExternalIdInfo - -#### Defined in - -[generated-client/models/external-id-info.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-info.ts#L47) diff --git a/docs/interfaces/generated_client.ExternalUrl.md b/docs/interfaces/generated_client.ExternalUrl.md deleted file mode 100644 index 6be262670..000000000 --- a/docs/interfaces/generated_client.ExternalUrl.md +++ /dev/null @@ -1,44 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ExternalUrl - -# Interface: ExternalUrl - -[generated-client](../modules/generated_client.md).ExternalUrl - -**`export`** - -**`interface`** ExternalUrl - -## Table of contents - -### Properties - -- [Name](generated_client.ExternalUrl.md#name) -- [Url](generated_client.ExternalUrl.md#url) - -## Properties - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** ExternalUrl - -#### Defined in - -[generated-client/models/external-url.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-url.ts#L28) - -___ - -### Url - -• `Optional` **Url**: ``null`` \| `string` - -Gets or sets the type of the item. - -**`memberof`** ExternalUrl - -#### Defined in - -[generated-client/models/external-url.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-url.ts#L34) diff --git a/docs/interfaces/generated_client.FileSystemEntryInfo.md b/docs/interfaces/generated_client.FileSystemEntryInfo.md deleted file mode 100644 index 73c9c7480..000000000 --- a/docs/interfaces/generated_client.FileSystemEntryInfo.md +++ /dev/null @@ -1,59 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / FileSystemEntryInfo - -# Interface: FileSystemEntryInfo - -[generated-client](../modules/generated_client.md).FileSystemEntryInfo - -Class FileSystemEntryInfo. - -**`export`** - -**`interface`** FileSystemEntryInfo - -## Table of contents - -### Properties - -- [Name](generated_client.FileSystemEntryInfo.md#name) -- [Path](generated_client.FileSystemEntryInfo.md#path) -- [Type](generated_client.FileSystemEntryInfo.md#type) - -## Properties - -### Name - -• `Optional` **Name**: `string` - -Gets the name. - -**`memberof`** FileSystemEntryInfo - -#### Defined in - -[generated-client/models/file-system-entry-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/file-system-entry-info.ts#L29) - -___ - -### Path - -• `Optional` **Path**: `string` - -Gets the path. - -**`memberof`** FileSystemEntryInfo - -#### Defined in - -[generated-client/models/file-system-entry-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/file-system-entry-info.ts#L35) - -___ - -### Type - -• `Optional` **Type**: [`FileSystemEntryType`](../enums/generated_client.FileSystemEntryType.md) - -**`memberof`** FileSystemEntryInfo - -#### Defined in - -[generated-client/models/file-system-entry-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/file-system-entry-info.ts#L41) diff --git a/docs/interfaces/generated_client.FilterApiGetQueryFiltersLegacyRequest.md b/docs/interfaces/generated_client.FilterApiGetQueryFiltersLegacyRequest.md deleted file mode 100644 index 8bdb90a48..000000000 --- a/docs/interfaces/generated_client.FilterApiGetQueryFiltersLegacyRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / FilterApiGetQueryFiltersLegacyRequest - -# Interface: FilterApiGetQueryFiltersLegacyRequest - -[generated-client](../modules/generated_client.md).FilterApiGetQueryFiltersLegacyRequest - -Request parameters for getQueryFiltersLegacy operation in FilterApi. - -**`export`** - -**`interface`** FilterApiGetQueryFiltersLegacyRequest - -## Table of contents - -### Properties - -- [includeItemTypes](generated_client.FilterApiGetQueryFiltersLegacyRequest.md#includeitemtypes) -- [mediaTypes](generated_client.FilterApiGetQueryFiltersLegacyRequest.md#mediatypes) -- [parentId](generated_client.FilterApiGetQueryFiltersLegacyRequest.md#parentid) -- [userId](generated_client.FilterApiGetQueryFiltersLegacyRequest.md#userid) - -## Properties - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - -**`memberof`** FilterApiGetQueryFiltersLegacy - -#### Defined in - -[generated-client/api/filter-api.ts:362](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L362) - -___ - -### mediaTypes - -• `Optional` `Readonly` **mediaTypes**: `string`[] - -Optional. Filter by MediaType. Allows multiple, comma delimited. - -**`memberof`** FilterApiGetQueryFiltersLegacy - -#### Defined in - -[generated-client/api/filter-api.ts:369](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L369) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Optional. Parent id. - -**`memberof`** FilterApiGetQueryFiltersLegacy - -#### Defined in - -[generated-client/api/filter-api.ts:355](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L355) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. User id. - -**`memberof`** FilterApiGetQueryFiltersLegacy - -#### Defined in - -[generated-client/api/filter-api.ts:348](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L348) diff --git a/docs/interfaces/generated_client.FilterApiGetQueryFiltersRequest.md b/docs/interfaces/generated_client.FilterApiGetQueryFiltersRequest.md deleted file mode 100644 index dd74b5e88..000000000 --- a/docs/interfaces/generated_client.FilterApiGetQueryFiltersRequest.md +++ /dev/null @@ -1,166 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / FilterApiGetQueryFiltersRequest - -# Interface: FilterApiGetQueryFiltersRequest - -[generated-client](../modules/generated_client.md).FilterApiGetQueryFiltersRequest - -Request parameters for getQueryFilters operation in FilterApi. - -**`export`** - -**`interface`** FilterApiGetQueryFiltersRequest - -## Table of contents - -### Properties - -- [includeItemTypes](generated_client.FilterApiGetQueryFiltersRequest.md#includeitemtypes) -- [isAiring](generated_client.FilterApiGetQueryFiltersRequest.md#isairing) -- [isKids](generated_client.FilterApiGetQueryFiltersRequest.md#iskids) -- [isMovie](generated_client.FilterApiGetQueryFiltersRequest.md#ismovie) -- [isNews](generated_client.FilterApiGetQueryFiltersRequest.md#isnews) -- [isSeries](generated_client.FilterApiGetQueryFiltersRequest.md#isseries) -- [isSports](generated_client.FilterApiGetQueryFiltersRequest.md#issports) -- [parentId](generated_client.FilterApiGetQueryFiltersRequest.md#parentid) -- [recursive](generated_client.FilterApiGetQueryFiltersRequest.md#recursive) -- [userId](generated_client.FilterApiGetQueryFiltersRequest.md#userid) - -## Properties - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - -**`memberof`** FilterApiGetQueryFilters - -#### Defined in - -[generated-client/api/filter-api.ts:285](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L285) - -___ - -### isAiring - -• `Optional` `Readonly` **isAiring**: `boolean` - -Optional. Is item airing. - -**`memberof`** FilterApiGetQueryFilters - -#### Defined in - -[generated-client/api/filter-api.ts:292](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L292) - -___ - -### isKids - -• `Optional` `Readonly` **isKids**: `boolean` - -Optional. Is item kids. - -**`memberof`** FilterApiGetQueryFilters - -#### Defined in - -[generated-client/api/filter-api.ts:313](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L313) - -___ - -### isMovie - -• `Optional` `Readonly` **isMovie**: `boolean` - -Optional. Is item movie. - -**`memberof`** FilterApiGetQueryFilters - -#### Defined in - -[generated-client/api/filter-api.ts:299](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L299) - -___ - -### isNews - -• `Optional` `Readonly` **isNews**: `boolean` - -Optional. Is item news. - -**`memberof`** FilterApiGetQueryFilters - -#### Defined in - -[generated-client/api/filter-api.ts:320](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L320) - -___ - -### isSeries - -• `Optional` `Readonly` **isSeries**: `boolean` - -Optional. Is item series. - -**`memberof`** FilterApiGetQueryFilters - -#### Defined in - -[generated-client/api/filter-api.ts:327](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L327) - -___ - -### isSports - -• `Optional` `Readonly` **isSports**: `boolean` - -Optional. Is item sports. - -**`memberof`** FilterApiGetQueryFilters - -#### Defined in - -[generated-client/api/filter-api.ts:306](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L306) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Optional. Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** FilterApiGetQueryFilters - -#### Defined in - -[generated-client/api/filter-api.ts:278](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L278) - -___ - -### recursive - -• `Optional` `Readonly` **recursive**: `boolean` - -Optional. Search recursive. - -**`memberof`** FilterApiGetQueryFilters - -#### Defined in - -[generated-client/api/filter-api.ts:334](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L334) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. User id. - -**`memberof`** FilterApiGetQueryFilters - -#### Defined in - -[generated-client/api/filter-api.ts:271](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L271) diff --git a/docs/interfaces/generated_client.FontFile.md b/docs/interfaces/generated_client.FontFile.md deleted file mode 100644 index a081152f9..000000000 --- a/docs/interfaces/generated_client.FontFile.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / FontFile - -# Interface: FontFile - -[generated-client](../modules/generated_client.md).FontFile - -Class FontFile. - -**`export`** - -**`interface`** FontFile - -## Table of contents - -### Properties - -- [DateCreated](generated_client.FontFile.md#datecreated) -- [DateModified](generated_client.FontFile.md#datemodified) -- [Name](generated_client.FontFile.md#name) -- [Size](generated_client.FontFile.md#size) - -## Properties - -### DateCreated - -• `Optional` **DateCreated**: `string` - -Gets or sets the date created. - -**`memberof`** FontFile - -#### Defined in - -[generated-client/models/font-file.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/font-file.ts#L40) - -___ - -### DateModified - -• `Optional` **DateModified**: `string` - -Gets or sets the date modified. - -**`memberof`** FontFile - -#### Defined in - -[generated-client/models/font-file.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/font-file.ts#L46) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** FontFile - -#### Defined in - -[generated-client/models/font-file.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/font-file.ts#L28) - -___ - -### Size - -• `Optional` **Size**: `number` - -Gets or sets the size. - -**`memberof`** FontFile - -#### Defined in - -[generated-client/models/font-file.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/font-file.ts#L34) diff --git a/docs/interfaces/generated_client.ForgotPasswordDto.md b/docs/interfaces/generated_client.ForgotPasswordDto.md deleted file mode 100644 index 97acd356f..000000000 --- a/docs/interfaces/generated_client.ForgotPasswordDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ForgotPasswordDto - -# Interface: ForgotPasswordDto - -[generated-client](../modules/generated_client.md).ForgotPasswordDto - -Forgot Password request body DTO. - -**`export`** - -**`interface`** ForgotPasswordDto - -## Table of contents - -### Properties - -- [EnteredUsername](generated_client.ForgotPasswordDto.md#enteredusername) - -## Properties - -### EnteredUsername - -• **EnteredUsername**: `string` - -Gets or sets the entered username to have its password reset. - -**`memberof`** ForgotPasswordDto - -#### Defined in - -[generated-client/models/forgot-password-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/forgot-password-dto.ts#L28) diff --git a/docs/interfaces/generated_client.ForgotPasswordPinDto.md b/docs/interfaces/generated_client.ForgotPasswordPinDto.md deleted file mode 100644 index 996ae0728..000000000 --- a/docs/interfaces/generated_client.ForgotPasswordPinDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ForgotPasswordPinDto - -# Interface: ForgotPasswordPinDto - -[generated-client](../modules/generated_client.md).ForgotPasswordPinDto - -Forgot Password Pin enter request body DTO. - -**`export`** - -**`interface`** ForgotPasswordPinDto - -## Table of contents - -### Properties - -- [Pin](generated_client.ForgotPasswordPinDto.md#pin) - -## Properties - -### Pin - -• **Pin**: `string` - -Gets or sets the entered pin to have the password reset. - -**`memberof`** ForgotPasswordPinDto - -#### Defined in - -[generated-client/models/forgot-password-pin-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/forgot-password-pin-dto.ts#L28) diff --git a/docs/interfaces/generated_client.ForgotPasswordResult.md b/docs/interfaces/generated_client.ForgotPasswordResult.md deleted file mode 100644 index dfcbcae9a..000000000 --- a/docs/interfaces/generated_client.ForgotPasswordResult.md +++ /dev/null @@ -1,57 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ForgotPasswordResult - -# Interface: ForgotPasswordResult - -[generated-client](../modules/generated_client.md).ForgotPasswordResult - -**`export`** - -**`interface`** ForgotPasswordResult - -## Table of contents - -### Properties - -- [Action](generated_client.ForgotPasswordResult.md#action) -- [PinExpirationDate](generated_client.ForgotPasswordResult.md#pinexpirationdate) -- [PinFile](generated_client.ForgotPasswordResult.md#pinfile) - -## Properties - -### Action - -• `Optional` **Action**: [`ForgotPasswordAction`](../enums/generated_client.ForgotPasswordAction.md) - -**`memberof`** ForgotPasswordResult - -#### Defined in - -[generated-client/models/forgot-password-result.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/forgot-password-result.ts#L29) - -___ - -### PinExpirationDate - -• `Optional` **PinExpirationDate**: ``null`` \| `string` - -Gets or sets the pin expiration date. - -**`memberof`** ForgotPasswordResult - -#### Defined in - -[generated-client/models/forgot-password-result.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/forgot-password-result.ts#L41) - -___ - -### PinFile - -• `Optional` **PinFile**: ``null`` \| `string` - -Gets or sets the pin file. - -**`memberof`** ForgotPasswordResult - -#### Defined in - -[generated-client/models/forgot-password-result.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/forgot-password-result.ts#L35) diff --git a/docs/interfaces/generated_client.GeneralCommand.md b/docs/interfaces/generated_client.GeneralCommand.md deleted file mode 100644 index d779cb02a..000000000 --- a/docs/interfaces/generated_client.GeneralCommand.md +++ /dev/null @@ -1,57 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GeneralCommand - -# Interface: GeneralCommand - -[generated-client](../modules/generated_client.md).GeneralCommand - -**`export`** - -**`interface`** GeneralCommand - -## Table of contents - -### Properties - -- [Arguments](generated_client.GeneralCommand.md#arguments) -- [ControllingUserId](generated_client.GeneralCommand.md#controllinguserid) -- [Name](generated_client.GeneralCommand.md#name) - -## Properties - -### Arguments - -• `Optional` **Arguments**: `Object` - -**`memberof`** GeneralCommand - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/models/general-command.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command.ts#L41) - -___ - -### ControllingUserId - -• `Optional` **ControllingUserId**: `string` - -**`memberof`** GeneralCommand - -#### Defined in - -[generated-client/models/general-command.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command.ts#L35) - -___ - -### Name - -• `Optional` **Name**: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md) - -**`memberof`** GeneralCommand - -#### Defined in - -[generated-client/models/general-command.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command.ts#L29) diff --git a/docs/interfaces/generated_client.GenresApiGetGenreRequest.md b/docs/interfaces/generated_client.GenresApiGetGenreRequest.md deleted file mode 100644 index 9fe573e26..000000000 --- a/docs/interfaces/generated_client.GenresApiGetGenreRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GenresApiGetGenreRequest - -# Interface: GenresApiGetGenreRequest - -[generated-client](../modules/generated_client.md).GenresApiGetGenreRequest - -Request parameters for getGenre operation in GenresApi. - -**`export`** - -**`interface`** GenresApiGetGenreRequest - -## Table of contents - -### Properties - -- [genreName](generated_client.GenresApiGetGenreRequest.md#genrename) -- [userId](generated_client.GenresApiGetGenreRequest.md#userid) - -## Properties - -### genreName - -• `Readonly` **genreName**: `string` - -The genre name. - -**`memberof`** GenresApiGetGenre - -#### Defined in - -[generated-client/api/genres-api.ts:318](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L318) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -The user id. - -**`memberof`** GenresApiGetGenre - -#### Defined in - -[generated-client/api/genres-api.ts:325](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L325) diff --git a/docs/interfaces/generated_client.GenresApiGetGenresRequest.md b/docs/interfaces/generated_client.GenresApiGetGenresRequest.md deleted file mode 100644 index 95461d202..000000000 --- a/docs/interfaces/generated_client.GenresApiGetGenresRequest.md +++ /dev/null @@ -1,286 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GenresApiGetGenresRequest - -# Interface: GenresApiGetGenresRequest - -[generated-client](../modules/generated_client.md).GenresApiGetGenresRequest - -Request parameters for getGenres operation in GenresApi. - -**`export`** - -**`interface`** GenresApiGetGenresRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.GenresApiGetGenresRequest.md#enableimagetypes) -- [enableImages](generated_client.GenresApiGetGenresRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.GenresApiGetGenresRequest.md#enabletotalrecordcount) -- [excludeItemTypes](generated_client.GenresApiGetGenresRequest.md#excludeitemtypes) -- [fields](generated_client.GenresApiGetGenresRequest.md#fields) -- [imageTypeLimit](generated_client.GenresApiGetGenresRequest.md#imagetypelimit) -- [includeItemTypes](generated_client.GenresApiGetGenresRequest.md#includeitemtypes) -- [isFavorite](generated_client.GenresApiGetGenresRequest.md#isfavorite) -- [limit](generated_client.GenresApiGetGenresRequest.md#limit) -- [nameLessThan](generated_client.GenresApiGetGenresRequest.md#namelessthan) -- [nameStartsWith](generated_client.GenresApiGetGenresRequest.md#namestartswith) -- [nameStartsWithOrGreater](generated_client.GenresApiGetGenresRequest.md#namestartswithorgreater) -- [parentId](generated_client.GenresApiGetGenresRequest.md#parentid) -- [searchTerm](generated_client.GenresApiGetGenresRequest.md#searchterm) -- [sortBy](generated_client.GenresApiGetGenresRequest.md#sortby) -- [sortOrder](generated_client.GenresApiGetGenresRequest.md#sortorder) -- [startIndex](generated_client.GenresApiGetGenresRequest.md#startindex) -- [userId](generated_client.GenresApiGetGenresRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:402](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L402) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional, include image information in output. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:451](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L451) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Optional. Include total record count. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:458](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L458) - -___ - -### excludeItemTypes - -• `Optional` `Readonly` **excludeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:374](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L374) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:367](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L367) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional, the max number of images to return, per image type. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:395](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L395) - -___ - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:381](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L381) - -___ - -### isFavorite - -• `Optional` `Readonly` **isFavorite**: `boolean` - -Optional filter by items that are marked as favorite, or not. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:388](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L388) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:346](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L346) - -___ - -### nameLessThan - -• `Optional` `Readonly` **nameLessThan**: `string` - -Optional filter by items whose name is equally or lesser than a given input string. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:430](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L430) - -___ - -### nameStartsWith - -• `Optional` `Readonly` **nameStartsWith**: `string` - -Optional filter by items whose name is sorted equally than a given input string. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:423](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L423) - -___ - -### nameStartsWithOrGreater - -• `Optional` `Readonly` **nameStartsWithOrGreater**: `string` - -Optional filter by items whose name is sorted equally or greater than a given input string. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:416](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L416) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:360](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L360) - -___ - -### searchTerm - -• `Optional` `Readonly` **searchTerm**: `string` - -The search term. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:353](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L353) - -___ - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string`[] - -Optional. Specify one or more sort orders, comma delimited. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:437](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L437) - -___ - -### sortOrder - -• `Optional` `Readonly` **sortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md)[] - -Sort Order - Ascending,Descending. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:444](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L444) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:339](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L339) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -User id. - -**`memberof`** GenresApiGetGenres - -#### Defined in - -[generated-client/api/genres-api.ts:409](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L409) diff --git a/docs/interfaces/generated_client.GetProgramsDto.md b/docs/interfaces/generated_client.GetProgramsDto.md deleted file mode 100644 index 7aa5a412c..000000000 --- a/docs/interfaces/generated_client.GetProgramsDto.md +++ /dev/null @@ -1,421 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GetProgramsDto - -# Interface: GetProgramsDto - -[generated-client](../modules/generated_client.md).GetProgramsDto - -Get programs dto. - -**`export`** - -**`interface`** GetProgramsDto - -## Table of contents - -### Properties - -- [ChannelIds](generated_client.GetProgramsDto.md#channelids) -- [EnableImageTypes](generated_client.GetProgramsDto.md#enableimagetypes) -- [EnableImages](generated_client.GetProgramsDto.md#enableimages) -- [EnableTotalRecordCount](generated_client.GetProgramsDto.md#enabletotalrecordcount) -- [EnableUserData](generated_client.GetProgramsDto.md#enableuserdata) -- [Fields](generated_client.GetProgramsDto.md#fields) -- [GenreIds](generated_client.GetProgramsDto.md#genreids) -- [Genres](generated_client.GetProgramsDto.md#genres) -- [HasAired](generated_client.GetProgramsDto.md#hasaired) -- [ImageTypeLimit](generated_client.GetProgramsDto.md#imagetypelimit) -- [IsAiring](generated_client.GetProgramsDto.md#isairing) -- [IsKids](generated_client.GetProgramsDto.md#iskids) -- [IsMovie](generated_client.GetProgramsDto.md#ismovie) -- [IsNews](generated_client.GetProgramsDto.md#isnews) -- [IsSeries](generated_client.GetProgramsDto.md#isseries) -- [IsSports](generated_client.GetProgramsDto.md#issports) -- [LibrarySeriesId](generated_client.GetProgramsDto.md#libraryseriesid) -- [Limit](generated_client.GetProgramsDto.md#limit) -- [MaxEndDate](generated_client.GetProgramsDto.md#maxenddate) -- [MaxStartDate](generated_client.GetProgramsDto.md#maxstartdate) -- [MinEndDate](generated_client.GetProgramsDto.md#minenddate) -- [MinStartDate](generated_client.GetProgramsDto.md#minstartdate) -- [SeriesTimerId](generated_client.GetProgramsDto.md#seriestimerid) -- [SortBy](generated_client.GetProgramsDto.md#sortby) -- [SortOrder](generated_client.GetProgramsDto.md#sortorder) -- [StartIndex](generated_client.GetProgramsDto.md#startindex) -- [UserId](generated_client.GetProgramsDto.md#userid) - -## Properties - -### ChannelIds - -• `Optional` **ChannelIds**: `string`[] - -Gets or sets the channels to return guide information for. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L31) - -___ - -### EnableImageTypes - -• `Optional` **EnableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Gets or sets the image types to include in the output. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:163](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L163) - -___ - -### EnableImages - -• `Optional` **EnableImages**: ``null`` \| `boolean` - -Gets or sets include image information in output. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:145](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L145) - -___ - -### EnableTotalRecordCount - -• `Optional` **EnableTotalRecordCount**: `boolean` - -Gets or sets a value indicating whether retrieve total record count. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:151](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L151) - -___ - -### EnableUserData - -• `Optional` **EnableUserData**: ``null`` \| `boolean` - -Gets or sets include user data. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:169](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L169) - -___ - -### Fields - -• `Optional` **Fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Gets or sets specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:187](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L187) - -___ - -### GenreIds - -• `Optional` **GenreIds**: `string`[] - -Gets or sets the genre ids to return guide information for. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:139](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L139) - -___ - -### Genres - -• `Optional` **Genres**: `string`[] - -Gets or sets the genres to return guide information for. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:133](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L133) - -___ - -### HasAired - -• `Optional` **HasAired**: ``null`` \| `boolean` - -Gets or sets filter by programs that have completed airing, or not. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L49) - -___ - -### ImageTypeLimit - -• `Optional` **ImageTypeLimit**: ``null`` \| `number` - -Gets or sets the max number of images to return, per image type. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:157](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L157) - -___ - -### IsAiring - -• `Optional` **IsAiring**: ``null`` \| `boolean` - -Gets or sets filter by programs that are currently airing, or not. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L55) - -___ - -### IsKids - -• `Optional` **IsKids**: ``null`` \| `boolean` - -Gets or sets filter for kids. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:97](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L97) - -___ - -### IsMovie - -• `Optional` **IsMovie**: ``null`` \| `boolean` - -Gets or sets filter for movies. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:79](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L79) - -___ - -### IsNews - -• `Optional` **IsNews**: ``null`` \| `boolean` - -Gets or sets filter for news. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:91](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L91) - -___ - -### IsSeries - -• `Optional` **IsSeries**: ``null`` \| `boolean` - -Gets or sets filter for series. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:85](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L85) - -___ - -### IsSports - -• `Optional` **IsSports**: ``null`` \| `boolean` - -Gets or sets filter for sports. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:103](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L103) - -___ - -### LibrarySeriesId - -• `Optional` **LibrarySeriesId**: `string` - -Gets or sets filter by library series id. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L181) - -___ - -### Limit - -• `Optional` **Limit**: ``null`` \| `number` - -Gets or sets the maximum number of records to return. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:115](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L115) - -___ - -### MaxEndDate - -• `Optional` **MaxEndDate**: ``null`` \| `string` - -Gets or sets the maximum premiere end date. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:73](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L73) - -___ - -### MaxStartDate - -• `Optional` **MaxStartDate**: ``null`` \| `string` - -Gets or sets the maximum premiere start date. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:61](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L61) - -___ - -### MinEndDate - -• `Optional` **MinEndDate**: ``null`` \| `string` - -Gets or sets the minimum premiere end date. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:67](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L67) - -___ - -### MinStartDate - -• `Optional` **MinStartDate**: ``null`` \| `string` - -Gets or sets the minimum premiere start date. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L43) - -___ - -### SeriesTimerId - -• `Optional` **SeriesTimerId**: ``null`` \| `string` - -Gets or sets filter by series timer id. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:175](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L175) - -___ - -### SortBy - -• `Optional` **SortBy**: `string`[] - -Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:121](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L121) - -___ - -### SortOrder - -• `Optional` **SortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md)[] - -Gets or sets sort Order - Ascending,Descending. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:127](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L127) - -___ - -### StartIndex - -• `Optional` **StartIndex**: ``null`` \| `number` - -Gets or sets the record index to start at. All items with a lower index will be dropped from the results. Optional. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:109](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L109) - -___ - -### UserId - -• `Optional` **UserId**: `string` - -Gets or sets optional. Filter by user id. - -**`memberof`** GetProgramsDto - -#### Defined in - -[generated-client/models/get-programs-dto.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/get-programs-dto.ts#L37) diff --git a/docs/interfaces/generated_client.GroupInfoDto.md b/docs/interfaces/generated_client.GroupInfoDto.md deleted file mode 100644 index 2c1c8201b..000000000 --- a/docs/interfaces/generated_client.GroupInfoDto.md +++ /dev/null @@ -1,89 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GroupInfoDto - -# Interface: GroupInfoDto - -[generated-client](../modules/generated_client.md).GroupInfoDto - -Class GroupInfoDto. - -**`export`** - -**`interface`** GroupInfoDto - -## Table of contents - -### Properties - -- [GroupId](generated_client.GroupInfoDto.md#groupid) -- [GroupName](generated_client.GroupInfoDto.md#groupname) -- [LastUpdatedAt](generated_client.GroupInfoDto.md#lastupdatedat) -- [Participants](generated_client.GroupInfoDto.md#participants) -- [State](generated_client.GroupInfoDto.md#state) - -## Properties - -### GroupId - -• `Optional` **GroupId**: `string` - -Gets the group identifier. - -**`memberof`** GroupInfoDto - -#### Defined in - -[generated-client/models/group-info-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-info-dto.ts#L29) - -___ - -### GroupName - -• `Optional` **GroupName**: `string` - -Gets the group name. - -**`memberof`** GroupInfoDto - -#### Defined in - -[generated-client/models/group-info-dto.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-info-dto.ts#L35) - -___ - -### LastUpdatedAt - -• `Optional` **LastUpdatedAt**: `string` - -Gets the date when this DTO has been created. - -**`memberof`** GroupInfoDto - -#### Defined in - -[generated-client/models/group-info-dto.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-info-dto.ts#L53) - -___ - -### Participants - -• `Optional` **Participants**: `string`[] - -Gets the participants. - -**`memberof`** GroupInfoDto - -#### Defined in - -[generated-client/models/group-info-dto.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-info-dto.ts#L47) - -___ - -### State - -• `Optional` **State**: [`GroupStateType`](../enums/generated_client.GroupStateType.md) - -**`memberof`** GroupInfoDto - -#### Defined in - -[generated-client/models/group-info-dto.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-info-dto.ts#L41) diff --git a/docs/interfaces/generated_client.GuideInfo.md b/docs/interfaces/generated_client.GuideInfo.md deleted file mode 100644 index 06d2f79dd..000000000 --- a/docs/interfaces/generated_client.GuideInfo.md +++ /dev/null @@ -1,44 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GuideInfo - -# Interface: GuideInfo - -[generated-client](../modules/generated_client.md).GuideInfo - -**`export`** - -**`interface`** GuideInfo - -## Table of contents - -### Properties - -- [EndDate](generated_client.GuideInfo.md#enddate) -- [StartDate](generated_client.GuideInfo.md#startdate) - -## Properties - -### EndDate - -• `Optional` **EndDate**: `string` - -Gets or sets the end date. - -**`memberof`** GuideInfo - -#### Defined in - -[generated-client/models/guide-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/guide-info.ts#L34) - -___ - -### StartDate - -• `Optional` **StartDate**: `string` - -Gets or sets the start date. - -**`memberof`** GuideInfo - -#### Defined in - -[generated-client/models/guide-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/guide-info.ts#L28) diff --git a/docs/interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest.md b/docs/interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest.md deleted file mode 100644 index c1d35b9cf..000000000 --- a/docs/interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest - -# Interface: HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest - -[generated-client](../modules/generated_client.md).HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest - -Request parameters for getHlsAudioSegmentLegacyAac operation in HlsSegmentApi. - -**`export`** - -**`interface`** HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest.md#itemid) -- [segmentId](generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest.md#segmentid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** HlsSegmentApiGetHlsAudioSegmentLegacyAac - -#### Defined in - -[generated-client/api/hls-segment-api.ts:394](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L394) - -___ - -### segmentId - -• `Readonly` **segmentId**: `string` - -The segment id. - -**`memberof`** HlsSegmentApiGetHlsAudioSegmentLegacyAac - -#### Defined in - -[generated-client/api/hls-segment-api.ts:401](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L401) diff --git a/docs/interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request.md b/docs/interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request.md deleted file mode 100644 index 7ddc12fbb..000000000 --- a/docs/interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request - -# Interface: HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request - -[generated-client](../modules/generated_client.md).HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request - -Request parameters for getHlsAudioSegmentLegacyMp3 operation in HlsSegmentApi. - -**`export`** - -**`interface`** HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request - -## Table of contents - -### Properties - -- [itemId](generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request.md#itemid) -- [segmentId](generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request.md#segmentid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** HlsSegmentApiGetHlsAudioSegmentLegacyMp3 - -#### Defined in - -[generated-client/api/hls-segment-api.ts:415](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L415) - -___ - -### segmentId - -• `Readonly` **segmentId**: `string` - -The segment id. - -**`memberof`** HlsSegmentApiGetHlsAudioSegmentLegacyMp3 - -#### Defined in - -[generated-client/api/hls-segment-api.ts:422](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L422) diff --git a/docs/interfaces/generated_client.HlsSegmentApiGetHlsPlaylistLegacyRequest.md b/docs/interfaces/generated_client.HlsSegmentApiGetHlsPlaylistLegacyRequest.md deleted file mode 100644 index bdc4e34d1..000000000 --- a/docs/interfaces/generated_client.HlsSegmentApiGetHlsPlaylistLegacyRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / HlsSegmentApiGetHlsPlaylistLegacyRequest - -# Interface: HlsSegmentApiGetHlsPlaylistLegacyRequest - -[generated-client](../modules/generated_client.md).HlsSegmentApiGetHlsPlaylistLegacyRequest - -Request parameters for getHlsPlaylistLegacy operation in HlsSegmentApi. - -**`export`** - -**`interface`** HlsSegmentApiGetHlsPlaylistLegacyRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.HlsSegmentApiGetHlsPlaylistLegacyRequest.md#itemid) -- [playlistId](generated_client.HlsSegmentApiGetHlsPlaylistLegacyRequest.md#playlistid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The video id. - -**`memberof`** HlsSegmentApiGetHlsPlaylistLegacy - -#### Defined in - -[generated-client/api/hls-segment-api.ts:436](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L436) - -___ - -### playlistId - -• `Readonly` **playlistId**: `string` - -The playlist id. - -**`memberof`** HlsSegmentApiGetHlsPlaylistLegacy - -#### Defined in - -[generated-client/api/hls-segment-api.ts:443](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L443) diff --git a/docs/interfaces/generated_client.HlsSegmentApiGetHlsVideoSegmentLegacyRequest.md b/docs/interfaces/generated_client.HlsSegmentApiGetHlsVideoSegmentLegacyRequest.md deleted file mode 100644 index 5e694365e..000000000 --- a/docs/interfaces/generated_client.HlsSegmentApiGetHlsVideoSegmentLegacyRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / HlsSegmentApiGetHlsVideoSegmentLegacyRequest - -# Interface: HlsSegmentApiGetHlsVideoSegmentLegacyRequest - -[generated-client](../modules/generated_client.md).HlsSegmentApiGetHlsVideoSegmentLegacyRequest - -Request parameters for getHlsVideoSegmentLegacy operation in HlsSegmentApi. - -**`export`** - -**`interface`** HlsSegmentApiGetHlsVideoSegmentLegacyRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.HlsSegmentApiGetHlsVideoSegmentLegacyRequest.md#itemid) -- [playlistId](generated_client.HlsSegmentApiGetHlsVideoSegmentLegacyRequest.md#playlistid) -- [segmentContainer](generated_client.HlsSegmentApiGetHlsVideoSegmentLegacyRequest.md#segmentcontainer) -- [segmentId](generated_client.HlsSegmentApiGetHlsVideoSegmentLegacyRequest.md#segmentid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** HlsSegmentApiGetHlsVideoSegmentLegacy - -#### Defined in - -[generated-client/api/hls-segment-api.ts:457](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L457) - -___ - -### playlistId - -• `Readonly` **playlistId**: `string` - -The playlist id. - -**`memberof`** HlsSegmentApiGetHlsVideoSegmentLegacy - -#### Defined in - -[generated-client/api/hls-segment-api.ts:464](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L464) - -___ - -### segmentContainer - -• `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** HlsSegmentApiGetHlsVideoSegmentLegacy - -#### Defined in - -[generated-client/api/hls-segment-api.ts:478](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L478) - -___ - -### segmentId - -• `Readonly` **segmentId**: `string` - -The segment id. - -**`memberof`** HlsSegmentApiGetHlsVideoSegmentLegacy - -#### Defined in - -[generated-client/api/hls-segment-api.ts:471](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L471) diff --git a/docs/interfaces/generated_client.HlsSegmentApiStopEncodingProcessRequest.md b/docs/interfaces/generated_client.HlsSegmentApiStopEncodingProcessRequest.md deleted file mode 100644 index 539f81310..000000000 --- a/docs/interfaces/generated_client.HlsSegmentApiStopEncodingProcessRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / HlsSegmentApiStopEncodingProcessRequest - -# Interface: HlsSegmentApiStopEncodingProcessRequest - -[generated-client](../modules/generated_client.md).HlsSegmentApiStopEncodingProcessRequest - -Request parameters for stopEncodingProcess operation in HlsSegmentApi. - -**`export`** - -**`interface`** HlsSegmentApiStopEncodingProcessRequest - -## Table of contents - -### Properties - -- [deviceId](generated_client.HlsSegmentApiStopEncodingProcessRequest.md#deviceid) -- [playSessionId](generated_client.HlsSegmentApiStopEncodingProcessRequest.md#playsessionid) - -## Properties - -### deviceId - -• `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** HlsSegmentApiStopEncodingProcess - -#### Defined in - -[generated-client/api/hls-segment-api.ts:492](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L492) - -___ - -### playSessionId - -• `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** HlsSegmentApiStopEncodingProcess - -#### Defined in - -[generated-client/api/hls-segment-api.ts:499](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L499) diff --git a/docs/interfaces/generated_client.HttpHeaderInfo.md b/docs/interfaces/generated_client.HttpHeaderInfo.md deleted file mode 100644 index 52d6d75e0..000000000 --- a/docs/interfaces/generated_client.HttpHeaderInfo.md +++ /dev/null @@ -1,53 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / HttpHeaderInfo - -# Interface: HttpHeaderInfo - -[generated-client](../modules/generated_client.md).HttpHeaderInfo - -**`export`** - -**`interface`** HttpHeaderInfo - -## Table of contents - -### Properties - -- [Match](generated_client.HttpHeaderInfo.md#match) -- [Name](generated_client.HttpHeaderInfo.md#name) -- [Value](generated_client.HttpHeaderInfo.md#value) - -## Properties - -### Match - -• `Optional` **Match**: [`HeaderMatchType`](../enums/generated_client.HeaderMatchType.md) - -**`memberof`** HttpHeaderInfo - -#### Defined in - -[generated-client/models/http-header-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/http-header-info.ts#L41) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -**`memberof`** HttpHeaderInfo - -#### Defined in - -[generated-client/models/http-header-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/http-header-info.ts#L29) - -___ - -### Value - -• `Optional` **Value**: ``null`` \| `string` - -**`memberof`** HttpHeaderInfo - -#### Defined in - -[generated-client/models/http-header-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/http-header-info.ts#L35) diff --git a/docs/interfaces/generated_client.IPlugin.md b/docs/interfaces/generated_client.IPlugin.md deleted file mode 100644 index fe42c9f5d..000000000 --- a/docs/interfaces/generated_client.IPlugin.md +++ /dev/null @@ -1,121 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / IPlugin - -# Interface: IPlugin - -[generated-client](../modules/generated_client.md).IPlugin - -Defines the MediaBrowser.Common.Plugins.IPlugin. - -**`export`** - -**`interface`** IPlugin - -## Table of contents - -### Properties - -- [AssemblyFilePath](generated_client.IPlugin.md#assemblyfilepath) -- [CanUninstall](generated_client.IPlugin.md#canuninstall) -- [DataFolderPath](generated_client.IPlugin.md#datafolderpath) -- [Description](generated_client.IPlugin.md#description) -- [Id](generated_client.IPlugin.md#id) -- [Name](generated_client.IPlugin.md#name) -- [Version](generated_client.IPlugin.md#version) - -## Properties - -### AssemblyFilePath - -• `Optional` **AssemblyFilePath**: ``null`` \| `string` - -Gets the path to the assembly file. - -**`memberof`** IPlugin - -#### Defined in - -[generated-client/models/iplugin.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/iplugin.ts#L52) - -___ - -### CanUninstall - -• `Optional` **CanUninstall**: `boolean` - -Gets a value indicating whether the plugin can be uninstalled. - -**`memberof`** IPlugin - -#### Defined in - -[generated-client/models/iplugin.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/iplugin.ts#L58) - -___ - -### DataFolderPath - -• `Optional` **DataFolderPath**: ``null`` \| `string` - -Gets the full path to the data folder, where the plugin can store any miscellaneous files needed. - -**`memberof`** IPlugin - -#### Defined in - -[generated-client/models/iplugin.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/iplugin.ts#L64) - -___ - -### Description - -• `Optional` **Description**: ``null`` \| `string` - -Gets the Description. - -**`memberof`** IPlugin - -#### Defined in - -[generated-client/models/iplugin.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/iplugin.ts#L34) - -___ - -### Id - -• `Optional` **Id**: `string` - -Gets the unique id. - -**`memberof`** IPlugin - -#### Defined in - -[generated-client/models/iplugin.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/iplugin.ts#L40) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets the name of the plugin. - -**`memberof`** IPlugin - -#### Defined in - -[generated-client/models/iplugin.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/iplugin.ts#L28) - -___ - -### Version - -• `Optional` **Version**: ``null`` \| `string` - -Gets the plugin version. - -**`memberof`** IPlugin - -#### Defined in - -[generated-client/models/iplugin.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/iplugin.ts#L46) diff --git a/docs/interfaces/generated_client.IgnoreWaitRequestDto.md b/docs/interfaces/generated_client.IgnoreWaitRequestDto.md deleted file mode 100644 index 29c5a84d7..000000000 --- a/docs/interfaces/generated_client.IgnoreWaitRequestDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / IgnoreWaitRequestDto - -# Interface: IgnoreWaitRequestDto - -[generated-client](../modules/generated_client.md).IgnoreWaitRequestDto - -Class IgnoreWaitRequestDto. - -**`export`** - -**`interface`** IgnoreWaitRequestDto - -## Table of contents - -### Properties - -- [IgnoreWait](generated_client.IgnoreWaitRequestDto.md#ignorewait) - -## Properties - -### IgnoreWait - -• `Optional` **IgnoreWait**: `boolean` - -Gets or sets a value indicating whether the client should be ignored. - -**`memberof`** IgnoreWaitRequestDto - -#### Defined in - -[generated-client/models/ignore-wait-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ignore-wait-request-dto.ts#L28) diff --git a/docs/interfaces/generated_client.ImageApiDeleteItemImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiDeleteItemImageByIndexRequest.md deleted file mode 100644 index 8e97dab06..000000000 --- a/docs/interfaces/generated_client.ImageApiDeleteItemImageByIndexRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiDeleteItemImageByIndexRequest - -# Interface: ImageApiDeleteItemImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiDeleteItemImageByIndexRequest - -Request parameters for deleteItemImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiDeleteItemImageByIndexRequest - -## Table of contents - -### Properties - -- [imageIndex](generated_client.ImageApiDeleteItemImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiDeleteItemImageByIndexRequest.md#imagetype) -- [itemId](generated_client.ImageApiDeleteItemImageByIndexRequest.md#itemid) - -## Properties - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -The image index. - -**`memberof`** ImageApiDeleteItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6086](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6086) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiDeleteItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6079](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6079) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ImageApiDeleteItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6072](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6072) diff --git a/docs/interfaces/generated_client.ImageApiDeleteItemImageRequest.md b/docs/interfaces/generated_client.ImageApiDeleteItemImageRequest.md deleted file mode 100644 index a191b317c..000000000 --- a/docs/interfaces/generated_client.ImageApiDeleteItemImageRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiDeleteItemImageRequest - -# Interface: ImageApiDeleteItemImageRequest - -[generated-client](../modules/generated_client.md).ImageApiDeleteItemImageRequest - -Request parameters for deleteItemImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiDeleteItemImageRequest - -## Table of contents - -### Properties - -- [imageIndex](generated_client.ImageApiDeleteItemImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiDeleteItemImageRequest.md#imagetype) -- [itemId](generated_client.ImageApiDeleteItemImageRequest.md#itemid) - -## Properties - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -The image index. - -**`memberof`** ImageApiDeleteItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6058](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6058) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiDeleteItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6051](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6051) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ImageApiDeleteItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6044](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6044) diff --git a/docs/interfaces/generated_client.ImageApiDeleteUserImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiDeleteUserImageByIndexRequest.md deleted file mode 100644 index 9d6e9db07..000000000 --- a/docs/interfaces/generated_client.ImageApiDeleteUserImageByIndexRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiDeleteUserImageByIndexRequest - -# Interface: ImageApiDeleteUserImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiDeleteUserImageByIndexRequest - -Request parameters for deleteUserImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiDeleteUserImageByIndexRequest - -## Table of contents - -### Properties - -- [imageType](generated_client.ImageApiDeleteUserImageByIndexRequest.md#imagetype) -- [index](generated_client.ImageApiDeleteUserImageByIndexRequest.md#index) -- [userId](generated_client.ImageApiDeleteUserImageByIndexRequest.md#userid) - -## Properties - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -(Unused) Image type. - -**`memberof`** ImageApiDeleteUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6135](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6135) - -___ - -### index - -• `Readonly` **index**: `number` - -(Unused) Image index. - -**`memberof`** ImageApiDeleteUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6142](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6142) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User Id. - -**`memberof`** ImageApiDeleteUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6128](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6128) diff --git a/docs/interfaces/generated_client.ImageApiDeleteUserImageRequest.md b/docs/interfaces/generated_client.ImageApiDeleteUserImageRequest.md deleted file mode 100644 index 01e71c716..000000000 --- a/docs/interfaces/generated_client.ImageApiDeleteUserImageRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiDeleteUserImageRequest - -# Interface: ImageApiDeleteUserImageRequest - -[generated-client](../modules/generated_client.md).ImageApiDeleteUserImageRequest - -Request parameters for deleteUserImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiDeleteUserImageRequest - -## Table of contents - -### Properties - -- [imageType](generated_client.ImageApiDeleteUserImageRequest.md#imagetype) -- [index](generated_client.ImageApiDeleteUserImageRequest.md#index) -- [userId](generated_client.ImageApiDeleteUserImageRequest.md#userid) - -## Properties - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -(Unused) Image type. - -**`memberof`** ImageApiDeleteUserImage - -#### Defined in - -[generated-client/api/image-api.ts:6107](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6107) - -___ - -### index - -• `Optional` `Readonly` **index**: `number` - -(Unused) Image index. - -**`memberof`** ImageApiDeleteUserImage - -#### Defined in - -[generated-client/api/image-api.ts:6114](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6114) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User Id. - -**`memberof`** ImageApiDeleteUserImage - -#### Defined in - -[generated-client/api/image-api.ts:6100](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6100) diff --git a/docs/interfaces/generated_client.ImageApiGetArtistImageRequest.md b/docs/interfaces/generated_client.ImageApiGetArtistImageRequest.md deleted file mode 100644 index 2c81c39d4..000000000 --- a/docs/interfaces/generated_client.ImageApiGetArtistImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetArtistImageRequest - -# Interface: ImageApiGetArtistImageRequest - -[generated-client](../modules/generated_client.md).ImageApiGetArtistImageRequest - -Request parameters for getArtistImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetArtistImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetArtistImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetArtistImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetArtistImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetArtistImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetArtistImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetArtistImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetArtistImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetArtistImageRequest.md#format) -- [height](generated_client.ImageApiGetArtistImageRequest.md#height) -- [imageIndex](generated_client.ImageApiGetArtistImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetArtistImageRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiGetArtistImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetArtistImageRequest.md#maxwidth) -- [name](generated_client.ImageApiGetArtistImageRequest.md#name) -- [percentPlayed](generated_client.ImageApiGetArtistImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetArtistImageRequest.md#quality) -- [tag](generated_client.ImageApiGetArtistImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetArtistImageRequest.md#unplayedcount) -- [width](generated_client.ImageApiGetArtistImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6261](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6261) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6275](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6275) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6268](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6268) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6254](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6254) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6247](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6247) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6240](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6240) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6282](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6282) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6184](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6184) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6226](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6226) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6170](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6170) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6163](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6163) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6198](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6198) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6191](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6191) - -___ - -### name - -• `Readonly` **name**: `string` - -Artist name. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6156](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6156) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6205](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6205) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6233](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6233) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6177](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6177) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6212](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6212) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:6219](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6219) diff --git a/docs/interfaces/generated_client.ImageApiGetGenreImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiGetGenreImageByIndexRequest.md deleted file mode 100644 index bdcba31dd..000000000 --- a/docs/interfaces/generated_client.ImageApiGetGenreImageByIndexRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetGenreImageByIndexRequest - -# Interface: ImageApiGetGenreImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiGetGenreImageByIndexRequest - -Request parameters for getGenreImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetGenreImageByIndexRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetGenreImageByIndexRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetGenreImageByIndexRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetGenreImageByIndexRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetGenreImageByIndexRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetGenreImageByIndexRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetGenreImageByIndexRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetGenreImageByIndexRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetGenreImageByIndexRequest.md#format) -- [height](generated_client.ImageApiGetGenreImageByIndexRequest.md#height) -- [imageIndex](generated_client.ImageApiGetGenreImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetGenreImageByIndexRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiGetGenreImageByIndexRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetGenreImageByIndexRequest.md#maxwidth) -- [name](generated_client.ImageApiGetGenreImageByIndexRequest.md#name) -- [percentPlayed](generated_client.ImageApiGetGenreImageByIndexRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetGenreImageByIndexRequest.md#quality) -- [tag](generated_client.ImageApiGetGenreImageByIndexRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetGenreImageByIndexRequest.md#unplayedcount) -- [width](generated_client.ImageApiGetGenreImageByIndexRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6541](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6541) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6555](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6555) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6548](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6548) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6534](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6534) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6527](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6527) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6520](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6520) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6562](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6562) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6464](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6464) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6506](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6506) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6450](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6450) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6443](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6443) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6478](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6478) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6471](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6471) - -___ - -### name - -• `Readonly` **name**: `string` - -Genre name. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6436](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6436) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6485](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6485) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6513](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6513) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6457](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6457) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6492](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6492) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6499](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6499) diff --git a/docs/interfaces/generated_client.ImageApiGetGenreImageRequest.md b/docs/interfaces/generated_client.ImageApiGetGenreImageRequest.md deleted file mode 100644 index f0e671369..000000000 --- a/docs/interfaces/generated_client.ImageApiGetGenreImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetGenreImageRequest - -# Interface: ImageApiGetGenreImageRequest - -[generated-client](../modules/generated_client.md).ImageApiGetGenreImageRequest - -Request parameters for getGenreImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetGenreImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetGenreImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetGenreImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetGenreImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetGenreImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetGenreImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetGenreImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetGenreImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetGenreImageRequest.md#format) -- [height](generated_client.ImageApiGetGenreImageRequest.md#height) -- [imageIndex](generated_client.ImageApiGetGenreImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetGenreImageRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiGetGenreImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetGenreImageRequest.md#maxwidth) -- [name](generated_client.ImageApiGetGenreImageRequest.md#name) -- [percentPlayed](generated_client.ImageApiGetGenreImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetGenreImageRequest.md#quality) -- [tag](generated_client.ImageApiGetGenreImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetGenreImageRequest.md#unplayedcount) -- [width](generated_client.ImageApiGetGenreImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6394](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6394) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6408](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6408) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6401](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6401) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6387](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6387) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6380](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6380) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6373](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6373) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6415](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6415) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6317](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6317) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6359](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6359) - -___ - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6422](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6422) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6303](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6303) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6331](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6331) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6324](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6324) - -___ - -### name - -• `Readonly` **name**: `string` - -Genre name. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6296](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6296) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6338](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6338) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6366](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6366) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6310](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6310) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6345](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6345) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:6352](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6352) diff --git a/docs/interfaces/generated_client.ImageApiGetItemImage2Request.md b/docs/interfaces/generated_client.ImageApiGetItemImage2Request.md deleted file mode 100644 index 24854f765..000000000 --- a/docs/interfaces/generated_client.ImageApiGetItemImage2Request.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetItemImage2Request - -# Interface: ImageApiGetItemImage2Request - -[generated-client](../modules/generated_client.md).ImageApiGetItemImage2Request - -Request parameters for getItemImage2 operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetItemImage2Request - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetItemImage2Request.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetItemImage2Request.md#backgroundcolor) -- [blur](generated_client.ImageApiGetItemImage2Request.md#blur) -- [cropWhitespace](generated_client.ImageApiGetItemImage2Request.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetItemImage2Request.md#fillheight) -- [fillWidth](generated_client.ImageApiGetItemImage2Request.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetItemImage2Request.md#foregroundlayer) -- [format](generated_client.ImageApiGetItemImage2Request.md#format) -- [height](generated_client.ImageApiGetItemImage2Request.md#height) -- [imageIndex](generated_client.ImageApiGetItemImage2Request.md#imageindex) -- [imageType](generated_client.ImageApiGetItemImage2Request.md#imagetype) -- [itemId](generated_client.ImageApiGetItemImage2Request.md#itemid) -- [maxHeight](generated_client.ImageApiGetItemImage2Request.md#maxheight) -- [maxWidth](generated_client.ImageApiGetItemImage2Request.md#maxwidth) -- [percentPlayed](generated_client.ImageApiGetItemImage2Request.md#percentplayed) -- [quality](generated_client.ImageApiGetItemImage2Request.md#quality) -- [tag](generated_client.ImageApiGetItemImage2Request.md#tag) -- [unplayedCount](generated_client.ImageApiGetItemImage2Request.md#unplayedcount) -- [width](generated_client.ImageApiGetItemImage2Request.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6821](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6821) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6835](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6835) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6828](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6828) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6814](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6814) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6807](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6807) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6800](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6800) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6842](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6842) - -___ - -### format - -• `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6751](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6751) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6786](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6786) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6772](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6772) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6723](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6723) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6716](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6716) - -___ - -### maxHeight - -• `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6737](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6737) - -___ - -### maxWidth - -• `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6730](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6730) - -___ - -### percentPlayed - -• `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6758](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6758) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6793](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6793) - -___ - -### tag - -• `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6744](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6744) - -___ - -### unplayedCount - -• `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6765](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6765) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:6779](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6779) diff --git a/docs/interfaces/generated_client.ImageApiGetItemImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiGetItemImageByIndexRequest.md deleted file mode 100644 index fd02c59f0..000000000 --- a/docs/interfaces/generated_client.ImageApiGetItemImageByIndexRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetItemImageByIndexRequest - -# Interface: ImageApiGetItemImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiGetItemImageByIndexRequest - -Request parameters for getItemImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetItemImageByIndexRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetItemImageByIndexRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetItemImageByIndexRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetItemImageByIndexRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetItemImageByIndexRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetItemImageByIndexRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetItemImageByIndexRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetItemImageByIndexRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetItemImageByIndexRequest.md#format) -- [height](generated_client.ImageApiGetItemImageByIndexRequest.md#height) -- [imageIndex](generated_client.ImageApiGetItemImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetItemImageByIndexRequest.md#imagetype) -- [itemId](generated_client.ImageApiGetItemImageByIndexRequest.md#itemid) -- [maxHeight](generated_client.ImageApiGetItemImageByIndexRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetItemImageByIndexRequest.md#maxwidth) -- [percentPlayed](generated_client.ImageApiGetItemImageByIndexRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetItemImageByIndexRequest.md#quality) -- [tag](generated_client.ImageApiGetItemImageByIndexRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetItemImageByIndexRequest.md#unplayedcount) -- [width](generated_client.ImageApiGetItemImageByIndexRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6947](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6947) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6975](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6975) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6968](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6968) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6933](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6933) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6919](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6919) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6912](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6912) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6982](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6982) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6940](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6940) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6898](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6898) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6870](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6870) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6863](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6863) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6856](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6856) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6884](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6884) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6877](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6877) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6954](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6954) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6905](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6905) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6926](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6926) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6961](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6961) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:6891](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6891) diff --git a/docs/interfaces/generated_client.ImageApiGetItemImageInfosRequest.md b/docs/interfaces/generated_client.ImageApiGetItemImageInfosRequest.md deleted file mode 100644 index a23850d69..000000000 --- a/docs/interfaces/generated_client.ImageApiGetItemImageInfosRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetItemImageInfosRequest - -# Interface: ImageApiGetItemImageInfosRequest - -[generated-client](../modules/generated_client.md).ImageApiGetItemImageInfosRequest - -Request parameters for getItemImageInfos operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetItemImageInfosRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.ImageApiGetItemImageInfosRequest.md#itemid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ImageApiGetItemImageInfos - -#### Defined in - -[generated-client/api/image-api.ts:6996](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6996) diff --git a/docs/interfaces/generated_client.ImageApiGetItemImageRequest.md b/docs/interfaces/generated_client.ImageApiGetItemImageRequest.md deleted file mode 100644 index 06665a3c4..000000000 --- a/docs/interfaces/generated_client.ImageApiGetItemImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetItemImageRequest - -# Interface: ImageApiGetItemImageRequest - -[generated-client](../modules/generated_client.md).ImageApiGetItemImageRequest - -Request parameters for getItemImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetItemImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetItemImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetItemImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetItemImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetItemImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetItemImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetItemImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetItemImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetItemImageRequest.md#format) -- [height](generated_client.ImageApiGetItemImageRequest.md#height) -- [imageIndex](generated_client.ImageApiGetItemImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetItemImageRequest.md#imagetype) -- [itemId](generated_client.ImageApiGetItemImageRequest.md#itemid) -- [maxHeight](generated_client.ImageApiGetItemImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetItemImageRequest.md#maxwidth) -- [percentPlayed](generated_client.ImageApiGetItemImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetItemImageRequest.md#quality) -- [tag](generated_client.ImageApiGetItemImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetItemImageRequest.md#unplayedcount) -- [width](generated_client.ImageApiGetItemImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6660](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6660) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6688](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6688) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6681](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6681) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6646](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6646) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6632](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6632) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6625](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6625) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6695](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6695) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6653](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6653) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6611](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6611) - -___ - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6702](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6702) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6583](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6583) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6576](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6576) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6597](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6597) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6590](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6590) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6667](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6667) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6618](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6618) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6639](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6639) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6674](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6674) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:6604](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L6604) diff --git a/docs/interfaces/generated_client.ImageApiGetMusicGenreImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiGetMusicGenreImageByIndexRequest.md deleted file mode 100644 index 5cc880fcd..000000000 --- a/docs/interfaces/generated_client.ImageApiGetMusicGenreImageByIndexRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetMusicGenreImageByIndexRequest - -# Interface: ImageApiGetMusicGenreImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiGetMusicGenreImageByIndexRequest - -Request parameters for getMusicGenreImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetMusicGenreImageByIndexRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#format) -- [height](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#height) -- [imageIndex](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#maxwidth) -- [name](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#name) -- [percentPlayed](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#quality) -- [tag](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#unplayedcount) -- [width](generated_client.ImageApiGetMusicGenreImageByIndexRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7255](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7255) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7269](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7269) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7262](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7262) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7248](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7248) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7241](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7241) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7234](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7234) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7276](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7276) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7178](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7178) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7220](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7220) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7164](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7164) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7157](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7157) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7192](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7192) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7185](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7185) - -___ - -### name - -• `Readonly` **name**: `string` - -Music genre name. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7150](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7150) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7199](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7199) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7227](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7227) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7171](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7171) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7206](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7206) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7213](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7213) diff --git a/docs/interfaces/generated_client.ImageApiGetMusicGenreImageRequest.md b/docs/interfaces/generated_client.ImageApiGetMusicGenreImageRequest.md deleted file mode 100644 index b3e322ef9..000000000 --- a/docs/interfaces/generated_client.ImageApiGetMusicGenreImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetMusicGenreImageRequest - -# Interface: ImageApiGetMusicGenreImageRequest - -[generated-client](../modules/generated_client.md).ImageApiGetMusicGenreImageRequest - -Request parameters for getMusicGenreImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetMusicGenreImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetMusicGenreImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetMusicGenreImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetMusicGenreImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetMusicGenreImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetMusicGenreImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetMusicGenreImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetMusicGenreImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetMusicGenreImageRequest.md#format) -- [height](generated_client.ImageApiGetMusicGenreImageRequest.md#height) -- [imageIndex](generated_client.ImageApiGetMusicGenreImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetMusicGenreImageRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiGetMusicGenreImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetMusicGenreImageRequest.md#maxwidth) -- [name](generated_client.ImageApiGetMusicGenreImageRequest.md#name) -- [percentPlayed](generated_client.ImageApiGetMusicGenreImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetMusicGenreImageRequest.md#quality) -- [tag](generated_client.ImageApiGetMusicGenreImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetMusicGenreImageRequest.md#unplayedcount) -- [width](generated_client.ImageApiGetMusicGenreImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7108](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7108) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7122](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7122) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7115](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7115) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7101](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7101) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7094](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7094) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7087](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7087) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7129](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7129) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7031](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7031) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7073](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7073) - -___ - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7136](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7136) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7017](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7017) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7045](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7045) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7038](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7038) - -___ - -### name - -• `Readonly` **name**: `string` - -Music genre name. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7010](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7010) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7052](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7052) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7080](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7080) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7024](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7024) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7059](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7059) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:7066](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7066) diff --git a/docs/interfaces/generated_client.ImageApiGetPersonImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiGetPersonImageByIndexRequest.md deleted file mode 100644 index 4e15f5183..000000000 --- a/docs/interfaces/generated_client.ImageApiGetPersonImageByIndexRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetPersonImageByIndexRequest - -# Interface: ImageApiGetPersonImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiGetPersonImageByIndexRequest - -Request parameters for getPersonImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetPersonImageByIndexRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetPersonImageByIndexRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetPersonImageByIndexRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetPersonImageByIndexRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetPersonImageByIndexRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetPersonImageByIndexRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetPersonImageByIndexRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetPersonImageByIndexRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetPersonImageByIndexRequest.md#format) -- [height](generated_client.ImageApiGetPersonImageByIndexRequest.md#height) -- [imageIndex](generated_client.ImageApiGetPersonImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetPersonImageByIndexRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiGetPersonImageByIndexRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetPersonImageByIndexRequest.md#maxwidth) -- [name](generated_client.ImageApiGetPersonImageByIndexRequest.md#name) -- [percentPlayed](generated_client.ImageApiGetPersonImageByIndexRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetPersonImageByIndexRequest.md#quality) -- [tag](generated_client.ImageApiGetPersonImageByIndexRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetPersonImageByIndexRequest.md#unplayedcount) -- [width](generated_client.ImageApiGetPersonImageByIndexRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7535](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7535) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7549](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7549) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7542](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7542) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7528](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7528) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7521](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7521) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7514](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7514) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7556](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7556) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7458](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7458) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7500](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7500) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7444](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7444) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7437](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7437) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7472](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7472) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7465](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7465) - -___ - -### name - -• `Readonly` **name**: `string` - -Person name. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7430](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7430) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7479](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7479) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7507](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7507) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7451](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7451) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7486](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7486) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7493](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7493) diff --git a/docs/interfaces/generated_client.ImageApiGetPersonImageRequest.md b/docs/interfaces/generated_client.ImageApiGetPersonImageRequest.md deleted file mode 100644 index a5991a2e8..000000000 --- a/docs/interfaces/generated_client.ImageApiGetPersonImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetPersonImageRequest - -# Interface: ImageApiGetPersonImageRequest - -[generated-client](../modules/generated_client.md).ImageApiGetPersonImageRequest - -Request parameters for getPersonImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetPersonImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetPersonImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetPersonImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetPersonImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetPersonImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetPersonImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetPersonImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetPersonImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetPersonImageRequest.md#format) -- [height](generated_client.ImageApiGetPersonImageRequest.md#height) -- [imageIndex](generated_client.ImageApiGetPersonImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetPersonImageRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiGetPersonImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetPersonImageRequest.md#maxwidth) -- [name](generated_client.ImageApiGetPersonImageRequest.md#name) -- [percentPlayed](generated_client.ImageApiGetPersonImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetPersonImageRequest.md#quality) -- [tag](generated_client.ImageApiGetPersonImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetPersonImageRequest.md#unplayedcount) -- [width](generated_client.ImageApiGetPersonImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7388](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7388) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7402](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7402) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7395](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7395) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7381](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7381) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7374](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7374) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7367](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7367) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7409](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7409) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7311](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7311) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7353](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7353) - -___ - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7416](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7416) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7297](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7297) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7325](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7325) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7318](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7318) - -___ - -### name - -• `Readonly` **name**: `string` - -Person name. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7290](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7290) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7332](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7332) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7360](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7360) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7304](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7304) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7339](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7339) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:7346](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7346) diff --git a/docs/interfaces/generated_client.ImageApiGetSplashscreenRequest.md b/docs/interfaces/generated_client.ImageApiGetSplashscreenRequest.md deleted file mode 100644 index 8e134bc4f..000000000 --- a/docs/interfaces/generated_client.ImageApiGetSplashscreenRequest.md +++ /dev/null @@ -1,196 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetSplashscreenRequest - -# Interface: ImageApiGetSplashscreenRequest - -[generated-client](../modules/generated_client.md).ImageApiGetSplashscreenRequest - -Request parameters for getSplashscreen operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetSplashscreenRequest - -## Table of contents - -### Properties - -- [backgroundColor](generated_client.ImageApiGetSplashscreenRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetSplashscreenRequest.md#blur) -- [fillHeight](generated_client.ImageApiGetSplashscreenRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetSplashscreenRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetSplashscreenRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetSplashscreenRequest.md#format) -- [height](generated_client.ImageApiGetSplashscreenRequest.md#height) -- [maxHeight](generated_client.ImageApiGetSplashscreenRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetSplashscreenRequest.md#maxwidth) -- [quality](generated_client.ImageApiGetSplashscreenRequest.md#quality) -- [tag](generated_client.ImageApiGetSplashscreenRequest.md#tag) -- [width](generated_client.ImageApiGetSplashscreenRequest.md#width) - -## Properties - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Apply a background color for transparent images. - -**`memberof`** ImageApiGetSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:7633](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7633) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Blur image. - -**`memberof`** ImageApiGetSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:7626](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7626) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:7619](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7619) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:7612](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7612) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:7640](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7640) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:7577](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7577) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:7605](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7605) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:7591](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7591) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:7584](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7584) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Quality setting, from 0-100. - -**`memberof`** ImageApiGetSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:7647](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7647) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:7570](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7570) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:7598](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7598) diff --git a/docs/interfaces/generated_client.ImageApiGetStudioImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiGetStudioImageByIndexRequest.md deleted file mode 100644 index 659cc6e00..000000000 --- a/docs/interfaces/generated_client.ImageApiGetStudioImageByIndexRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetStudioImageByIndexRequest - -# Interface: ImageApiGetStudioImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiGetStudioImageByIndexRequest - -Request parameters for getStudioImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetStudioImageByIndexRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetStudioImageByIndexRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetStudioImageByIndexRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetStudioImageByIndexRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetStudioImageByIndexRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetStudioImageByIndexRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetStudioImageByIndexRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetStudioImageByIndexRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetStudioImageByIndexRequest.md#format) -- [height](generated_client.ImageApiGetStudioImageByIndexRequest.md#height) -- [imageIndex](generated_client.ImageApiGetStudioImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetStudioImageByIndexRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiGetStudioImageByIndexRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetStudioImageByIndexRequest.md#maxwidth) -- [name](generated_client.ImageApiGetStudioImageByIndexRequest.md#name) -- [percentPlayed](generated_client.ImageApiGetStudioImageByIndexRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetStudioImageByIndexRequest.md#quality) -- [tag](generated_client.ImageApiGetStudioImageByIndexRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetStudioImageByIndexRequest.md#unplayedcount) -- [width](generated_client.ImageApiGetStudioImageByIndexRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7906](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7906) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7920](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7920) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7913](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7913) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7899](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7899) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7892](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7892) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7885](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7885) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7927](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7927) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7829](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7829) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7871](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7871) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7815](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7815) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7808](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7808) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7843](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7843) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7836](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7836) - -___ - -### name - -• `Readonly` **name**: `string` - -Studio name. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7801](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7801) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7850](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7850) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7878](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7878) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7822](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7822) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7857](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7857) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:7864](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7864) diff --git a/docs/interfaces/generated_client.ImageApiGetStudioImageRequest.md b/docs/interfaces/generated_client.ImageApiGetStudioImageRequest.md deleted file mode 100644 index 5554f6e15..000000000 --- a/docs/interfaces/generated_client.ImageApiGetStudioImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetStudioImageRequest - -# Interface: ImageApiGetStudioImageRequest - -[generated-client](../modules/generated_client.md).ImageApiGetStudioImageRequest - -Request parameters for getStudioImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetStudioImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetStudioImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetStudioImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetStudioImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetStudioImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetStudioImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetStudioImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetStudioImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetStudioImageRequest.md#format) -- [height](generated_client.ImageApiGetStudioImageRequest.md#height) -- [imageIndex](generated_client.ImageApiGetStudioImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetStudioImageRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiGetStudioImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetStudioImageRequest.md#maxwidth) -- [name](generated_client.ImageApiGetStudioImageRequest.md#name) -- [percentPlayed](generated_client.ImageApiGetStudioImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetStudioImageRequest.md#quality) -- [tag](generated_client.ImageApiGetStudioImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetStudioImageRequest.md#unplayedcount) -- [width](generated_client.ImageApiGetStudioImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7759](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7759) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7773](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7773) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7766](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7766) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7752](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7752) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7745](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7745) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7738](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7738) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7780](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7780) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7682](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7682) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7724](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7724) - -___ - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7787](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7787) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7668](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7668) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7696](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7696) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7689](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7689) - -___ - -### name - -• `Readonly` **name**: `string` - -Studio name. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7661](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7661) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7703](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7703) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7731](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7731) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7675](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7675) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7710](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7710) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:7717](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7717) diff --git a/docs/interfaces/generated_client.ImageApiGetUserImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiGetUserImageByIndexRequest.md deleted file mode 100644 index 6da9a6680..000000000 --- a/docs/interfaces/generated_client.ImageApiGetUserImageByIndexRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetUserImageByIndexRequest - -# Interface: ImageApiGetUserImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiGetUserImageByIndexRequest - -Request parameters for getUserImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetUserImageByIndexRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetUserImageByIndexRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetUserImageByIndexRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetUserImageByIndexRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetUserImageByIndexRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetUserImageByIndexRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetUserImageByIndexRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetUserImageByIndexRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetUserImageByIndexRequest.md#format) -- [height](generated_client.ImageApiGetUserImageByIndexRequest.md#height) -- [imageIndex](generated_client.ImageApiGetUserImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetUserImageByIndexRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiGetUserImageByIndexRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetUserImageByIndexRequest.md#maxwidth) -- [percentPlayed](generated_client.ImageApiGetUserImageByIndexRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetUserImageByIndexRequest.md#quality) -- [tag](generated_client.ImageApiGetUserImageByIndexRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetUserImageByIndexRequest.md#unplayedcount) -- [userId](generated_client.ImageApiGetUserImageByIndexRequest.md#userid) -- [width](generated_client.ImageApiGetUserImageByIndexRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8186](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8186) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8200](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8200) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8193](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8193) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8179](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8179) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8172](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8172) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8165](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8165) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8207](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8207) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8109](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8109) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8151](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8151) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8095](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8095) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8088](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8088) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8123](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8123) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8116](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8116) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8130](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8130) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8158](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8158) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8102](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8102) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8137](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8137) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8081](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8081) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8144](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8144) diff --git a/docs/interfaces/generated_client.ImageApiGetUserImageRequest.md b/docs/interfaces/generated_client.ImageApiGetUserImageRequest.md deleted file mode 100644 index bc63f9dd7..000000000 --- a/docs/interfaces/generated_client.ImageApiGetUserImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiGetUserImageRequest - -# Interface: ImageApiGetUserImageRequest - -[generated-client](../modules/generated_client.md).ImageApiGetUserImageRequest - -Request parameters for getUserImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiGetUserImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiGetUserImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiGetUserImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiGetUserImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiGetUserImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiGetUserImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiGetUserImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiGetUserImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiGetUserImageRequest.md#format) -- [height](generated_client.ImageApiGetUserImageRequest.md#height) -- [imageIndex](generated_client.ImageApiGetUserImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiGetUserImageRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiGetUserImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiGetUserImageRequest.md#maxwidth) -- [percentPlayed](generated_client.ImageApiGetUserImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiGetUserImageRequest.md#quality) -- [tag](generated_client.ImageApiGetUserImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiGetUserImageRequest.md#unplayedcount) -- [userId](generated_client.ImageApiGetUserImageRequest.md#userid) -- [width](generated_client.ImageApiGetUserImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:8039](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8039) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:8053](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8053) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:8046](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8046) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:8032](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8032) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:8025](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8025) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:8018](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8018) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:8060](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8060) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:7962](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7962) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:8004](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8004) - -___ - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:8067](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8067) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:7948](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7948) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:7976](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7976) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:7969](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7969) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:7983](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7983) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:8011](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8011) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:7955](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7955) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:7990](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7990) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:7941](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7941) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiGetUserImage - -#### Defined in - -[generated-client/api/image-api.ts:7997](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L7997) diff --git a/docs/interfaces/generated_client.ImageApiHeadArtistImageRequest.md b/docs/interfaces/generated_client.ImageApiHeadArtistImageRequest.md deleted file mode 100644 index bdfd1debb..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadArtistImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadArtistImageRequest - -# Interface: ImageApiHeadArtistImageRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadArtistImageRequest - -Request parameters for headArtistImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadArtistImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadArtistImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadArtistImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadArtistImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadArtistImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadArtistImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadArtistImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadArtistImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadArtistImageRequest.md#format) -- [height](generated_client.ImageApiHeadArtistImageRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadArtistImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadArtistImageRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiHeadArtistImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadArtistImageRequest.md#maxwidth) -- [name](generated_client.ImageApiHeadArtistImageRequest.md#name) -- [percentPlayed](generated_client.ImageApiHeadArtistImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadArtistImageRequest.md#quality) -- [tag](generated_client.ImageApiHeadArtistImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadArtistImageRequest.md#unplayedcount) -- [width](generated_client.ImageApiHeadArtistImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8326](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8326) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8340](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8340) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8333](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8333) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8319](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8319) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8312](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8312) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8305](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8305) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8347](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8347) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8249](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8249) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8291](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8291) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8235](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8235) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8228](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8228) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8263](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8263) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8256](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8256) - -___ - -### name - -• `Readonly` **name**: `string` - -Artist name. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8221](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8221) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8270](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8270) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8298](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8298) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8242](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8242) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8277](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8277) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadArtistImage - -#### Defined in - -[generated-client/api/image-api.ts:8284](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8284) diff --git a/docs/interfaces/generated_client.ImageApiHeadGenreImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiHeadGenreImageByIndexRequest.md deleted file mode 100644 index 8bbb7f71b..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadGenreImageByIndexRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadGenreImageByIndexRequest - -# Interface: ImageApiHeadGenreImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadGenreImageByIndexRequest - -Request parameters for headGenreImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadGenreImageByIndexRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadGenreImageByIndexRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadGenreImageByIndexRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadGenreImageByIndexRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadGenreImageByIndexRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadGenreImageByIndexRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadGenreImageByIndexRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadGenreImageByIndexRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadGenreImageByIndexRequest.md#format) -- [height](generated_client.ImageApiHeadGenreImageByIndexRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadGenreImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadGenreImageByIndexRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiHeadGenreImageByIndexRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadGenreImageByIndexRequest.md#maxwidth) -- [name](generated_client.ImageApiHeadGenreImageByIndexRequest.md#name) -- [percentPlayed](generated_client.ImageApiHeadGenreImageByIndexRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadGenreImageByIndexRequest.md#quality) -- [tag](generated_client.ImageApiHeadGenreImageByIndexRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadGenreImageByIndexRequest.md#unplayedcount) -- [width](generated_client.ImageApiHeadGenreImageByIndexRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8606](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8606) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8620](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8620) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8613](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8613) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8599](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8599) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8592](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8592) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8585](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8585) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8627](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8627) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8529](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8529) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8571](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8571) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8515](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8515) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8508](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8508) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8543](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8543) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8536](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8536) - -___ - -### name - -• `Readonly` **name**: `string` - -Genre name. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8501](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8501) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8550](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8550) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8578](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8578) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8522](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8522) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8557](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8557) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8564](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8564) diff --git a/docs/interfaces/generated_client.ImageApiHeadGenreImageRequest.md b/docs/interfaces/generated_client.ImageApiHeadGenreImageRequest.md deleted file mode 100644 index 19fa6e054..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadGenreImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadGenreImageRequest - -# Interface: ImageApiHeadGenreImageRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadGenreImageRequest - -Request parameters for headGenreImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadGenreImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadGenreImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadGenreImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadGenreImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadGenreImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadGenreImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadGenreImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadGenreImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadGenreImageRequest.md#format) -- [height](generated_client.ImageApiHeadGenreImageRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadGenreImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadGenreImageRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiHeadGenreImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadGenreImageRequest.md#maxwidth) -- [name](generated_client.ImageApiHeadGenreImageRequest.md#name) -- [percentPlayed](generated_client.ImageApiHeadGenreImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadGenreImageRequest.md#quality) -- [tag](generated_client.ImageApiHeadGenreImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadGenreImageRequest.md#unplayedcount) -- [width](generated_client.ImageApiHeadGenreImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8459](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8459) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8473](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8473) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8466](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8466) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8452](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8452) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8445](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8445) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8438](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8438) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8480](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8480) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8382](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8382) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8424](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8424) - -___ - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8487](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8487) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8368](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8368) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8396](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8396) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8389](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8389) - -___ - -### name - -• `Readonly` **name**: `string` - -Genre name. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8361](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8361) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8403](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8403) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8431](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8431) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8375](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8375) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8410](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8410) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:8417](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8417) diff --git a/docs/interfaces/generated_client.ImageApiHeadItemImage2Request.md b/docs/interfaces/generated_client.ImageApiHeadItemImage2Request.md deleted file mode 100644 index 7a9ace1b4..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadItemImage2Request.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadItemImage2Request - -# Interface: ImageApiHeadItemImage2Request - -[generated-client](../modules/generated_client.md).ImageApiHeadItemImage2Request - -Request parameters for headItemImage2 operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadItemImage2Request - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadItemImage2Request.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadItemImage2Request.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadItemImage2Request.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadItemImage2Request.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadItemImage2Request.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadItemImage2Request.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadItemImage2Request.md#foregroundlayer) -- [format](generated_client.ImageApiHeadItemImage2Request.md#format) -- [height](generated_client.ImageApiHeadItemImage2Request.md#height) -- [imageIndex](generated_client.ImageApiHeadItemImage2Request.md#imageindex) -- [imageType](generated_client.ImageApiHeadItemImage2Request.md#imagetype) -- [itemId](generated_client.ImageApiHeadItemImage2Request.md#itemid) -- [maxHeight](generated_client.ImageApiHeadItemImage2Request.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadItemImage2Request.md#maxwidth) -- [percentPlayed](generated_client.ImageApiHeadItemImage2Request.md#percentplayed) -- [quality](generated_client.ImageApiHeadItemImage2Request.md#quality) -- [tag](generated_client.ImageApiHeadItemImage2Request.md#tag) -- [unplayedCount](generated_client.ImageApiHeadItemImage2Request.md#unplayedcount) -- [width](generated_client.ImageApiHeadItemImage2Request.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8886](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8886) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8900](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8900) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8893](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8893) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8879](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8879) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8872](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8872) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8865](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8865) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8907](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8907) - -___ - -### format - -• `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8816](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8816) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8851](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8851) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8837](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8837) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8788](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8788) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8781](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8781) - -___ - -### maxHeight - -• `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8802](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8802) - -___ - -### maxWidth - -• `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8795](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8795) - -___ - -### percentPlayed - -• `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8823](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8823) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8858](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8858) - -___ - -### tag - -• `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8809](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8809) - -___ - -### unplayedCount - -• `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8830](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8830) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadItemImage2 - -#### Defined in - -[generated-client/api/image-api.ts:8844](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8844) diff --git a/docs/interfaces/generated_client.ImageApiHeadItemImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiHeadItemImageByIndexRequest.md deleted file mode 100644 index 6df75ea53..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadItemImageByIndexRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadItemImageByIndexRequest - -# Interface: ImageApiHeadItemImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadItemImageByIndexRequest - -Request parameters for headItemImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadItemImageByIndexRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadItemImageByIndexRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadItemImageByIndexRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadItemImageByIndexRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadItemImageByIndexRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadItemImageByIndexRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadItemImageByIndexRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadItemImageByIndexRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadItemImageByIndexRequest.md#format) -- [height](generated_client.ImageApiHeadItemImageByIndexRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadItemImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadItemImageByIndexRequest.md#imagetype) -- [itemId](generated_client.ImageApiHeadItemImageByIndexRequest.md#itemid) -- [maxHeight](generated_client.ImageApiHeadItemImageByIndexRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadItemImageByIndexRequest.md#maxwidth) -- [percentPlayed](generated_client.ImageApiHeadItemImageByIndexRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadItemImageByIndexRequest.md#quality) -- [tag](generated_client.ImageApiHeadItemImageByIndexRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadItemImageByIndexRequest.md#unplayedcount) -- [width](generated_client.ImageApiHeadItemImageByIndexRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9012](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9012) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9040](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9040) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9033](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9033) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8998](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8998) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8984](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8984) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8977](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8977) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9047](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9047) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9005](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9005) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8963](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8963) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8935](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8935) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8928](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8928) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8921](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8921) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8949](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8949) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8942](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8942) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9019](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9019) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8970](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8970) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8991](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8991) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9026](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9026) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:8956](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8956) diff --git a/docs/interfaces/generated_client.ImageApiHeadItemImageRequest.md b/docs/interfaces/generated_client.ImageApiHeadItemImageRequest.md deleted file mode 100644 index a08c085e1..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadItemImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadItemImageRequest - -# Interface: ImageApiHeadItemImageRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadItemImageRequest - -Request parameters for headItemImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadItemImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadItemImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadItemImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadItemImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadItemImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadItemImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadItemImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadItemImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadItemImageRequest.md#format) -- [height](generated_client.ImageApiHeadItemImageRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadItemImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadItemImageRequest.md#imagetype) -- [itemId](generated_client.ImageApiHeadItemImageRequest.md#itemid) -- [maxHeight](generated_client.ImageApiHeadItemImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadItemImageRequest.md#maxwidth) -- [percentPlayed](generated_client.ImageApiHeadItemImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadItemImageRequest.md#quality) -- [tag](generated_client.ImageApiHeadItemImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadItemImageRequest.md#unplayedcount) -- [width](generated_client.ImageApiHeadItemImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8725](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8725) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8753](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8753) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8746](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8746) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8711](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8711) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8697](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8697) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8690](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8690) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8760](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8760) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8718](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8718) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8676](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8676) - -___ - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8767](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8767) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8648](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8648) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8641](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8641) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8662](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8662) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8655](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8655) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8732](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8732) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8683](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8683) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8704](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8704) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8739](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8739) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadItemImage - -#### Defined in - -[generated-client/api/image-api.ts:8669](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L8669) diff --git a/docs/interfaces/generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md deleted file mode 100644 index 262f88a59..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadMusicGenreImageByIndexRequest - -# Interface: ImageApiHeadMusicGenreImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadMusicGenreImageByIndexRequest - -Request parameters for headMusicGenreImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadMusicGenreImageByIndexRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#format) -- [height](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#maxwidth) -- [name](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#name) -- [percentPlayed](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#quality) -- [tag](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#unplayedcount) -- [width](generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9306](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9306) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9320](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9320) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9313](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9313) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9299](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9299) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9292](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9292) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9285](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9285) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9327](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9327) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9229](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9229) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9271](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9271) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9215](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9215) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9208](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9208) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9243](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9243) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9236](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9236) - -___ - -### name - -• `Readonly` **name**: `string` - -Music genre name. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9201](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9201) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9250](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9250) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9278](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9278) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9222](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9222) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9257](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9257) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadMusicGenreImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9264](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9264) diff --git a/docs/interfaces/generated_client.ImageApiHeadMusicGenreImageRequest.md b/docs/interfaces/generated_client.ImageApiHeadMusicGenreImageRequest.md deleted file mode 100644 index b3798e877..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadMusicGenreImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadMusicGenreImageRequest - -# Interface: ImageApiHeadMusicGenreImageRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadMusicGenreImageRequest - -Request parameters for headMusicGenreImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadMusicGenreImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadMusicGenreImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadMusicGenreImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadMusicGenreImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadMusicGenreImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadMusicGenreImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadMusicGenreImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadMusicGenreImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadMusicGenreImageRequest.md#format) -- [height](generated_client.ImageApiHeadMusicGenreImageRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadMusicGenreImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadMusicGenreImageRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiHeadMusicGenreImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadMusicGenreImageRequest.md#maxwidth) -- [name](generated_client.ImageApiHeadMusicGenreImageRequest.md#name) -- [percentPlayed](generated_client.ImageApiHeadMusicGenreImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadMusicGenreImageRequest.md#quality) -- [tag](generated_client.ImageApiHeadMusicGenreImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadMusicGenreImageRequest.md#unplayedcount) -- [width](generated_client.ImageApiHeadMusicGenreImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9159](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9159) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9173](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9173) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9166](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9166) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9152](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9152) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9145](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9145) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9138](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9138) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9180](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9180) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9082](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9082) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9124](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9124) - -___ - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9187](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9187) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9068](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9068) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9096](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9096) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9089](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9089) - -___ - -### name - -• `Readonly` **name**: `string` - -Music genre name. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9061](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9061) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9103](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9103) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9131](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9131) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9075](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9075) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9110](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9110) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadMusicGenreImage - -#### Defined in - -[generated-client/api/image-api.ts:9117](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9117) diff --git a/docs/interfaces/generated_client.ImageApiHeadPersonImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiHeadPersonImageByIndexRequest.md deleted file mode 100644 index 15b1958f3..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadPersonImageByIndexRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadPersonImageByIndexRequest - -# Interface: ImageApiHeadPersonImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadPersonImageByIndexRequest - -Request parameters for headPersonImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadPersonImageByIndexRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadPersonImageByIndexRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadPersonImageByIndexRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadPersonImageByIndexRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadPersonImageByIndexRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadPersonImageByIndexRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadPersonImageByIndexRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadPersonImageByIndexRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadPersonImageByIndexRequest.md#format) -- [height](generated_client.ImageApiHeadPersonImageByIndexRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadPersonImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadPersonImageByIndexRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiHeadPersonImageByIndexRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadPersonImageByIndexRequest.md#maxwidth) -- [name](generated_client.ImageApiHeadPersonImageByIndexRequest.md#name) -- [percentPlayed](generated_client.ImageApiHeadPersonImageByIndexRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadPersonImageByIndexRequest.md#quality) -- [tag](generated_client.ImageApiHeadPersonImageByIndexRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadPersonImageByIndexRequest.md#unplayedcount) -- [width](generated_client.ImageApiHeadPersonImageByIndexRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9586](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9586) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9600](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9600) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9593](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9593) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9579](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9579) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9572](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9572) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9565](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9565) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9607](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9607) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9509](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9509) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9551](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9551) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9495](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9495) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9488](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9488) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9523](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9523) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9516](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9516) - -___ - -### name - -• `Readonly` **name**: `string` - -Person name. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9481](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9481) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9530](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9530) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9558](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9558) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9502](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9502) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9537](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9537) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadPersonImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9544](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9544) diff --git a/docs/interfaces/generated_client.ImageApiHeadPersonImageRequest.md b/docs/interfaces/generated_client.ImageApiHeadPersonImageRequest.md deleted file mode 100644 index 1348451df..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadPersonImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadPersonImageRequest - -# Interface: ImageApiHeadPersonImageRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadPersonImageRequest - -Request parameters for headPersonImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadPersonImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadPersonImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadPersonImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadPersonImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadPersonImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadPersonImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadPersonImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadPersonImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadPersonImageRequest.md#format) -- [height](generated_client.ImageApiHeadPersonImageRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadPersonImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadPersonImageRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiHeadPersonImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadPersonImageRequest.md#maxwidth) -- [name](generated_client.ImageApiHeadPersonImageRequest.md#name) -- [percentPlayed](generated_client.ImageApiHeadPersonImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadPersonImageRequest.md#quality) -- [tag](generated_client.ImageApiHeadPersonImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadPersonImageRequest.md#unplayedcount) -- [width](generated_client.ImageApiHeadPersonImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9439](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9439) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9453](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9453) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9446](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9446) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9432](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9432) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9425](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9425) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9418](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9418) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9460](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9460) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9362](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9362) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9404](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9404) - -___ - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9467](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9467) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9348](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9348) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9376](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9376) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9369](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9369) - -___ - -### name - -• `Readonly` **name**: `string` - -Person name. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9341](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9341) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9383](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9383) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9411](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9411) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9355](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9355) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9390](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9390) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadPersonImage - -#### Defined in - -[generated-client/api/image-api.ts:9397](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9397) diff --git a/docs/interfaces/generated_client.ImageApiHeadStudioImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiHeadStudioImageByIndexRequest.md deleted file mode 100644 index 1e18d26f5..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadStudioImageByIndexRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadStudioImageByIndexRequest - -# Interface: ImageApiHeadStudioImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadStudioImageByIndexRequest - -Request parameters for headStudioImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadStudioImageByIndexRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadStudioImageByIndexRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadStudioImageByIndexRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadStudioImageByIndexRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadStudioImageByIndexRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadStudioImageByIndexRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadStudioImageByIndexRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadStudioImageByIndexRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadStudioImageByIndexRequest.md#format) -- [height](generated_client.ImageApiHeadStudioImageByIndexRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadStudioImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadStudioImageByIndexRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiHeadStudioImageByIndexRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadStudioImageByIndexRequest.md#maxwidth) -- [name](generated_client.ImageApiHeadStudioImageByIndexRequest.md#name) -- [percentPlayed](generated_client.ImageApiHeadStudioImageByIndexRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadStudioImageByIndexRequest.md#quality) -- [tag](generated_client.ImageApiHeadStudioImageByIndexRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadStudioImageByIndexRequest.md#unplayedcount) -- [width](generated_client.ImageApiHeadStudioImageByIndexRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9866](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9866) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9880](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9880) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9873](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9873) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9859](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9859) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9852](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9852) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9845](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9845) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9887](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9887) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9789](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9789) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9831](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9831) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9775](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9775) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9768](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9768) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9803](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9803) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9796](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9796) - -___ - -### name - -• `Readonly` **name**: `string` - -Studio name. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9761](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9761) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9810](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9810) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9838](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9838) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9782](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9782) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9817](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9817) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadStudioImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:9824](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9824) diff --git a/docs/interfaces/generated_client.ImageApiHeadStudioImageRequest.md b/docs/interfaces/generated_client.ImageApiHeadStudioImageRequest.md deleted file mode 100644 index 0c7e2fc72..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadStudioImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadStudioImageRequest - -# Interface: ImageApiHeadStudioImageRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadStudioImageRequest - -Request parameters for headStudioImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadStudioImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadStudioImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadStudioImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadStudioImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadStudioImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadStudioImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadStudioImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadStudioImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadStudioImageRequest.md#format) -- [height](generated_client.ImageApiHeadStudioImageRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadStudioImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadStudioImageRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiHeadStudioImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadStudioImageRequest.md#maxwidth) -- [name](generated_client.ImageApiHeadStudioImageRequest.md#name) -- [percentPlayed](generated_client.ImageApiHeadStudioImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadStudioImageRequest.md#quality) -- [tag](generated_client.ImageApiHeadStudioImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadStudioImageRequest.md#unplayedcount) -- [width](generated_client.ImageApiHeadStudioImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9719](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9719) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9733](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9733) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9726](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9726) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9712](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9712) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9705](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9705) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9698](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9698) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9740](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9740) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9642](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9642) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9684](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9684) - -___ - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9747](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9747) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9628](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9628) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9656](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9656) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9649](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9649) - -___ - -### name - -• `Readonly` **name**: `string` - -Studio name. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9621](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9621) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9663](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9663) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9691](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9691) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9635](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9635) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9670](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9670) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadStudioImage - -#### Defined in - -[generated-client/api/image-api.ts:9677](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9677) diff --git a/docs/interfaces/generated_client.ImageApiHeadUserImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiHeadUserImageByIndexRequest.md deleted file mode 100644 index e65fb88c5..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadUserImageByIndexRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadUserImageByIndexRequest - -# Interface: ImageApiHeadUserImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadUserImageByIndexRequest - -Request parameters for headUserImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadUserImageByIndexRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadUserImageByIndexRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadUserImageByIndexRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadUserImageByIndexRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadUserImageByIndexRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadUserImageByIndexRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadUserImageByIndexRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadUserImageByIndexRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadUserImageByIndexRequest.md#format) -- [height](generated_client.ImageApiHeadUserImageByIndexRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadUserImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadUserImageByIndexRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiHeadUserImageByIndexRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadUserImageByIndexRequest.md#maxwidth) -- [percentPlayed](generated_client.ImageApiHeadUserImageByIndexRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadUserImageByIndexRequest.md#quality) -- [tag](generated_client.ImageApiHeadUserImageByIndexRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadUserImageByIndexRequest.md#unplayedcount) -- [userId](generated_client.ImageApiHeadUserImageByIndexRequest.md#userid) -- [width](generated_client.ImageApiHeadUserImageByIndexRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10146](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10146) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10160](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10160) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10153](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10153) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10139](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10139) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10132](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10132) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10125](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10125) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10167](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10167) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10069](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10069) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10111](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10111) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10055](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10055) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10048](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10048) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10083](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10083) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10076](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10076) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10090](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10090) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10118](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10118) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10062](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10062) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10097](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10097) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10041](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10041) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10104](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10104) diff --git a/docs/interfaces/generated_client.ImageApiHeadUserImageRequest.md b/docs/interfaces/generated_client.ImageApiHeadUserImageRequest.md deleted file mode 100644 index a68f633a0..000000000 --- a/docs/interfaces/generated_client.ImageApiHeadUserImageRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiHeadUserImageRequest - -# Interface: ImageApiHeadUserImageRequest - -[generated-client](../modules/generated_client.md).ImageApiHeadUserImageRequest - -Request parameters for headUserImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiHeadUserImageRequest - -## Table of contents - -### Properties - -- [addPlayedIndicator](generated_client.ImageApiHeadUserImageRequest.md#addplayedindicator) -- [backgroundColor](generated_client.ImageApiHeadUserImageRequest.md#backgroundcolor) -- [blur](generated_client.ImageApiHeadUserImageRequest.md#blur) -- [cropWhitespace](generated_client.ImageApiHeadUserImageRequest.md#cropwhitespace) -- [fillHeight](generated_client.ImageApiHeadUserImageRequest.md#fillheight) -- [fillWidth](generated_client.ImageApiHeadUserImageRequest.md#fillwidth) -- [foregroundLayer](generated_client.ImageApiHeadUserImageRequest.md#foregroundlayer) -- [format](generated_client.ImageApiHeadUserImageRequest.md#format) -- [height](generated_client.ImageApiHeadUserImageRequest.md#height) -- [imageIndex](generated_client.ImageApiHeadUserImageRequest.md#imageindex) -- [imageType](generated_client.ImageApiHeadUserImageRequest.md#imagetype) -- [maxHeight](generated_client.ImageApiHeadUserImageRequest.md#maxheight) -- [maxWidth](generated_client.ImageApiHeadUserImageRequest.md#maxwidth) -- [percentPlayed](generated_client.ImageApiHeadUserImageRequest.md#percentplayed) -- [quality](generated_client.ImageApiHeadUserImageRequest.md#quality) -- [tag](generated_client.ImageApiHeadUserImageRequest.md#tag) -- [unplayedCount](generated_client.ImageApiHeadUserImageRequest.md#unplayedcount) -- [userId](generated_client.ImageApiHeadUserImageRequest.md#userid) -- [width](generated_client.ImageApiHeadUserImageRequest.md#width) - -## Properties - -### addPlayedIndicator - -• `Optional` `Readonly` **addPlayedIndicator**: `boolean` - -Optional. Add a played indicator. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9999](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9999) - -___ - -### backgroundColor - -• `Optional` `Readonly` **backgroundColor**: `string` - -Optional. Apply a background color for transparent images. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:10013](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10013) - -___ - -### blur - -• `Optional` `Readonly` **blur**: `number` - -Optional. Blur image. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:10006](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10006) - -___ - -### cropWhitespace - -• `Optional` `Readonly` **cropWhitespace**: `boolean` - -Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9992](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9992) - -___ - -### fillHeight - -• `Optional` `Readonly` **fillHeight**: `number` - -Height of box to fill. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9985](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9985) - -___ - -### fillWidth - -• `Optional` `Readonly` **fillWidth**: `number` - -Width of box to fill. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9978](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9978) - -___ - -### foregroundLayer - -• `Optional` `Readonly` **foregroundLayer**: `string` - -Optional. Apply a foreground layer on top of the image. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:10020](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10020) - -___ - -### format - -• `Optional` `Readonly` **format**: [`ImageFormat`](../enums/generated_client.ImageFormat.md) - -Determines the output format of the image - original,gif,jpg,png. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9922](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9922) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -The fixed image height to return. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9964](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9964) - -___ - -### imageIndex - -• `Optional` `Readonly` **imageIndex**: `number` - -Image index. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:10027](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10027) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9908](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9908) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -The maximum image height to return. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9936](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9936) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -The maximum image width to return. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9929](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9929) - -___ - -### percentPlayed - -• `Optional` `Readonly` **percentPlayed**: `number` - -Optional. Percent to render for the percent played overlay. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9943](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9943) - -___ - -### quality - -• `Optional` `Readonly` **quality**: `number` - -Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9971](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9971) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -Optional. Supply the cache tag from the item object to receive strong caching headers. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9915](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9915) - -___ - -### unplayedCount - -• `Optional` `Readonly` **unplayedCount**: `number` - -Optional. Unplayed count overlay to render. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9950](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9950) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9901](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9901) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -The fixed image width to return. - -**`memberof`** ImageApiHeadUserImage - -#### Defined in - -[generated-client/api/image-api.ts:9957](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L9957) diff --git a/docs/interfaces/generated_client.ImageApiPostUserImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiPostUserImageByIndexRequest.md deleted file mode 100644 index 98a035189..000000000 --- a/docs/interfaces/generated_client.ImageApiPostUserImageByIndexRequest.md +++ /dev/null @@ -1,74 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiPostUserImageByIndexRequest - -# Interface: ImageApiPostUserImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiPostUserImageByIndexRequest - -Request parameters for postUserImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiPostUserImageByIndexRequest - -## Table of contents - -### Properties - -- [body](generated_client.ImageApiPostUserImageByIndexRequest.md#body) -- [imageType](generated_client.ImageApiPostUserImageByIndexRequest.md#imagetype) -- [index](generated_client.ImageApiPostUserImageByIndexRequest.md#index) -- [userId](generated_client.ImageApiPostUserImageByIndexRequest.md#userid) - -## Properties - -### body - -• `Optional` `Readonly` **body**: `any` - -**`memberof`** ImageApiPostUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10237](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10237) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -(Unused) Image type. - -**`memberof`** ImageApiPostUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10223](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10223) - -___ - -### index - -• `Readonly` **index**: `number` - -(Unused) Image index. - -**`memberof`** ImageApiPostUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10230](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10230) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User Id. - -**`memberof`** ImageApiPostUserImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10216](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10216) diff --git a/docs/interfaces/generated_client.ImageApiPostUserImageRequest.md b/docs/interfaces/generated_client.ImageApiPostUserImageRequest.md deleted file mode 100644 index b27ae230f..000000000 --- a/docs/interfaces/generated_client.ImageApiPostUserImageRequest.md +++ /dev/null @@ -1,74 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiPostUserImageRequest - -# Interface: ImageApiPostUserImageRequest - -[generated-client](../modules/generated_client.md).ImageApiPostUserImageRequest - -Request parameters for postUserImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiPostUserImageRequest - -## Table of contents - -### Properties - -- [body](generated_client.ImageApiPostUserImageRequest.md#body) -- [imageType](generated_client.ImageApiPostUserImageRequest.md#imagetype) -- [index](generated_client.ImageApiPostUserImageRequest.md#index) -- [userId](generated_client.ImageApiPostUserImageRequest.md#userid) - -## Properties - -### body - -• `Optional` `Readonly` **body**: `any` - -**`memberof`** ImageApiPostUserImage - -#### Defined in - -[generated-client/api/image-api.ts:10202](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10202) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -(Unused) Image type. - -**`memberof`** ImageApiPostUserImage - -#### Defined in - -[generated-client/api/image-api.ts:10188](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10188) - -___ - -### index - -• `Optional` `Readonly` **index**: `number` - -(Unused) Image index. - -**`memberof`** ImageApiPostUserImage - -#### Defined in - -[generated-client/api/image-api.ts:10195](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10195) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User Id. - -**`memberof`** ImageApiPostUserImage - -#### Defined in - -[generated-client/api/image-api.ts:10181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10181) diff --git a/docs/interfaces/generated_client.ImageApiSetItemImageByIndexRequest.md b/docs/interfaces/generated_client.ImageApiSetItemImageByIndexRequest.md deleted file mode 100644 index f067f9272..000000000 --- a/docs/interfaces/generated_client.ImageApiSetItemImageByIndexRequest.md +++ /dev/null @@ -1,74 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiSetItemImageByIndexRequest - -# Interface: ImageApiSetItemImageByIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiSetItemImageByIndexRequest - -Request parameters for setItemImageByIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiSetItemImageByIndexRequest - -## Table of contents - -### Properties - -- [body](generated_client.ImageApiSetItemImageByIndexRequest.md#body) -- [imageIndex](generated_client.ImageApiSetItemImageByIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiSetItemImageByIndexRequest.md#imagetype) -- [itemId](generated_client.ImageApiSetItemImageByIndexRequest.md#itemid) - -## Properties - -### body - -• `Optional` `Readonly` **body**: `any` - -**`memberof`** ImageApiSetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10300](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10300) - -___ - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -(Unused) Image index. - -**`memberof`** ImageApiSetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10293](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10293) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiSetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10286](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10286) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ImageApiSetItemImageByIndex - -#### Defined in - -[generated-client/api/image-api.ts:10279](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10279) diff --git a/docs/interfaces/generated_client.ImageApiSetItemImageRequest.md b/docs/interfaces/generated_client.ImageApiSetItemImageRequest.md deleted file mode 100644 index be35344bb..000000000 --- a/docs/interfaces/generated_client.ImageApiSetItemImageRequest.md +++ /dev/null @@ -1,59 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiSetItemImageRequest - -# Interface: ImageApiSetItemImageRequest - -[generated-client](../modules/generated_client.md).ImageApiSetItemImageRequest - -Request parameters for setItemImage operation in ImageApi. - -**`export`** - -**`interface`** ImageApiSetItemImageRequest - -## Table of contents - -### Properties - -- [body](generated_client.ImageApiSetItemImageRequest.md#body) -- [imageType](generated_client.ImageApiSetItemImageRequest.md#imagetype) -- [itemId](generated_client.ImageApiSetItemImageRequest.md#itemid) - -## Properties - -### body - -• `Optional` `Readonly` **body**: `any` - -**`memberof`** ImageApiSetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:10265](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10265) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiSetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:10258](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10258) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ImageApiSetItemImage - -#### Defined in - -[generated-client/api/image-api.ts:10251](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10251) diff --git a/docs/interfaces/generated_client.ImageApiUpdateItemImageIndexRequest.md b/docs/interfaces/generated_client.ImageApiUpdateItemImageIndexRequest.md deleted file mode 100644 index 586d9dcfe..000000000 --- a/docs/interfaces/generated_client.ImageApiUpdateItemImageIndexRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiUpdateItemImageIndexRequest - -# Interface: ImageApiUpdateItemImageIndexRequest - -[generated-client](../modules/generated_client.md).ImageApiUpdateItemImageIndexRequest - -Request parameters for updateItemImageIndex operation in ImageApi. - -**`export`** - -**`interface`** ImageApiUpdateItemImageIndexRequest - -## Table of contents - -### Properties - -- [imageIndex](generated_client.ImageApiUpdateItemImageIndexRequest.md#imageindex) -- [imageType](generated_client.ImageApiUpdateItemImageIndexRequest.md#imagetype) -- [itemId](generated_client.ImageApiUpdateItemImageIndexRequest.md#itemid) -- [newIndex](generated_client.ImageApiUpdateItemImageIndexRequest.md#newindex) - -## Properties - -### imageIndex - -• `Readonly` **imageIndex**: `number` - -Old image index. - -**`memberof`** ImageApiUpdateItemImageIndex - -#### Defined in - -[generated-client/api/image-api.ts:10328](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10328) - -___ - -### imageType - -• `Readonly` **imageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -Image type. - -**`memberof`** ImageApiUpdateItemImageIndex - -#### Defined in - -[generated-client/api/image-api.ts:10321](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10321) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ImageApiUpdateItemImageIndex - -#### Defined in - -[generated-client/api/image-api.ts:10314](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10314) - -___ - -### newIndex - -• `Readonly` **newIndex**: `number` - -New image index. - -**`memberof`** ImageApiUpdateItemImageIndex - -#### Defined in - -[generated-client/api/image-api.ts:10335](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10335) diff --git a/docs/interfaces/generated_client.ImageApiUploadCustomSplashscreenRequest.md b/docs/interfaces/generated_client.ImageApiUploadCustomSplashscreenRequest.md deleted file mode 100644 index 72bcfe94f..000000000 --- a/docs/interfaces/generated_client.ImageApiUploadCustomSplashscreenRequest.md +++ /dev/null @@ -1,29 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageApiUploadCustomSplashscreenRequest - -# Interface: ImageApiUploadCustomSplashscreenRequest - -[generated-client](../modules/generated_client.md).ImageApiUploadCustomSplashscreenRequest - -Request parameters for uploadCustomSplashscreen operation in ImageApi. - -**`export`** - -**`interface`** ImageApiUploadCustomSplashscreenRequest - -## Table of contents - -### Properties - -- [body](generated_client.ImageApiUploadCustomSplashscreenRequest.md#body) - -## Properties - -### body - -• `Optional` `Readonly` **body**: `any` - -**`memberof`** ImageApiUploadCustomSplashscreen - -#### Defined in - -[generated-client/api/image-api.ts:10349](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L10349) diff --git a/docs/interfaces/generated_client.ImageByNameApiGetGeneralImageRequest.md b/docs/interfaces/generated_client.ImageByNameApiGetGeneralImageRequest.md deleted file mode 100644 index 14e0fe8dc..000000000 --- a/docs/interfaces/generated_client.ImageByNameApiGetGeneralImageRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageByNameApiGetGeneralImageRequest - -# Interface: ImageByNameApiGetGeneralImageRequest - -[generated-client](../modules/generated_client.md).ImageByNameApiGetGeneralImageRequest - -Request parameters for getGeneralImage operation in ImageByNameApi. - -**`export`** - -**`interface`** ImageByNameApiGetGeneralImageRequest - -## Table of contents - -### Properties - -- [name](generated_client.ImageByNameApiGetGeneralImageRequest.md#name) -- [type](generated_client.ImageByNameApiGetGeneralImageRequest.md#type) - -## Properties - -### name - -• `Readonly` **name**: `string` - -The name of the image. - -**`memberof`** ImageByNameApiGetGeneralImage - -#### Defined in - -[generated-client/api/image-by-name-api.ts:406](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L406) - -___ - -### type - -• `Readonly` **type**: `string` - -Image Type (primary, backdrop, logo, etc). - -**`memberof`** ImageByNameApiGetGeneralImage - -#### Defined in - -[generated-client/api/image-by-name-api.ts:413](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L413) diff --git a/docs/interfaces/generated_client.ImageByNameApiGetMediaInfoImageRequest.md b/docs/interfaces/generated_client.ImageByNameApiGetMediaInfoImageRequest.md deleted file mode 100644 index 5fe853508..000000000 --- a/docs/interfaces/generated_client.ImageByNameApiGetMediaInfoImageRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageByNameApiGetMediaInfoImageRequest - -# Interface: ImageByNameApiGetMediaInfoImageRequest - -[generated-client](../modules/generated_client.md).ImageByNameApiGetMediaInfoImageRequest - -Request parameters for getMediaInfoImage operation in ImageByNameApi. - -**`export`** - -**`interface`** ImageByNameApiGetMediaInfoImageRequest - -## Table of contents - -### Properties - -- [name](generated_client.ImageByNameApiGetMediaInfoImageRequest.md#name) -- [theme](generated_client.ImageByNameApiGetMediaInfoImageRequest.md#theme) - -## Properties - -### name - -• `Readonly` **name**: `string` - -The name of the image. - -**`memberof`** ImageByNameApiGetMediaInfoImage - -#### Defined in - -[generated-client/api/image-by-name-api.ts:434](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L434) - -___ - -### theme - -• `Readonly` **theme**: `string` - -The theme to get the image from. - -**`memberof`** ImageByNameApiGetMediaInfoImage - -#### Defined in - -[generated-client/api/image-by-name-api.ts:427](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L427) diff --git a/docs/interfaces/generated_client.ImageByNameApiGetRatingImageRequest.md b/docs/interfaces/generated_client.ImageByNameApiGetRatingImageRequest.md deleted file mode 100644 index dc20e8453..000000000 --- a/docs/interfaces/generated_client.ImageByNameApiGetRatingImageRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageByNameApiGetRatingImageRequest - -# Interface: ImageByNameApiGetRatingImageRequest - -[generated-client](../modules/generated_client.md).ImageByNameApiGetRatingImageRequest - -Request parameters for getRatingImage operation in ImageByNameApi. - -**`export`** - -**`interface`** ImageByNameApiGetRatingImageRequest - -## Table of contents - -### Properties - -- [name](generated_client.ImageByNameApiGetRatingImageRequest.md#name) -- [theme](generated_client.ImageByNameApiGetRatingImageRequest.md#theme) - -## Properties - -### name - -• `Readonly` **name**: `string` - -The name of the image. - -**`memberof`** ImageByNameApiGetRatingImage - -#### Defined in - -[generated-client/api/image-by-name-api.ts:455](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L455) - -___ - -### theme - -• `Readonly` **theme**: `string` - -The theme to get the image from. - -**`memberof`** ImageByNameApiGetRatingImage - -#### Defined in - -[generated-client/api/image-by-name-api.ts:448](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L448) diff --git a/docs/interfaces/generated_client.ImageByNameInfo.md b/docs/interfaces/generated_client.ImageByNameInfo.md deleted file mode 100644 index 9988b5c98..000000000 --- a/docs/interfaces/generated_client.ImageByNameInfo.md +++ /dev/null @@ -1,89 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageByNameInfo - -# Interface: ImageByNameInfo - -[generated-client](../modules/generated_client.md).ImageByNameInfo - -**`export`** - -**`interface`** ImageByNameInfo - -## Table of contents - -### Properties - -- [Context](generated_client.ImageByNameInfo.md#context) -- [FileLength](generated_client.ImageByNameInfo.md#filelength) -- [Format](generated_client.ImageByNameInfo.md#format) -- [Name](generated_client.ImageByNameInfo.md#name) -- [Theme](generated_client.ImageByNameInfo.md#theme) - -## Properties - -### Context - -• `Optional` **Context**: ``null`` \| `string` - -Gets or sets the context. - -**`memberof`** ImageByNameInfo - -#### Defined in - -[generated-client/models/image-by-name-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-by-name-info.ts#L40) - -___ - -### FileLength - -• `Optional` **FileLength**: `number` - -Gets or sets the length of the file. - -**`memberof`** ImageByNameInfo - -#### Defined in - -[generated-client/models/image-by-name-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-by-name-info.ts#L46) - -___ - -### Format - -• `Optional` **Format**: ``null`` \| `string` - -Gets or sets the format. - -**`memberof`** ImageByNameInfo - -#### Defined in - -[generated-client/models/image-by-name-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-by-name-info.ts#L52) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** ImageByNameInfo - -#### Defined in - -[generated-client/models/image-by-name-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-by-name-info.ts#L28) - -___ - -### Theme - -• `Optional` **Theme**: ``null`` \| `string` - -Gets or sets the theme. - -**`memberof`** ImageByNameInfo - -#### Defined in - -[generated-client/models/image-by-name-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-by-name-info.ts#L34) diff --git a/docs/interfaces/generated_client.ImageInfo.md b/docs/interfaces/generated_client.ImageInfo.md deleted file mode 100644 index c5213310e..000000000 --- a/docs/interfaces/generated_client.ImageInfo.md +++ /dev/null @@ -1,134 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageInfo - -# Interface: ImageInfo - -[generated-client](../modules/generated_client.md).ImageInfo - -Class ImageInfo. - -**`export`** - -**`interface`** ImageInfo - -## Table of contents - -### Properties - -- [BlurHash](generated_client.ImageInfo.md#blurhash) -- [Height](generated_client.ImageInfo.md#height) -- [ImageIndex](generated_client.ImageInfo.md#imageindex) -- [ImageTag](generated_client.ImageInfo.md#imagetag) -- [ImageType](generated_client.ImageInfo.md#imagetype) -- [Path](generated_client.ImageInfo.md#path) -- [Size](generated_client.ImageInfo.md#size) -- [Width](generated_client.ImageInfo.md#width) - -## Properties - -### BlurHash - -• `Optional` **BlurHash**: ``null`` \| `string` - -Gets or sets the blurhash. - -**`memberof`** ImageInfo - -#### Defined in - -[generated-client/models/image-info.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-info.ts#L53) - -___ - -### Height - -• `Optional` **Height**: ``null`` \| `number` - -Gets or sets the height. - -**`memberof`** ImageInfo - -#### Defined in - -[generated-client/models/image-info.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-info.ts#L59) - -___ - -### ImageIndex - -• `Optional` **ImageIndex**: ``null`` \| `number` - -Gets or sets the index of the image. - -**`memberof`** ImageInfo - -#### Defined in - -[generated-client/models/image-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-info.ts#L35) - -___ - -### ImageTag - -• `Optional` **ImageTag**: ``null`` \| `string` - -Gets or sets the image tag. - -**`memberof`** ImageInfo - -#### Defined in - -[generated-client/models/image-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-info.ts#L41) - -___ - -### ImageType - -• `Optional` **ImageType**: [`ImageType`](../enums/generated_client.ImageType.md) - -**`memberof`** ImageInfo - -#### Defined in - -[generated-client/models/image-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-info.ts#L29) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** ImageInfo - -#### Defined in - -[generated-client/models/image-info.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-info.ts#L47) - -___ - -### Size - -• `Optional` **Size**: `number` - -Gets or sets the size. - -**`memberof`** ImageInfo - -#### Defined in - -[generated-client/models/image-info.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-info.ts#L71) - -___ - -### Width - -• `Optional` **Width**: ``null`` \| `number` - -Gets or sets the width. - -**`memberof`** ImageInfo - -#### Defined in - -[generated-client/models/image-info.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-info.ts#L65) diff --git a/docs/interfaces/generated_client.ImageOption.md b/docs/interfaces/generated_client.ImageOption.md deleted file mode 100644 index 7437b053c..000000000 --- a/docs/interfaces/generated_client.ImageOption.md +++ /dev/null @@ -1,57 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageOption - -# Interface: ImageOption - -[generated-client](../modules/generated_client.md).ImageOption - -**`export`** - -**`interface`** ImageOption - -## Table of contents - -### Properties - -- [Limit](generated_client.ImageOption.md#limit) -- [MinWidth](generated_client.ImageOption.md#minwidth) -- [Type](generated_client.ImageOption.md#type) - -## Properties - -### Limit - -• `Optional` **Limit**: `number` - -Gets or sets the limit. - -**`memberof`** ImageOption - -#### Defined in - -[generated-client/models/image-option.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-option.ts#L35) - -___ - -### MinWidth - -• `Optional` **MinWidth**: `number` - -Gets or sets the minimum width. - -**`memberof`** ImageOption - -#### Defined in - -[generated-client/models/image-option.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-option.ts#L41) - -___ - -### Type - -• `Optional` **Type**: [`ImageType`](../enums/generated_client.ImageType.md) - -**`memberof`** ImageOption - -#### Defined in - -[generated-client/models/image-option.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-option.ts#L29) diff --git a/docs/interfaces/generated_client.ImageProviderInfo.md b/docs/interfaces/generated_client.ImageProviderInfo.md deleted file mode 100644 index 6c3a5e648..000000000 --- a/docs/interfaces/generated_client.ImageProviderInfo.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageProviderInfo - -# Interface: ImageProviderInfo - -[generated-client](../modules/generated_client.md).ImageProviderInfo - -Class ImageProviderInfo. - -**`export`** - -**`interface`** ImageProviderInfo - -## Table of contents - -### Properties - -- [Name](generated_client.ImageProviderInfo.md#name) -- [SupportedImages](generated_client.ImageProviderInfo.md#supportedimages) - -## Properties - -### Name - -• `Optional` **Name**: `string` - -Gets the name. - -**`memberof`** ImageProviderInfo - -#### Defined in - -[generated-client/models/image-provider-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-provider-info.ts#L29) - -___ - -### SupportedImages - -• `Optional` **SupportedImages**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Gets the supported image types. - -**`memberof`** ImageProviderInfo - -#### Defined in - -[generated-client/models/image-provider-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/image-provider-info.ts#L35) diff --git a/docs/interfaces/generated_client.InstallationInfo.md b/docs/interfaces/generated_client.InstallationInfo.md deleted file mode 100644 index 54dac798c..000000000 --- a/docs/interfaces/generated_client.InstallationInfo.md +++ /dev/null @@ -1,119 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / InstallationInfo - -# Interface: InstallationInfo - -[generated-client](../modules/generated_client.md).InstallationInfo - -Class InstallationInfo. - -**`export`** - -**`interface`** InstallationInfo - -## Table of contents - -### Properties - -- [Changelog](generated_client.InstallationInfo.md#changelog) -- [Checksum](generated_client.InstallationInfo.md#checksum) -- [Guid](generated_client.InstallationInfo.md#guid) -- [Name](generated_client.InstallationInfo.md#name) -- [PackageInfo](generated_client.InstallationInfo.md#packageinfo) -- [SourceUrl](generated_client.InstallationInfo.md#sourceurl) -- [Version](generated_client.InstallationInfo.md#version) - -## Properties - -### Changelog - -• `Optional` **Changelog**: ``null`` \| `string` - -Gets or sets the changelog for this version. - -**`memberof`** InstallationInfo - -#### Defined in - -[generated-client/models/installation-info.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/installation-info.ts#L47) - -___ - -### Checksum - -• `Optional` **Checksum**: ``null`` \| `string` - -Gets or sets a checksum for the binary. - -**`memberof`** InstallationInfo - -#### Defined in - -[generated-client/models/installation-info.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/installation-info.ts#L59) - -___ - -### Guid - -• `Optional` **Guid**: `string` - -Gets or sets the Id. - -**`memberof`** InstallationInfo - -#### Defined in - -[generated-client/models/installation-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/installation-info.ts#L29) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** InstallationInfo - -#### Defined in - -[generated-client/models/installation-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/installation-info.ts#L35) - -___ - -### PackageInfo - -• `Optional` **PackageInfo**: [`PackageInfo`](generated_client.PackageInfo.md) - -**`memberof`** InstallationInfo - -#### Defined in - -[generated-client/models/installation-info.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/installation-info.ts#L65) - -___ - -### SourceUrl - -• `Optional` **SourceUrl**: ``null`` \| `string` - -Gets or sets the source URL. - -**`memberof`** InstallationInfo - -#### Defined in - -[generated-client/models/installation-info.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/installation-info.ts#L53) - -___ - -### Version - -• `Optional` **Version**: ``null`` \| `string` - -Gets or sets the version. - -**`memberof`** InstallationInfo - -#### Defined in - -[generated-client/models/installation-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/installation-info.ts#L41) diff --git a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md b/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md deleted file mode 100644 index 12a4ebb6a..000000000 --- a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md +++ /dev/null @@ -1,136 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / InstantMixApiGetInstantMixFromAlbumRequest - -# Interface: InstantMixApiGetInstantMixFromAlbumRequest - -[generated-client](../modules/generated_client.md).InstantMixApiGetInstantMixFromAlbumRequest - -Request parameters for getInstantMixFromAlbum operation in InstantMixApi. - -**`export`** - -**`interface`** InstantMixApiGetInstantMixFromAlbumRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md#enableimagetypes) -- [enableImages](generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md#enableimages) -- [enableUserData](generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md#enableuserdata) -- [fields](generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md#fields) -- [id](generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md#id) -- [imageTypeLimit](generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md#imagetypelimit) -- [limit](generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md#limit) -- [userId](generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** InstantMixApiGetInstantMixFromAlbum - -#### Defined in - -[generated-client/api/instant-mix-api.ts:983](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L983) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** InstantMixApiGetInstantMixFromAlbum - -#### Defined in - -[generated-client/api/instant-mix-api.ts:962](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L962) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** InstantMixApiGetInstantMixFromAlbum - -#### Defined in - -[generated-client/api/instant-mix-api.ts:969](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L969) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** InstantMixApiGetInstantMixFromAlbum - -#### Defined in - -[generated-client/api/instant-mix-api.ts:955](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L955) - -___ - -### id - -• `Readonly` **id**: `string` - -The item id. - -**`memberof`** InstantMixApiGetInstantMixFromAlbum - -#### Defined in - -[generated-client/api/instant-mix-api.ts:934](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L934) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** InstantMixApiGetInstantMixFromAlbum - -#### Defined in - -[generated-client/api/instant-mix-api.ts:976](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L976) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** InstantMixApiGetInstantMixFromAlbum - -#### Defined in - -[generated-client/api/instant-mix-api.ts:948](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L948) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** InstantMixApiGetInstantMixFromAlbum - -#### Defined in - -[generated-client/api/instant-mix-api.ts:941](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L941) diff --git a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromArtists2Request.md b/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromArtists2Request.md deleted file mode 100644 index 05e032c92..000000000 --- a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromArtists2Request.md +++ /dev/null @@ -1,136 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / InstantMixApiGetInstantMixFromArtists2Request - -# Interface: InstantMixApiGetInstantMixFromArtists2Request - -[generated-client](../modules/generated_client.md).InstantMixApiGetInstantMixFromArtists2Request - -Request parameters for getInstantMixFromArtists2 operation in InstantMixApi. - -**`export`** - -**`interface`** InstantMixApiGetInstantMixFromArtists2Request - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.InstantMixApiGetInstantMixFromArtists2Request.md#enableimagetypes) -- [enableImages](generated_client.InstantMixApiGetInstantMixFromArtists2Request.md#enableimages) -- [enableUserData](generated_client.InstantMixApiGetInstantMixFromArtists2Request.md#enableuserdata) -- [fields](generated_client.InstantMixApiGetInstantMixFromArtists2Request.md#fields) -- [id](generated_client.InstantMixApiGetInstantMixFromArtists2Request.md#id) -- [imageTypeLimit](generated_client.InstantMixApiGetInstantMixFromArtists2Request.md#imagetypelimit) -- [limit](generated_client.InstantMixApiGetInstantMixFromArtists2Request.md#limit) -- [userId](generated_client.InstantMixApiGetInstantMixFromArtists2Request.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** InstantMixApiGetInstantMixFromArtists2 - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1109](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1109) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** InstantMixApiGetInstantMixFromArtists2 - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1088](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1088) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** InstantMixApiGetInstantMixFromArtists2 - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1095](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1095) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** InstantMixApiGetInstantMixFromArtists2 - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1081](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1081) - -___ - -### id - -• `Readonly` **id**: `string` - -The item id. - -**`memberof`** InstantMixApiGetInstantMixFromArtists2 - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1060](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1060) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** InstantMixApiGetInstantMixFromArtists2 - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1102](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1102) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** InstantMixApiGetInstantMixFromArtists2 - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1074](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1074) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** InstantMixApiGetInstantMixFromArtists2 - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1067](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1067) diff --git a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md b/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md deleted file mode 100644 index fd9e8602d..000000000 --- a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md +++ /dev/null @@ -1,136 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / InstantMixApiGetInstantMixFromArtistsRequest - -# Interface: InstantMixApiGetInstantMixFromArtistsRequest - -[generated-client](../modules/generated_client.md).InstantMixApiGetInstantMixFromArtistsRequest - -Request parameters for getInstantMixFromArtists operation in InstantMixApi. - -**`export`** - -**`interface`** InstantMixApiGetInstantMixFromArtistsRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md#enableimagetypes) -- [enableImages](generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md#enableimages) -- [enableUserData](generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md#enableuserdata) -- [fields](generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md#fields) -- [id](generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md#id) -- [imageTypeLimit](generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md#imagetypelimit) -- [limit](generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md#limit) -- [userId](generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** InstantMixApiGetInstantMixFromArtists - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1046](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1046) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** InstantMixApiGetInstantMixFromArtists - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1025](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1025) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** InstantMixApiGetInstantMixFromArtists - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1032](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1032) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** InstantMixApiGetInstantMixFromArtists - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1018](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1018) - -___ - -### id - -• `Readonly` **id**: `string` - -The item id. - -**`memberof`** InstantMixApiGetInstantMixFromArtists - -#### Defined in - -[generated-client/api/instant-mix-api.ts:997](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L997) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** InstantMixApiGetInstantMixFromArtists - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1039](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1039) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** InstantMixApiGetInstantMixFromArtists - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1011](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1011) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** InstantMixApiGetInstantMixFromArtists - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1004](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1004) diff --git a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromItemRequest.md b/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromItemRequest.md deleted file mode 100644 index e895648cc..000000000 --- a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromItemRequest.md +++ /dev/null @@ -1,136 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / InstantMixApiGetInstantMixFromItemRequest - -# Interface: InstantMixApiGetInstantMixFromItemRequest - -[generated-client](../modules/generated_client.md).InstantMixApiGetInstantMixFromItemRequest - -Request parameters for getInstantMixFromItem operation in InstantMixApi. - -**`export`** - -**`interface`** InstantMixApiGetInstantMixFromItemRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.InstantMixApiGetInstantMixFromItemRequest.md#enableimagetypes) -- [enableImages](generated_client.InstantMixApiGetInstantMixFromItemRequest.md#enableimages) -- [enableUserData](generated_client.InstantMixApiGetInstantMixFromItemRequest.md#enableuserdata) -- [fields](generated_client.InstantMixApiGetInstantMixFromItemRequest.md#fields) -- [id](generated_client.InstantMixApiGetInstantMixFromItemRequest.md#id) -- [imageTypeLimit](generated_client.InstantMixApiGetInstantMixFromItemRequest.md#imagetypelimit) -- [limit](generated_client.InstantMixApiGetInstantMixFromItemRequest.md#limit) -- [userId](generated_client.InstantMixApiGetInstantMixFromItemRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** InstantMixApiGetInstantMixFromItem - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1172](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1172) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** InstantMixApiGetInstantMixFromItem - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1151](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1151) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** InstantMixApiGetInstantMixFromItem - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1158](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1158) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** InstantMixApiGetInstantMixFromItem - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1144](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1144) - -___ - -### id - -• `Readonly` **id**: `string` - -The item id. - -**`memberof`** InstantMixApiGetInstantMixFromItem - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1123](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1123) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** InstantMixApiGetInstantMixFromItem - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1165](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1165) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** InstantMixApiGetInstantMixFromItem - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1137](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1137) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** InstantMixApiGetInstantMixFromItem - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1130](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1130) diff --git a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md b/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md deleted file mode 100644 index 8fb1d30d9..000000000 --- a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md +++ /dev/null @@ -1,136 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / InstantMixApiGetInstantMixFromMusicGenreByIdRequest - -# Interface: InstantMixApiGetInstantMixFromMusicGenreByIdRequest - -[generated-client](../modules/generated_client.md).InstantMixApiGetInstantMixFromMusicGenreByIdRequest - -Request parameters for getInstantMixFromMusicGenreById operation in InstantMixApi. - -**`export`** - -**`interface`** InstantMixApiGetInstantMixFromMusicGenreByIdRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md#enableimagetypes) -- [enableImages](generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md#enableimages) -- [enableUserData](generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md#enableuserdata) -- [fields](generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md#fields) -- [id](generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md#id) -- [imageTypeLimit](generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md#imagetypelimit) -- [limit](generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md#limit) -- [userId](generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreById - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1235](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1235) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreById - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1214](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1214) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreById - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1221](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1221) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreById - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1207](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1207) - -___ - -### id - -• `Readonly` **id**: `string` - -The item id. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreById - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1186](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1186) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreById - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1228](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1228) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreById - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1200](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1200) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreById - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1193](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1193) diff --git a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md b/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md deleted file mode 100644 index f89f6f5bf..000000000 --- a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md +++ /dev/null @@ -1,136 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / InstantMixApiGetInstantMixFromMusicGenreByNameRequest - -# Interface: InstantMixApiGetInstantMixFromMusicGenreByNameRequest - -[generated-client](../modules/generated_client.md).InstantMixApiGetInstantMixFromMusicGenreByNameRequest - -Request parameters for getInstantMixFromMusicGenreByName operation in InstantMixApi. - -**`export`** - -**`interface`** InstantMixApiGetInstantMixFromMusicGenreByNameRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md#enableimagetypes) -- [enableImages](generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md#enableimages) -- [enableUserData](generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md#enableuserdata) -- [fields](generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md#fields) -- [imageTypeLimit](generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md#imagetypelimit) -- [limit](generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md#limit) -- [name](generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md#name) -- [userId](generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreByName - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1298](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1298) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreByName - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1277](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1277) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreByName - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1284](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1284) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreByName - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1270](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1270) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreByName - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1291](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1291) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreByName - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1263](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1263) - -___ - -### name - -• `Readonly` **name**: `string` - -The genre name. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreByName - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1249](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1249) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** InstantMixApiGetInstantMixFromMusicGenreByName - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1256](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1256) diff --git a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md b/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md deleted file mode 100644 index 5d1da6f42..000000000 --- a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md +++ /dev/null @@ -1,136 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / InstantMixApiGetInstantMixFromPlaylistRequest - -# Interface: InstantMixApiGetInstantMixFromPlaylistRequest - -[generated-client](../modules/generated_client.md).InstantMixApiGetInstantMixFromPlaylistRequest - -Request parameters for getInstantMixFromPlaylist operation in InstantMixApi. - -**`export`** - -**`interface`** InstantMixApiGetInstantMixFromPlaylistRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md#enableimagetypes) -- [enableImages](generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md#enableimages) -- [enableUserData](generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md#enableuserdata) -- [fields](generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md#fields) -- [id](generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md#id) -- [imageTypeLimit](generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md#imagetypelimit) -- [limit](generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md#limit) -- [userId](generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** InstantMixApiGetInstantMixFromPlaylist - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1361](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1361) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** InstantMixApiGetInstantMixFromPlaylist - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1340](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1340) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** InstantMixApiGetInstantMixFromPlaylist - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1347](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1347) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** InstantMixApiGetInstantMixFromPlaylist - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1333](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1333) - -___ - -### id - -• `Readonly` **id**: `string` - -The item id. - -**`memberof`** InstantMixApiGetInstantMixFromPlaylist - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1312](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1312) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** InstantMixApiGetInstantMixFromPlaylist - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1354](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1354) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** InstantMixApiGetInstantMixFromPlaylist - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1326](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1326) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** InstantMixApiGetInstantMixFromPlaylist - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1319](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1319) diff --git a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromSongRequest.md b/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromSongRequest.md deleted file mode 100644 index 8fad60111..000000000 --- a/docs/interfaces/generated_client.InstantMixApiGetInstantMixFromSongRequest.md +++ /dev/null @@ -1,136 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / InstantMixApiGetInstantMixFromSongRequest - -# Interface: InstantMixApiGetInstantMixFromSongRequest - -[generated-client](../modules/generated_client.md).InstantMixApiGetInstantMixFromSongRequest - -Request parameters for getInstantMixFromSong operation in InstantMixApi. - -**`export`** - -**`interface`** InstantMixApiGetInstantMixFromSongRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.InstantMixApiGetInstantMixFromSongRequest.md#enableimagetypes) -- [enableImages](generated_client.InstantMixApiGetInstantMixFromSongRequest.md#enableimages) -- [enableUserData](generated_client.InstantMixApiGetInstantMixFromSongRequest.md#enableuserdata) -- [fields](generated_client.InstantMixApiGetInstantMixFromSongRequest.md#fields) -- [id](generated_client.InstantMixApiGetInstantMixFromSongRequest.md#id) -- [imageTypeLimit](generated_client.InstantMixApiGetInstantMixFromSongRequest.md#imagetypelimit) -- [limit](generated_client.InstantMixApiGetInstantMixFromSongRequest.md#limit) -- [userId](generated_client.InstantMixApiGetInstantMixFromSongRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** InstantMixApiGetInstantMixFromSong - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1424](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1424) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** InstantMixApiGetInstantMixFromSong - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1403](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1403) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** InstantMixApiGetInstantMixFromSong - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1410](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1410) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** InstantMixApiGetInstantMixFromSong - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1396](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1396) - -___ - -### id - -• `Readonly` **id**: `string` - -The item id. - -**`memberof`** InstantMixApiGetInstantMixFromSong - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1375](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1375) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** InstantMixApiGetInstantMixFromSong - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1417](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1417) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** InstantMixApiGetInstantMixFromSong - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1389](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1389) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** InstantMixApiGetInstantMixFromSong - -#### Defined in - -[generated-client/api/instant-mix-api.ts:1382](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1382) diff --git a/docs/interfaces/generated_client.ItemCounts.md b/docs/interfaces/generated_client.ItemCounts.md deleted file mode 100644 index dc030a240..000000000 --- a/docs/interfaces/generated_client.ItemCounts.md +++ /dev/null @@ -1,196 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemCounts - -# Interface: ItemCounts - -[generated-client](../modules/generated_client.md).ItemCounts - -Class LibrarySummary. - -**`export`** - -**`interface`** ItemCounts - -## Table of contents - -### Properties - -- [AlbumCount](generated_client.ItemCounts.md#albumcount) -- [ArtistCount](generated_client.ItemCounts.md#artistcount) -- [BookCount](generated_client.ItemCounts.md#bookcount) -- [BoxSetCount](generated_client.ItemCounts.md#boxsetcount) -- [EpisodeCount](generated_client.ItemCounts.md#episodecount) -- [ItemCount](generated_client.ItemCounts.md#itemcount) -- [MovieCount](generated_client.ItemCounts.md#moviecount) -- [MusicVideoCount](generated_client.ItemCounts.md#musicvideocount) -- [ProgramCount](generated_client.ItemCounts.md#programcount) -- [SeriesCount](generated_client.ItemCounts.md#seriescount) -- [SongCount](generated_client.ItemCounts.md#songcount) -- [TrailerCount](generated_client.ItemCounts.md#trailercount) - -## Properties - -### AlbumCount - -• `Optional` **AlbumCount**: `number` - -Gets or sets the album count. - -**`memberof`** ItemCounts - -#### Defined in - -[generated-client/models/item-counts.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-counts.ts#L70) - -___ - -### ArtistCount - -• `Optional` **ArtistCount**: `number` - -Gets or sets the artist count. - -**`memberof`** ItemCounts - -#### Defined in - -[generated-client/models/item-counts.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-counts.ts#L46) - -___ - -### BookCount - -• `Optional` **BookCount**: `number` - -Gets or sets the book count. - -**`memberof`** ItemCounts - -#### Defined in - -[generated-client/models/item-counts.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-counts.ts#L88) - -___ - -### BoxSetCount - -• `Optional` **BoxSetCount**: `number` - -Gets or sets the box set count. - -**`memberof`** ItemCounts - -#### Defined in - -[generated-client/models/item-counts.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-counts.ts#L82) - -___ - -### EpisodeCount - -• `Optional` **EpisodeCount**: `number` - -Gets or sets the episode count. - -**`memberof`** ItemCounts - -#### Defined in - -[generated-client/models/item-counts.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-counts.ts#L40) - -___ - -### ItemCount - -• `Optional` **ItemCount**: `number` - -Gets or sets the item count. - -**`memberof`** ItemCounts - -#### Defined in - -[generated-client/models/item-counts.ts:94](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-counts.ts#L94) - -___ - -### MovieCount - -• `Optional` **MovieCount**: `number` - -Gets or sets the movie count. - -**`memberof`** ItemCounts - -#### Defined in - -[generated-client/models/item-counts.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-counts.ts#L28) - -___ - -### MusicVideoCount - -• `Optional` **MusicVideoCount**: `number` - -Gets or sets the music video count. - -**`memberof`** ItemCounts - -#### Defined in - -[generated-client/models/item-counts.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-counts.ts#L76) - -___ - -### ProgramCount - -• `Optional` **ProgramCount**: `number` - -Gets or sets the program count. - -**`memberof`** ItemCounts - -#### Defined in - -[generated-client/models/item-counts.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-counts.ts#L52) - -___ - -### SeriesCount - -• `Optional` **SeriesCount**: `number` - -Gets or sets the series count. - -**`memberof`** ItemCounts - -#### Defined in - -[generated-client/models/item-counts.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-counts.ts#L34) - -___ - -### SongCount - -• `Optional` **SongCount**: `number` - -Gets or sets the song count. - -**`memberof`** ItemCounts - -#### Defined in - -[generated-client/models/item-counts.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-counts.ts#L64) - -___ - -### TrailerCount - -• `Optional` **TrailerCount**: `number` - -Gets or sets the trailer count. - -**`memberof`** ItemCounts - -#### Defined in - -[generated-client/models/item-counts.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/item-counts.ts#L58) diff --git a/docs/interfaces/generated_client.ItemLookupApiApplySearchCriteriaRequest.md b/docs/interfaces/generated_client.ItemLookupApiApplySearchCriteriaRequest.md deleted file mode 100644 index 1437aca0c..000000000 --- a/docs/interfaces/generated_client.ItemLookupApiApplySearchCriteriaRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApiApplySearchCriteriaRequest - -# Interface: ItemLookupApiApplySearchCriteriaRequest - -[generated-client](../modules/generated_client.md).ItemLookupApiApplySearchCriteriaRequest - -Request parameters for applySearchCriteria operation in ItemLookupApi. - -**`export`** - -**`interface`** ItemLookupApiApplySearchCriteriaRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.ItemLookupApiApplySearchCriteriaRequest.md#itemid) -- [remoteSearchResult](generated_client.ItemLookupApiApplySearchCriteriaRequest.md#remotesearchresult) -- [replaceAllImages](generated_client.ItemLookupApiApplySearchCriteriaRequest.md#replaceallimages) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ItemLookupApiApplySearchCriteria - -#### Defined in - -[generated-client/api/item-lookup-api.ts:758](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L758) - -___ - -### remoteSearchResult - -• `Readonly` **remoteSearchResult**: [`RemoteSearchResult`](generated_client.RemoteSearchResult.md) - -The remote search result. - -**`memberof`** ItemLookupApiApplySearchCriteria - -#### Defined in - -[generated-client/api/item-lookup-api.ts:765](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L765) - -___ - -### replaceAllImages - -• `Optional` `Readonly` **replaceAllImages**: `boolean` - -Optional. Whether or not to replace all images. Default: True. - -**`memberof`** ItemLookupApiApplySearchCriteria - -#### Defined in - -[generated-client/api/item-lookup-api.ts:772](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L772) diff --git a/docs/interfaces/generated_client.ItemLookupApiGetBookRemoteSearchResultsRequest.md b/docs/interfaces/generated_client.ItemLookupApiGetBookRemoteSearchResultsRequest.md deleted file mode 100644 index 61cf4583a..000000000 --- a/docs/interfaces/generated_client.ItemLookupApiGetBookRemoteSearchResultsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApiGetBookRemoteSearchResultsRequest - -# Interface: ItemLookupApiGetBookRemoteSearchResultsRequest - -[generated-client](../modules/generated_client.md).ItemLookupApiGetBookRemoteSearchResultsRequest - -Request parameters for getBookRemoteSearchResults operation in ItemLookupApi. - -**`export`** - -**`interface`** ItemLookupApiGetBookRemoteSearchResultsRequest - -## Table of contents - -### Properties - -- [bookInfoRemoteSearchQuery](generated_client.ItemLookupApiGetBookRemoteSearchResultsRequest.md#bookinforemotesearchquery) - -## Properties - -### bookInfoRemoteSearchQuery - -• `Readonly` **bookInfoRemoteSearchQuery**: [`BookInfoRemoteSearchQuery`](generated_client.BookInfoRemoteSearchQuery.md) - -Remote search query. - -**`memberof`** ItemLookupApiGetBookRemoteSearchResults - -#### Defined in - -[generated-client/api/item-lookup-api.ts:786](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L786) diff --git a/docs/interfaces/generated_client.ItemLookupApiGetBoxSetRemoteSearchResultsRequest.md b/docs/interfaces/generated_client.ItemLookupApiGetBoxSetRemoteSearchResultsRequest.md deleted file mode 100644 index da317ee0b..000000000 --- a/docs/interfaces/generated_client.ItemLookupApiGetBoxSetRemoteSearchResultsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApiGetBoxSetRemoteSearchResultsRequest - -# Interface: ItemLookupApiGetBoxSetRemoteSearchResultsRequest - -[generated-client](../modules/generated_client.md).ItemLookupApiGetBoxSetRemoteSearchResultsRequest - -Request parameters for getBoxSetRemoteSearchResults operation in ItemLookupApi. - -**`export`** - -**`interface`** ItemLookupApiGetBoxSetRemoteSearchResultsRequest - -## Table of contents - -### Properties - -- [boxSetInfoRemoteSearchQuery](generated_client.ItemLookupApiGetBoxSetRemoteSearchResultsRequest.md#boxsetinforemotesearchquery) - -## Properties - -### boxSetInfoRemoteSearchQuery - -• `Readonly` **boxSetInfoRemoteSearchQuery**: [`BoxSetInfoRemoteSearchQuery`](generated_client.BoxSetInfoRemoteSearchQuery.md) - -Remote search query. - -**`memberof`** ItemLookupApiGetBoxSetRemoteSearchResults - -#### Defined in - -[generated-client/api/item-lookup-api.ts:800](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L800) diff --git a/docs/interfaces/generated_client.ItemLookupApiGetExternalIdInfosRequest.md b/docs/interfaces/generated_client.ItemLookupApiGetExternalIdInfosRequest.md deleted file mode 100644 index 1c7d2371c..000000000 --- a/docs/interfaces/generated_client.ItemLookupApiGetExternalIdInfosRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApiGetExternalIdInfosRequest - -# Interface: ItemLookupApiGetExternalIdInfosRequest - -[generated-client](../modules/generated_client.md).ItemLookupApiGetExternalIdInfosRequest - -Request parameters for getExternalIdInfos operation in ItemLookupApi. - -**`export`** - -**`interface`** ItemLookupApiGetExternalIdInfosRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.ItemLookupApiGetExternalIdInfosRequest.md#itemid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ItemLookupApiGetExternalIdInfos - -#### Defined in - -[generated-client/api/item-lookup-api.ts:814](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L814) diff --git a/docs/interfaces/generated_client.ItemLookupApiGetMovieRemoteSearchResultsRequest.md b/docs/interfaces/generated_client.ItemLookupApiGetMovieRemoteSearchResultsRequest.md deleted file mode 100644 index 94988f484..000000000 --- a/docs/interfaces/generated_client.ItemLookupApiGetMovieRemoteSearchResultsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApiGetMovieRemoteSearchResultsRequest - -# Interface: ItemLookupApiGetMovieRemoteSearchResultsRequest - -[generated-client](../modules/generated_client.md).ItemLookupApiGetMovieRemoteSearchResultsRequest - -Request parameters for getMovieRemoteSearchResults operation in ItemLookupApi. - -**`export`** - -**`interface`** ItemLookupApiGetMovieRemoteSearchResultsRequest - -## Table of contents - -### Properties - -- [movieInfoRemoteSearchQuery](generated_client.ItemLookupApiGetMovieRemoteSearchResultsRequest.md#movieinforemotesearchquery) - -## Properties - -### movieInfoRemoteSearchQuery - -• `Readonly` **movieInfoRemoteSearchQuery**: [`MovieInfoRemoteSearchQuery`](generated_client.MovieInfoRemoteSearchQuery.md) - -Remote search query. - -**`memberof`** ItemLookupApiGetMovieRemoteSearchResults - -#### Defined in - -[generated-client/api/item-lookup-api.ts:828](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L828) diff --git a/docs/interfaces/generated_client.ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest.md b/docs/interfaces/generated_client.ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest.md deleted file mode 100644 index 89a010b87..000000000 --- a/docs/interfaces/generated_client.ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest - -# Interface: ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest - -[generated-client](../modules/generated_client.md).ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest - -Request parameters for getMusicAlbumRemoteSearchResults operation in ItemLookupApi. - -**`export`** - -**`interface`** ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest - -## Table of contents - -### Properties - -- [albumInfoRemoteSearchQuery](generated_client.ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest.md#albuminforemotesearchquery) - -## Properties - -### albumInfoRemoteSearchQuery - -• `Readonly` **albumInfoRemoteSearchQuery**: [`AlbumInfoRemoteSearchQuery`](generated_client.AlbumInfoRemoteSearchQuery.md) - -Remote search query. - -**`memberof`** ItemLookupApiGetMusicAlbumRemoteSearchResults - -#### Defined in - -[generated-client/api/item-lookup-api.ts:842](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L842) diff --git a/docs/interfaces/generated_client.ItemLookupApiGetMusicArtistRemoteSearchResultsRequest.md b/docs/interfaces/generated_client.ItemLookupApiGetMusicArtistRemoteSearchResultsRequest.md deleted file mode 100644 index 896647196..000000000 --- a/docs/interfaces/generated_client.ItemLookupApiGetMusicArtistRemoteSearchResultsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApiGetMusicArtistRemoteSearchResultsRequest - -# Interface: ItemLookupApiGetMusicArtistRemoteSearchResultsRequest - -[generated-client](../modules/generated_client.md).ItemLookupApiGetMusicArtistRemoteSearchResultsRequest - -Request parameters for getMusicArtistRemoteSearchResults operation in ItemLookupApi. - -**`export`** - -**`interface`** ItemLookupApiGetMusicArtistRemoteSearchResultsRequest - -## Table of contents - -### Properties - -- [artistInfoRemoteSearchQuery](generated_client.ItemLookupApiGetMusicArtistRemoteSearchResultsRequest.md#artistinforemotesearchquery) - -## Properties - -### artistInfoRemoteSearchQuery - -• `Readonly` **artistInfoRemoteSearchQuery**: [`ArtistInfoRemoteSearchQuery`](generated_client.ArtistInfoRemoteSearchQuery.md) - -Remote search query. - -**`memberof`** ItemLookupApiGetMusicArtistRemoteSearchResults - -#### Defined in - -[generated-client/api/item-lookup-api.ts:856](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L856) diff --git a/docs/interfaces/generated_client.ItemLookupApiGetMusicVideoRemoteSearchResultsRequest.md b/docs/interfaces/generated_client.ItemLookupApiGetMusicVideoRemoteSearchResultsRequest.md deleted file mode 100644 index c4a5be23e..000000000 --- a/docs/interfaces/generated_client.ItemLookupApiGetMusicVideoRemoteSearchResultsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApiGetMusicVideoRemoteSearchResultsRequest - -# Interface: ItemLookupApiGetMusicVideoRemoteSearchResultsRequest - -[generated-client](../modules/generated_client.md).ItemLookupApiGetMusicVideoRemoteSearchResultsRequest - -Request parameters for getMusicVideoRemoteSearchResults operation in ItemLookupApi. - -**`export`** - -**`interface`** ItemLookupApiGetMusicVideoRemoteSearchResultsRequest - -## Table of contents - -### Properties - -- [musicVideoInfoRemoteSearchQuery](generated_client.ItemLookupApiGetMusicVideoRemoteSearchResultsRequest.md#musicvideoinforemotesearchquery) - -## Properties - -### musicVideoInfoRemoteSearchQuery - -• `Readonly` **musicVideoInfoRemoteSearchQuery**: [`MusicVideoInfoRemoteSearchQuery`](generated_client.MusicVideoInfoRemoteSearchQuery.md) - -Remote search query. - -**`memberof`** ItemLookupApiGetMusicVideoRemoteSearchResults - -#### Defined in - -[generated-client/api/item-lookup-api.ts:870](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L870) diff --git a/docs/interfaces/generated_client.ItemLookupApiGetPersonRemoteSearchResultsRequest.md b/docs/interfaces/generated_client.ItemLookupApiGetPersonRemoteSearchResultsRequest.md deleted file mode 100644 index 3e67bc8b5..000000000 --- a/docs/interfaces/generated_client.ItemLookupApiGetPersonRemoteSearchResultsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApiGetPersonRemoteSearchResultsRequest - -# Interface: ItemLookupApiGetPersonRemoteSearchResultsRequest - -[generated-client](../modules/generated_client.md).ItemLookupApiGetPersonRemoteSearchResultsRequest - -Request parameters for getPersonRemoteSearchResults operation in ItemLookupApi. - -**`export`** - -**`interface`** ItemLookupApiGetPersonRemoteSearchResultsRequest - -## Table of contents - -### Properties - -- [personLookupInfoRemoteSearchQuery](generated_client.ItemLookupApiGetPersonRemoteSearchResultsRequest.md#personlookupinforemotesearchquery) - -## Properties - -### personLookupInfoRemoteSearchQuery - -• `Readonly` **personLookupInfoRemoteSearchQuery**: [`PersonLookupInfoRemoteSearchQuery`](generated_client.PersonLookupInfoRemoteSearchQuery.md) - -Remote search query. - -**`memberof`** ItemLookupApiGetPersonRemoteSearchResults - -#### Defined in - -[generated-client/api/item-lookup-api.ts:884](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L884) diff --git a/docs/interfaces/generated_client.ItemLookupApiGetSeriesRemoteSearchResultsRequest.md b/docs/interfaces/generated_client.ItemLookupApiGetSeriesRemoteSearchResultsRequest.md deleted file mode 100644 index d0481594a..000000000 --- a/docs/interfaces/generated_client.ItemLookupApiGetSeriesRemoteSearchResultsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApiGetSeriesRemoteSearchResultsRequest - -# Interface: ItemLookupApiGetSeriesRemoteSearchResultsRequest - -[generated-client](../modules/generated_client.md).ItemLookupApiGetSeriesRemoteSearchResultsRequest - -Request parameters for getSeriesRemoteSearchResults operation in ItemLookupApi. - -**`export`** - -**`interface`** ItemLookupApiGetSeriesRemoteSearchResultsRequest - -## Table of contents - -### Properties - -- [seriesInfoRemoteSearchQuery](generated_client.ItemLookupApiGetSeriesRemoteSearchResultsRequest.md#seriesinforemotesearchquery) - -## Properties - -### seriesInfoRemoteSearchQuery - -• `Readonly` **seriesInfoRemoteSearchQuery**: [`SeriesInfoRemoteSearchQuery`](generated_client.SeriesInfoRemoteSearchQuery.md) - -Remote search query. - -**`memberof`** ItemLookupApiGetSeriesRemoteSearchResults - -#### Defined in - -[generated-client/api/item-lookup-api.ts:898](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L898) diff --git a/docs/interfaces/generated_client.ItemLookupApiGetTrailerRemoteSearchResultsRequest.md b/docs/interfaces/generated_client.ItemLookupApiGetTrailerRemoteSearchResultsRequest.md deleted file mode 100644 index 03b2e8798..000000000 --- a/docs/interfaces/generated_client.ItemLookupApiGetTrailerRemoteSearchResultsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApiGetTrailerRemoteSearchResultsRequest - -# Interface: ItemLookupApiGetTrailerRemoteSearchResultsRequest - -[generated-client](../modules/generated_client.md).ItemLookupApiGetTrailerRemoteSearchResultsRequest - -Request parameters for getTrailerRemoteSearchResults operation in ItemLookupApi. - -**`export`** - -**`interface`** ItemLookupApiGetTrailerRemoteSearchResultsRequest - -## Table of contents - -### Properties - -- [trailerInfoRemoteSearchQuery](generated_client.ItemLookupApiGetTrailerRemoteSearchResultsRequest.md#trailerinforemotesearchquery) - -## Properties - -### trailerInfoRemoteSearchQuery - -• `Readonly` **trailerInfoRemoteSearchQuery**: [`TrailerInfoRemoteSearchQuery`](generated_client.TrailerInfoRemoteSearchQuery.md) - -Remote search query. - -**`memberof`** ItemLookupApiGetTrailerRemoteSearchResults - -#### Defined in - -[generated-client/api/item-lookup-api.ts:912](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L912) diff --git a/docs/interfaces/generated_client.ItemRefreshApiRefreshItemRequest.md b/docs/interfaces/generated_client.ItemRefreshApiRefreshItemRequest.md deleted file mode 100644 index 25f2cae81..000000000 --- a/docs/interfaces/generated_client.ItemRefreshApiRefreshItemRequest.md +++ /dev/null @@ -1,91 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemRefreshApiRefreshItemRequest - -# Interface: ItemRefreshApiRefreshItemRequest - -[generated-client](../modules/generated_client.md).ItemRefreshApiRefreshItemRequest - -Request parameters for refreshItem operation in ItemRefreshApi. - -**`export`** - -**`interface`** ItemRefreshApiRefreshItemRequest - -## Table of contents - -### Properties - -- [imageRefreshMode](generated_client.ItemRefreshApiRefreshItemRequest.md#imagerefreshmode) -- [itemId](generated_client.ItemRefreshApiRefreshItemRequest.md#itemid) -- [metadataRefreshMode](generated_client.ItemRefreshApiRefreshItemRequest.md#metadatarefreshmode) -- [replaceAllImages](generated_client.ItemRefreshApiRefreshItemRequest.md#replaceallimages) -- [replaceAllMetadata](generated_client.ItemRefreshApiRefreshItemRequest.md#replaceallmetadata) - -## Properties - -### imageRefreshMode - -• `Optional` `Readonly` **imageRefreshMode**: [`MetadataRefreshMode`](../enums/generated_client.MetadataRefreshMode.md) - -(Optional) Specifies the image refresh mode. - -**`memberof`** ItemRefreshApiRefreshItem - -#### Defined in - -[generated-client/api/item-refresh-api.ts:167](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-refresh-api.ts#L167) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** ItemRefreshApiRefreshItem - -#### Defined in - -[generated-client/api/item-refresh-api.ts:153](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-refresh-api.ts#L153) - -___ - -### metadataRefreshMode - -• `Optional` `Readonly` **metadataRefreshMode**: [`MetadataRefreshMode`](../enums/generated_client.MetadataRefreshMode.md) - -(Optional) Specifies the metadata refresh mode. - -**`memberof`** ItemRefreshApiRefreshItem - -#### Defined in - -[generated-client/api/item-refresh-api.ts:160](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-refresh-api.ts#L160) - -___ - -### replaceAllImages - -• `Optional` `Readonly` **replaceAllImages**: `boolean` - -(Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh. - -**`memberof`** ItemRefreshApiRefreshItem - -#### Defined in - -[generated-client/api/item-refresh-api.ts:181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-refresh-api.ts#L181) - -___ - -### replaceAllMetadata - -• `Optional` `Readonly` **replaceAllMetadata**: `boolean` - -(Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh. - -**`memberof`** ItemRefreshApiRefreshItem - -#### Defined in - -[generated-client/api/item-refresh-api.ts:174](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-refresh-api.ts#L174) diff --git a/docs/interfaces/generated_client.ItemUpdateApiGetMetadataEditorInfoRequest.md b/docs/interfaces/generated_client.ItemUpdateApiGetMetadataEditorInfoRequest.md deleted file mode 100644 index 0a18c915c..000000000 --- a/docs/interfaces/generated_client.ItemUpdateApiGetMetadataEditorInfoRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemUpdateApiGetMetadataEditorInfoRequest - -# Interface: ItemUpdateApiGetMetadataEditorInfoRequest - -[generated-client](../modules/generated_client.md).ItemUpdateApiGetMetadataEditorInfoRequest - -Request parameters for getMetadataEditorInfo operation in ItemUpdateApi. - -**`export`** - -**`interface`** ItemUpdateApiGetMetadataEditorInfoRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.ItemUpdateApiGetMetadataEditorInfoRequest.md#itemid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** ItemUpdateApiGetMetadataEditorInfo - -#### Defined in - -[generated-client/api/item-update-api.ts:258](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L258) diff --git a/docs/interfaces/generated_client.ItemUpdateApiUpdateItemContentTypeRequest.md b/docs/interfaces/generated_client.ItemUpdateApiUpdateItemContentTypeRequest.md deleted file mode 100644 index 7452d5033..000000000 --- a/docs/interfaces/generated_client.ItemUpdateApiUpdateItemContentTypeRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemUpdateApiUpdateItemContentTypeRequest - -# Interface: ItemUpdateApiUpdateItemContentTypeRequest - -[generated-client](../modules/generated_client.md).ItemUpdateApiUpdateItemContentTypeRequest - -Request parameters for updateItemContentType operation in ItemUpdateApi. - -**`export`** - -**`interface`** ItemUpdateApiUpdateItemContentTypeRequest - -## Table of contents - -### Properties - -- [contentType](generated_client.ItemUpdateApiUpdateItemContentTypeRequest.md#contenttype) -- [itemId](generated_client.ItemUpdateApiUpdateItemContentTypeRequest.md#itemid) - -## Properties - -### contentType - -• `Optional` `Readonly` **contentType**: `string` - -The content type of the item. - -**`memberof`** ItemUpdateApiUpdateItemContentType - -#### Defined in - -[generated-client/api/item-update-api.ts:300](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L300) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** ItemUpdateApiUpdateItemContentType - -#### Defined in - -[generated-client/api/item-update-api.ts:293](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L293) diff --git a/docs/interfaces/generated_client.ItemUpdateApiUpdateItemRequest.md b/docs/interfaces/generated_client.ItemUpdateApiUpdateItemRequest.md deleted file mode 100644 index 0b0382656..000000000 --- a/docs/interfaces/generated_client.ItemUpdateApiUpdateItemRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemUpdateApiUpdateItemRequest - -# Interface: ItemUpdateApiUpdateItemRequest - -[generated-client](../modules/generated_client.md).ItemUpdateApiUpdateItemRequest - -Request parameters for updateItem operation in ItemUpdateApi. - -**`export`** - -**`interface`** ItemUpdateApiUpdateItemRequest - -## Table of contents - -### Properties - -- [baseItemDto](generated_client.ItemUpdateApiUpdateItemRequest.md#baseitemdto) -- [itemId](generated_client.ItemUpdateApiUpdateItemRequest.md#itemid) - -## Properties - -### baseItemDto - -• `Readonly` **baseItemDto**: [`BaseItemDto`](generated_client.BaseItemDto.md) - -The new item properties. - -**`memberof`** ItemUpdateApiUpdateItem - -#### Defined in - -[generated-client/api/item-update-api.ts:279](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L279) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** ItemUpdateApiUpdateItem - -#### Defined in - -[generated-client/api/item-update-api.ts:272](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L272) diff --git a/docs/interfaces/generated_client.ItemsApiGetItemsByUserIdRequest.md b/docs/interfaces/generated_client.ItemsApiGetItemsByUserIdRequest.md deleted file mode 100644 index c979e0e82..000000000 --- a/docs/interfaces/generated_client.ItemsApiGetItemsByUserIdRequest.md +++ /dev/null @@ -1,1291 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemsApiGetItemsByUserIdRequest - -# Interface: ItemsApiGetItemsByUserIdRequest - -[generated-client](../modules/generated_client.md).ItemsApiGetItemsByUserIdRequest - -Request parameters for getItemsByUserId operation in ItemsApi. - -**`export`** - -**`interface`** ItemsApiGetItemsByUserIdRequest - -## Table of contents - -### Properties - -- [adjacentTo](generated_client.ItemsApiGetItemsByUserIdRequest.md#adjacentto) -- [albumArtistIds](generated_client.ItemsApiGetItemsByUserIdRequest.md#albumartistids) -- [albumIds](generated_client.ItemsApiGetItemsByUserIdRequest.md#albumids) -- [albums](generated_client.ItemsApiGetItemsByUserIdRequest.md#albums) -- [artistIds](generated_client.ItemsApiGetItemsByUserIdRequest.md#artistids) -- [artists](generated_client.ItemsApiGetItemsByUserIdRequest.md#artists) -- [collapseBoxSetItems](generated_client.ItemsApiGetItemsByUserIdRequest.md#collapseboxsetitems) -- [contributingArtistIds](generated_client.ItemsApiGetItemsByUserIdRequest.md#contributingartistids) -- [enableImageTypes](generated_client.ItemsApiGetItemsByUserIdRequest.md#enableimagetypes) -- [enableImages](generated_client.ItemsApiGetItemsByUserIdRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.ItemsApiGetItemsByUserIdRequest.md#enabletotalrecordcount) -- [enableUserData](generated_client.ItemsApiGetItemsByUserIdRequest.md#enableuserdata) -- [excludeArtistIds](generated_client.ItemsApiGetItemsByUserIdRequest.md#excludeartistids) -- [excludeItemIds](generated_client.ItemsApiGetItemsByUserIdRequest.md#excludeitemids) -- [excludeItemTypes](generated_client.ItemsApiGetItemsByUserIdRequest.md#excludeitemtypes) -- [excludeLocationTypes](generated_client.ItemsApiGetItemsByUserIdRequest.md#excludelocationtypes) -- [fields](generated_client.ItemsApiGetItemsByUserIdRequest.md#fields) -- [filters](generated_client.ItemsApiGetItemsByUserIdRequest.md#filters) -- [genreIds](generated_client.ItemsApiGetItemsByUserIdRequest.md#genreids) -- [genres](generated_client.ItemsApiGetItemsByUserIdRequest.md#genres) -- [hasImdbId](generated_client.ItemsApiGetItemsByUserIdRequest.md#hasimdbid) -- [hasOfficialRating](generated_client.ItemsApiGetItemsByUserIdRequest.md#hasofficialrating) -- [hasOverview](generated_client.ItemsApiGetItemsByUserIdRequest.md#hasoverview) -- [hasParentalRating](generated_client.ItemsApiGetItemsByUserIdRequest.md#hasparentalrating) -- [hasSpecialFeature](generated_client.ItemsApiGetItemsByUserIdRequest.md#hasspecialfeature) -- [hasSubtitles](generated_client.ItemsApiGetItemsByUserIdRequest.md#hassubtitles) -- [hasThemeSong](generated_client.ItemsApiGetItemsByUserIdRequest.md#hasthemesong) -- [hasThemeVideo](generated_client.ItemsApiGetItemsByUserIdRequest.md#hasthemevideo) -- [hasTmdbId](generated_client.ItemsApiGetItemsByUserIdRequest.md#hastmdbid) -- [hasTrailer](generated_client.ItemsApiGetItemsByUserIdRequest.md#hastrailer) -- [hasTvdbId](generated_client.ItemsApiGetItemsByUserIdRequest.md#hastvdbid) -- [ids](generated_client.ItemsApiGetItemsByUserIdRequest.md#ids) -- [imageTypeLimit](generated_client.ItemsApiGetItemsByUserIdRequest.md#imagetypelimit) -- [imageTypes](generated_client.ItemsApiGetItemsByUserIdRequest.md#imagetypes) -- [includeItemTypes](generated_client.ItemsApiGetItemsByUserIdRequest.md#includeitemtypes) -- [is3D](generated_client.ItemsApiGetItemsByUserIdRequest.md#is3d) -- [is4K](generated_client.ItemsApiGetItemsByUserIdRequest.md#is4k) -- [isFavorite](generated_client.ItemsApiGetItemsByUserIdRequest.md#isfavorite) -- [isHd](generated_client.ItemsApiGetItemsByUserIdRequest.md#ishd) -- [isKids](generated_client.ItemsApiGetItemsByUserIdRequest.md#iskids) -- [isLocked](generated_client.ItemsApiGetItemsByUserIdRequest.md#islocked) -- [isMissing](generated_client.ItemsApiGetItemsByUserIdRequest.md#ismissing) -- [isMovie](generated_client.ItemsApiGetItemsByUserIdRequest.md#ismovie) -- [isNews](generated_client.ItemsApiGetItemsByUserIdRequest.md#isnews) -- [isPlaceHolder](generated_client.ItemsApiGetItemsByUserIdRequest.md#isplaceholder) -- [isPlayed](generated_client.ItemsApiGetItemsByUserIdRequest.md#isplayed) -- [isSeries](generated_client.ItemsApiGetItemsByUserIdRequest.md#isseries) -- [isSports](generated_client.ItemsApiGetItemsByUserIdRequest.md#issports) -- [isUnaired](generated_client.ItemsApiGetItemsByUserIdRequest.md#isunaired) -- [limit](generated_client.ItemsApiGetItemsByUserIdRequest.md#limit) -- [locationTypes](generated_client.ItemsApiGetItemsByUserIdRequest.md#locationtypes) -- [maxHeight](generated_client.ItemsApiGetItemsByUserIdRequest.md#maxheight) -- [maxOfficialRating](generated_client.ItemsApiGetItemsByUserIdRequest.md#maxofficialrating) -- [maxPremiereDate](generated_client.ItemsApiGetItemsByUserIdRequest.md#maxpremieredate) -- [maxWidth](generated_client.ItemsApiGetItemsByUserIdRequest.md#maxwidth) -- [mediaTypes](generated_client.ItemsApiGetItemsByUserIdRequest.md#mediatypes) -- [minCommunityRating](generated_client.ItemsApiGetItemsByUserIdRequest.md#mincommunityrating) -- [minCriticRating](generated_client.ItemsApiGetItemsByUserIdRequest.md#mincriticrating) -- [minDateLastSaved](generated_client.ItemsApiGetItemsByUserIdRequest.md#mindatelastsaved) -- [minDateLastSavedForUser](generated_client.ItemsApiGetItemsByUserIdRequest.md#mindatelastsavedforuser) -- [minHeight](generated_client.ItemsApiGetItemsByUserIdRequest.md#minheight) -- [minOfficialRating](generated_client.ItemsApiGetItemsByUserIdRequest.md#minofficialrating) -- [minPremiereDate](generated_client.ItemsApiGetItemsByUserIdRequest.md#minpremieredate) -- [minWidth](generated_client.ItemsApiGetItemsByUserIdRequest.md#minwidth) -- [nameLessThan](generated_client.ItemsApiGetItemsByUserIdRequest.md#namelessthan) -- [nameStartsWith](generated_client.ItemsApiGetItemsByUserIdRequest.md#namestartswith) -- [nameStartsWithOrGreater](generated_client.ItemsApiGetItemsByUserIdRequest.md#namestartswithorgreater) -- [officialRatings](generated_client.ItemsApiGetItemsByUserIdRequest.md#officialratings) -- [parentId](generated_client.ItemsApiGetItemsByUserIdRequest.md#parentid) -- [parentIndexNumber](generated_client.ItemsApiGetItemsByUserIdRequest.md#parentindexnumber) -- [person](generated_client.ItemsApiGetItemsByUserIdRequest.md#person) -- [personIds](generated_client.ItemsApiGetItemsByUserIdRequest.md#personids) -- [personTypes](generated_client.ItemsApiGetItemsByUserIdRequest.md#persontypes) -- [recursive](generated_client.ItemsApiGetItemsByUserIdRequest.md#recursive) -- [searchTerm](generated_client.ItemsApiGetItemsByUserIdRequest.md#searchterm) -- [seriesStatus](generated_client.ItemsApiGetItemsByUserIdRequest.md#seriesstatus) -- [sortBy](generated_client.ItemsApiGetItemsByUserIdRequest.md#sortby) -- [sortOrder](generated_client.ItemsApiGetItemsByUserIdRequest.md#sortorder) -- [startIndex](generated_client.ItemsApiGetItemsByUserIdRequest.md#startindex) -- [studioIds](generated_client.ItemsApiGetItemsByUserIdRequest.md#studioids) -- [studios](generated_client.ItemsApiGetItemsByUserIdRequest.md#studios) -- [tags](generated_client.ItemsApiGetItemsByUserIdRequest.md#tags) -- [userId](generated_client.ItemsApiGetItemsByUserIdRequest.md#userid) -- [videoTypes](generated_client.ItemsApiGetItemsByUserIdRequest.md#videotypes) -- [years](generated_client.ItemsApiGetItemsByUserIdRequest.md#years) - -## Properties - -### adjacentTo - -• `Optional` `Readonly` **adjacentTo**: `string` - -Optional. Return items that are siblings of a supplied item. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2197](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2197) - -___ - -### albumArtistIds - -• `Optional` `Readonly` **albumArtistIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified album artist id. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2575](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2575) - -___ - -### albumIds - -• `Optional` `Readonly` **albumIds**: `string`[] - -Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2596](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2596) - -___ - -### albums - -• `Optional` `Readonly` **albums**: `string`[] - -Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2589](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2589) - -___ - -### artistIds - -• `Optional` `Readonly` **artistIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified artist id. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2568](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2568) - -___ - -### artists - -• `Optional` `Readonly` **artists**: `string`[] - -Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2554](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2554) - -___ - -### collapseBoxSetItems - -• `Optional` `Readonly` **collapseBoxSetItems**: `boolean` - -Whether or not to hide items behind their boxsets. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2645](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2645) - -___ - -### contributingArtistIds - -• `Optional` `Readonly` **contributingArtistIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2582](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2582) - -___ - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2519](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2519) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional, include image information in output. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2736](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2736) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Optional. Enable the total record count. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2729](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2729) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional, include user data. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2505](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2505) - -___ - -### excludeArtistIds - -• `Optional` `Readonly` **excludeArtistIds**: `string`[] - -Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2561](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2561) - -___ - -### excludeItemIds - -• `Optional` `Readonly` **excludeItemIds**: `string`[] - -Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2365](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2365) - -___ - -### excludeItemTypes - -• `Optional` `Readonly` **excludeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2421](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2421) - -___ - -### excludeLocationTypes - -• `Optional` `Readonly` **excludeLocationTypes**: [`LocationType`](../enums/generated_client.LocationType.md)[] - -Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2239](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2239) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2414](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2414) - -___ - -### filters - -• `Optional` `Readonly` **filters**: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[] - -Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2435](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2435) - -___ - -### genreIds - -• `Optional` `Readonly` **genreIds**: `string`[] - -Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2722](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2722) - -___ - -### genres - -• `Optional` `Readonly` **genres**: `string`[] - -Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2477](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2477) - -___ - -### hasImdbId - -• `Optional` `Readonly` **hasImdbId**: `boolean` - -Optional filter by items that have an imdb id or not. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2309](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2309) - -___ - -### hasOfficialRating - -• `Optional` `Readonly` **hasOfficialRating**: `boolean` - -Optional filter by items that have official ratings. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2638](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2638) - -___ - -### hasOverview - -• `Optional` `Readonly` **hasOverview**: `boolean` - -Optional filter by items that have an overview or not. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2302](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2302) - -___ - -### hasParentalRating - -• `Optional` `Readonly` **hasParentalRating**: `boolean` - -Optional filter by items that have or do not have a parental rating. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2211](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2211) - -___ - -### hasSpecialFeature - -• `Optional` `Readonly` **hasSpecialFeature**: `boolean` - -Optional filter by items with special features. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2183](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2183) - -___ - -### hasSubtitles - -• `Optional` `Readonly` **hasSubtitles**: `boolean` - -Optional filter by items with subtitles. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2176](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2176) - -___ - -### hasThemeSong - -• `Optional` `Readonly` **hasThemeSong**: `boolean` - -Optional filter by items with theme songs. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2162](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2162) - -___ - -### hasThemeVideo - -• `Optional` `Readonly` **hasThemeVideo**: `boolean` - -Optional filter by items with theme videos. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2169](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2169) - -___ - -### hasTmdbId - -• `Optional` `Readonly` **hasTmdbId**: `boolean` - -Optional filter by items that have a tmdb id or not. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2316](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2316) - -___ - -### hasTrailer - -• `Optional` `Readonly` **hasTrailer**: `boolean` - -Optional filter by items with trailers. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2190](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2190) - -___ - -### hasTvdbId - -• `Optional` `Readonly` **hasTvdbId**: `boolean` - -Optional filter by items that have a tvdb id or not. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2323](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2323) - -___ - -### ids - -• `Optional` `Readonly` **ids**: `string`[] - -Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2603](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2603) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional, the max number of images to return, per image type. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2512](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2512) - -___ - -### imageTypes - -• `Optional` `Readonly` **imageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2456](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2456) - -___ - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2428](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2428) - -___ - -### is3D - -• `Optional` `Readonly` **is3D**: `boolean` - -Optional filter by items that are 3D, or not. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2680](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2680) - -___ - -### is4K - -• `Optional` `Readonly` **is4K**: `boolean` - -Optional filter by items that are 4K or not. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2225](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2225) - -___ - -### isFavorite - -• `Optional` `Readonly` **isFavorite**: `boolean` - -Optional filter by items that are marked as favorite, or not. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2442](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2442) - -___ - -### isHd - -• `Optional` `Readonly` **isHd**: `boolean` - -Optional filter by items that are HD or not. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2218](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2218) - -___ - -### isKids - -• `Optional` `Readonly` **isKids**: `boolean` - -Optional filter for live tv kids. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2351](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2351) - -___ - -### isLocked - -• `Optional` `Readonly` **isLocked**: `boolean` - -Optional filter by items that are locked. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2624](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2624) - -___ - -### isMissing - -• `Optional` `Readonly` **isMissing**: `boolean` - -Optional filter by items that are missing episodes or not. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2246](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2246) - -___ - -### isMovie - -• `Optional` `Readonly` **isMovie**: `boolean` - -Optional filter for live tv movies. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2330](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2330) - -___ - -### isNews - -• `Optional` `Readonly` **isNews**: `boolean` - -Optional filter for live tv news. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2344](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2344) - -___ - -### isPlaceHolder - -• `Optional` `Readonly` **isPlaceHolder**: `boolean` - -Optional filter by items that are placeholders. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2631](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2631) - -___ - -### isPlayed - -• `Optional` `Readonly` **isPlayed**: `boolean` - -Optional filter by items that are played, or not. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2470](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2470) - -___ - -### isSeries - -• `Optional` `Readonly` **isSeries**: `boolean` - -Optional filter for live tv series. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2337](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2337) - -___ - -### isSports - -• `Optional` `Readonly` **isSports**: `boolean` - -Optional filter for live tv sports. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2358](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2358) - -___ - -### isUnaired - -• `Optional` `Readonly` **isUnaired**: `boolean` - -Optional filter by items that are unaired episodes or not. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2253](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2253) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2379](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2379) - -___ - -### locationTypes - -• `Optional` `Readonly` **locationTypes**: [`LocationType`](../enums/generated_client.LocationType.md)[] - -Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2232](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2232) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -Optional. Filter by the maximum height of the item. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2673](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2673) - -___ - -### maxOfficialRating - -• `Optional` `Readonly` **maxOfficialRating**: `string` - -Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2155](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2155) - -___ - -### maxPremiereDate - -• `Optional` `Readonly` **maxPremiereDate**: `string` - -Optional. The maximum premiere date. Format = ISO. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2295](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2295) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -Optional. Filter by the maximum width of the item. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2666](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2666) - -___ - -### mediaTypes - -• `Optional` `Readonly` **mediaTypes**: `string`[] - -Optional filter by MediaType. Allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2449](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2449) - -___ - -### minCommunityRating - -• `Optional` `Readonly` **minCommunityRating**: `number` - -Optional filter by minimum community rating. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2260](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2260) - -___ - -### minCriticRating - -• `Optional` `Readonly` **minCriticRating**: `number` - -Optional filter by minimum critic rating. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2267](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2267) - -___ - -### minDateLastSaved - -• `Optional` `Readonly` **minDateLastSaved**: `string` - -Optional. The minimum last saved date. Format = ISO. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2281](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2281) - -___ - -### minDateLastSavedForUser - -• `Optional` `Readonly` **minDateLastSavedForUser**: `string` - -Optional. The minimum last saved date for the current user. Format = ISO. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2288](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2288) - -___ - -### minHeight - -• `Optional` `Readonly` **minHeight**: `number` - -Optional. Filter by the minimum height of the item. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2659](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2659) - -___ - -### minOfficialRating - -• `Optional` `Readonly` **minOfficialRating**: `string` - -Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2617](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2617) - -___ - -### minPremiereDate - -• `Optional` `Readonly` **minPremiereDate**: `string` - -Optional. The minimum premiere date. Format = ISO. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2274](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2274) - -___ - -### minWidth - -• `Optional` `Readonly` **minWidth**: `number` - -Optional. Filter by the minimum width of the item. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2652](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2652) - -___ - -### nameLessThan - -• `Optional` `Readonly` **nameLessThan**: `string` - -Optional filter by items whose name is equally or lesser than a given input string. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2708](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2708) - -___ - -### nameStartsWith - -• `Optional` `Readonly` **nameStartsWith**: `string` - -Optional filter by items whose name is sorted equally than a given input string. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2701](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2701) - -___ - -### nameStartsWithOrGreater - -• `Optional` `Readonly` **nameStartsWithOrGreater**: `string` - -Optional filter by items whose name is sorted equally or greater than a given input string. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2694](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2694) - -___ - -### officialRatings - -• `Optional` `Readonly` **officialRatings**: `string`[] - -Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2484](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2484) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2407](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2407) - -___ - -### parentIndexNumber - -• `Optional` `Readonly` **parentIndexNumber**: `number` - -Optional filter by parent index number. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2204](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2204) - -___ - -### person - -• `Optional` `Readonly` **person**: `string` - -Optional. If specified, results will be filtered to include only those containing the specified person. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2526](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2526) - -___ - -### personIds - -• `Optional` `Readonly` **personIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified person id. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2533](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2533) - -___ - -### personTypes - -• `Optional` `Readonly` **personTypes**: `string`[] - -Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2540](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2540) - -___ - -### recursive - -• `Optional` `Readonly` **recursive**: `boolean` - -When searching within folders, this determines whether or not the search will be recursive. true/false. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2386](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2386) - -___ - -### searchTerm - -• `Optional` `Readonly` **searchTerm**: `string` - -Optional. Filter based on a search term. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2393](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2393) - -___ - -### seriesStatus - -• `Optional` `Readonly` **seriesStatus**: [`SeriesStatus`](../enums/generated_client.SeriesStatus.md)[] - -Optional filter by Series Status. Allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2687](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2687) - -___ - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string`[] - -Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2463](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2463) - -___ - -### sortOrder - -• `Optional` `Readonly` **sortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md)[] - -Sort Order - Ascending,Descending. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2400](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2400) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2372](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2372) - -___ - -### studioIds - -• `Optional` `Readonly` **studioIds**: `string`[] - -Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2715](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2715) - -___ - -### studios - -• `Optional` `Readonly` **studios**: `string`[] - -Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2547](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2547) - -___ - -### tags - -• `Optional` `Readonly` **tags**: `string`[] - -Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2491](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2491) - -___ - -### userId - -• `Readonly` **userId**: `string` - -The user id supplied as query parameter. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2148](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2148) - -___ - -### videoTypes - -• `Optional` `Readonly` **videoTypes**: [`VideoType`](../enums/generated_client.VideoType.md)[] - -Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2610](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2610) - -___ - -### years - -• `Optional` `Readonly` **years**: `number`[] - -Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItemsByUserId - -#### Defined in - -[generated-client/api/items-api.ts:2498](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2498) diff --git a/docs/interfaces/generated_client.ItemsApiGetItemsRequest.md b/docs/interfaces/generated_client.ItemsApiGetItemsRequest.md deleted file mode 100644 index 5e51973b8..000000000 --- a/docs/interfaces/generated_client.ItemsApiGetItemsRequest.md +++ /dev/null @@ -1,1291 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemsApiGetItemsRequest - -# Interface: ItemsApiGetItemsRequest - -[generated-client](../modules/generated_client.md).ItemsApiGetItemsRequest - -Request parameters for getItems operation in ItemsApi. - -**`export`** - -**`interface`** ItemsApiGetItemsRequest - -## Table of contents - -### Properties - -- [adjacentTo](generated_client.ItemsApiGetItemsRequest.md#adjacentto) -- [albumArtistIds](generated_client.ItemsApiGetItemsRequest.md#albumartistids) -- [albumIds](generated_client.ItemsApiGetItemsRequest.md#albumids) -- [albums](generated_client.ItemsApiGetItemsRequest.md#albums) -- [artistIds](generated_client.ItemsApiGetItemsRequest.md#artistids) -- [artists](generated_client.ItemsApiGetItemsRequest.md#artists) -- [collapseBoxSetItems](generated_client.ItemsApiGetItemsRequest.md#collapseboxsetitems) -- [contributingArtistIds](generated_client.ItemsApiGetItemsRequest.md#contributingartistids) -- [enableImageTypes](generated_client.ItemsApiGetItemsRequest.md#enableimagetypes) -- [enableImages](generated_client.ItemsApiGetItemsRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.ItemsApiGetItemsRequest.md#enabletotalrecordcount) -- [enableUserData](generated_client.ItemsApiGetItemsRequest.md#enableuserdata) -- [excludeArtistIds](generated_client.ItemsApiGetItemsRequest.md#excludeartistids) -- [excludeItemIds](generated_client.ItemsApiGetItemsRequest.md#excludeitemids) -- [excludeItemTypes](generated_client.ItemsApiGetItemsRequest.md#excludeitemtypes) -- [excludeLocationTypes](generated_client.ItemsApiGetItemsRequest.md#excludelocationtypes) -- [fields](generated_client.ItemsApiGetItemsRequest.md#fields) -- [filters](generated_client.ItemsApiGetItemsRequest.md#filters) -- [genreIds](generated_client.ItemsApiGetItemsRequest.md#genreids) -- [genres](generated_client.ItemsApiGetItemsRequest.md#genres) -- [hasImdbId](generated_client.ItemsApiGetItemsRequest.md#hasimdbid) -- [hasOfficialRating](generated_client.ItemsApiGetItemsRequest.md#hasofficialrating) -- [hasOverview](generated_client.ItemsApiGetItemsRequest.md#hasoverview) -- [hasParentalRating](generated_client.ItemsApiGetItemsRequest.md#hasparentalrating) -- [hasSpecialFeature](generated_client.ItemsApiGetItemsRequest.md#hasspecialfeature) -- [hasSubtitles](generated_client.ItemsApiGetItemsRequest.md#hassubtitles) -- [hasThemeSong](generated_client.ItemsApiGetItemsRequest.md#hasthemesong) -- [hasThemeVideo](generated_client.ItemsApiGetItemsRequest.md#hasthemevideo) -- [hasTmdbId](generated_client.ItemsApiGetItemsRequest.md#hastmdbid) -- [hasTrailer](generated_client.ItemsApiGetItemsRequest.md#hastrailer) -- [hasTvdbId](generated_client.ItemsApiGetItemsRequest.md#hastvdbid) -- [ids](generated_client.ItemsApiGetItemsRequest.md#ids) -- [imageTypeLimit](generated_client.ItemsApiGetItemsRequest.md#imagetypelimit) -- [imageTypes](generated_client.ItemsApiGetItemsRequest.md#imagetypes) -- [includeItemTypes](generated_client.ItemsApiGetItemsRequest.md#includeitemtypes) -- [is3D](generated_client.ItemsApiGetItemsRequest.md#is3d) -- [is4K](generated_client.ItemsApiGetItemsRequest.md#is4k) -- [isFavorite](generated_client.ItemsApiGetItemsRequest.md#isfavorite) -- [isHd](generated_client.ItemsApiGetItemsRequest.md#ishd) -- [isKids](generated_client.ItemsApiGetItemsRequest.md#iskids) -- [isLocked](generated_client.ItemsApiGetItemsRequest.md#islocked) -- [isMissing](generated_client.ItemsApiGetItemsRequest.md#ismissing) -- [isMovie](generated_client.ItemsApiGetItemsRequest.md#ismovie) -- [isNews](generated_client.ItemsApiGetItemsRequest.md#isnews) -- [isPlaceHolder](generated_client.ItemsApiGetItemsRequest.md#isplaceholder) -- [isPlayed](generated_client.ItemsApiGetItemsRequest.md#isplayed) -- [isSeries](generated_client.ItemsApiGetItemsRequest.md#isseries) -- [isSports](generated_client.ItemsApiGetItemsRequest.md#issports) -- [isUnaired](generated_client.ItemsApiGetItemsRequest.md#isunaired) -- [limit](generated_client.ItemsApiGetItemsRequest.md#limit) -- [locationTypes](generated_client.ItemsApiGetItemsRequest.md#locationtypes) -- [maxHeight](generated_client.ItemsApiGetItemsRequest.md#maxheight) -- [maxOfficialRating](generated_client.ItemsApiGetItemsRequest.md#maxofficialrating) -- [maxPremiereDate](generated_client.ItemsApiGetItemsRequest.md#maxpremieredate) -- [maxWidth](generated_client.ItemsApiGetItemsRequest.md#maxwidth) -- [mediaTypes](generated_client.ItemsApiGetItemsRequest.md#mediatypes) -- [minCommunityRating](generated_client.ItemsApiGetItemsRequest.md#mincommunityrating) -- [minCriticRating](generated_client.ItemsApiGetItemsRequest.md#mincriticrating) -- [minDateLastSaved](generated_client.ItemsApiGetItemsRequest.md#mindatelastsaved) -- [minDateLastSavedForUser](generated_client.ItemsApiGetItemsRequest.md#mindatelastsavedforuser) -- [minHeight](generated_client.ItemsApiGetItemsRequest.md#minheight) -- [minOfficialRating](generated_client.ItemsApiGetItemsRequest.md#minofficialrating) -- [minPremiereDate](generated_client.ItemsApiGetItemsRequest.md#minpremieredate) -- [minWidth](generated_client.ItemsApiGetItemsRequest.md#minwidth) -- [nameLessThan](generated_client.ItemsApiGetItemsRequest.md#namelessthan) -- [nameStartsWith](generated_client.ItemsApiGetItemsRequest.md#namestartswith) -- [nameStartsWithOrGreater](generated_client.ItemsApiGetItemsRequest.md#namestartswithorgreater) -- [officialRatings](generated_client.ItemsApiGetItemsRequest.md#officialratings) -- [parentId](generated_client.ItemsApiGetItemsRequest.md#parentid) -- [parentIndexNumber](generated_client.ItemsApiGetItemsRequest.md#parentindexnumber) -- [person](generated_client.ItemsApiGetItemsRequest.md#person) -- [personIds](generated_client.ItemsApiGetItemsRequest.md#personids) -- [personTypes](generated_client.ItemsApiGetItemsRequest.md#persontypes) -- [recursive](generated_client.ItemsApiGetItemsRequest.md#recursive) -- [searchTerm](generated_client.ItemsApiGetItemsRequest.md#searchterm) -- [seriesStatus](generated_client.ItemsApiGetItemsRequest.md#seriesstatus) -- [sortBy](generated_client.ItemsApiGetItemsRequest.md#sortby) -- [sortOrder](generated_client.ItemsApiGetItemsRequest.md#sortorder) -- [startIndex](generated_client.ItemsApiGetItemsRequest.md#startindex) -- [studioIds](generated_client.ItemsApiGetItemsRequest.md#studioids) -- [studios](generated_client.ItemsApiGetItemsRequest.md#studios) -- [tags](generated_client.ItemsApiGetItemsRequest.md#tags) -- [userId](generated_client.ItemsApiGetItemsRequest.md#userid) -- [videoTypes](generated_client.ItemsApiGetItemsRequest.md#videotypes) -- [years](generated_client.ItemsApiGetItemsRequest.md#years) - -## Properties - -### adjacentTo - -• `Optional` `Readonly` **adjacentTo**: `string` - -Optional. Return items that are siblings of a supplied item. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1595](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1595) - -___ - -### albumArtistIds - -• `Optional` `Readonly` **albumArtistIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified album artist id. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1973](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1973) - -___ - -### albumIds - -• `Optional` `Readonly` **albumIds**: `string`[] - -Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1994](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1994) - -___ - -### albums - -• `Optional` `Readonly` **albums**: `string`[] - -Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1987](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1987) - -___ - -### artistIds - -• `Optional` `Readonly` **artistIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified artist id. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1966](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1966) - -___ - -### artists - -• `Optional` `Readonly` **artists**: `string`[] - -Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1952](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1952) - -___ - -### collapseBoxSetItems - -• `Optional` `Readonly` **collapseBoxSetItems**: `boolean` - -Whether or not to hide items behind their boxsets. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2043](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2043) - -___ - -### contributingArtistIds - -• `Optional` `Readonly` **contributingArtistIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1980](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1980) - -___ - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1917](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1917) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional, include image information in output. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2134](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2134) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Optional. Enable the total record count. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2127](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2127) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional, include user data. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1903](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1903) - -___ - -### excludeArtistIds - -• `Optional` `Readonly` **excludeArtistIds**: `string`[] - -Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1959](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1959) - -___ - -### excludeItemIds - -• `Optional` `Readonly` **excludeItemIds**: `string`[] - -Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1763](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1763) - -___ - -### excludeItemTypes - -• `Optional` `Readonly` **excludeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1819](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1819) - -___ - -### excludeLocationTypes - -• `Optional` `Readonly` **excludeLocationTypes**: [`LocationType`](../enums/generated_client.LocationType.md)[] - -Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1637](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1637) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1812](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1812) - -___ - -### filters - -• `Optional` `Readonly` **filters**: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[] - -Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1833](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1833) - -___ - -### genreIds - -• `Optional` `Readonly` **genreIds**: `string`[] - -Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2120](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2120) - -___ - -### genres - -• `Optional` `Readonly` **genres**: `string`[] - -Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1875](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1875) - -___ - -### hasImdbId - -• `Optional` `Readonly` **hasImdbId**: `boolean` - -Optional filter by items that have an imdb id or not. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1707](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1707) - -___ - -### hasOfficialRating - -• `Optional` `Readonly` **hasOfficialRating**: `boolean` - -Optional filter by items that have official ratings. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2036](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2036) - -___ - -### hasOverview - -• `Optional` `Readonly` **hasOverview**: `boolean` - -Optional filter by items that have an overview or not. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1700](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1700) - -___ - -### hasParentalRating - -• `Optional` `Readonly` **hasParentalRating**: `boolean` - -Optional filter by items that have or do not have a parental rating. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1609](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1609) - -___ - -### hasSpecialFeature - -• `Optional` `Readonly` **hasSpecialFeature**: `boolean` - -Optional filter by items with special features. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1581](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1581) - -___ - -### hasSubtitles - -• `Optional` `Readonly` **hasSubtitles**: `boolean` - -Optional filter by items with subtitles. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1574](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1574) - -___ - -### hasThemeSong - -• `Optional` `Readonly` **hasThemeSong**: `boolean` - -Optional filter by items with theme songs. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1560](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1560) - -___ - -### hasThemeVideo - -• `Optional` `Readonly` **hasThemeVideo**: `boolean` - -Optional filter by items with theme videos. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1567](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1567) - -___ - -### hasTmdbId - -• `Optional` `Readonly` **hasTmdbId**: `boolean` - -Optional filter by items that have a tmdb id or not. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1714](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1714) - -___ - -### hasTrailer - -• `Optional` `Readonly` **hasTrailer**: `boolean` - -Optional filter by items with trailers. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1588](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1588) - -___ - -### hasTvdbId - -• `Optional` `Readonly` **hasTvdbId**: `boolean` - -Optional filter by items that have a tvdb id or not. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1721](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1721) - -___ - -### ids - -• `Optional` `Readonly` **ids**: `string`[] - -Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2001](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2001) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional, the max number of images to return, per image type. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1910](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1910) - -___ - -### imageTypes - -• `Optional` `Readonly` **imageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1854](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1854) - -___ - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1826](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1826) - -___ - -### is3D - -• `Optional` `Readonly` **is3D**: `boolean` - -Optional filter by items that are 3D, or not. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2078](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2078) - -___ - -### is4K - -• `Optional` `Readonly` **is4K**: `boolean` - -Optional filter by items that are 4K or not. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1623](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1623) - -___ - -### isFavorite - -• `Optional` `Readonly` **isFavorite**: `boolean` - -Optional filter by items that are marked as favorite, or not. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1840](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1840) - -___ - -### isHd - -• `Optional` `Readonly` **isHd**: `boolean` - -Optional filter by items that are HD or not. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1616](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1616) - -___ - -### isKids - -• `Optional` `Readonly` **isKids**: `boolean` - -Optional filter for live tv kids. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1749](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1749) - -___ - -### isLocked - -• `Optional` `Readonly` **isLocked**: `boolean` - -Optional filter by items that are locked. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2022](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2022) - -___ - -### isMissing - -• `Optional` `Readonly` **isMissing**: `boolean` - -Optional filter by items that are missing episodes or not. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1644](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1644) - -___ - -### isMovie - -• `Optional` `Readonly` **isMovie**: `boolean` - -Optional filter for live tv movies. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1728](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1728) - -___ - -### isNews - -• `Optional` `Readonly` **isNews**: `boolean` - -Optional filter for live tv news. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1742](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1742) - -___ - -### isPlaceHolder - -• `Optional` `Readonly` **isPlaceHolder**: `boolean` - -Optional filter by items that are placeholders. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2029](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2029) - -___ - -### isPlayed - -• `Optional` `Readonly` **isPlayed**: `boolean` - -Optional filter by items that are played, or not. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1868](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1868) - -___ - -### isSeries - -• `Optional` `Readonly` **isSeries**: `boolean` - -Optional filter for live tv series. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1735](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1735) - -___ - -### isSports - -• `Optional` `Readonly` **isSports**: `boolean` - -Optional filter for live tv sports. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1756](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1756) - -___ - -### isUnaired - -• `Optional` `Readonly` **isUnaired**: `boolean` - -Optional filter by items that are unaired episodes or not. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1651](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1651) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1777](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1777) - -___ - -### locationTypes - -• `Optional` `Readonly` **locationTypes**: [`LocationType`](../enums/generated_client.LocationType.md)[] - -Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1630](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1630) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -Optional. Filter by the maximum height of the item. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2071](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2071) - -___ - -### maxOfficialRating - -• `Optional` `Readonly` **maxOfficialRating**: `string` - -Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1553](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1553) - -___ - -### maxPremiereDate - -• `Optional` `Readonly` **maxPremiereDate**: `string` - -Optional. The maximum premiere date. Format = ISO. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1693](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1693) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -Optional. Filter by the maximum width of the item. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2064](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2064) - -___ - -### mediaTypes - -• `Optional` `Readonly` **mediaTypes**: `string`[] - -Optional filter by MediaType. Allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1847](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1847) - -___ - -### minCommunityRating - -• `Optional` `Readonly` **minCommunityRating**: `number` - -Optional filter by minimum community rating. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1658](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1658) - -___ - -### minCriticRating - -• `Optional` `Readonly` **minCriticRating**: `number` - -Optional filter by minimum critic rating. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1665](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1665) - -___ - -### minDateLastSaved - -• `Optional` `Readonly` **minDateLastSaved**: `string` - -Optional. The minimum last saved date. Format = ISO. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1679](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1679) - -___ - -### minDateLastSavedForUser - -• `Optional` `Readonly` **minDateLastSavedForUser**: `string` - -Optional. The minimum last saved date for the current user. Format = ISO. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1686](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1686) - -___ - -### minHeight - -• `Optional` `Readonly` **minHeight**: `number` - -Optional. Filter by the minimum height of the item. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2057](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2057) - -___ - -### minOfficialRating - -• `Optional` `Readonly` **minOfficialRating**: `string` - -Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2015](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2015) - -___ - -### minPremiereDate - -• `Optional` `Readonly` **minPremiereDate**: `string` - -Optional. The minimum premiere date. Format = ISO. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1672](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1672) - -___ - -### minWidth - -• `Optional` `Readonly` **minWidth**: `number` - -Optional. Filter by the minimum width of the item. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2050](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2050) - -___ - -### nameLessThan - -• `Optional` `Readonly` **nameLessThan**: `string` - -Optional filter by items whose name is equally or lesser than a given input string. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2106](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2106) - -___ - -### nameStartsWith - -• `Optional` `Readonly` **nameStartsWith**: `string` - -Optional filter by items whose name is sorted equally than a given input string. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2099](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2099) - -___ - -### nameStartsWithOrGreater - -• `Optional` `Readonly` **nameStartsWithOrGreater**: `string` - -Optional filter by items whose name is sorted equally or greater than a given input string. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2092](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2092) - -___ - -### officialRatings - -• `Optional` `Readonly` **officialRatings**: `string`[] - -Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1882](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1882) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1805](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1805) - -___ - -### parentIndexNumber - -• `Optional` `Readonly` **parentIndexNumber**: `number` - -Optional filter by parent index number. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1602](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1602) - -___ - -### person - -• `Optional` `Readonly` **person**: `string` - -Optional. If specified, results will be filtered to include only those containing the specified person. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1924](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1924) - -___ - -### personIds - -• `Optional` `Readonly` **personIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified person id. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1931](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1931) - -___ - -### personTypes - -• `Optional` `Readonly` **personTypes**: `string`[] - -Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1938](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1938) - -___ - -### recursive - -• `Optional` `Readonly` **recursive**: `boolean` - -When searching within folders, this determines whether or not the search will be recursive. true/false. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1784](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1784) - -___ - -### searchTerm - -• `Optional` `Readonly` **searchTerm**: `string` - -Optional. Filter based on a search term. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1791](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1791) - -___ - -### seriesStatus - -• `Optional` `Readonly` **seriesStatus**: [`SeriesStatus`](../enums/generated_client.SeriesStatus.md)[] - -Optional filter by Series Status. Allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2085](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2085) - -___ - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string`[] - -Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1861](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1861) - -___ - -### sortOrder - -• `Optional` `Readonly` **sortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md)[] - -Sort Order - Ascending,Descending. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1798](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1798) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1770](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1770) - -___ - -### studioIds - -• `Optional` `Readonly` **studioIds**: `string`[] - -Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2113](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2113) - -___ - -### studios - -• `Optional` `Readonly` **studios**: `string`[] - -Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1945](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1945) - -___ - -### tags - -• `Optional` `Readonly` **tags**: `string`[] - -Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1889](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1889) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -The user id supplied as query parameter. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1546](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1546) - -___ - -### videoTypes - -• `Optional` `Readonly` **videoTypes**: [`VideoType`](../enums/generated_client.VideoType.md)[] - -Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:2008](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2008) - -___ - -### years - -• `Optional` `Readonly` **years**: `number`[] - -Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetItems - -#### Defined in - -[generated-client/api/items-api.ts:1896](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1896) diff --git a/docs/interfaces/generated_client.ItemsApiGetResumeItemsRequest.md b/docs/interfaces/generated_client.ItemsApiGetResumeItemsRequest.md deleted file mode 100644 index 71946d6dc..000000000 --- a/docs/interfaces/generated_client.ItemsApiGetResumeItemsRequest.md +++ /dev/null @@ -1,241 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemsApiGetResumeItemsRequest - -# Interface: ItemsApiGetResumeItemsRequest - -[generated-client](../modules/generated_client.md).ItemsApiGetResumeItemsRequest - -Request parameters for getResumeItems operation in ItemsApi. - -**`export`** - -**`interface`** ItemsApiGetResumeItemsRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.ItemsApiGetResumeItemsRequest.md#enableimagetypes) -- [enableImages](generated_client.ItemsApiGetResumeItemsRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.ItemsApiGetResumeItemsRequest.md#enabletotalrecordcount) -- [enableUserData](generated_client.ItemsApiGetResumeItemsRequest.md#enableuserdata) -- [excludeActiveSessions](generated_client.ItemsApiGetResumeItemsRequest.md#excludeactivesessions) -- [excludeItemTypes](generated_client.ItemsApiGetResumeItemsRequest.md#excludeitemtypes) -- [fields](generated_client.ItemsApiGetResumeItemsRequest.md#fields) -- [imageTypeLimit](generated_client.ItemsApiGetResumeItemsRequest.md#imagetypelimit) -- [includeItemTypes](generated_client.ItemsApiGetResumeItemsRequest.md#includeitemtypes) -- [limit](generated_client.ItemsApiGetResumeItemsRequest.md#limit) -- [mediaTypes](generated_client.ItemsApiGetResumeItemsRequest.md#mediatypes) -- [parentId](generated_client.ItemsApiGetResumeItemsRequest.md#parentid) -- [searchTerm](generated_client.ItemsApiGetResumeItemsRequest.md#searchterm) -- [startIndex](generated_client.ItemsApiGetResumeItemsRequest.md#startindex) -- [userId](generated_client.ItemsApiGetResumeItemsRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2813](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2813) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2841](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2841) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Optional. Enable the total record count. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2834](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2834) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2799](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2799) - -___ - -### excludeActiveSessions - -• `Optional` `Readonly` **excludeActiveSessions**: `boolean` - -Optional. Whether to exclude the currently active sessions. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2848](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2848) - -___ - -### excludeItemTypes - -• `Optional` `Readonly` **excludeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2820](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2820) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2785](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2785) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2806](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2806) - -___ - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2827](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2827) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -The item limit. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2764](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2764) - -___ - -### mediaTypes - -• `Optional` `Readonly` **mediaTypes**: `string`[] - -Optional. Filter by MediaType. Allows multiple, comma delimited. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2792](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2792) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2778](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2778) - -___ - -### searchTerm - -• `Optional` `Readonly` **searchTerm**: `string` - -The search term. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2771](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2771) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -The start index. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2757](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2757) - -___ - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** ItemsApiGetResumeItems - -#### Defined in - -[generated-client/api/items-api.ts:2750](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2750) diff --git a/docs/interfaces/generated_client.JoinGroupRequestDto.md b/docs/interfaces/generated_client.JoinGroupRequestDto.md deleted file mode 100644 index 7c88a298c..000000000 --- a/docs/interfaces/generated_client.JoinGroupRequestDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / JoinGroupRequestDto - -# Interface: JoinGroupRequestDto - -[generated-client](../modules/generated_client.md).JoinGroupRequestDto - -Class JoinGroupRequestDto. - -**`export`** - -**`interface`** JoinGroupRequestDto - -## Table of contents - -### Properties - -- [GroupId](generated_client.JoinGroupRequestDto.md#groupid) - -## Properties - -### GroupId - -• `Optional` **GroupId**: `string` - -Gets or sets the group identifier. - -**`memberof`** JoinGroupRequestDto - -#### Defined in - -[generated-client/models/join-group-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/join-group-request-dto.ts#L28) diff --git a/docs/interfaces/generated_client.LibraryApiDeleteItemRequest.md b/docs/interfaces/generated_client.LibraryApiDeleteItemRequest.md deleted file mode 100644 index 87245929a..000000000 --- a/docs/interfaces/generated_client.LibraryApiDeleteItemRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiDeleteItemRequest - -# Interface: LibraryApiDeleteItemRequest - -[generated-client](../modules/generated_client.md).LibraryApiDeleteItemRequest - -Request parameters for deleteItem operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiDeleteItemRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.LibraryApiDeleteItemRequest.md#itemid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiDeleteItem - -#### Defined in - -[generated-client/api/library-api.ts:1777](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1777) diff --git a/docs/interfaces/generated_client.LibraryApiDeleteItemsRequest.md b/docs/interfaces/generated_client.LibraryApiDeleteItemsRequest.md deleted file mode 100644 index b1e9acfbb..000000000 --- a/docs/interfaces/generated_client.LibraryApiDeleteItemsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiDeleteItemsRequest - -# Interface: LibraryApiDeleteItemsRequest - -[generated-client](../modules/generated_client.md).LibraryApiDeleteItemsRequest - -Request parameters for deleteItems operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiDeleteItemsRequest - -## Table of contents - -### Properties - -- [ids](generated_client.LibraryApiDeleteItemsRequest.md#ids) - -## Properties - -### ids - -• `Optional` `Readonly` **ids**: `string`[] - -The item ids. - -**`memberof`** LibraryApiDeleteItems - -#### Defined in - -[generated-client/api/library-api.ts:1791](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1791) diff --git a/docs/interfaces/generated_client.LibraryApiGetAncestorsRequest.md b/docs/interfaces/generated_client.LibraryApiGetAncestorsRequest.md deleted file mode 100644 index 9e4117aeb..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetAncestorsRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetAncestorsRequest - -# Interface: LibraryApiGetAncestorsRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetAncestorsRequest - -Request parameters for getAncestors operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetAncestorsRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.LibraryApiGetAncestorsRequest.md#itemid) -- [userId](generated_client.LibraryApiGetAncestorsRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiGetAncestors - -#### Defined in - -[generated-client/api/library-api.ts:1805](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1805) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** LibraryApiGetAncestors - -#### Defined in - -[generated-client/api/library-api.ts:1812](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1812) diff --git a/docs/interfaces/generated_client.LibraryApiGetCriticReviewsRequest.md b/docs/interfaces/generated_client.LibraryApiGetCriticReviewsRequest.md deleted file mode 100644 index 718d1ad76..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetCriticReviewsRequest.md +++ /dev/null @@ -1,29 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetCriticReviewsRequest - -# Interface: LibraryApiGetCriticReviewsRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetCriticReviewsRequest - -Request parameters for getCriticReviews operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetCriticReviewsRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.LibraryApiGetCriticReviewsRequest.md#itemid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -**`memberof`** LibraryApiGetCriticReviews - -#### Defined in - -[generated-client/api/library-api.ts:1826](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1826) diff --git a/docs/interfaces/generated_client.LibraryApiGetDownloadRequest.md b/docs/interfaces/generated_client.LibraryApiGetDownloadRequest.md deleted file mode 100644 index 29b1ac943..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetDownloadRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetDownloadRequest - -# Interface: LibraryApiGetDownloadRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetDownloadRequest - -Request parameters for getDownload operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetDownloadRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.LibraryApiGetDownloadRequest.md#itemid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiGetDownload - -#### Defined in - -[generated-client/api/library-api.ts:1840](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1840) diff --git a/docs/interfaces/generated_client.LibraryApiGetFileRequest.md b/docs/interfaces/generated_client.LibraryApiGetFileRequest.md deleted file mode 100644 index 7d28d3271..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetFileRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetFileRequest - -# Interface: LibraryApiGetFileRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetFileRequest - -Request parameters for getFile operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetFileRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.LibraryApiGetFileRequest.md#itemid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiGetFile - -#### Defined in - -[generated-client/api/library-api.ts:1854](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1854) diff --git a/docs/interfaces/generated_client.LibraryApiGetItemCountsRequest.md b/docs/interfaces/generated_client.LibraryApiGetItemCountsRequest.md deleted file mode 100644 index 273755942..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetItemCountsRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetItemCountsRequest - -# Interface: LibraryApiGetItemCountsRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetItemCountsRequest - -Request parameters for getItemCounts operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetItemCountsRequest - -## Table of contents - -### Properties - -- [isFavorite](generated_client.LibraryApiGetItemCountsRequest.md#isfavorite) -- [userId](generated_client.LibraryApiGetItemCountsRequest.md#userid) - -## Properties - -### isFavorite - -• `Optional` `Readonly` **isFavorite**: `boolean` - -Optional. Get counts of favorite items. - -**`memberof`** LibraryApiGetItemCounts - -#### Defined in - -[generated-client/api/library-api.ts:1875](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1875) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Get counts from a specific user\'s library. - -**`memberof`** LibraryApiGetItemCounts - -#### Defined in - -[generated-client/api/library-api.ts:1868](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1868) diff --git a/docs/interfaces/generated_client.LibraryApiGetLibraryOptionsInfoRequest.md b/docs/interfaces/generated_client.LibraryApiGetLibraryOptionsInfoRequest.md deleted file mode 100644 index 0eb1d147d..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetLibraryOptionsInfoRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetLibraryOptionsInfoRequest - -# Interface: LibraryApiGetLibraryOptionsInfoRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetLibraryOptionsInfoRequest - -Request parameters for getLibraryOptionsInfo operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetLibraryOptionsInfoRequest - -## Table of contents - -### Properties - -- [isNewLibrary](generated_client.LibraryApiGetLibraryOptionsInfoRequest.md#isnewlibrary) -- [libraryContentType](generated_client.LibraryApiGetLibraryOptionsInfoRequest.md#librarycontenttype) - -## Properties - -### isNewLibrary - -• `Optional` `Readonly` **isNewLibrary**: `boolean` - -Whether this is a new library. - -**`memberof`** LibraryApiGetLibraryOptionsInfo - -#### Defined in - -[generated-client/api/library-api.ts:1896](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1896) - -___ - -### libraryContentType - -• `Optional` `Readonly` **libraryContentType**: `string` - -Library content type. - -**`memberof`** LibraryApiGetLibraryOptionsInfo - -#### Defined in - -[generated-client/api/library-api.ts:1889](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1889) diff --git a/docs/interfaces/generated_client.LibraryApiGetMediaFoldersRequest.md b/docs/interfaces/generated_client.LibraryApiGetMediaFoldersRequest.md deleted file mode 100644 index 6419f15a6..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetMediaFoldersRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetMediaFoldersRequest - -# Interface: LibraryApiGetMediaFoldersRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetMediaFoldersRequest - -Request parameters for getMediaFolders operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetMediaFoldersRequest - -## Table of contents - -### Properties - -- [isHidden](generated_client.LibraryApiGetMediaFoldersRequest.md#ishidden) - -## Properties - -### isHidden - -• `Optional` `Readonly` **isHidden**: `boolean` - -Optional. Filter by folders that are marked hidden, or not. - -**`memberof`** LibraryApiGetMediaFolders - -#### Defined in - -[generated-client/api/library-api.ts:1910](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1910) diff --git a/docs/interfaces/generated_client.LibraryApiGetSimilarAlbumsRequest.md b/docs/interfaces/generated_client.LibraryApiGetSimilarAlbumsRequest.md deleted file mode 100644 index 6c3650846..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetSimilarAlbumsRequest.md +++ /dev/null @@ -1,91 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetSimilarAlbumsRequest - -# Interface: LibraryApiGetSimilarAlbumsRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetSimilarAlbumsRequest - -Request parameters for getSimilarAlbums operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetSimilarAlbumsRequest - -## Table of contents - -### Properties - -- [excludeArtistIds](generated_client.LibraryApiGetSimilarAlbumsRequest.md#excludeartistids) -- [fields](generated_client.LibraryApiGetSimilarAlbumsRequest.md#fields) -- [itemId](generated_client.LibraryApiGetSimilarAlbumsRequest.md#itemid) -- [limit](generated_client.LibraryApiGetSimilarAlbumsRequest.md#limit) -- [userId](generated_client.LibraryApiGetSimilarAlbumsRequest.md#userid) - -## Properties - -### excludeArtistIds - -• `Optional` `Readonly` **excludeArtistIds**: `string`[] - -Exclude artist ids. - -**`memberof`** LibraryApiGetSimilarAlbums - -#### Defined in - -[generated-client/api/library-api.ts:1931](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1931) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. - -**`memberof`** LibraryApiGetSimilarAlbums - -#### Defined in - -[generated-client/api/library-api.ts:1952](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1952) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiGetSimilarAlbums - -#### Defined in - -[generated-client/api/library-api.ts:1924](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1924) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** LibraryApiGetSimilarAlbums - -#### Defined in - -[generated-client/api/library-api.ts:1945](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1945) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** LibraryApiGetSimilarAlbums - -#### Defined in - -[generated-client/api/library-api.ts:1938](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1938) diff --git a/docs/interfaces/generated_client.LibraryApiGetSimilarArtistsRequest.md b/docs/interfaces/generated_client.LibraryApiGetSimilarArtistsRequest.md deleted file mode 100644 index 418b5fa19..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetSimilarArtistsRequest.md +++ /dev/null @@ -1,91 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetSimilarArtistsRequest - -# Interface: LibraryApiGetSimilarArtistsRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetSimilarArtistsRequest - -Request parameters for getSimilarArtists operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetSimilarArtistsRequest - -## Table of contents - -### Properties - -- [excludeArtistIds](generated_client.LibraryApiGetSimilarArtistsRequest.md#excludeartistids) -- [fields](generated_client.LibraryApiGetSimilarArtistsRequest.md#fields) -- [itemId](generated_client.LibraryApiGetSimilarArtistsRequest.md#itemid) -- [limit](generated_client.LibraryApiGetSimilarArtistsRequest.md#limit) -- [userId](generated_client.LibraryApiGetSimilarArtistsRequest.md#userid) - -## Properties - -### excludeArtistIds - -• `Optional` `Readonly` **excludeArtistIds**: `string`[] - -Exclude artist ids. - -**`memberof`** LibraryApiGetSimilarArtists - -#### Defined in - -[generated-client/api/library-api.ts:1973](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1973) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. - -**`memberof`** LibraryApiGetSimilarArtists - -#### Defined in - -[generated-client/api/library-api.ts:1994](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1994) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiGetSimilarArtists - -#### Defined in - -[generated-client/api/library-api.ts:1966](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1966) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** LibraryApiGetSimilarArtists - -#### Defined in - -[generated-client/api/library-api.ts:1987](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1987) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** LibraryApiGetSimilarArtists - -#### Defined in - -[generated-client/api/library-api.ts:1980](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1980) diff --git a/docs/interfaces/generated_client.LibraryApiGetSimilarItemsRequest.md b/docs/interfaces/generated_client.LibraryApiGetSimilarItemsRequest.md deleted file mode 100644 index 1eae844bf..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetSimilarItemsRequest.md +++ /dev/null @@ -1,91 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetSimilarItemsRequest - -# Interface: LibraryApiGetSimilarItemsRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetSimilarItemsRequest - -Request parameters for getSimilarItems operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetSimilarItemsRequest - -## Table of contents - -### Properties - -- [excludeArtistIds](generated_client.LibraryApiGetSimilarItemsRequest.md#excludeartistids) -- [fields](generated_client.LibraryApiGetSimilarItemsRequest.md#fields) -- [itemId](generated_client.LibraryApiGetSimilarItemsRequest.md#itemid) -- [limit](generated_client.LibraryApiGetSimilarItemsRequest.md#limit) -- [userId](generated_client.LibraryApiGetSimilarItemsRequest.md#userid) - -## Properties - -### excludeArtistIds - -• `Optional` `Readonly` **excludeArtistIds**: `string`[] - -Exclude artist ids. - -**`memberof`** LibraryApiGetSimilarItems - -#### Defined in - -[generated-client/api/library-api.ts:2015](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2015) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. - -**`memberof`** LibraryApiGetSimilarItems - -#### Defined in - -[generated-client/api/library-api.ts:2036](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2036) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiGetSimilarItems - -#### Defined in - -[generated-client/api/library-api.ts:2008](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2008) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** LibraryApiGetSimilarItems - -#### Defined in - -[generated-client/api/library-api.ts:2029](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2029) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** LibraryApiGetSimilarItems - -#### Defined in - -[generated-client/api/library-api.ts:2022](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2022) diff --git a/docs/interfaces/generated_client.LibraryApiGetSimilarMoviesRequest.md b/docs/interfaces/generated_client.LibraryApiGetSimilarMoviesRequest.md deleted file mode 100644 index fa43ea1d7..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetSimilarMoviesRequest.md +++ /dev/null @@ -1,91 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetSimilarMoviesRequest - -# Interface: LibraryApiGetSimilarMoviesRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetSimilarMoviesRequest - -Request parameters for getSimilarMovies operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetSimilarMoviesRequest - -## Table of contents - -### Properties - -- [excludeArtistIds](generated_client.LibraryApiGetSimilarMoviesRequest.md#excludeartistids) -- [fields](generated_client.LibraryApiGetSimilarMoviesRequest.md#fields) -- [itemId](generated_client.LibraryApiGetSimilarMoviesRequest.md#itemid) -- [limit](generated_client.LibraryApiGetSimilarMoviesRequest.md#limit) -- [userId](generated_client.LibraryApiGetSimilarMoviesRequest.md#userid) - -## Properties - -### excludeArtistIds - -• `Optional` `Readonly` **excludeArtistIds**: `string`[] - -Exclude artist ids. - -**`memberof`** LibraryApiGetSimilarMovies - -#### Defined in - -[generated-client/api/library-api.ts:2057](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2057) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. - -**`memberof`** LibraryApiGetSimilarMovies - -#### Defined in - -[generated-client/api/library-api.ts:2078](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2078) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiGetSimilarMovies - -#### Defined in - -[generated-client/api/library-api.ts:2050](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2050) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** LibraryApiGetSimilarMovies - -#### Defined in - -[generated-client/api/library-api.ts:2071](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2071) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** LibraryApiGetSimilarMovies - -#### Defined in - -[generated-client/api/library-api.ts:2064](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2064) diff --git a/docs/interfaces/generated_client.LibraryApiGetSimilarShowsRequest.md b/docs/interfaces/generated_client.LibraryApiGetSimilarShowsRequest.md deleted file mode 100644 index cde707121..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetSimilarShowsRequest.md +++ /dev/null @@ -1,91 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetSimilarShowsRequest - -# Interface: LibraryApiGetSimilarShowsRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetSimilarShowsRequest - -Request parameters for getSimilarShows operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetSimilarShowsRequest - -## Table of contents - -### Properties - -- [excludeArtistIds](generated_client.LibraryApiGetSimilarShowsRequest.md#excludeartistids) -- [fields](generated_client.LibraryApiGetSimilarShowsRequest.md#fields) -- [itemId](generated_client.LibraryApiGetSimilarShowsRequest.md#itemid) -- [limit](generated_client.LibraryApiGetSimilarShowsRequest.md#limit) -- [userId](generated_client.LibraryApiGetSimilarShowsRequest.md#userid) - -## Properties - -### excludeArtistIds - -• `Optional` `Readonly` **excludeArtistIds**: `string`[] - -Exclude artist ids. - -**`memberof`** LibraryApiGetSimilarShows - -#### Defined in - -[generated-client/api/library-api.ts:2099](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2099) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. - -**`memberof`** LibraryApiGetSimilarShows - -#### Defined in - -[generated-client/api/library-api.ts:2120](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2120) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiGetSimilarShows - -#### Defined in - -[generated-client/api/library-api.ts:2092](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2092) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** LibraryApiGetSimilarShows - -#### Defined in - -[generated-client/api/library-api.ts:2113](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2113) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** LibraryApiGetSimilarShows - -#### Defined in - -[generated-client/api/library-api.ts:2106](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2106) diff --git a/docs/interfaces/generated_client.LibraryApiGetSimilarTrailersRequest.md b/docs/interfaces/generated_client.LibraryApiGetSimilarTrailersRequest.md deleted file mode 100644 index 325fddefa..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetSimilarTrailersRequest.md +++ /dev/null @@ -1,91 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetSimilarTrailersRequest - -# Interface: LibraryApiGetSimilarTrailersRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetSimilarTrailersRequest - -Request parameters for getSimilarTrailers operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetSimilarTrailersRequest - -## Table of contents - -### Properties - -- [excludeArtistIds](generated_client.LibraryApiGetSimilarTrailersRequest.md#excludeartistids) -- [fields](generated_client.LibraryApiGetSimilarTrailersRequest.md#fields) -- [itemId](generated_client.LibraryApiGetSimilarTrailersRequest.md#itemid) -- [limit](generated_client.LibraryApiGetSimilarTrailersRequest.md#limit) -- [userId](generated_client.LibraryApiGetSimilarTrailersRequest.md#userid) - -## Properties - -### excludeArtistIds - -• `Optional` `Readonly` **excludeArtistIds**: `string`[] - -Exclude artist ids. - -**`memberof`** LibraryApiGetSimilarTrailers - -#### Defined in - -[generated-client/api/library-api.ts:2141](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2141) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. - -**`memberof`** LibraryApiGetSimilarTrailers - -#### Defined in - -[generated-client/api/library-api.ts:2162](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2162) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiGetSimilarTrailers - -#### Defined in - -[generated-client/api/library-api.ts:2134](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2134) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** LibraryApiGetSimilarTrailers - -#### Defined in - -[generated-client/api/library-api.ts:2155](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2155) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** LibraryApiGetSimilarTrailers - -#### Defined in - -[generated-client/api/library-api.ts:2148](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2148) diff --git a/docs/interfaces/generated_client.LibraryApiGetThemeMediaRequest.md b/docs/interfaces/generated_client.LibraryApiGetThemeMediaRequest.md deleted file mode 100644 index 2318476ec..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetThemeMediaRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetThemeMediaRequest - -# Interface: LibraryApiGetThemeMediaRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetThemeMediaRequest - -Request parameters for getThemeMedia operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetThemeMediaRequest - -## Table of contents - -### Properties - -- [inheritFromParent](generated_client.LibraryApiGetThemeMediaRequest.md#inheritfromparent) -- [itemId](generated_client.LibraryApiGetThemeMediaRequest.md#itemid) -- [userId](generated_client.LibraryApiGetThemeMediaRequest.md#userid) - -## Properties - -### inheritFromParent - -• `Optional` `Readonly` **inheritFromParent**: `boolean` - -Optional. Determines whether or not parent items should be searched for theme media. - -**`memberof`** LibraryApiGetThemeMedia - -#### Defined in - -[generated-client/api/library-api.ts:2190](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2190) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiGetThemeMedia - -#### Defined in - -[generated-client/api/library-api.ts:2176](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2176) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** LibraryApiGetThemeMedia - -#### Defined in - -[generated-client/api/library-api.ts:2183](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2183) diff --git a/docs/interfaces/generated_client.LibraryApiGetThemeSongsRequest.md b/docs/interfaces/generated_client.LibraryApiGetThemeSongsRequest.md deleted file mode 100644 index f1d6cce59..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetThemeSongsRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetThemeSongsRequest - -# Interface: LibraryApiGetThemeSongsRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetThemeSongsRequest - -Request parameters for getThemeSongs operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetThemeSongsRequest - -## Table of contents - -### Properties - -- [inheritFromParent](generated_client.LibraryApiGetThemeSongsRequest.md#inheritfromparent) -- [itemId](generated_client.LibraryApiGetThemeSongsRequest.md#itemid) -- [userId](generated_client.LibraryApiGetThemeSongsRequest.md#userid) - -## Properties - -### inheritFromParent - -• `Optional` `Readonly` **inheritFromParent**: `boolean` - -Optional. Determines whether or not parent items should be searched for theme media. - -**`memberof`** LibraryApiGetThemeSongs - -#### Defined in - -[generated-client/api/library-api.ts:2218](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2218) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiGetThemeSongs - -#### Defined in - -[generated-client/api/library-api.ts:2204](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2204) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** LibraryApiGetThemeSongs - -#### Defined in - -[generated-client/api/library-api.ts:2211](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2211) diff --git a/docs/interfaces/generated_client.LibraryApiGetThemeVideosRequest.md b/docs/interfaces/generated_client.LibraryApiGetThemeVideosRequest.md deleted file mode 100644 index 79361abad..000000000 --- a/docs/interfaces/generated_client.LibraryApiGetThemeVideosRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiGetThemeVideosRequest - -# Interface: LibraryApiGetThemeVideosRequest - -[generated-client](../modules/generated_client.md).LibraryApiGetThemeVideosRequest - -Request parameters for getThemeVideos operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiGetThemeVideosRequest - -## Table of contents - -### Properties - -- [inheritFromParent](generated_client.LibraryApiGetThemeVideosRequest.md#inheritfromparent) -- [itemId](generated_client.LibraryApiGetThemeVideosRequest.md#itemid) -- [userId](generated_client.LibraryApiGetThemeVideosRequest.md#userid) - -## Properties - -### inheritFromParent - -• `Optional` `Readonly` **inheritFromParent**: `boolean` - -Optional. Determines whether or not parent items should be searched for theme media. - -**`memberof`** LibraryApiGetThemeVideos - -#### Defined in - -[generated-client/api/library-api.ts:2246](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2246) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** LibraryApiGetThemeVideos - -#### Defined in - -[generated-client/api/library-api.ts:2232](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2232) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** LibraryApiGetThemeVideos - -#### Defined in - -[generated-client/api/library-api.ts:2239](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2239) diff --git a/docs/interfaces/generated_client.LibraryApiPostAddedMoviesRequest.md b/docs/interfaces/generated_client.LibraryApiPostAddedMoviesRequest.md deleted file mode 100644 index 32382b537..000000000 --- a/docs/interfaces/generated_client.LibraryApiPostAddedMoviesRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiPostAddedMoviesRequest - -# Interface: LibraryApiPostAddedMoviesRequest - -[generated-client](../modules/generated_client.md).LibraryApiPostAddedMoviesRequest - -Request parameters for postAddedMovies operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiPostAddedMoviesRequest - -## Table of contents - -### Properties - -- [imdbId](generated_client.LibraryApiPostAddedMoviesRequest.md#imdbid) -- [tmdbId](generated_client.LibraryApiPostAddedMoviesRequest.md#tmdbid) - -## Properties - -### imdbId - -• `Optional` `Readonly` **imdbId**: `string` - -The imdbId. - -**`memberof`** LibraryApiPostAddedMovies - -#### Defined in - -[generated-client/api/library-api.ts:2267](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2267) - -___ - -### tmdbId - -• `Optional` `Readonly` **tmdbId**: `string` - -The tmdbId. - -**`memberof`** LibraryApiPostAddedMovies - -#### Defined in - -[generated-client/api/library-api.ts:2260](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2260) diff --git a/docs/interfaces/generated_client.LibraryApiPostAddedSeriesRequest.md b/docs/interfaces/generated_client.LibraryApiPostAddedSeriesRequest.md deleted file mode 100644 index 1ece42ee1..000000000 --- a/docs/interfaces/generated_client.LibraryApiPostAddedSeriesRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiPostAddedSeriesRequest - -# Interface: LibraryApiPostAddedSeriesRequest - -[generated-client](../modules/generated_client.md).LibraryApiPostAddedSeriesRequest - -Request parameters for postAddedSeries operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiPostAddedSeriesRequest - -## Table of contents - -### Properties - -- [tvdbId](generated_client.LibraryApiPostAddedSeriesRequest.md#tvdbid) - -## Properties - -### tvdbId - -• `Optional` `Readonly` **tvdbId**: `string` - -The tvdbId. - -**`memberof`** LibraryApiPostAddedSeries - -#### Defined in - -[generated-client/api/library-api.ts:2281](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2281) diff --git a/docs/interfaces/generated_client.LibraryApiPostUpdatedMediaRequest.md b/docs/interfaces/generated_client.LibraryApiPostUpdatedMediaRequest.md deleted file mode 100644 index 1872159b1..000000000 --- a/docs/interfaces/generated_client.LibraryApiPostUpdatedMediaRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiPostUpdatedMediaRequest - -# Interface: LibraryApiPostUpdatedMediaRequest - -[generated-client](../modules/generated_client.md).LibraryApiPostUpdatedMediaRequest - -Request parameters for postUpdatedMedia operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiPostUpdatedMediaRequest - -## Table of contents - -### Properties - -- [mediaUpdateInfoDto](generated_client.LibraryApiPostUpdatedMediaRequest.md#mediaupdateinfodto) - -## Properties - -### mediaUpdateInfoDto - -• `Readonly` **mediaUpdateInfoDto**: [`MediaUpdateInfoDto`](generated_client.MediaUpdateInfoDto.md) - -The update paths. - -**`memberof`** LibraryApiPostUpdatedMedia - -#### Defined in - -[generated-client/api/library-api.ts:2295](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2295) diff --git a/docs/interfaces/generated_client.LibraryApiPostUpdatedMoviesRequest.md b/docs/interfaces/generated_client.LibraryApiPostUpdatedMoviesRequest.md deleted file mode 100644 index 4817ccd8c..000000000 --- a/docs/interfaces/generated_client.LibraryApiPostUpdatedMoviesRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiPostUpdatedMoviesRequest - -# Interface: LibraryApiPostUpdatedMoviesRequest - -[generated-client](../modules/generated_client.md).LibraryApiPostUpdatedMoviesRequest - -Request parameters for postUpdatedMovies operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiPostUpdatedMoviesRequest - -## Table of contents - -### Properties - -- [imdbId](generated_client.LibraryApiPostUpdatedMoviesRequest.md#imdbid) -- [tmdbId](generated_client.LibraryApiPostUpdatedMoviesRequest.md#tmdbid) - -## Properties - -### imdbId - -• `Optional` `Readonly` **imdbId**: `string` - -The imdbId. - -**`memberof`** LibraryApiPostUpdatedMovies - -#### Defined in - -[generated-client/api/library-api.ts:2316](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2316) - -___ - -### tmdbId - -• `Optional` `Readonly` **tmdbId**: `string` - -The tmdbId. - -**`memberof`** LibraryApiPostUpdatedMovies - -#### Defined in - -[generated-client/api/library-api.ts:2309](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2309) diff --git a/docs/interfaces/generated_client.LibraryApiPostUpdatedSeriesRequest.md b/docs/interfaces/generated_client.LibraryApiPostUpdatedSeriesRequest.md deleted file mode 100644 index 8819056a2..000000000 --- a/docs/interfaces/generated_client.LibraryApiPostUpdatedSeriesRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApiPostUpdatedSeriesRequest - -# Interface: LibraryApiPostUpdatedSeriesRequest - -[generated-client](../modules/generated_client.md).LibraryApiPostUpdatedSeriesRequest - -Request parameters for postUpdatedSeries operation in LibraryApi. - -**`export`** - -**`interface`** LibraryApiPostUpdatedSeriesRequest - -## Table of contents - -### Properties - -- [tvdbId](generated_client.LibraryApiPostUpdatedSeriesRequest.md#tvdbid) - -## Properties - -### tvdbId - -• `Optional` `Readonly` **tvdbId**: `string` - -The tvdbId. - -**`memberof`** LibraryApiPostUpdatedSeries - -#### Defined in - -[generated-client/api/library-api.ts:2330](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2330) diff --git a/docs/interfaces/generated_client.LibraryOptionInfoDto.md b/docs/interfaces/generated_client.LibraryOptionInfoDto.md deleted file mode 100644 index 483234c6e..000000000 --- a/docs/interfaces/generated_client.LibraryOptionInfoDto.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryOptionInfoDto - -# Interface: LibraryOptionInfoDto - -[generated-client](../modules/generated_client.md).LibraryOptionInfoDto - -Library option info dto. - -**`export`** - -**`interface`** LibraryOptionInfoDto - -## Table of contents - -### Properties - -- [DefaultEnabled](generated_client.LibraryOptionInfoDto.md#defaultenabled) -- [Name](generated_client.LibraryOptionInfoDto.md#name) - -## Properties - -### DefaultEnabled - -• `Optional` **DefaultEnabled**: `boolean` - -Gets or sets a value indicating whether default enabled. - -**`memberof`** LibraryOptionInfoDto - -#### Defined in - -[generated-client/models/library-option-info-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-option-info-dto.ts#L34) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets name. - -**`memberof`** LibraryOptionInfoDto - -#### Defined in - -[generated-client/models/library-option-info-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-option-info-dto.ts#L28) diff --git a/docs/interfaces/generated_client.LibraryOptions.md b/docs/interfaces/generated_client.LibraryOptions.md deleted file mode 100644 index 223168ea8..000000000 --- a/docs/interfaces/generated_client.LibraryOptions.md +++ /dev/null @@ -1,371 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryOptions - -# Interface: LibraryOptions - -[generated-client](../modules/generated_client.md).LibraryOptions - -**`export`** - -**`interface`** LibraryOptions - -## Table of contents - -### Properties - -- [AllowEmbeddedSubtitles](generated_client.LibraryOptions.md#allowembeddedsubtitles) -- [AutomaticRefreshIntervalDays](generated_client.LibraryOptions.md#automaticrefreshintervaldays) -- [AutomaticallyAddToCollection](generated_client.LibraryOptions.md#automaticallyaddtocollection) -- [DisabledLocalMetadataReaders](generated_client.LibraryOptions.md#disabledlocalmetadatareaders) -- [DisabledSubtitleFetchers](generated_client.LibraryOptions.md#disabledsubtitlefetchers) -- [EnableAutomaticSeriesGrouping](generated_client.LibraryOptions.md#enableautomaticseriesgrouping) -- [EnableChapterImageExtraction](generated_client.LibraryOptions.md#enablechapterimageextraction) -- [EnableEmbeddedEpisodeInfos](generated_client.LibraryOptions.md#enableembeddedepisodeinfos) -- [EnableEmbeddedTitles](generated_client.LibraryOptions.md#enableembeddedtitles) -- [EnableInternetProviders](generated_client.LibraryOptions.md#enableinternetproviders) -- [EnablePhotos](generated_client.LibraryOptions.md#enablephotos) -- [EnableRealtimeMonitor](generated_client.LibraryOptions.md#enablerealtimemonitor) -- [ExtractChapterImagesDuringLibraryScan](generated_client.LibraryOptions.md#extractchapterimagesduringlibraryscan) -- [LocalMetadataReaderOrder](generated_client.LibraryOptions.md#localmetadatareaderorder) -- [MetadataCountryCode](generated_client.LibraryOptions.md#metadatacountrycode) -- [MetadataSavers](generated_client.LibraryOptions.md#metadatasavers) -- [PathInfos](generated_client.LibraryOptions.md#pathinfos) -- [PreferredMetadataLanguage](generated_client.LibraryOptions.md#preferredmetadatalanguage) -- [RequirePerfectSubtitleMatch](generated_client.LibraryOptions.md#requireperfectsubtitlematch) -- [SaveLocalMetadata](generated_client.LibraryOptions.md#savelocalmetadata) -- [SaveSubtitlesWithMedia](generated_client.LibraryOptions.md#savesubtitleswithmedia) -- [SeasonZeroDisplayName](generated_client.LibraryOptions.md#seasonzerodisplayname) -- [SkipSubtitlesIfAudioTrackMatches](generated_client.LibraryOptions.md#skipsubtitlesifaudiotrackmatches) -- [SkipSubtitlesIfEmbeddedSubtitlesPresent](generated_client.LibraryOptions.md#skipsubtitlesifembeddedsubtitlespresent) -- [SubtitleDownloadLanguages](generated_client.LibraryOptions.md#subtitledownloadlanguages) -- [SubtitleFetcherOrder](generated_client.LibraryOptions.md#subtitlefetcherorder) -- [TypeOptions](generated_client.LibraryOptions.md#typeoptions) - -## Properties - -### AllowEmbeddedSubtitles - -• `Optional` **AllowEmbeddedSubtitles**: [`EmbeddedSubtitleOptions`](../enums/generated_client.EmbeddedSubtitleOptions.md) - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:182](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L182) - -___ - -### AutomaticRefreshIntervalDays - -• `Optional` **AutomaticRefreshIntervalDays**: `number` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:92](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L92) - -___ - -### AutomaticallyAddToCollection - -• `Optional` **AutomaticallyAddToCollection**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:176](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L176) - -___ - -### DisabledLocalMetadataReaders - -• `Optional` **DisabledLocalMetadataReaders**: `string`[] - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:122](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L122) - -___ - -### DisabledSubtitleFetchers - -• `Optional` **DisabledSubtitleFetchers**: `string`[] - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:134](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L134) - -___ - -### EnableAutomaticSeriesGrouping - -• `Optional` **EnableAutomaticSeriesGrouping**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:74](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L74) - -___ - -### EnableChapterImageExtraction - -• `Optional` **EnableChapterImageExtraction**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L43) - -___ - -### EnableEmbeddedEpisodeInfos - -• `Optional` **EnableEmbeddedEpisodeInfos**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:86](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L86) - -___ - -### EnableEmbeddedTitles - -• `Optional` **EnableEmbeddedTitles**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:80](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L80) - -___ - -### EnableInternetProviders - -• `Optional` **EnableInternetProviders**: `boolean` - -**`memberof`** LibraryOptions - -**`deprecated`** - -#### Defined in - -[generated-client/models/library-options.ts:68](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L68) - -___ - -### EnablePhotos - -• `Optional` **EnablePhotos**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L31) - -___ - -### EnableRealtimeMonitor - -• `Optional` **EnableRealtimeMonitor**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L37) - -___ - -### ExtractChapterImagesDuringLibraryScan - -• `Optional` **ExtractChapterImagesDuringLibraryScan**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L49) - -___ - -### LocalMetadataReaderOrder - -• `Optional` **LocalMetadataReaderOrder**: ``null`` \| `string`[] - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:128](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L128) - -___ - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: ``null`` \| `string` - -Gets or sets the metadata country code. - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:104](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L104) - -___ - -### MetadataSavers - -• `Optional` **MetadataSavers**: ``null`` \| `string`[] - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:116](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L116) - -___ - -### PathInfos - -• `Optional` **PathInfos**: [`MediaPathInfo`](generated_client.MediaPathInfo.md)[] - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L55) - -___ - -### PreferredMetadataLanguage - -• `Optional` **PreferredMetadataLanguage**: ``null`` \| `string` - -Gets or sets the preferred metadata language. - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:98](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L98) - -___ - -### RequirePerfectSubtitleMatch - -• `Optional` **RequirePerfectSubtitleMatch**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:164](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L164) - -___ - -### SaveLocalMetadata - -• `Optional` **SaveLocalMetadata**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:61](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L61) - -___ - -### SaveSubtitlesWithMedia - -• `Optional` **SaveSubtitlesWithMedia**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:170](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L170) - -___ - -### SeasonZeroDisplayName - -• `Optional` **SeasonZeroDisplayName**: `string` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:110](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L110) - -___ - -### SkipSubtitlesIfAudioTrackMatches - -• `Optional` **SkipSubtitlesIfAudioTrackMatches**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:152](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L152) - -___ - -### SkipSubtitlesIfEmbeddedSubtitlesPresent - -• `Optional` **SkipSubtitlesIfEmbeddedSubtitlesPresent**: `boolean` - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:146](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L146) - -___ - -### SubtitleDownloadLanguages - -• `Optional` **SubtitleDownloadLanguages**: ``null`` \| `string`[] - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:158](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L158) - -___ - -### SubtitleFetcherOrder - -• `Optional` **SubtitleFetcherOrder**: `string`[] - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:140](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L140) - -___ - -### TypeOptions - -• `Optional` **TypeOptions**: [`TypeOptions`](generated_client.TypeOptions.md)[] - -**`memberof`** LibraryOptions - -#### Defined in - -[generated-client/models/library-options.ts:188](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options.ts#L188) diff --git a/docs/interfaces/generated_client.LibraryOptionsResultDto.md b/docs/interfaces/generated_client.LibraryOptionsResultDto.md deleted file mode 100644 index d6e57f81b..000000000 --- a/docs/interfaces/generated_client.LibraryOptionsResultDto.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryOptionsResultDto - -# Interface: LibraryOptionsResultDto - -[generated-client](../modules/generated_client.md).LibraryOptionsResultDto - -Library options result dto. - -**`export`** - -**`interface`** LibraryOptionsResultDto - -## Table of contents - -### Properties - -- [MetadataReaders](generated_client.LibraryOptionsResultDto.md#metadatareaders) -- [MetadataSavers](generated_client.LibraryOptionsResultDto.md#metadatasavers) -- [SubtitleFetchers](generated_client.LibraryOptionsResultDto.md#subtitlefetchers) -- [TypeOptions](generated_client.LibraryOptionsResultDto.md#typeoptions) - -## Properties - -### MetadataReaders - -• `Optional` **MetadataReaders**: [`LibraryOptionInfoDto`](generated_client.LibraryOptionInfoDto.md)[] - -Gets or sets the metadata readers. - -**`memberof`** LibraryOptionsResultDto - -#### Defined in - -[generated-client/models/library-options-result-dto.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options-result-dto.ts#L36) - -___ - -### MetadataSavers - -• `Optional` **MetadataSavers**: [`LibraryOptionInfoDto`](generated_client.LibraryOptionInfoDto.md)[] - -Gets or sets the metadata savers. - -**`memberof`** LibraryOptionsResultDto - -#### Defined in - -[generated-client/models/library-options-result-dto.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options-result-dto.ts#L30) - -___ - -### SubtitleFetchers - -• `Optional` **SubtitleFetchers**: [`LibraryOptionInfoDto`](generated_client.LibraryOptionInfoDto.md)[] - -Gets or sets the subtitle fetchers. - -**`memberof`** LibraryOptionsResultDto - -#### Defined in - -[generated-client/models/library-options-result-dto.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options-result-dto.ts#L42) - -___ - -### TypeOptions - -• `Optional` **TypeOptions**: [`LibraryTypeOptionsDto`](generated_client.LibraryTypeOptionsDto.md)[] - -Gets or sets the type options. - -**`memberof`** LibraryOptionsResultDto - -#### Defined in - -[generated-client/models/library-options-result-dto.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-options-result-dto.ts#L48) diff --git a/docs/interfaces/generated_client.LibraryStructureApiAddMediaPathRequest.md b/docs/interfaces/generated_client.LibraryStructureApiAddMediaPathRequest.md deleted file mode 100644 index ad6157d16..000000000 --- a/docs/interfaces/generated_client.LibraryStructureApiAddMediaPathRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryStructureApiAddMediaPathRequest - -# Interface: LibraryStructureApiAddMediaPathRequest - -[generated-client](../modules/generated_client.md).LibraryStructureApiAddMediaPathRequest - -Request parameters for addMediaPath operation in LibraryStructureApi. - -**`export`** - -**`interface`** LibraryStructureApiAddMediaPathRequest - -## Table of contents - -### Properties - -- [mediaPathDto](generated_client.LibraryStructureApiAddMediaPathRequest.md#mediapathdto) -- [refreshLibrary](generated_client.LibraryStructureApiAddMediaPathRequest.md#refreshlibrary) - -## Properties - -### mediaPathDto - -• `Readonly` **mediaPathDto**: [`MediaPathDto`](generated_client.MediaPathDto.md) - -The media path dto. - -**`memberof`** LibraryStructureApiAddMediaPath - -#### Defined in - -[generated-client/api/library-structure-api.ts:612](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L612) - -___ - -### refreshLibrary - -• `Optional` `Readonly` **refreshLibrary**: `boolean` - -Whether to refresh the library. - -**`memberof`** LibraryStructureApiAddMediaPath - -#### Defined in - -[generated-client/api/library-structure-api.ts:619](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L619) diff --git a/docs/interfaces/generated_client.LibraryStructureApiAddVirtualFolderRequest.md b/docs/interfaces/generated_client.LibraryStructureApiAddVirtualFolderRequest.md deleted file mode 100644 index 7ba50195d..000000000 --- a/docs/interfaces/generated_client.LibraryStructureApiAddVirtualFolderRequest.md +++ /dev/null @@ -1,91 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryStructureApiAddVirtualFolderRequest - -# Interface: LibraryStructureApiAddVirtualFolderRequest - -[generated-client](../modules/generated_client.md).LibraryStructureApiAddVirtualFolderRequest - -Request parameters for addVirtualFolder operation in LibraryStructureApi. - -**`export`** - -**`interface`** LibraryStructureApiAddVirtualFolderRequest - -## Table of contents - -### Properties - -- [addVirtualFolderDto](generated_client.LibraryStructureApiAddVirtualFolderRequest.md#addvirtualfolderdto) -- [collectionType](generated_client.LibraryStructureApiAddVirtualFolderRequest.md#collectiontype) -- [name](generated_client.LibraryStructureApiAddVirtualFolderRequest.md#name) -- [paths](generated_client.LibraryStructureApiAddVirtualFolderRequest.md#paths) -- [refreshLibrary](generated_client.LibraryStructureApiAddVirtualFolderRequest.md#refreshlibrary) - -## Properties - -### addVirtualFolderDto - -• `Optional` `Readonly` **addVirtualFolderDto**: [`AddVirtualFolderDto`](generated_client.AddVirtualFolderDto.md) - -The library options. - -**`memberof`** LibraryStructureApiAddVirtualFolder - -#### Defined in - -[generated-client/api/library-structure-api.ts:661](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L661) - -___ - -### collectionType - -• `Optional` `Readonly` **collectionType**: [`CollectionTypeOptions`](../enums/generated_client.CollectionTypeOptions.md) - -The type of the collection. - -**`memberof`** LibraryStructureApiAddVirtualFolder - -#### Defined in - -[generated-client/api/library-structure-api.ts:640](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L640) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -The name of the virtual folder. - -**`memberof`** LibraryStructureApiAddVirtualFolder - -#### Defined in - -[generated-client/api/library-structure-api.ts:633](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L633) - -___ - -### paths - -• `Optional` `Readonly` **paths**: `string`[] - -The paths of the virtual folder. - -**`memberof`** LibraryStructureApiAddVirtualFolder - -#### Defined in - -[generated-client/api/library-structure-api.ts:647](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L647) - -___ - -### refreshLibrary - -• `Optional` `Readonly` **refreshLibrary**: `boolean` - -Whether to refresh the library. - -**`memberof`** LibraryStructureApiAddVirtualFolder - -#### Defined in - -[generated-client/api/library-structure-api.ts:654](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L654) diff --git a/docs/interfaces/generated_client.LibraryStructureApiRemoveMediaPathRequest.md b/docs/interfaces/generated_client.LibraryStructureApiRemoveMediaPathRequest.md deleted file mode 100644 index dbf0f37a6..000000000 --- a/docs/interfaces/generated_client.LibraryStructureApiRemoveMediaPathRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryStructureApiRemoveMediaPathRequest - -# Interface: LibraryStructureApiRemoveMediaPathRequest - -[generated-client](../modules/generated_client.md).LibraryStructureApiRemoveMediaPathRequest - -Request parameters for removeMediaPath operation in LibraryStructureApi. - -**`export`** - -**`interface`** LibraryStructureApiRemoveMediaPathRequest - -## Table of contents - -### Properties - -- [name](generated_client.LibraryStructureApiRemoveMediaPathRequest.md#name) -- [path](generated_client.LibraryStructureApiRemoveMediaPathRequest.md#path) -- [refreshLibrary](generated_client.LibraryStructureApiRemoveMediaPathRequest.md#refreshlibrary) - -## Properties - -### name - -• `Optional` `Readonly` **name**: `string` - -The name of the library. - -**`memberof`** LibraryStructureApiRemoveMediaPath - -#### Defined in - -[generated-client/api/library-structure-api.ts:675](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L675) - -___ - -### path - -• `Optional` `Readonly` **path**: `string` - -The path to remove. - -**`memberof`** LibraryStructureApiRemoveMediaPath - -#### Defined in - -[generated-client/api/library-structure-api.ts:682](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L682) - -___ - -### refreshLibrary - -• `Optional` `Readonly` **refreshLibrary**: `boolean` - -Whether to refresh the library. - -**`memberof`** LibraryStructureApiRemoveMediaPath - -#### Defined in - -[generated-client/api/library-structure-api.ts:689](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L689) diff --git a/docs/interfaces/generated_client.LibraryStructureApiRemoveVirtualFolderRequest.md b/docs/interfaces/generated_client.LibraryStructureApiRemoveVirtualFolderRequest.md deleted file mode 100644 index cba3fbada..000000000 --- a/docs/interfaces/generated_client.LibraryStructureApiRemoveVirtualFolderRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryStructureApiRemoveVirtualFolderRequest - -# Interface: LibraryStructureApiRemoveVirtualFolderRequest - -[generated-client](../modules/generated_client.md).LibraryStructureApiRemoveVirtualFolderRequest - -Request parameters for removeVirtualFolder operation in LibraryStructureApi. - -**`export`** - -**`interface`** LibraryStructureApiRemoveVirtualFolderRequest - -## Table of contents - -### Properties - -- [name](generated_client.LibraryStructureApiRemoveVirtualFolderRequest.md#name) -- [refreshLibrary](generated_client.LibraryStructureApiRemoveVirtualFolderRequest.md#refreshlibrary) - -## Properties - -### name - -• `Optional` `Readonly` **name**: `string` - -The name of the folder. - -**`memberof`** LibraryStructureApiRemoveVirtualFolder - -#### Defined in - -[generated-client/api/library-structure-api.ts:703](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L703) - -___ - -### refreshLibrary - -• `Optional` `Readonly` **refreshLibrary**: `boolean` - -Whether to refresh the library. - -**`memberof`** LibraryStructureApiRemoveVirtualFolder - -#### Defined in - -[generated-client/api/library-structure-api.ts:710](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L710) diff --git a/docs/interfaces/generated_client.LibraryStructureApiRenameVirtualFolderRequest.md b/docs/interfaces/generated_client.LibraryStructureApiRenameVirtualFolderRequest.md deleted file mode 100644 index 09bc1c174..000000000 --- a/docs/interfaces/generated_client.LibraryStructureApiRenameVirtualFolderRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryStructureApiRenameVirtualFolderRequest - -# Interface: LibraryStructureApiRenameVirtualFolderRequest - -[generated-client](../modules/generated_client.md).LibraryStructureApiRenameVirtualFolderRequest - -Request parameters for renameVirtualFolder operation in LibraryStructureApi. - -**`export`** - -**`interface`** LibraryStructureApiRenameVirtualFolderRequest - -## Table of contents - -### Properties - -- [name](generated_client.LibraryStructureApiRenameVirtualFolderRequest.md#name) -- [newName](generated_client.LibraryStructureApiRenameVirtualFolderRequest.md#newname) -- [refreshLibrary](generated_client.LibraryStructureApiRenameVirtualFolderRequest.md#refreshlibrary) - -## Properties - -### name - -• `Optional` `Readonly` **name**: `string` - -The name of the virtual folder. - -**`memberof`** LibraryStructureApiRenameVirtualFolder - -#### Defined in - -[generated-client/api/library-structure-api.ts:724](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L724) - -___ - -### newName - -• `Optional` `Readonly` **newName**: `string` - -The new name. - -**`memberof`** LibraryStructureApiRenameVirtualFolder - -#### Defined in - -[generated-client/api/library-structure-api.ts:731](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L731) - -___ - -### refreshLibrary - -• `Optional` `Readonly` **refreshLibrary**: `boolean` - -Whether to refresh the library. - -**`memberof`** LibraryStructureApiRenameVirtualFolder - -#### Defined in - -[generated-client/api/library-structure-api.ts:738](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L738) diff --git a/docs/interfaces/generated_client.LibraryStructureApiUpdateLibraryOptionsRequest.md b/docs/interfaces/generated_client.LibraryStructureApiUpdateLibraryOptionsRequest.md deleted file mode 100644 index 89e2e2396..000000000 --- a/docs/interfaces/generated_client.LibraryStructureApiUpdateLibraryOptionsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryStructureApiUpdateLibraryOptionsRequest - -# Interface: LibraryStructureApiUpdateLibraryOptionsRequest - -[generated-client](../modules/generated_client.md).LibraryStructureApiUpdateLibraryOptionsRequest - -Request parameters for updateLibraryOptions operation in LibraryStructureApi. - -**`export`** - -**`interface`** LibraryStructureApiUpdateLibraryOptionsRequest - -## Table of contents - -### Properties - -- [updateLibraryOptionsDto](generated_client.LibraryStructureApiUpdateLibraryOptionsRequest.md#updatelibraryoptionsdto) - -## Properties - -### updateLibraryOptionsDto - -• `Optional` `Readonly` **updateLibraryOptionsDto**: [`UpdateLibraryOptionsDto`](generated_client.UpdateLibraryOptionsDto.md) - -The library name and options. - -**`memberof`** LibraryStructureApiUpdateLibraryOptions - -#### Defined in - -[generated-client/api/library-structure-api.ts:752](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L752) diff --git a/docs/interfaces/generated_client.LibraryStructureApiUpdateMediaPathRequest.md b/docs/interfaces/generated_client.LibraryStructureApiUpdateMediaPathRequest.md deleted file mode 100644 index 321b756d7..000000000 --- a/docs/interfaces/generated_client.LibraryStructureApiUpdateMediaPathRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryStructureApiUpdateMediaPathRequest - -# Interface: LibraryStructureApiUpdateMediaPathRequest - -[generated-client](../modules/generated_client.md).LibraryStructureApiUpdateMediaPathRequest - -Request parameters for updateMediaPath operation in LibraryStructureApi. - -**`export`** - -**`interface`** LibraryStructureApiUpdateMediaPathRequest - -## Table of contents - -### Properties - -- [updateMediaPathRequestDto](generated_client.LibraryStructureApiUpdateMediaPathRequest.md#updatemediapathrequestdto) - -## Properties - -### updateMediaPathRequestDto - -• `Readonly` **updateMediaPathRequestDto**: [`UpdateMediaPathRequestDto`](generated_client.UpdateMediaPathRequestDto.md) - -The name of the library and path infos. - -**`memberof`** LibraryStructureApiUpdateMediaPath - -#### Defined in - -[generated-client/api/library-structure-api.ts:766](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L766) diff --git a/docs/interfaces/generated_client.LibraryTypeOptionsDto.md b/docs/interfaces/generated_client.LibraryTypeOptionsDto.md deleted file mode 100644 index cc5c3c77c..000000000 --- a/docs/interfaces/generated_client.LibraryTypeOptionsDto.md +++ /dev/null @@ -1,91 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryTypeOptionsDto - -# Interface: LibraryTypeOptionsDto - -[generated-client](../modules/generated_client.md).LibraryTypeOptionsDto - -Library type options dto. - -**`export`** - -**`interface`** LibraryTypeOptionsDto - -## Table of contents - -### Properties - -- [DefaultImageOptions](generated_client.LibraryTypeOptionsDto.md#defaultimageoptions) -- [ImageFetchers](generated_client.LibraryTypeOptionsDto.md#imagefetchers) -- [MetadataFetchers](generated_client.LibraryTypeOptionsDto.md#metadatafetchers) -- [SupportedImageTypes](generated_client.LibraryTypeOptionsDto.md#supportedimagetypes) -- [Type](generated_client.LibraryTypeOptionsDto.md#type) - -## Properties - -### DefaultImageOptions - -• `Optional` **DefaultImageOptions**: [`ImageOption`](generated_client.ImageOption.md)[] - -Gets or sets the default image options. - -**`memberof`** LibraryTypeOptionsDto - -#### Defined in - -[generated-client/models/library-type-options-dto.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-type-options-dto.ts#L55) - -___ - -### ImageFetchers - -• `Optional` **ImageFetchers**: [`LibraryOptionInfoDto`](generated_client.LibraryOptionInfoDto.md)[] - -Gets or sets the image fetchers. - -**`memberof`** LibraryTypeOptionsDto - -#### Defined in - -[generated-client/models/library-type-options-dto.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-type-options-dto.ts#L43) - -___ - -### MetadataFetchers - -• `Optional` **MetadataFetchers**: [`LibraryOptionInfoDto`](generated_client.LibraryOptionInfoDto.md)[] - -Gets or sets the metadata fetchers. - -**`memberof`** LibraryTypeOptionsDto - -#### Defined in - -[generated-client/models/library-type-options-dto.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-type-options-dto.ts#L37) - -___ - -### SupportedImageTypes - -• `Optional` **SupportedImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Gets or sets the supported image types. - -**`memberof`** LibraryTypeOptionsDto - -#### Defined in - -[generated-client/models/library-type-options-dto.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-type-options-dto.ts#L49) - -___ - -### Type - -• `Optional` **Type**: ``null`` \| `string` - -Gets or sets the type. - -**`memberof`** LibraryTypeOptionsDto - -#### Defined in - -[generated-client/models/library-type-options-dto.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-type-options-dto.ts#L31) diff --git a/docs/interfaces/generated_client.LibraryUpdateInfo.md b/docs/interfaces/generated_client.LibraryUpdateInfo.md deleted file mode 100644 index aae100b92..000000000 --- a/docs/interfaces/generated_client.LibraryUpdateInfo.md +++ /dev/null @@ -1,117 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryUpdateInfo - -# Interface: LibraryUpdateInfo - -[generated-client](../modules/generated_client.md).LibraryUpdateInfo - -Class LibraryUpdateInfo. - -**`export`** - -**`interface`** LibraryUpdateInfo - -## Table of contents - -### Properties - -- [CollectionFolders](generated_client.LibraryUpdateInfo.md#collectionfolders) -- [FoldersAddedTo](generated_client.LibraryUpdateInfo.md#foldersaddedto) -- [FoldersRemovedFrom](generated_client.LibraryUpdateInfo.md#foldersremovedfrom) -- [IsEmpty](generated_client.LibraryUpdateInfo.md#isempty) -- [ItemsAdded](generated_client.LibraryUpdateInfo.md#itemsadded) -- [ItemsRemoved](generated_client.LibraryUpdateInfo.md#itemsremoved) -- [ItemsUpdated](generated_client.LibraryUpdateInfo.md#itemsupdated) - -## Properties - -### CollectionFolders - -• `Optional` **CollectionFolders**: `string`[] - -**`memberof`** LibraryUpdateInfo - -#### Defined in - -[generated-client/models/library-update-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-update-info.ts#L58) - -___ - -### FoldersAddedTo - -• `Optional` **FoldersAddedTo**: `string`[] - -Gets or sets the folders added to. - -**`memberof`** LibraryUpdateInfo - -#### Defined in - -[generated-client/models/library-update-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-update-info.ts#L28) - -___ - -### FoldersRemovedFrom - -• `Optional` **FoldersRemovedFrom**: `string`[] - -Gets or sets the folders removed from. - -**`memberof`** LibraryUpdateInfo - -#### Defined in - -[generated-client/models/library-update-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-update-info.ts#L34) - -___ - -### IsEmpty - -• `Optional` **IsEmpty**: `boolean` - -**`memberof`** LibraryUpdateInfo - -#### Defined in - -[generated-client/models/library-update-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-update-info.ts#L64) - -___ - -### ItemsAdded - -• `Optional` **ItemsAdded**: `string`[] - -Gets or sets the items added. - -**`memberof`** LibraryUpdateInfo - -#### Defined in - -[generated-client/models/library-update-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-update-info.ts#L40) - -___ - -### ItemsRemoved - -• `Optional` **ItemsRemoved**: `string`[] - -Gets or sets the items removed. - -**`memberof`** LibraryUpdateInfo - -#### Defined in - -[generated-client/models/library-update-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-update-info.ts#L46) - -___ - -### ItemsUpdated - -• `Optional` **ItemsUpdated**: `string`[] - -Gets or sets the items updated. - -**`memberof`** LibraryUpdateInfo - -#### Defined in - -[generated-client/models/library-update-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/library-update-info.ts#L52) diff --git a/docs/interfaces/generated_client.ListingsProviderInfo.md b/docs/interfaces/generated_client.ListingsProviderInfo.md deleted file mode 100644 index 14111cd26..000000000 --- a/docs/interfaces/generated_client.ListingsProviderInfo.md +++ /dev/null @@ -1,248 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ListingsProviderInfo - -# Interface: ListingsProviderInfo - -[generated-client](../modules/generated_client.md).ListingsProviderInfo - -**`export`** - -**`interface`** ListingsProviderInfo - -## Table of contents - -### Properties - -- [ChannelMappings](generated_client.ListingsProviderInfo.md#channelmappings) -- [Country](generated_client.ListingsProviderInfo.md#country) -- [EnableAllTuners](generated_client.ListingsProviderInfo.md#enablealltuners) -- [EnabledTuners](generated_client.ListingsProviderInfo.md#enabledtuners) -- [Id](generated_client.ListingsProviderInfo.md#id) -- [KidsCategories](generated_client.ListingsProviderInfo.md#kidscategories) -- [ListingsId](generated_client.ListingsProviderInfo.md#listingsid) -- [MovieCategories](generated_client.ListingsProviderInfo.md#moviecategories) -- [MoviePrefix](generated_client.ListingsProviderInfo.md#movieprefix) -- [NewsCategories](generated_client.ListingsProviderInfo.md#newscategories) -- [Password](generated_client.ListingsProviderInfo.md#password) -- [Path](generated_client.ListingsProviderInfo.md#path) -- [PreferredLanguage](generated_client.ListingsProviderInfo.md#preferredlanguage) -- [SportsCategories](generated_client.ListingsProviderInfo.md#sportscategories) -- [Type](generated_client.ListingsProviderInfo.md#type) -- [UserAgent](generated_client.ListingsProviderInfo.md#useragent) -- [Username](generated_client.ListingsProviderInfo.md#username) -- [ZipCode](generated_client.ListingsProviderInfo.md#zipcode) - -## Properties - -### ChannelMappings - -• `Optional` **ChannelMappings**: ``null`` \| [`NameValuePair`](generated_client.NameValuePair.md)[] - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:113](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L113) - -___ - -### Country - -• `Optional` **Country**: ``null`` \| `string` - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L65) - -___ - -### EnableAllTuners - -• `Optional` **EnableAllTuners**: `boolean` - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:83](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L83) - -___ - -### EnabledTuners - -• `Optional` **EnabledTuners**: ``null`` \| `string`[] - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L77) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L29) - -___ - -### KidsCategories - -• `Optional` **KidsCategories**: ``null`` \| `string`[] - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:101](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L101) - -___ - -### ListingsId - -• `Optional` **ListingsId**: ``null`` \| `string` - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L53) - -___ - -### MovieCategories - -• `Optional` **MovieCategories**: ``null`` \| `string`[] - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:107](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L107) - -___ - -### MoviePrefix - -• `Optional` **MoviePrefix**: ``null`` \| `string` - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:119](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L119) - -___ - -### NewsCategories - -• `Optional` **NewsCategories**: ``null`` \| `string`[] - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:89](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L89) - -___ - -### Password - -• `Optional` **Password**: ``null`` \| `string` - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L47) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L71) - -___ - -### PreferredLanguage - -• `Optional` **PreferredLanguage**: ``null`` \| `string` - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:125](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L125) - -___ - -### SportsCategories - -• `Optional` **SportsCategories**: ``null`` \| `string`[] - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:95](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L95) - -___ - -### Type - -• `Optional` **Type**: ``null`` \| `string` - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L35) - -___ - -### UserAgent - -• `Optional` **UserAgent**: ``null`` \| `string` - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:131](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L131) - -___ - -### Username - -• `Optional` **Username**: ``null`` \| `string` - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L41) - -___ - -### ZipCode - -• `Optional` **ZipCode**: ``null`` \| `string` - -**`memberof`** ListingsProviderInfo - -#### Defined in - -[generated-client/models/listings-provider-info.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/listings-provider-info.ts#L59) diff --git a/docs/interfaces/generated_client.LiveStreamResponse.md b/docs/interfaces/generated_client.LiveStreamResponse.md deleted file mode 100644 index f5b679326..000000000 --- a/docs/interfaces/generated_client.LiveStreamResponse.md +++ /dev/null @@ -1,27 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveStreamResponse - -# Interface: LiveStreamResponse - -[generated-client](../modules/generated_client.md).LiveStreamResponse - -**`export`** - -**`interface`** LiveStreamResponse - -## Table of contents - -### Properties - -- [MediaSource](generated_client.LiveStreamResponse.md#mediasource) - -## Properties - -### MediaSource - -• `Optional` **MediaSource**: [`MediaSourceInfo`](generated_client.MediaSourceInfo.md) - -**`memberof`** LiveStreamResponse - -#### Defined in - -[generated-client/models/live-stream-response.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-stream-response.ts#L29) diff --git a/docs/interfaces/generated_client.LiveTvApiAddListingProviderRequest.md b/docs/interfaces/generated_client.LiveTvApiAddListingProviderRequest.md deleted file mode 100644 index a6b590524..000000000 --- a/docs/interfaces/generated_client.LiveTvApiAddListingProviderRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiAddListingProviderRequest - -# Interface: LiveTvApiAddListingProviderRequest - -[generated-client](../modules/generated_client.md).LiveTvApiAddListingProviderRequest - -Request parameters for addListingProvider operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiAddListingProviderRequest - -## Table of contents - -### Properties - -- [listingsProviderInfo](generated_client.LiveTvApiAddListingProviderRequest.md#listingsproviderinfo) -- [pw](generated_client.LiveTvApiAddListingProviderRequest.md#pw) -- [validateListings](generated_client.LiveTvApiAddListingProviderRequest.md#validatelistings) -- [validateLogin](generated_client.LiveTvApiAddListingProviderRequest.md#validatelogin) - -## Properties - -### listingsProviderInfo - -• `Optional` `Readonly` **listingsProviderInfo**: [`ListingsProviderInfo`](generated_client.ListingsProviderInfo.md) - -New listings info. - -**`memberof`** LiveTvApiAddListingProvider - -#### Defined in - -[generated-client/api/live-tv-api.ts:3256](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3256) - -___ - -### pw - -• `Optional` `Readonly` **pw**: `string` - -Password. - -**`memberof`** LiveTvApiAddListingProvider - -#### Defined in - -[generated-client/api/live-tv-api.ts:3235](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3235) - -___ - -### validateListings - -• `Optional` `Readonly` **validateListings**: `boolean` - -Validate listings. - -**`memberof`** LiveTvApiAddListingProvider - -#### Defined in - -[generated-client/api/live-tv-api.ts:3242](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3242) - -___ - -### validateLogin - -• `Optional` `Readonly` **validateLogin**: `boolean` - -Validate login. - -**`memberof`** LiveTvApiAddListingProvider - -#### Defined in - -[generated-client/api/live-tv-api.ts:3249](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3249) diff --git a/docs/interfaces/generated_client.LiveTvApiAddTunerHostRequest.md b/docs/interfaces/generated_client.LiveTvApiAddTunerHostRequest.md deleted file mode 100644 index 301bd484a..000000000 --- a/docs/interfaces/generated_client.LiveTvApiAddTunerHostRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiAddTunerHostRequest - -# Interface: LiveTvApiAddTunerHostRequest - -[generated-client](../modules/generated_client.md).LiveTvApiAddTunerHostRequest - -Request parameters for addTunerHost operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiAddTunerHostRequest - -## Table of contents - -### Properties - -- [tunerHostInfo](generated_client.LiveTvApiAddTunerHostRequest.md#tunerhostinfo) - -## Properties - -### tunerHostInfo - -• `Optional` `Readonly` **tunerHostInfo**: [`TunerHostInfo`](generated_client.TunerHostInfo.md) - -New tuner host. - -**`memberof`** LiveTvApiAddTunerHost - -#### Defined in - -[generated-client/api/live-tv-api.ts:3270](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3270) diff --git a/docs/interfaces/generated_client.LiveTvApiCancelSeriesTimerRequest.md b/docs/interfaces/generated_client.LiveTvApiCancelSeriesTimerRequest.md deleted file mode 100644 index cfd8c35aa..000000000 --- a/docs/interfaces/generated_client.LiveTvApiCancelSeriesTimerRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiCancelSeriesTimerRequest - -# Interface: LiveTvApiCancelSeriesTimerRequest - -[generated-client](../modules/generated_client.md).LiveTvApiCancelSeriesTimerRequest - -Request parameters for cancelSeriesTimer operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiCancelSeriesTimerRequest - -## Table of contents - -### Properties - -- [timerId](generated_client.LiveTvApiCancelSeriesTimerRequest.md#timerid) - -## Properties - -### timerId - -• `Readonly` **timerId**: `string` - -Timer id. - -**`memberof`** LiveTvApiCancelSeriesTimer - -#### Defined in - -[generated-client/api/live-tv-api.ts:3284](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3284) diff --git a/docs/interfaces/generated_client.LiveTvApiCancelTimerRequest.md b/docs/interfaces/generated_client.LiveTvApiCancelTimerRequest.md deleted file mode 100644 index fd290038b..000000000 --- a/docs/interfaces/generated_client.LiveTvApiCancelTimerRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiCancelTimerRequest - -# Interface: LiveTvApiCancelTimerRequest - -[generated-client](../modules/generated_client.md).LiveTvApiCancelTimerRequest - -Request parameters for cancelTimer operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiCancelTimerRequest - -## Table of contents - -### Properties - -- [timerId](generated_client.LiveTvApiCancelTimerRequest.md#timerid) - -## Properties - -### timerId - -• `Readonly` **timerId**: `string` - -Timer id. - -**`memberof`** LiveTvApiCancelTimer - -#### Defined in - -[generated-client/api/live-tv-api.ts:3298](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3298) diff --git a/docs/interfaces/generated_client.LiveTvApiCreateSeriesTimerRequest.md b/docs/interfaces/generated_client.LiveTvApiCreateSeriesTimerRequest.md deleted file mode 100644 index 2ebf908e1..000000000 --- a/docs/interfaces/generated_client.LiveTvApiCreateSeriesTimerRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiCreateSeriesTimerRequest - -# Interface: LiveTvApiCreateSeriesTimerRequest - -[generated-client](../modules/generated_client.md).LiveTvApiCreateSeriesTimerRequest - -Request parameters for createSeriesTimer operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiCreateSeriesTimerRequest - -## Table of contents - -### Properties - -- [seriesTimerInfoDto](generated_client.LiveTvApiCreateSeriesTimerRequest.md#seriestimerinfodto) - -## Properties - -### seriesTimerInfoDto - -• `Optional` `Readonly` **seriesTimerInfoDto**: [`SeriesTimerInfoDto`](generated_client.SeriesTimerInfoDto.md) - -New series timer info. - -**`memberof`** LiveTvApiCreateSeriesTimer - -#### Defined in - -[generated-client/api/live-tv-api.ts:3312](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3312) diff --git a/docs/interfaces/generated_client.LiveTvApiCreateTimerRequest.md b/docs/interfaces/generated_client.LiveTvApiCreateTimerRequest.md deleted file mode 100644 index 1ddac9fb6..000000000 --- a/docs/interfaces/generated_client.LiveTvApiCreateTimerRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiCreateTimerRequest - -# Interface: LiveTvApiCreateTimerRequest - -[generated-client](../modules/generated_client.md).LiveTvApiCreateTimerRequest - -Request parameters for createTimer operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiCreateTimerRequest - -## Table of contents - -### Properties - -- [timerInfoDto](generated_client.LiveTvApiCreateTimerRequest.md#timerinfodto) - -## Properties - -### timerInfoDto - -• `Optional` `Readonly` **timerInfoDto**: [`TimerInfoDto`](generated_client.TimerInfoDto.md) - -New timer info. - -**`memberof`** LiveTvApiCreateTimer - -#### Defined in - -[generated-client/api/live-tv-api.ts:3326](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3326) diff --git a/docs/interfaces/generated_client.LiveTvApiDeleteListingProviderRequest.md b/docs/interfaces/generated_client.LiveTvApiDeleteListingProviderRequest.md deleted file mode 100644 index c6349364f..000000000 --- a/docs/interfaces/generated_client.LiveTvApiDeleteListingProviderRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiDeleteListingProviderRequest - -# Interface: LiveTvApiDeleteListingProviderRequest - -[generated-client](../modules/generated_client.md).LiveTvApiDeleteListingProviderRequest - -Request parameters for deleteListingProvider operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiDeleteListingProviderRequest - -## Table of contents - -### Properties - -- [id](generated_client.LiveTvApiDeleteListingProviderRequest.md#id) - -## Properties - -### id - -• `Optional` `Readonly` **id**: `string` - -Listing provider id. - -**`memberof`** LiveTvApiDeleteListingProvider - -#### Defined in - -[generated-client/api/live-tv-api.ts:3340](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3340) diff --git a/docs/interfaces/generated_client.LiveTvApiDeleteRecordingRequest.md b/docs/interfaces/generated_client.LiveTvApiDeleteRecordingRequest.md deleted file mode 100644 index 03364033e..000000000 --- a/docs/interfaces/generated_client.LiveTvApiDeleteRecordingRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiDeleteRecordingRequest - -# Interface: LiveTvApiDeleteRecordingRequest - -[generated-client](../modules/generated_client.md).LiveTvApiDeleteRecordingRequest - -Request parameters for deleteRecording operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiDeleteRecordingRequest - -## Table of contents - -### Properties - -- [recordingId](generated_client.LiveTvApiDeleteRecordingRequest.md#recordingid) - -## Properties - -### recordingId - -• `Readonly` **recordingId**: `string` - -Recording id. - -**`memberof`** LiveTvApiDeleteRecording - -#### Defined in - -[generated-client/api/live-tv-api.ts:3354](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3354) diff --git a/docs/interfaces/generated_client.LiveTvApiDeleteTunerHostRequest.md b/docs/interfaces/generated_client.LiveTvApiDeleteTunerHostRequest.md deleted file mode 100644 index 26c5f661e..000000000 --- a/docs/interfaces/generated_client.LiveTvApiDeleteTunerHostRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiDeleteTunerHostRequest - -# Interface: LiveTvApiDeleteTunerHostRequest - -[generated-client](../modules/generated_client.md).LiveTvApiDeleteTunerHostRequest - -Request parameters for deleteTunerHost operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiDeleteTunerHostRequest - -## Table of contents - -### Properties - -- [id](generated_client.LiveTvApiDeleteTunerHostRequest.md#id) - -## Properties - -### id - -• `Optional` `Readonly` **id**: `string` - -Tuner host id. - -**`memberof`** LiveTvApiDeleteTunerHost - -#### Defined in - -[generated-client/api/live-tv-api.ts:3368](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3368) diff --git a/docs/interfaces/generated_client.LiveTvApiDiscoverTunersRequest.md b/docs/interfaces/generated_client.LiveTvApiDiscoverTunersRequest.md deleted file mode 100644 index 8bdf900e5..000000000 --- a/docs/interfaces/generated_client.LiveTvApiDiscoverTunersRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiDiscoverTunersRequest - -# Interface: LiveTvApiDiscoverTunersRequest - -[generated-client](../modules/generated_client.md).LiveTvApiDiscoverTunersRequest - -Request parameters for discoverTuners operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiDiscoverTunersRequest - -## Table of contents - -### Properties - -- [newDevicesOnly](generated_client.LiveTvApiDiscoverTunersRequest.md#newdevicesonly) - -## Properties - -### newDevicesOnly - -• `Optional` `Readonly` **newDevicesOnly**: `boolean` - -Only discover new tuners. - -**`memberof`** LiveTvApiDiscoverTuners - -#### Defined in - -[generated-client/api/live-tv-api.ts:3382](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3382) diff --git a/docs/interfaces/generated_client.LiveTvApiDiscvoverTunersRequest.md b/docs/interfaces/generated_client.LiveTvApiDiscvoverTunersRequest.md deleted file mode 100644 index fd56b8ff2..000000000 --- a/docs/interfaces/generated_client.LiveTvApiDiscvoverTunersRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiDiscvoverTunersRequest - -# Interface: LiveTvApiDiscvoverTunersRequest - -[generated-client](../modules/generated_client.md).LiveTvApiDiscvoverTunersRequest - -Request parameters for discvoverTuners operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiDiscvoverTunersRequest - -## Table of contents - -### Properties - -- [newDevicesOnly](generated_client.LiveTvApiDiscvoverTunersRequest.md#newdevicesonly) - -## Properties - -### newDevicesOnly - -• `Optional` `Readonly` **newDevicesOnly**: `boolean` - -Only discover new tuners. - -**`memberof`** LiveTvApiDiscvoverTuners - -#### Defined in - -[generated-client/api/live-tv-api.ts:3396](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3396) diff --git a/docs/interfaces/generated_client.LiveTvApiGetChannelMappingOptionsRequest.md b/docs/interfaces/generated_client.LiveTvApiGetChannelMappingOptionsRequest.md deleted file mode 100644 index a3cf642ce..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetChannelMappingOptionsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetChannelMappingOptionsRequest - -# Interface: LiveTvApiGetChannelMappingOptionsRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetChannelMappingOptionsRequest - -Request parameters for getChannelMappingOptions operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetChannelMappingOptionsRequest - -## Table of contents - -### Properties - -- [providerId](generated_client.LiveTvApiGetChannelMappingOptionsRequest.md#providerid) - -## Properties - -### providerId - -• `Optional` `Readonly` **providerId**: `string` - -Provider id. - -**`memberof`** LiveTvApiGetChannelMappingOptions - -#### Defined in - -[generated-client/api/live-tv-api.ts:3431](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3431) diff --git a/docs/interfaces/generated_client.LiveTvApiGetChannelRequest.md b/docs/interfaces/generated_client.LiveTvApiGetChannelRequest.md deleted file mode 100644 index cc4411324..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetChannelRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetChannelRequest - -# Interface: LiveTvApiGetChannelRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetChannelRequest - -Request parameters for getChannel operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetChannelRequest - -## Table of contents - -### Properties - -- [channelId](generated_client.LiveTvApiGetChannelRequest.md#channelid) -- [userId](generated_client.LiveTvApiGetChannelRequest.md#userid) - -## Properties - -### channelId - -• `Readonly` **channelId**: `string` - -Channel id. - -**`memberof`** LiveTvApiGetChannel - -#### Defined in - -[generated-client/api/live-tv-api.ts:3410](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3410) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Attach user data. - -**`memberof`** LiveTvApiGetChannel - -#### Defined in - -[generated-client/api/live-tv-api.ts:3417](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3417) diff --git a/docs/interfaces/generated_client.LiveTvApiGetDefaultTimerRequest.md b/docs/interfaces/generated_client.LiveTvApiGetDefaultTimerRequest.md deleted file mode 100644 index 2860e2af4..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetDefaultTimerRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetDefaultTimerRequest - -# Interface: LiveTvApiGetDefaultTimerRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetDefaultTimerRequest - -Request parameters for getDefaultTimer operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetDefaultTimerRequest - -## Table of contents - -### Properties - -- [programId](generated_client.LiveTvApiGetDefaultTimerRequest.md#programid) - -## Properties - -### programId - -• `Optional` `Readonly` **programId**: `string` - -Optional. To attach default values based on a program. - -**`memberof`** LiveTvApiGetDefaultTimer - -#### Defined in - -[generated-client/api/live-tv-api.ts:3445](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3445) diff --git a/docs/interfaces/generated_client.LiveTvApiGetLineupsRequest.md b/docs/interfaces/generated_client.LiveTvApiGetLineupsRequest.md deleted file mode 100644 index d0905c4b2..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetLineupsRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetLineupsRequest - -# Interface: LiveTvApiGetLineupsRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetLineupsRequest - -Request parameters for getLineups operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetLineupsRequest - -## Table of contents - -### Properties - -- [country](generated_client.LiveTvApiGetLineupsRequest.md#country) -- [id](generated_client.LiveTvApiGetLineupsRequest.md#id) -- [location](generated_client.LiveTvApiGetLineupsRequest.md#location) -- [type](generated_client.LiveTvApiGetLineupsRequest.md#type) - -## Properties - -### country - -• `Optional` `Readonly` **country**: `string` - -Country. - -**`memberof`** LiveTvApiGetLineups - -#### Defined in - -[generated-client/api/live-tv-api.ts:3480](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3480) - -___ - -### id - -• `Optional` `Readonly` **id**: `string` - -Provider id. - -**`memberof`** LiveTvApiGetLineups - -#### Defined in - -[generated-client/api/live-tv-api.ts:3459](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3459) - -___ - -### location - -• `Optional` `Readonly` **location**: `string` - -Location. - -**`memberof`** LiveTvApiGetLineups - -#### Defined in - -[generated-client/api/live-tv-api.ts:3473](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3473) - -___ - -### type - -• `Optional` `Readonly` **type**: `string` - -Provider type. - -**`memberof`** LiveTvApiGetLineups - -#### Defined in - -[generated-client/api/live-tv-api.ts:3466](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3466) diff --git a/docs/interfaces/generated_client.LiveTvApiGetLiveRecordingFileRequest.md b/docs/interfaces/generated_client.LiveTvApiGetLiveRecordingFileRequest.md deleted file mode 100644 index 299bc5780..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetLiveRecordingFileRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetLiveRecordingFileRequest - -# Interface: LiveTvApiGetLiveRecordingFileRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetLiveRecordingFileRequest - -Request parameters for getLiveRecordingFile operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetLiveRecordingFileRequest - -## Table of contents - -### Properties - -- [recordingId](generated_client.LiveTvApiGetLiveRecordingFileRequest.md#recordingid) - -## Properties - -### recordingId - -• `Readonly` **recordingId**: `string` - -Recording id. - -**`memberof`** LiveTvApiGetLiveRecordingFile - -#### Defined in - -[generated-client/api/live-tv-api.ts:3494](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3494) diff --git a/docs/interfaces/generated_client.LiveTvApiGetLiveStreamFileRequest.md b/docs/interfaces/generated_client.LiveTvApiGetLiveStreamFileRequest.md deleted file mode 100644 index c13862f6c..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetLiveStreamFileRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetLiveStreamFileRequest - -# Interface: LiveTvApiGetLiveStreamFileRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetLiveStreamFileRequest - -Request parameters for getLiveStreamFile operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetLiveStreamFileRequest - -## Table of contents - -### Properties - -- [container](generated_client.LiveTvApiGetLiveStreamFileRequest.md#container) -- [streamId](generated_client.LiveTvApiGetLiveStreamFileRequest.md#streamid) - -## Properties - -### container - -• `Readonly` **container**: `string` - -Container type. - -**`memberof`** LiveTvApiGetLiveStreamFile - -#### Defined in - -[generated-client/api/live-tv-api.ts:3515](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3515) - -___ - -### streamId - -• `Readonly` **streamId**: `string` - -Stream id. - -**`memberof`** LiveTvApiGetLiveStreamFile - -#### Defined in - -[generated-client/api/live-tv-api.ts:3508](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3508) diff --git a/docs/interfaces/generated_client.LiveTvApiGetLiveTvChannelsRequest.md b/docs/interfaces/generated_client.LiveTvApiGetLiveTvChannelsRequest.md deleted file mode 100644 index 112497681..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetLiveTvChannelsRequest.md +++ /dev/null @@ -1,331 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetLiveTvChannelsRequest - -# Interface: LiveTvApiGetLiveTvChannelsRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetLiveTvChannelsRequest - -Request parameters for getLiveTvChannels operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetLiveTvChannelsRequest - -## Table of contents - -### Properties - -- [addCurrentProgram](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#addcurrentprogram) -- [enableFavoriteSorting](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#enablefavoritesorting) -- [enableImageTypes](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#enableimagetypes) -- [enableImages](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#enableimages) -- [enableUserData](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#enableuserdata) -- [fields](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#fields) -- [imageTypeLimit](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#imagetypelimit) -- [isDisliked](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#isdisliked) -- [isFavorite](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#isfavorite) -- [isKids](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#iskids) -- [isLiked](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#isliked) -- [isMovie](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#ismovie) -- [isNews](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#isnews) -- [isSeries](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#isseries) -- [isSports](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#issports) -- [limit](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#limit) -- [sortBy](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#sortby) -- [sortOrder](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#sortorder) -- [startIndex](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#startindex) -- [type](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#type) -- [userId](generated_client.LiveTvApiGetLiveTvChannelsRequest.md#userid) - -## Properties - -### addCurrentProgram - -• `Optional` `Readonly` **addCurrentProgram**: `boolean` - -Optional. Adds current program info to each channel. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3669](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3669) - -___ - -### enableFavoriteSorting - -• `Optional` `Readonly` **enableFavoriteSorting**: `boolean` - -Optional. Incorporate favorite and like status into channel sorting. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3662](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3662) - -___ - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -\"Optional. The image types to include in the output. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3627](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3627) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3613](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3613) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3641](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3641) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3634](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3634) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3620](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3620) - -___ - -### isDisliked - -• `Optional` `Readonly` **isDisliked**: `boolean` - -Optional. Filter by channels that are disliked, or not. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3606](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3606) - -___ - -### isFavorite - -• `Optional` `Readonly` **isFavorite**: `boolean` - -Optional. Filter by channels that are favorites, or not. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3592](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3592) - -___ - -### isKids - -• `Optional` `Readonly` **isKids**: `boolean` - -Optional. Filter for kids. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3571](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3571) - -___ - -### isLiked - -• `Optional` `Readonly` **isLiked**: `boolean` - -Optional. Filter by channels that are liked, or not. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3599](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3599) - -___ - -### isMovie - -• `Optional` `Readonly` **isMovie**: `boolean` - -Optional. Filter for movies. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3550](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3550) - -___ - -### isNews - -• `Optional` `Readonly` **isNews**: `boolean` - -Optional. Filter for news. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3564](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3564) - -___ - -### isSeries - -• `Optional` `Readonly` **isSeries**: `boolean` - -Optional. Filter for series. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3557](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3557) - -___ - -### isSports - -• `Optional` `Readonly` **isSports**: `boolean` - -Optional. Filter for sports. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3578](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3578) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3585](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3585) - -___ - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string`[] - -Optional. Key to sort by. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3648](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3648) - -___ - -### sortOrder - -• `Optional` `Readonly` **sortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md) - -Optional. Sort order. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3655](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3655) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3543](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3543) - -___ - -### type - -• `Optional` `Readonly` **type**: [`ChannelType`](../enums/generated_client.ChannelType.md) - -Optional. Filter by channel type. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3529](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3529) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user and attach user data. - -**`memberof`** LiveTvApiGetLiveTvChannels - -#### Defined in - -[generated-client/api/live-tv-api.ts:3536](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3536) diff --git a/docs/interfaces/generated_client.LiveTvApiGetLiveTvProgramsRequest.md b/docs/interfaces/generated_client.LiveTvApiGetLiveTvProgramsRequest.md deleted file mode 100644 index ec77c5870..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetLiveTvProgramsRequest.md +++ /dev/null @@ -1,421 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetLiveTvProgramsRequest - -# Interface: LiveTvApiGetLiveTvProgramsRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetLiveTvProgramsRequest - -Request parameters for getLiveTvPrograms operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetLiveTvProgramsRequest - -## Table of contents - -### Properties - -- [channelIds](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#channelids) -- [enableImageTypes](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#enableimagetypes) -- [enableImages](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#enabletotalrecordcount) -- [enableUserData](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#enableuserdata) -- [fields](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#fields) -- [genreIds](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#genreids) -- [genres](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#genres) -- [hasAired](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#hasaired) -- [imageTypeLimit](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#imagetypelimit) -- [isAiring](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#isairing) -- [isKids](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#iskids) -- [isMovie](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#ismovie) -- [isNews](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#isnews) -- [isSeries](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#isseries) -- [isSports](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#issports) -- [librarySeriesId](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#libraryseriesid) -- [limit](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#limit) -- [maxEndDate](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#maxenddate) -- [maxStartDate](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#maxstartdate) -- [minEndDate](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#minenddate) -- [minStartDate](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#minstartdate) -- [seriesTimerId](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#seriestimerid) -- [sortBy](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#sortby) -- [sortOrder](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#sortorder) -- [startIndex](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#startindex) -- [userId](generated_client.LiveTvApiGetLiveTvProgramsRequest.md#userid) - -## Properties - -### channelIds - -• `Optional` `Readonly` **channelIds**: `string`[] - -The channels to return guide information for. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3683](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3683) - -___ - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3830](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3830) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3816](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3816) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Retrieve total record count. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3865](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3865) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3837](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3837) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3858](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3858) - -___ - -### genreIds - -• `Optional` `Readonly` **genreIds**: `string`[] - -The genre ids to return guide information for. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3809](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3809) - -___ - -### genres - -• `Optional` `Readonly` **genres**: `string`[] - -The genres to return guide information for. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3802](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3802) - -___ - -### hasAired - -• `Optional` `Readonly` **hasAired**: `boolean` - -Optional. Filter by programs that have completed airing, or not. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3704](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3704) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3823](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3823) - -___ - -### isAiring - -• `Optional` `Readonly` **isAiring**: `boolean` - -Optional. Filter by programs that are currently airing, or not. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3711](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3711) - -___ - -### isKids - -• `Optional` `Readonly` **isKids**: `boolean` - -Optional. Filter for kids. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3760](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3760) - -___ - -### isMovie - -• `Optional` `Readonly` **isMovie**: `boolean` - -Optional. Filter for movies. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3739](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3739) - -___ - -### isNews - -• `Optional` `Readonly` **isNews**: `boolean` - -Optional. Filter for news. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3753](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3753) - -___ - -### isSeries - -• `Optional` `Readonly` **isSeries**: `boolean` - -Optional. Filter for series. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3746](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3746) - -___ - -### isSports - -• `Optional` `Readonly` **isSports**: `boolean` - -Optional. Filter for sports. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3767](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3767) - -___ - -### librarySeriesId - -• `Optional` `Readonly` **librarySeriesId**: `string` - -Optional. Filter by library series id. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3851](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3851) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3781](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3781) - -___ - -### maxEndDate - -• `Optional` `Readonly` **maxEndDate**: `string` - -Optional. The maximum premiere end date. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3732](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3732) - -___ - -### maxStartDate - -• `Optional` `Readonly` **maxStartDate**: `string` - -Optional. The maximum premiere start date. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3718](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3718) - -___ - -### minEndDate - -• `Optional` `Readonly` **minEndDate**: `string` - -Optional. The minimum premiere end date. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3725](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3725) - -___ - -### minStartDate - -• `Optional` `Readonly` **minStartDate**: `string` - -Optional. The minimum premiere start date. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3697](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3697) - -___ - -### seriesTimerId - -• `Optional` `Readonly` **seriesTimerId**: `string` - -Optional. Filter by series timer id. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3844](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3844) - -___ - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string`[] - -Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3788](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3788) - -___ - -### sortOrder - -• `Optional` `Readonly` **sortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md)[] - -Sort Order - Ascending,Descending. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3795](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3795) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3774](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3774) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id. - -**`memberof`** LiveTvApiGetLiveTvPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3690](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3690) diff --git a/docs/interfaces/generated_client.LiveTvApiGetProgramRequest.md b/docs/interfaces/generated_client.LiveTvApiGetProgramRequest.md deleted file mode 100644 index bee62af13..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetProgramRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetProgramRequest - -# Interface: LiveTvApiGetProgramRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetProgramRequest - -Request parameters for getProgram operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetProgramRequest - -## Table of contents - -### Properties - -- [programId](generated_client.LiveTvApiGetProgramRequest.md#programid) -- [userId](generated_client.LiveTvApiGetProgramRequest.md#userid) - -## Properties - -### programId - -• `Readonly` **programId**: `string` - -Program id. - -**`memberof`** LiveTvApiGetProgram - -#### Defined in - -[generated-client/api/live-tv-api.ts:3879](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3879) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Attach user data. - -**`memberof`** LiveTvApiGetProgram - -#### Defined in - -[generated-client/api/live-tv-api.ts:3886](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3886) diff --git a/docs/interfaces/generated_client.LiveTvApiGetProgramsRequest.md b/docs/interfaces/generated_client.LiveTvApiGetProgramsRequest.md deleted file mode 100644 index 957512ddb..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetProgramsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetProgramsRequest - -# Interface: LiveTvApiGetProgramsRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetProgramsRequest - -Request parameters for getPrograms operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetProgramsRequest - -## Table of contents - -### Properties - -- [getProgramsDto](generated_client.LiveTvApiGetProgramsRequest.md#getprogramsdto) - -## Properties - -### getProgramsDto - -• `Optional` `Readonly` **getProgramsDto**: [`GetProgramsDto`](generated_client.GetProgramsDto.md) - -Request body. - -**`memberof`** LiveTvApiGetPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3900](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3900) diff --git a/docs/interfaces/generated_client.LiveTvApiGetRecommendedProgramsRequest.md b/docs/interfaces/generated_client.LiveTvApiGetRecommendedProgramsRequest.md deleted file mode 100644 index 94f428e6c..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetRecommendedProgramsRequest.md +++ /dev/null @@ -1,256 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetRecommendedProgramsRequest - -# Interface: LiveTvApiGetRecommendedProgramsRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetRecommendedProgramsRequest - -Request parameters for getRecommendedPrograms operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetRecommendedProgramsRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#enableimagetypes) -- [enableImages](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#enabletotalrecordcount) -- [enableUserData](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#enableuserdata) -- [fields](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#fields) -- [genreIds](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#genreids) -- [hasAired](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#hasaired) -- [imageTypeLimit](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#imagetypelimit) -- [isAiring](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#isairing) -- [isKids](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#iskids) -- [isMovie](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#ismovie) -- [isNews](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#isnews) -- [isSeries](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#isseries) -- [isSports](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#issports) -- [limit](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#limit) -- [userId](generated_client.LiveTvApiGetRecommendedProgramsRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3991](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3991) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3977](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3977) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Retrieve total record count. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:4019](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4019) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. include user data. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:4012](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4012) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:4005](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4005) - -___ - -### genreIds - -• `Optional` `Readonly` **genreIds**: `string`[] - -The genres to return guide information for. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3998](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3998) - -___ - -### hasAired - -• `Optional` `Readonly` **hasAired**: `boolean` - -Optional. Filter by programs that have completed airing, or not. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3935](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3935) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3984](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3984) - -___ - -### isAiring - -• `Optional` `Readonly` **isAiring**: `boolean` - -Optional. Filter by programs that are currently airing, or not. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3928](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3928) - -___ - -### isKids - -• `Optional` `Readonly` **isKids**: `boolean` - -Optional. Filter for kids. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3963](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3963) - -___ - -### isMovie - -• `Optional` `Readonly` **isMovie**: `boolean` - -Optional. Filter for movies. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3949](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3949) - -___ - -### isNews - -• `Optional` `Readonly` **isNews**: `boolean` - -Optional. Filter for news. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3956](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3956) - -___ - -### isSeries - -• `Optional` `Readonly` **isSeries**: `boolean` - -Optional. Filter for series. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3942](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3942) - -___ - -### isSports - -• `Optional` `Readonly` **isSports**: `boolean` - -Optional. Filter for sports. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3970](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3970) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3921](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3921) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. filter by user id. - -**`memberof`** LiveTvApiGetRecommendedPrograms - -#### Defined in - -[generated-client/api/live-tv-api.ts:3914](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L3914) diff --git a/docs/interfaces/generated_client.LiveTvApiGetRecordingFoldersRequest.md b/docs/interfaces/generated_client.LiveTvApiGetRecordingFoldersRequest.md deleted file mode 100644 index ea78aa3dc..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetRecordingFoldersRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetRecordingFoldersRequest - -# Interface: LiveTvApiGetRecordingFoldersRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetRecordingFoldersRequest - -Request parameters for getRecordingFolders operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetRecordingFoldersRequest - -## Table of contents - -### Properties - -- [userId](generated_client.LiveTvApiGetRecordingFoldersRequest.md#userid) - -## Properties - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user and attach user data. - -**`memberof`** LiveTvApiGetRecordingFolders - -#### Defined in - -[generated-client/api/live-tv-api.ts:4054](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4054) diff --git a/docs/interfaces/generated_client.LiveTvApiGetRecordingGroupRequest.md b/docs/interfaces/generated_client.LiveTvApiGetRecordingGroupRequest.md deleted file mode 100644 index 277b8fe75..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetRecordingGroupRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetRecordingGroupRequest - -# Interface: LiveTvApiGetRecordingGroupRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetRecordingGroupRequest - -Request parameters for getRecordingGroup operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetRecordingGroupRequest - -## Table of contents - -### Properties - -- [groupId](generated_client.LiveTvApiGetRecordingGroupRequest.md#groupid) - -## Properties - -### groupId - -• `Readonly` **groupId**: `string` - -Group id. - -**`memberof`** LiveTvApiGetRecordingGroup - -#### Defined in - -[generated-client/api/live-tv-api.ts:4068](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4068) diff --git a/docs/interfaces/generated_client.LiveTvApiGetRecordingGroupsRequest.md b/docs/interfaces/generated_client.LiveTvApiGetRecordingGroupsRequest.md deleted file mode 100644 index 8c71e780e..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetRecordingGroupsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetRecordingGroupsRequest - -# Interface: LiveTvApiGetRecordingGroupsRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetRecordingGroupsRequest - -Request parameters for getRecordingGroups operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetRecordingGroupsRequest - -## Table of contents - -### Properties - -- [userId](generated_client.LiveTvApiGetRecordingGroupsRequest.md#userid) - -## Properties - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user and attach user data. - -**`memberof`** LiveTvApiGetRecordingGroups - -#### Defined in - -[generated-client/api/live-tv-api.ts:4082](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4082) diff --git a/docs/interfaces/generated_client.LiveTvApiGetRecordingRequest.md b/docs/interfaces/generated_client.LiveTvApiGetRecordingRequest.md deleted file mode 100644 index a85092bed..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetRecordingRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetRecordingRequest - -# Interface: LiveTvApiGetRecordingRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetRecordingRequest - -Request parameters for getRecording operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetRecordingRequest - -## Table of contents - -### Properties - -- [recordingId](generated_client.LiveTvApiGetRecordingRequest.md#recordingid) -- [userId](generated_client.LiveTvApiGetRecordingRequest.md#userid) - -## Properties - -### recordingId - -• `Readonly` **recordingId**: `string` - -Recording id. - -**`memberof`** LiveTvApiGetRecording - -#### Defined in - -[generated-client/api/live-tv-api.ts:4033](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4033) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Attach user data. - -**`memberof`** LiveTvApiGetRecording - -#### Defined in - -[generated-client/api/live-tv-api.ts:4040](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4040) diff --git a/docs/interfaces/generated_client.LiveTvApiGetRecordingsRequest.md b/docs/interfaces/generated_client.LiveTvApiGetRecordingsRequest.md deleted file mode 100644 index 48293553b..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetRecordingsRequest.md +++ /dev/null @@ -1,301 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetRecordingsRequest - -# Interface: LiveTvApiGetRecordingsRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetRecordingsRequest - -Request parameters for getRecordings operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetRecordingsRequest - -## Table of contents - -### Properties - -- [channelId](generated_client.LiveTvApiGetRecordingsRequest.md#channelid) -- [enableImageTypes](generated_client.LiveTvApiGetRecordingsRequest.md#enableimagetypes) -- [enableImages](generated_client.LiveTvApiGetRecordingsRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.LiveTvApiGetRecordingsRequest.md#enabletotalrecordcount) -- [enableUserData](generated_client.LiveTvApiGetRecordingsRequest.md#enableuserdata) -- [fields](generated_client.LiveTvApiGetRecordingsRequest.md#fields) -- [imageTypeLimit](generated_client.LiveTvApiGetRecordingsRequest.md#imagetypelimit) -- [isInProgress](generated_client.LiveTvApiGetRecordingsRequest.md#isinprogress) -- [isKids](generated_client.LiveTvApiGetRecordingsRequest.md#iskids) -- [isLibraryItem](generated_client.LiveTvApiGetRecordingsRequest.md#islibraryitem) -- [isMovie](generated_client.LiveTvApiGetRecordingsRequest.md#ismovie) -- [isNews](generated_client.LiveTvApiGetRecordingsRequest.md#isnews) -- [isSeries](generated_client.LiveTvApiGetRecordingsRequest.md#isseries) -- [isSports](generated_client.LiveTvApiGetRecordingsRequest.md#issports) -- [limit](generated_client.LiveTvApiGetRecordingsRequest.md#limit) -- [seriesTimerId](generated_client.LiveTvApiGetRecordingsRequest.md#seriestimerid) -- [startIndex](generated_client.LiveTvApiGetRecordingsRequest.md#startindex) -- [status](generated_client.LiveTvApiGetRecordingsRequest.md#status) -- [userId](generated_client.LiveTvApiGetRecordingsRequest.md#userid) - -## Properties - -### channelId - -• `Optional` `Readonly` **channelId**: `string` - -Optional. Filter by channel id. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4096](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4096) - -___ - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4159](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4159) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4145](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4145) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Optional. Return total record count. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4222](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4222) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4173](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4173) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4166](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4166) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4152](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4152) - -___ - -### isInProgress - -• `Optional` `Readonly` **isInProgress**: `boolean` - -Optional. Filter by recordings that are in progress, or not. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4131](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4131) - -___ - -### isKids - -• `Optional` `Readonly` **isKids**: `boolean` - -Optional. Filter for kids. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4194](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4194) - -___ - -### isLibraryItem - -• `Optional` `Readonly` **isLibraryItem**: `boolean` - -Optional. Filter for is library item. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4215](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4215) - -___ - -### isMovie - -• `Optional` `Readonly` **isMovie**: `boolean` - -Optional. Filter for movies. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4180](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4180) - -___ - -### isNews - -• `Optional` `Readonly` **isNews**: `boolean` - -Optional. Filter for news. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4208](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4208) - -___ - -### isSeries - -• `Optional` `Readonly` **isSeries**: `boolean` - -Optional. Filter for series. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4187](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4187) - -___ - -### isSports - -• `Optional` `Readonly` **isSports**: `boolean` - -Optional. Filter for sports. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4201](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4201) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4117](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4117) - -___ - -### seriesTimerId - -• `Optional` `Readonly` **seriesTimerId**: `string` - -Optional. Filter by recordings belonging to a series timer. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4138](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4138) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4110](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4110) - -___ - -### status - -• `Optional` `Readonly` **status**: [`RecordingStatus`](../enums/generated_client.RecordingStatus.md) - -Optional. Filter by recording status. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4124](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4124) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user and attach user data. - -**`memberof`** LiveTvApiGetRecordings - -#### Defined in - -[generated-client/api/live-tv-api.ts:4103](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4103) diff --git a/docs/interfaces/generated_client.LiveTvApiGetRecordingsSeriesRequest.md b/docs/interfaces/generated_client.LiveTvApiGetRecordingsSeriesRequest.md deleted file mode 100644 index 0abc8b013..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetRecordingsSeriesRequest.md +++ /dev/null @@ -1,226 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetRecordingsSeriesRequest - -# Interface: LiveTvApiGetRecordingsSeriesRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetRecordingsSeriesRequest - -Request parameters for getRecordingsSeries operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetRecordingsSeriesRequest - -## Table of contents - -### Properties - -- [channelId](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#channelid) -- [enableImageTypes](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#enableimagetypes) -- [enableImages](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#enabletotalrecordcount) -- [enableUserData](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#enableuserdata) -- [fields](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#fields) -- [groupId](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#groupid) -- [imageTypeLimit](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#imagetypelimit) -- [isInProgress](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#isinprogress) -- [limit](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#limit) -- [seriesTimerId](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#seriestimerid) -- [startIndex](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#startindex) -- [status](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#status) -- [userId](generated_client.LiveTvApiGetRecordingsSeriesRequest.md#userid) - -## Properties - -### channelId - -• `Optional` `Readonly` **channelId**: `string` - -Optional. Filter by channel id. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4236](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4236) - -___ - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4306](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4306) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4292](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4292) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Optional. Return total record count. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4327](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4327) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4320](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4320) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4313](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4313) - -___ - -### groupId - -• `Optional` `Readonly` **groupId**: `string` - -Optional. Filter by recording group. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4250](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4250) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4299](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4299) - -___ - -### isInProgress - -• `Optional` `Readonly` **isInProgress**: `boolean` - -Optional. Filter by recordings that are in progress, or not. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4278](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4278) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4264](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4264) - -___ - -### seriesTimerId - -• `Optional` `Readonly` **seriesTimerId**: `string` - -Optional. Filter by recordings belonging to a series timer. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4285](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4285) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4257](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4257) - -___ - -### status - -• `Optional` `Readonly` **status**: [`RecordingStatus`](../enums/generated_client.RecordingStatus.md) - -Optional. Filter by recording status. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4271](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4271) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user and attach user data. - -**`memberof`** LiveTvApiGetRecordingsSeries - -#### Defined in - -[generated-client/api/live-tv-api.ts:4243](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4243) diff --git a/docs/interfaces/generated_client.LiveTvApiGetSeriesTimerRequest.md b/docs/interfaces/generated_client.LiveTvApiGetSeriesTimerRequest.md deleted file mode 100644 index 7a40bfc48..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetSeriesTimerRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetSeriesTimerRequest - -# Interface: LiveTvApiGetSeriesTimerRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetSeriesTimerRequest - -Request parameters for getSeriesTimer operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetSeriesTimerRequest - -## Table of contents - -### Properties - -- [timerId](generated_client.LiveTvApiGetSeriesTimerRequest.md#timerid) - -## Properties - -### timerId - -• `Readonly` **timerId**: `string` - -Timer id. - -**`memberof`** LiveTvApiGetSeriesTimer - -#### Defined in - -[generated-client/api/live-tv-api.ts:4341](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4341) diff --git a/docs/interfaces/generated_client.LiveTvApiGetSeriesTimersRequest.md b/docs/interfaces/generated_client.LiveTvApiGetSeriesTimersRequest.md deleted file mode 100644 index c585bddfe..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetSeriesTimersRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetSeriesTimersRequest - -# Interface: LiveTvApiGetSeriesTimersRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetSeriesTimersRequest - -Request parameters for getSeriesTimers operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetSeriesTimersRequest - -## Table of contents - -### Properties - -- [sortBy](generated_client.LiveTvApiGetSeriesTimersRequest.md#sortby) -- [sortOrder](generated_client.LiveTvApiGetSeriesTimersRequest.md#sortorder) - -## Properties - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string` - -Optional. Sort by SortName or Priority. - -**`memberof`** LiveTvApiGetSeriesTimers - -#### Defined in - -[generated-client/api/live-tv-api.ts:4355](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4355) - -___ - -### sortOrder - -• `Optional` `Readonly` **sortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md) - -Optional. Sort in Ascending or Descending order. - -**`memberof`** LiveTvApiGetSeriesTimers - -#### Defined in - -[generated-client/api/live-tv-api.ts:4362](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4362) diff --git a/docs/interfaces/generated_client.LiveTvApiGetTimerRequest.md b/docs/interfaces/generated_client.LiveTvApiGetTimerRequest.md deleted file mode 100644 index 6f419e14b..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetTimerRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetTimerRequest - -# Interface: LiveTvApiGetTimerRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetTimerRequest - -Request parameters for getTimer operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetTimerRequest - -## Table of contents - -### Properties - -- [timerId](generated_client.LiveTvApiGetTimerRequest.md#timerid) - -## Properties - -### timerId - -• `Readonly` **timerId**: `string` - -Timer id. - -**`memberof`** LiveTvApiGetTimer - -#### Defined in - -[generated-client/api/live-tv-api.ts:4376](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4376) diff --git a/docs/interfaces/generated_client.LiveTvApiGetTimersRequest.md b/docs/interfaces/generated_client.LiveTvApiGetTimersRequest.md deleted file mode 100644 index 090b28c97..000000000 --- a/docs/interfaces/generated_client.LiveTvApiGetTimersRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiGetTimersRequest - -# Interface: LiveTvApiGetTimersRequest - -[generated-client](../modules/generated_client.md).LiveTvApiGetTimersRequest - -Request parameters for getTimers operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiGetTimersRequest - -## Table of contents - -### Properties - -- [channelId](generated_client.LiveTvApiGetTimersRequest.md#channelid) -- [isActive](generated_client.LiveTvApiGetTimersRequest.md#isactive) -- [isScheduled](generated_client.LiveTvApiGetTimersRequest.md#isscheduled) -- [seriesTimerId](generated_client.LiveTvApiGetTimersRequest.md#seriestimerid) - -## Properties - -### channelId - -• `Optional` `Readonly` **channelId**: `string` - -Optional. Filter by channel id. - -**`memberof`** LiveTvApiGetTimers - -#### Defined in - -[generated-client/api/live-tv-api.ts:4390](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4390) - -___ - -### isActive - -• `Optional` `Readonly` **isActive**: `boolean` - -Optional. Filter by timers that are active. - -**`memberof`** LiveTvApiGetTimers - -#### Defined in - -[generated-client/api/live-tv-api.ts:4404](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4404) - -___ - -### isScheduled - -• `Optional` `Readonly` **isScheduled**: `boolean` - -Optional. Filter by timers that are scheduled. - -**`memberof`** LiveTvApiGetTimers - -#### Defined in - -[generated-client/api/live-tv-api.ts:4411](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4411) - -___ - -### seriesTimerId - -• `Optional` `Readonly` **seriesTimerId**: `string` - -Optional. Filter by timers belonging to a series timer. - -**`memberof`** LiveTvApiGetTimers - -#### Defined in - -[generated-client/api/live-tv-api.ts:4397](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4397) diff --git a/docs/interfaces/generated_client.LiveTvApiResetTunerRequest.md b/docs/interfaces/generated_client.LiveTvApiResetTunerRequest.md deleted file mode 100644 index f56fc626f..000000000 --- a/docs/interfaces/generated_client.LiveTvApiResetTunerRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiResetTunerRequest - -# Interface: LiveTvApiResetTunerRequest - -[generated-client](../modules/generated_client.md).LiveTvApiResetTunerRequest - -Request parameters for resetTuner operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiResetTunerRequest - -## Table of contents - -### Properties - -- [tunerId](generated_client.LiveTvApiResetTunerRequest.md#tunerid) - -## Properties - -### tunerId - -• `Readonly` **tunerId**: `string` - -Tuner id. - -**`memberof`** LiveTvApiResetTuner - -#### Defined in - -[generated-client/api/live-tv-api.ts:4425](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4425) diff --git a/docs/interfaces/generated_client.LiveTvApiSetChannelMappingRequest.md b/docs/interfaces/generated_client.LiveTvApiSetChannelMappingRequest.md deleted file mode 100644 index a02be11be..000000000 --- a/docs/interfaces/generated_client.LiveTvApiSetChannelMappingRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiSetChannelMappingRequest - -# Interface: LiveTvApiSetChannelMappingRequest - -[generated-client](../modules/generated_client.md).LiveTvApiSetChannelMappingRequest - -Request parameters for setChannelMapping operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiSetChannelMappingRequest - -## Table of contents - -### Properties - -- [setChannelMappingDto](generated_client.LiveTvApiSetChannelMappingRequest.md#setchannelmappingdto) - -## Properties - -### setChannelMappingDto - -• `Readonly` **setChannelMappingDto**: [`SetChannelMappingDto`](generated_client.SetChannelMappingDto.md) - -The set channel mapping dto. - -**`memberof`** LiveTvApiSetChannelMapping - -#### Defined in - -[generated-client/api/live-tv-api.ts:4439](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4439) diff --git a/docs/interfaces/generated_client.LiveTvApiUpdateSeriesTimerRequest.md b/docs/interfaces/generated_client.LiveTvApiUpdateSeriesTimerRequest.md deleted file mode 100644 index 7b920ae4e..000000000 --- a/docs/interfaces/generated_client.LiveTvApiUpdateSeriesTimerRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiUpdateSeriesTimerRequest - -# Interface: LiveTvApiUpdateSeriesTimerRequest - -[generated-client](../modules/generated_client.md).LiveTvApiUpdateSeriesTimerRequest - -Request parameters for updateSeriesTimer operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiUpdateSeriesTimerRequest - -## Table of contents - -### Properties - -- [seriesTimerInfoDto](generated_client.LiveTvApiUpdateSeriesTimerRequest.md#seriestimerinfodto) -- [timerId](generated_client.LiveTvApiUpdateSeriesTimerRequest.md#timerid) - -## Properties - -### seriesTimerInfoDto - -• `Optional` `Readonly` **seriesTimerInfoDto**: [`SeriesTimerInfoDto`](generated_client.SeriesTimerInfoDto.md) - -New series timer info. - -**`memberof`** LiveTvApiUpdateSeriesTimer - -#### Defined in - -[generated-client/api/live-tv-api.ts:4460](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4460) - -___ - -### timerId - -• `Readonly` **timerId**: `string` - -Timer id. - -**`memberof`** LiveTvApiUpdateSeriesTimer - -#### Defined in - -[generated-client/api/live-tv-api.ts:4453](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4453) diff --git a/docs/interfaces/generated_client.LiveTvApiUpdateTimerRequest.md b/docs/interfaces/generated_client.LiveTvApiUpdateTimerRequest.md deleted file mode 100644 index 60c3f9e43..000000000 --- a/docs/interfaces/generated_client.LiveTvApiUpdateTimerRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvApiUpdateTimerRequest - -# Interface: LiveTvApiUpdateTimerRequest - -[generated-client](../modules/generated_client.md).LiveTvApiUpdateTimerRequest - -Request parameters for updateTimer operation in LiveTvApi. - -**`export`** - -**`interface`** LiveTvApiUpdateTimerRequest - -## Table of contents - -### Properties - -- [timerId](generated_client.LiveTvApiUpdateTimerRequest.md#timerid) -- [timerInfoDto](generated_client.LiveTvApiUpdateTimerRequest.md#timerinfodto) - -## Properties - -### timerId - -• `Readonly` **timerId**: `string` - -Timer id. - -**`memberof`** LiveTvApiUpdateTimer - -#### Defined in - -[generated-client/api/live-tv-api.ts:4474](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4474) - -___ - -### timerInfoDto - -• `Optional` `Readonly` **timerInfoDto**: [`TimerInfoDto`](generated_client.TimerInfoDto.md) - -New timer info. - -**`memberof`** LiveTvApiUpdateTimer - -#### Defined in - -[generated-client/api/live-tv-api.ts:4481](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L4481) diff --git a/docs/interfaces/generated_client.LiveTvInfo.md b/docs/interfaces/generated_client.LiveTvInfo.md deleted file mode 100644 index 33e69b61c..000000000 --- a/docs/interfaces/generated_client.LiveTvInfo.md +++ /dev/null @@ -1,59 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvInfo - -# Interface: LiveTvInfo - -[generated-client](../modules/generated_client.md).LiveTvInfo - -**`export`** - -**`interface`** LiveTvInfo - -## Table of contents - -### Properties - -- [EnabledUsers](generated_client.LiveTvInfo.md#enabledusers) -- [IsEnabled](generated_client.LiveTvInfo.md#isenabled) -- [Services](generated_client.LiveTvInfo.md#services) - -## Properties - -### EnabledUsers - -• `Optional` **EnabledUsers**: `string`[] - -Gets or sets the enabled users. - -**`memberof`** LiveTvInfo - -#### Defined in - -[generated-client/models/live-tv-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-info.ts#L41) - -___ - -### IsEnabled - -• `Optional` **IsEnabled**: `boolean` - -Gets or sets a value indicating whether this instance is enabled. - -**`memberof`** LiveTvInfo - -#### Defined in - -[generated-client/models/live-tv-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-info.ts#L35) - -___ - -### Services - -• `Optional` **Services**: [`LiveTvServiceInfo`](generated_client.LiveTvServiceInfo.md)[] - -Gets or sets the services. - -**`memberof`** LiveTvInfo - -#### Defined in - -[generated-client/models/live-tv-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-info.ts#L29) diff --git a/docs/interfaces/generated_client.LiveTvOptions.md b/docs/interfaces/generated_client.LiveTvOptions.md deleted file mode 100644 index 7d6426ed3..000000000 --- a/docs/interfaces/generated_client.LiveTvOptions.md +++ /dev/null @@ -1,183 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvOptions - -# Interface: LiveTvOptions - -[generated-client](../modules/generated_client.md).LiveTvOptions - -**`export`** - -**`interface`** LiveTvOptions - -## Table of contents - -### Properties - -- [EnableOriginalAudioWithEncodedRecordings](generated_client.LiveTvOptions.md#enableoriginalaudiowithencodedrecordings) -- [EnableRecordingSubfolders](generated_client.LiveTvOptions.md#enablerecordingsubfolders) -- [GuideDays](generated_client.LiveTvOptions.md#guidedays) -- [ListingProviders](generated_client.LiveTvOptions.md#listingproviders) -- [MediaLocationsCreated](generated_client.LiveTvOptions.md#medialocationscreated) -- [MovieRecordingPath](generated_client.LiveTvOptions.md#movierecordingpath) -- [PostPaddingSeconds](generated_client.LiveTvOptions.md#postpaddingseconds) -- [PrePaddingSeconds](generated_client.LiveTvOptions.md#prepaddingseconds) -- [RecordingPath](generated_client.LiveTvOptions.md#recordingpath) -- [RecordingPostProcessor](generated_client.LiveTvOptions.md#recordingpostprocessor) -- [RecordingPostProcessorArguments](generated_client.LiveTvOptions.md#recordingpostprocessorarguments) -- [SeriesRecordingPath](generated_client.LiveTvOptions.md#seriesrecordingpath) -- [TunerHosts](generated_client.LiveTvOptions.md#tunerhosts) - -## Properties - -### EnableOriginalAudioWithEncodedRecordings - -• `Optional` **EnableOriginalAudioWithEncodedRecordings**: `boolean` - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L60) - -___ - -### EnableRecordingSubfolders - -• `Optional` **EnableRecordingSubfolders**: `boolean` - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L54) - -___ - -### GuideDays - -• `Optional` **GuideDays**: ``null`` \| `number` - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L30) - -___ - -### ListingProviders - -• `Optional` **ListingProviders**: ``null`` \| [`ListingsProviderInfo`](generated_client.ListingsProviderInfo.md)[] - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L72) - -___ - -### MediaLocationsCreated - -• `Optional` **MediaLocationsCreated**: ``null`` \| `string`[] - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:90](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L90) - -___ - -### MovieRecordingPath - -• `Optional` **MovieRecordingPath**: ``null`` \| `string` - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L42) - -___ - -### PostPaddingSeconds - -• `Optional` **PostPaddingSeconds**: `number` - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L84) - -___ - -### PrePaddingSeconds - -• `Optional` **PrePaddingSeconds**: `number` - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L78) - -___ - -### RecordingPath - -• `Optional` **RecordingPath**: ``null`` \| `string` - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L36) - -___ - -### RecordingPostProcessor - -• `Optional` **RecordingPostProcessor**: ``null`` \| `string` - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:96](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L96) - -___ - -### RecordingPostProcessorArguments - -• `Optional` **RecordingPostProcessorArguments**: ``null`` \| `string` - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:102](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L102) - -___ - -### SeriesRecordingPath - -• `Optional` **SeriesRecordingPath**: ``null`` \| `string` - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L48) - -___ - -### TunerHosts - -• `Optional` **TunerHosts**: ``null`` \| [`TunerHostInfo`](generated_client.TunerHostInfo.md)[] - -**`memberof`** LiveTvOptions - -#### Defined in - -[generated-client/models/live-tv-options.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-options.ts#L66) diff --git a/docs/interfaces/generated_client.LiveTvServiceInfo.md b/docs/interfaces/generated_client.LiveTvServiceInfo.md deleted file mode 100644 index 4e6ffee1a..000000000 --- a/docs/interfaces/generated_client.LiveTvServiceInfo.md +++ /dev/null @@ -1,132 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LiveTvServiceInfo - -# Interface: LiveTvServiceInfo - -[generated-client](../modules/generated_client.md).LiveTvServiceInfo - -Class ServiceInfo. - -**`export`** - -**`interface`** LiveTvServiceInfo - -## Table of contents - -### Properties - -- [HasUpdateAvailable](generated_client.LiveTvServiceInfo.md#hasupdateavailable) -- [HomePageUrl](generated_client.LiveTvServiceInfo.md#homepageurl) -- [IsVisible](generated_client.LiveTvServiceInfo.md#isvisible) -- [Name](generated_client.LiveTvServiceInfo.md#name) -- [Status](generated_client.LiveTvServiceInfo.md#status) -- [StatusMessage](generated_client.LiveTvServiceInfo.md#statusmessage) -- [Tuners](generated_client.LiveTvServiceInfo.md#tuners) -- [Version](generated_client.LiveTvServiceInfo.md#version) - -## Properties - -### HasUpdateAvailable - -• `Optional` **HasUpdateAvailable**: `boolean` - -Gets or sets a value indicating whether this instance has update available. - -**`memberof`** LiveTvServiceInfo - -#### Defined in - -[generated-client/models/live-tv-service-info.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-service-info.ts#L59) - -___ - -### HomePageUrl - -• `Optional` **HomePageUrl**: ``null`` \| `string` - -Gets or sets the home page URL. - -**`memberof`** LiveTvServiceInfo - -#### Defined in - -[generated-client/models/live-tv-service-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-service-info.ts#L35) - -___ - -### IsVisible - -• `Optional` **IsVisible**: `boolean` - -Gets or sets a value indicating whether this instance is visible. - -**`memberof`** LiveTvServiceInfo - -#### Defined in - -[generated-client/models/live-tv-service-info.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-service-info.ts#L65) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** LiveTvServiceInfo - -#### Defined in - -[generated-client/models/live-tv-service-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-service-info.ts#L29) - -___ - -### Status - -• `Optional` **Status**: [`LiveTvServiceStatus`](../enums/generated_client.LiveTvServiceStatus.md) - -**`memberof`** LiveTvServiceInfo - -#### Defined in - -[generated-client/models/live-tv-service-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-service-info.ts#L41) - -___ - -### StatusMessage - -• `Optional` **StatusMessage**: ``null`` \| `string` - -Gets or sets the status message. - -**`memberof`** LiveTvServiceInfo - -#### Defined in - -[generated-client/models/live-tv-service-info.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-service-info.ts#L47) - -___ - -### Tuners - -• `Optional` **Tuners**: ``null`` \| `string`[] - -**`memberof`** LiveTvServiceInfo - -#### Defined in - -[generated-client/models/live-tv-service-info.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-service-info.ts#L71) - -___ - -### Version - -• `Optional` **Version**: ``null`` \| `string` - -Gets or sets the version. - -**`memberof`** LiveTvServiceInfo - -#### Defined in - -[generated-client/models/live-tv-service-info.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/live-tv-service-info.ts#L53) diff --git a/docs/interfaces/generated_client.LocalizationOption.md b/docs/interfaces/generated_client.LocalizationOption.md deleted file mode 100644 index 3c39d0c48..000000000 --- a/docs/interfaces/generated_client.LocalizationOption.md +++ /dev/null @@ -1,40 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LocalizationOption - -# Interface: LocalizationOption - -[generated-client](../modules/generated_client.md).LocalizationOption - -**`export`** - -**`interface`** LocalizationOption - -## Table of contents - -### Properties - -- [Name](generated_client.LocalizationOption.md#name) -- [Value](generated_client.LocalizationOption.md#value) - -## Properties - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -**`memberof`** LocalizationOption - -#### Defined in - -[generated-client/models/localization-option.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/localization-option.ts#L28) - -___ - -### Value - -• `Optional` **Value**: ``null`` \| `string` - -**`memberof`** LocalizationOption - -#### Defined in - -[generated-client/models/localization-option.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/localization-option.ts#L34) diff --git a/docs/interfaces/generated_client.LogFile.md b/docs/interfaces/generated_client.LogFile.md deleted file mode 100644 index d66fd01c4..000000000 --- a/docs/interfaces/generated_client.LogFile.md +++ /dev/null @@ -1,74 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LogFile - -# Interface: LogFile - -[generated-client](../modules/generated_client.md).LogFile - -**`export`** - -**`interface`** LogFile - -## Table of contents - -### Properties - -- [DateCreated](generated_client.LogFile.md#datecreated) -- [DateModified](generated_client.LogFile.md#datemodified) -- [Name](generated_client.LogFile.md#name) -- [Size](generated_client.LogFile.md#size) - -## Properties - -### DateCreated - -• `Optional` **DateCreated**: `string` - -Gets or sets the date created. - -**`memberof`** LogFile - -#### Defined in - -[generated-client/models/log-file.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/log-file.ts#L28) - -___ - -### DateModified - -• `Optional` **DateModified**: `string` - -Gets or sets the date modified. - -**`memberof`** LogFile - -#### Defined in - -[generated-client/models/log-file.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/log-file.ts#L34) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** LogFile - -#### Defined in - -[generated-client/models/log-file.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/log-file.ts#L46) - -___ - -### Size - -• `Optional` **Size**: `number` - -Gets or sets the size. - -**`memberof`** LogFile - -#### Defined in - -[generated-client/models/log-file.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/log-file.ts#L40) diff --git a/docs/interfaces/generated_client.MediaAttachment.md b/docs/interfaces/generated_client.MediaAttachment.md deleted file mode 100644 index 2c05090ab..000000000 --- a/docs/interfaces/generated_client.MediaAttachment.md +++ /dev/null @@ -1,121 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaAttachment - -# Interface: MediaAttachment - -[generated-client](../modules/generated_client.md).MediaAttachment - -Class MediaAttachment. - -**`export`** - -**`interface`** MediaAttachment - -## Table of contents - -### Properties - -- [Codec](generated_client.MediaAttachment.md#codec) -- [CodecTag](generated_client.MediaAttachment.md#codectag) -- [Comment](generated_client.MediaAttachment.md#comment) -- [DeliveryUrl](generated_client.MediaAttachment.md#deliveryurl) -- [FileName](generated_client.MediaAttachment.md#filename) -- [Index](generated_client.MediaAttachment.md#index) -- [MimeType](generated_client.MediaAttachment.md#mimetype) - -## Properties - -### Codec - -• `Optional` **Codec**: ``null`` \| `string` - -Gets or sets the codec. - -**`memberof`** MediaAttachment - -#### Defined in - -[generated-client/models/media-attachment.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-attachment.ts#L28) - -___ - -### CodecTag - -• `Optional` **CodecTag**: ``null`` \| `string` - -Gets or sets the codec tag. - -**`memberof`** MediaAttachment - -#### Defined in - -[generated-client/models/media-attachment.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-attachment.ts#L34) - -___ - -### Comment - -• `Optional` **Comment**: ``null`` \| `string` - -Gets or sets the comment. - -**`memberof`** MediaAttachment - -#### Defined in - -[generated-client/models/media-attachment.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-attachment.ts#L40) - -___ - -### DeliveryUrl - -• `Optional` **DeliveryUrl**: ``null`` \| `string` - -Gets or sets the delivery URL. - -**`memberof`** MediaAttachment - -#### Defined in - -[generated-client/models/media-attachment.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-attachment.ts#L64) - -___ - -### FileName - -• `Optional` **FileName**: ``null`` \| `string` - -Gets or sets the filename. - -**`memberof`** MediaAttachment - -#### Defined in - -[generated-client/models/media-attachment.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-attachment.ts#L52) - -___ - -### Index - -• `Optional` **Index**: `number` - -Gets or sets the index. - -**`memberof`** MediaAttachment - -#### Defined in - -[generated-client/models/media-attachment.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-attachment.ts#L46) - -___ - -### MimeType - -• `Optional` **MimeType**: ``null`` \| `string` - -Gets or sets the MIME type. - -**`memberof`** MediaAttachment - -#### Defined in - -[generated-client/models/media-attachment.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-attachment.ts#L58) diff --git a/docs/interfaces/generated_client.MediaEncoderPathDto.md b/docs/interfaces/generated_client.MediaEncoderPathDto.md deleted file mode 100644 index 02f01ce90..000000000 --- a/docs/interfaces/generated_client.MediaEncoderPathDto.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaEncoderPathDto - -# Interface: MediaEncoderPathDto - -[generated-client](../modules/generated_client.md).MediaEncoderPathDto - -Media Encoder Path Dto. - -**`export`** - -**`interface`** MediaEncoderPathDto - -## Table of contents - -### Properties - -- [Path](generated_client.MediaEncoderPathDto.md#path) -- [PathType](generated_client.MediaEncoderPathDto.md#pathtype) - -## Properties - -### Path - -• `Optional` **Path**: `string` - -Gets or sets media encoder path. - -**`memberof`** MediaEncoderPathDto - -#### Defined in - -[generated-client/models/media-encoder-path-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-encoder-path-dto.ts#L28) - -___ - -### PathType - -• `Optional` **PathType**: `string` - -Gets or sets media encoder path type. - -**`memberof`** MediaEncoderPathDto - -#### Defined in - -[generated-client/models/media-encoder-path-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-encoder-path-dto.ts#L34) diff --git a/docs/interfaces/generated_client.MediaInfoApiCloseLiveStreamRequest.md b/docs/interfaces/generated_client.MediaInfoApiCloseLiveStreamRequest.md deleted file mode 100644 index 04de6f79b..000000000 --- a/docs/interfaces/generated_client.MediaInfoApiCloseLiveStreamRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaInfoApiCloseLiveStreamRequest - -# Interface: MediaInfoApiCloseLiveStreamRequest - -[generated-client](../modules/generated_client.md).MediaInfoApiCloseLiveStreamRequest - -Request parameters for closeLiveStream operation in MediaInfoApi. - -**`export`** - -**`interface`** MediaInfoApiCloseLiveStreamRequest - -## Table of contents - -### Properties - -- [liveStreamId](generated_client.MediaInfoApiCloseLiveStreamRequest.md#livestreamid) - -## Properties - -### liveStreamId - -• `Readonly` **liveStreamId**: `string` - -The livestream id. - -**`memberof`** MediaInfoApiCloseLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:555](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L555) diff --git a/docs/interfaces/generated_client.MediaInfoApiGetBitrateTestBytesRequest.md b/docs/interfaces/generated_client.MediaInfoApiGetBitrateTestBytesRequest.md deleted file mode 100644 index b4d46e76b..000000000 --- a/docs/interfaces/generated_client.MediaInfoApiGetBitrateTestBytesRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaInfoApiGetBitrateTestBytesRequest - -# Interface: MediaInfoApiGetBitrateTestBytesRequest - -[generated-client](../modules/generated_client.md).MediaInfoApiGetBitrateTestBytesRequest - -Request parameters for getBitrateTestBytes operation in MediaInfoApi. - -**`export`** - -**`interface`** MediaInfoApiGetBitrateTestBytesRequest - -## Table of contents - -### Properties - -- [size](generated_client.MediaInfoApiGetBitrateTestBytesRequest.md#size) - -## Properties - -### size - -• `Optional` `Readonly` **size**: `number` - -The bitrate. Defaults to 102400. - -**`memberof`** MediaInfoApiGetBitrateTestBytes - -#### Defined in - -[generated-client/api/media-info-api.ts:569](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L569) diff --git a/docs/interfaces/generated_client.MediaInfoApiGetPlaybackInfoRequest.md b/docs/interfaces/generated_client.MediaInfoApiGetPlaybackInfoRequest.md deleted file mode 100644 index 060ae2d39..000000000 --- a/docs/interfaces/generated_client.MediaInfoApiGetPlaybackInfoRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaInfoApiGetPlaybackInfoRequest - -# Interface: MediaInfoApiGetPlaybackInfoRequest - -[generated-client](../modules/generated_client.md).MediaInfoApiGetPlaybackInfoRequest - -Request parameters for getPlaybackInfo operation in MediaInfoApi. - -**`export`** - -**`interface`** MediaInfoApiGetPlaybackInfoRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.MediaInfoApiGetPlaybackInfoRequest.md#itemid) -- [userId](generated_client.MediaInfoApiGetPlaybackInfoRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** MediaInfoApiGetPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:583](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L583) - -___ - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** MediaInfoApiGetPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:590](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L590) diff --git a/docs/interfaces/generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md b/docs/interfaces/generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md deleted file mode 100644 index 52b6590b0..000000000 --- a/docs/interfaces/generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md +++ /dev/null @@ -1,256 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaInfoApiGetPostedPlaybackInfoRequest - -# Interface: MediaInfoApiGetPostedPlaybackInfoRequest - -[generated-client](../modules/generated_client.md).MediaInfoApiGetPostedPlaybackInfoRequest - -Request parameters for getPostedPlaybackInfo operation in MediaInfoApi. - -**`export`** - -**`interface`** MediaInfoApiGetPostedPlaybackInfoRequest - -## Table of contents - -### Properties - -- [allowAudioStreamCopy](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#allowvideostreamcopy) -- [audioStreamIndex](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#audiostreamindex) -- [autoOpenLiveStream](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#autoopenlivestream) -- [enableDirectPlay](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#enabledirectplay) -- [enableDirectStream](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#enabledirectstream) -- [enableTranscoding](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#enabletranscoding) -- [itemId](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#itemid) -- [liveStreamId](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#livestreamid) -- [maxAudioChannels](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#maxaudiochannels) -- [maxStreamingBitrate](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#maxstreamingbitrate) -- [mediaSourceId](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#mediasourceid) -- [playbackInfoDto](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#playbackinfodto) -- [startTimeTicks](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#starttimeticks) -- [subtitleStreamIndex](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#subtitlestreamindex) -- [userId](generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md#userid) - -## Properties - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether to allow to copy the audio stream. Default: true. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:702](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L702) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether to allow to copy the video stream. Default: true. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:695](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L695) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -The audio stream index. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:632](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L632) - -___ - -### autoOpenLiveStream - -• `Optional` `Readonly` **autoOpenLiveStream**: `boolean` - -Whether to auto open the livestream. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:667](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L667) - -___ - -### enableDirectPlay - -• `Optional` `Readonly` **enableDirectPlay**: `boolean` - -Whether to enable direct play. Default: true. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:674](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L674) - -___ - -### enableDirectStream - -• `Optional` `Readonly` **enableDirectStream**: `boolean` - -Whether to enable direct stream. Default: true. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:681](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L681) - -___ - -### enableTranscoding - -• `Optional` `Readonly` **enableTranscoding**: `boolean` - -Whether to enable transcoding. Default: true. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:688](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L688) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:604](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L604) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The livestream id. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:660](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L660) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -The maximum number of audio channels. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:646](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L646) - -___ - -### maxStreamingBitrate - -• `Optional` `Readonly` **maxStreamingBitrate**: `number` - -The maximum streaming bitrate. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:618](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L618) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media source id. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:653](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L653) - -___ - -### playbackInfoDto - -• `Optional` `Readonly` **playbackInfoDto**: [`PlaybackInfoDto`](generated_client.PlaybackInfoDto.md) - -The playback info. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:709](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L709) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -The start time in ticks. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:625](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L625) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -The subtitle stream index. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:639](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L639) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -The user id. - -**`memberof`** MediaInfoApiGetPostedPlaybackInfo - -#### Defined in - -[generated-client/api/media-info-api.ts:611](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L611) diff --git a/docs/interfaces/generated_client.MediaInfoApiOpenLiveStreamRequest.md b/docs/interfaces/generated_client.MediaInfoApiOpenLiveStreamRequest.md deleted file mode 100644 index 128326303..000000000 --- a/docs/interfaces/generated_client.MediaInfoApiOpenLiveStreamRequest.md +++ /dev/null @@ -1,196 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaInfoApiOpenLiveStreamRequest - -# Interface: MediaInfoApiOpenLiveStreamRequest - -[generated-client](../modules/generated_client.md).MediaInfoApiOpenLiveStreamRequest - -Request parameters for openLiveStream operation in MediaInfoApi. - -**`export`** - -**`interface`** MediaInfoApiOpenLiveStreamRequest - -## Table of contents - -### Properties - -- [audioStreamIndex](generated_client.MediaInfoApiOpenLiveStreamRequest.md#audiostreamindex) -- [enableDirectPlay](generated_client.MediaInfoApiOpenLiveStreamRequest.md#enabledirectplay) -- [enableDirectStream](generated_client.MediaInfoApiOpenLiveStreamRequest.md#enabledirectstream) -- [itemId](generated_client.MediaInfoApiOpenLiveStreamRequest.md#itemid) -- [maxAudioChannels](generated_client.MediaInfoApiOpenLiveStreamRequest.md#maxaudiochannels) -- [maxStreamingBitrate](generated_client.MediaInfoApiOpenLiveStreamRequest.md#maxstreamingbitrate) -- [openLiveStreamDto](generated_client.MediaInfoApiOpenLiveStreamRequest.md#openlivestreamdto) -- [openToken](generated_client.MediaInfoApiOpenLiveStreamRequest.md#opentoken) -- [playSessionId](generated_client.MediaInfoApiOpenLiveStreamRequest.md#playsessionid) -- [startTimeTicks](generated_client.MediaInfoApiOpenLiveStreamRequest.md#starttimeticks) -- [subtitleStreamIndex](generated_client.MediaInfoApiOpenLiveStreamRequest.md#subtitlestreamindex) -- [userId](generated_client.MediaInfoApiOpenLiveStreamRequest.md#userid) - -## Properties - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -The audio stream index. - -**`memberof`** MediaInfoApiOpenLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:758](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L758) - -___ - -### enableDirectPlay - -• `Optional` `Readonly` **enableDirectPlay**: `boolean` - -Whether to enable direct play. Default: true. - -**`memberof`** MediaInfoApiOpenLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:786](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L786) - -___ - -### enableDirectStream - -• `Optional` `Readonly` **enableDirectStream**: `boolean` - -Whether to enable direct stream. Default: true. - -**`memberof`** MediaInfoApiOpenLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:793](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L793) - -___ - -### itemId - -• `Optional` `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** MediaInfoApiOpenLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:779](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L779) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -The maximum number of audio channels. - -**`memberof`** MediaInfoApiOpenLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:772](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L772) - -___ - -### maxStreamingBitrate - -• `Optional` `Readonly` **maxStreamingBitrate**: `number` - -The maximum streaming bitrate. - -**`memberof`** MediaInfoApiOpenLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:744](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L744) - -___ - -### openLiveStreamDto - -• `Optional` `Readonly` **openLiveStreamDto**: [`OpenLiveStreamDto`](generated_client.OpenLiveStreamDto.md) - -The open live stream dto. - -**`memberof`** MediaInfoApiOpenLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:800](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L800) - -___ - -### openToken - -• `Optional` `Readonly` **openToken**: `string` - -The open token. - -**`memberof`** MediaInfoApiOpenLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:723](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L723) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** MediaInfoApiOpenLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:737](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L737) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -The start time in ticks. - -**`memberof`** MediaInfoApiOpenLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:751](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L751) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -The subtitle stream index. - -**`memberof`** MediaInfoApiOpenLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:765](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L765) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -The user id. - -**`memberof`** MediaInfoApiOpenLiveStream - -#### Defined in - -[generated-client/api/media-info-api.ts:730](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L730) diff --git a/docs/interfaces/generated_client.MediaPathDto.md b/docs/interfaces/generated_client.MediaPathDto.md deleted file mode 100644 index b40e5d486..000000000 --- a/docs/interfaces/generated_client.MediaPathDto.md +++ /dev/null @@ -1,59 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaPathDto - -# Interface: MediaPathDto - -[generated-client](../modules/generated_client.md).MediaPathDto - -Media Path dto. - -**`export`** - -**`interface`** MediaPathDto - -## Table of contents - -### Properties - -- [Name](generated_client.MediaPathDto.md#name) -- [Path](generated_client.MediaPathDto.md#path) -- [PathInfo](generated_client.MediaPathDto.md#pathinfo) - -## Properties - -### Name - -• **Name**: `string` - -Gets or sets the name of the library. - -**`memberof`** MediaPathDto - -#### Defined in - -[generated-client/models/media-path-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-path-dto.ts#L29) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path to add. - -**`memberof`** MediaPathDto - -#### Defined in - -[generated-client/models/media-path-dto.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-path-dto.ts#L35) - -___ - -### PathInfo - -• `Optional` **PathInfo**: [`MediaPathInfo`](generated_client.MediaPathInfo.md) - -**`memberof`** MediaPathDto - -#### Defined in - -[generated-client/models/media-path-dto.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-path-dto.ts#L41) diff --git a/docs/interfaces/generated_client.MediaPathInfo.md b/docs/interfaces/generated_client.MediaPathInfo.md deleted file mode 100644 index 870969b35..000000000 --- a/docs/interfaces/generated_client.MediaPathInfo.md +++ /dev/null @@ -1,40 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaPathInfo - -# Interface: MediaPathInfo - -[generated-client](../modules/generated_client.md).MediaPathInfo - -**`export`** - -**`interface`** MediaPathInfo - -## Table of contents - -### Properties - -- [NetworkPath](generated_client.MediaPathInfo.md#networkpath) -- [Path](generated_client.MediaPathInfo.md#path) - -## Properties - -### NetworkPath - -• `Optional` **NetworkPath**: ``null`` \| `string` - -**`memberof`** MediaPathInfo - -#### Defined in - -[generated-client/models/media-path-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-path-info.ts#L34) - -___ - -### Path - -• `Optional` **Path**: `string` - -**`memberof`** MediaPathInfo - -#### Defined in - -[generated-client/models/media-path-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-path-info.ts#L28) diff --git a/docs/interfaces/generated_client.MediaSourceInfo.md b/docs/interfaces/generated_client.MediaSourceInfo.md deleted file mode 100644 index a2bbc4af6..000000000 --- a/docs/interfaces/generated_client.MediaSourceInfo.md +++ /dev/null @@ -1,562 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaSourceInfo - -# Interface: MediaSourceInfo - -[generated-client](../modules/generated_client.md).MediaSourceInfo - -**`export`** - -**`interface`** MediaSourceInfo - -## Table of contents - -### Properties - -- [AnalyzeDurationMs](generated_client.MediaSourceInfo.md#analyzedurationms) -- [Bitrate](generated_client.MediaSourceInfo.md#bitrate) -- [BufferMs](generated_client.MediaSourceInfo.md#bufferms) -- [Container](generated_client.MediaSourceInfo.md#container) -- [DefaultAudioStreamIndex](generated_client.MediaSourceInfo.md#defaultaudiostreamindex) -- [DefaultSubtitleStreamIndex](generated_client.MediaSourceInfo.md#defaultsubtitlestreamindex) -- [ETag](generated_client.MediaSourceInfo.md#etag) -- [EncoderPath](generated_client.MediaSourceInfo.md#encoderpath) -- [EncoderProtocol](generated_client.MediaSourceInfo.md#encoderprotocol) -- [Formats](generated_client.MediaSourceInfo.md#formats) -- [GenPtsInput](generated_client.MediaSourceInfo.md#genptsinput) -- [Id](generated_client.MediaSourceInfo.md#id) -- [IgnoreDts](generated_client.MediaSourceInfo.md#ignoredts) -- [IgnoreIndex](generated_client.MediaSourceInfo.md#ignoreindex) -- [IsInfiniteStream](generated_client.MediaSourceInfo.md#isinfinitestream) -- [IsRemote](generated_client.MediaSourceInfo.md#isremote) -- [IsoType](generated_client.MediaSourceInfo.md#isotype) -- [LiveStreamId](generated_client.MediaSourceInfo.md#livestreamid) -- [MediaAttachments](generated_client.MediaSourceInfo.md#mediaattachments) -- [MediaStreams](generated_client.MediaSourceInfo.md#mediastreams) -- [Name](generated_client.MediaSourceInfo.md#name) -- [OpenToken](generated_client.MediaSourceInfo.md#opentoken) -- [Path](generated_client.MediaSourceInfo.md#path) -- [Protocol](generated_client.MediaSourceInfo.md#protocol) -- [ReadAtNativeFramerate](generated_client.MediaSourceInfo.md#readatnativeframerate) -- [RequiredHttpHeaders](generated_client.MediaSourceInfo.md#requiredhttpheaders) -- [RequiresClosing](generated_client.MediaSourceInfo.md#requiresclosing) -- [RequiresLooping](generated_client.MediaSourceInfo.md#requireslooping) -- [RequiresOpening](generated_client.MediaSourceInfo.md#requiresopening) -- [RunTimeTicks](generated_client.MediaSourceInfo.md#runtimeticks) -- [Size](generated_client.MediaSourceInfo.md#size) -- [SupportsDirectPlay](generated_client.MediaSourceInfo.md#supportsdirectplay) -- [SupportsDirectStream](generated_client.MediaSourceInfo.md#supportsdirectstream) -- [SupportsProbing](generated_client.MediaSourceInfo.md#supportsprobing) -- [SupportsTranscoding](generated_client.MediaSourceInfo.md#supportstranscoding) -- [Timestamp](generated_client.MediaSourceInfo.md#timestamp) -- [TranscodingContainer](generated_client.MediaSourceInfo.md#transcodingcontainer) -- [TranscodingSubProtocol](generated_client.MediaSourceInfo.md#transcodingsubprotocol) -- [TranscodingUrl](generated_client.MediaSourceInfo.md#transcodingurl) -- [Type](generated_client.MediaSourceInfo.md#type) -- [Video3DFormat](generated_client.MediaSourceInfo.md#video3dformat) -- [VideoType](generated_client.MediaSourceInfo.md#videotype) - -## Properties - -### AnalyzeDurationMs - -• `Optional` **AnalyzeDurationMs**: ``null`` \| `number` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:270](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L270) - -___ - -### Bitrate - -• `Optional` **Bitrate**: ``null`` \| `number` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:234](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L234) - -___ - -### BufferMs - -• `Optional` **BufferMs**: ``null`` \| `number` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:180](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L180) - -___ - -### Container - -• `Optional` **Container**: ``null`` \| `string` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L72) - -___ - -### DefaultAudioStreamIndex - -• `Optional` **DefaultAudioStreamIndex**: ``null`` \| `number` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:276](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L276) - -___ - -### DefaultSubtitleStreamIndex - -• `Optional` **DefaultSubtitleStreamIndex**: ``null`` \| `number` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:282](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L282) - -___ - -### ETag - -• `Optional` **ETag**: ``null`` \| `string` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:96](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L96) - -___ - -### EncoderPath - -• `Optional` **EncoderPath**: ``null`` \| `string` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L54) - -___ - -### EncoderProtocol - -• `Optional` **EncoderProtocol**: [`MediaProtocol`](../enums/generated_client.MediaProtocol.md) - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L60) - -___ - -### Formats - -• `Optional` **Formats**: ``null`` \| `string`[] - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:228](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L228) - -___ - -### GenPtsInput - -• `Optional` **GenPtsInput**: `boolean` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:126](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L126) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L42) - -___ - -### IgnoreDts - -• `Optional` **IgnoreDts**: `boolean` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:114](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L114) - -___ - -### IgnoreIndex - -• `Optional` **IgnoreIndex**: `boolean` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:120](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L120) - -___ - -### IsInfiniteStream - -• `Optional` **IsInfiniteStream**: `boolean` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:150](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L150) - -___ - -### IsRemote - -• `Optional` **IsRemote**: `boolean` - -Gets or sets a value indicating whether the media is remote. Differentiate internet url vs local network. - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:90](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L90) - -___ - -### IsoType - -• `Optional` **IsoType**: [`IsoType`](../enums/generated_client.IsoType.md) - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:204](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L204) - -___ - -### LiveStreamId - -• `Optional` **LiveStreamId**: ``null`` \| `string` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:174](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L174) - -___ - -### MediaAttachments - -• `Optional` **MediaAttachments**: ``null`` \| [`MediaAttachment`](generated_client.MediaAttachment.md)[] - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:222](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L222) - -___ - -### MediaStreams - -• `Optional` **MediaStreams**: ``null`` \| [`MediaStream`](generated_client.MediaStream.md)[] - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:216](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L216) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L84) - -___ - -### OpenToken - -• `Optional` **OpenToken**: ``null`` \| `string` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:162](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L162) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L48) - -___ - -### Protocol - -• `Optional` **Protocol**: [`MediaProtocol`](../enums/generated_client.MediaProtocol.md) - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L36) - -___ - -### ReadAtNativeFramerate - -• `Optional` **ReadAtNativeFramerate**: `boolean` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:108](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L108) - -___ - -### RequiredHttpHeaders - -• `Optional` **RequiredHttpHeaders**: ``null`` \| { `[key: string]`: `string`; } - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:246](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L246) - -___ - -### RequiresClosing - -• `Optional` **RequiresClosing**: `boolean` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:168](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L168) - -___ - -### RequiresLooping - -• `Optional` **RequiresLooping**: `boolean` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:186](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L186) - -___ - -### RequiresOpening - -• `Optional` **RequiresOpening**: `boolean` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:156](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L156) - -___ - -### RunTimeTicks - -• `Optional` **RunTimeTicks**: ``null`` \| `number` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:102](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L102) - -___ - -### Size - -• `Optional` **Size**: ``null`` \| `number` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L78) - -___ - -### SupportsDirectPlay - -• `Optional` **SupportsDirectPlay**: `boolean` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:144](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L144) - -___ - -### SupportsDirectStream - -• `Optional` **SupportsDirectStream**: `boolean` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:138](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L138) - -___ - -### SupportsProbing - -• `Optional` **SupportsProbing**: `boolean` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:192](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L192) - -___ - -### SupportsTranscoding - -• `Optional` **SupportsTranscoding**: `boolean` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:132](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L132) - -___ - -### Timestamp - -• `Optional` **Timestamp**: [`TransportStreamTimestamp`](../enums/generated_client.TransportStreamTimestamp.md) - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:240](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L240) - -___ - -### TranscodingContainer - -• `Optional` **TranscodingContainer**: ``null`` \| `string` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:264](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L264) - -___ - -### TranscodingSubProtocol - -• `Optional` **TranscodingSubProtocol**: ``null`` \| `string` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:258](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L258) - -___ - -### TranscodingUrl - -• `Optional` **TranscodingUrl**: ``null`` \| `string` - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:252](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L252) - -___ - -### Type - -• `Optional` **Type**: [`MediaSourceType`](../enums/generated_client.MediaSourceType.md) - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L66) - -___ - -### Video3DFormat - -• `Optional` **Video3DFormat**: [`Video3DFormat`](../enums/generated_client.Video3DFormat.md) - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:210](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L210) - -___ - -### VideoType - -• `Optional` **VideoType**: [`VideoType`](../enums/generated_client.VideoType.md) - -**`memberof`** MediaSourceInfo - -#### Defined in - -[generated-client/models/media-source-info.ts:198](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-source-info.ts#L198) diff --git a/docs/interfaces/generated_client.MediaStream.md b/docs/interfaces/generated_client.MediaStream.md deleted file mode 100644 index e14cecd18..000000000 --- a/docs/interfaces/generated_client.MediaStream.md +++ /dev/null @@ -1,866 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaStream - -# Interface: MediaStream - -[generated-client](../modules/generated_client.md).MediaStream - -Class MediaStream. - -**`export`** - -**`interface`** MediaStream - -## Table of contents - -### Properties - -- [AspectRatio](generated_client.MediaStream.md#aspectratio) -- [AverageFrameRate](generated_client.MediaStream.md#averageframerate) -- [BitDepth](generated_client.MediaStream.md#bitdepth) -- [BitRate](generated_client.MediaStream.md#bitrate) -- [BlPresentFlag](generated_client.MediaStream.md#blpresentflag) -- [ChannelLayout](generated_client.MediaStream.md#channellayout) -- [Channels](generated_client.MediaStream.md#channels) -- [Codec](generated_client.MediaStream.md#codec) -- [CodecTag](generated_client.MediaStream.md#codectag) -- [CodecTimeBase](generated_client.MediaStream.md#codectimebase) -- [ColorPrimaries](generated_client.MediaStream.md#colorprimaries) -- [ColorRange](generated_client.MediaStream.md#colorrange) -- [ColorSpace](generated_client.MediaStream.md#colorspace) -- [ColorTransfer](generated_client.MediaStream.md#colortransfer) -- [Comment](generated_client.MediaStream.md#comment) -- [DeliveryMethod](generated_client.MediaStream.md#deliverymethod) -- [DeliveryUrl](generated_client.MediaStream.md#deliveryurl) -- [DisplayTitle](generated_client.MediaStream.md#displaytitle) -- [DvBlSignalCompatibilityId](generated_client.MediaStream.md#dvblsignalcompatibilityid) -- [DvLevel](generated_client.MediaStream.md#dvlevel) -- [DvProfile](generated_client.MediaStream.md#dvprofile) -- [DvVersionMajor](generated_client.MediaStream.md#dvversionmajor) -- [DvVersionMinor](generated_client.MediaStream.md#dvversionminor) -- [ElPresentFlag](generated_client.MediaStream.md#elpresentflag) -- [Height](generated_client.MediaStream.md#height) -- [Index](generated_client.MediaStream.md#index) -- [IsAVC](generated_client.MediaStream.md#isavc) -- [IsAnamorphic](generated_client.MediaStream.md#isanamorphic) -- [IsDefault](generated_client.MediaStream.md#isdefault) -- [IsExternal](generated_client.MediaStream.md#isexternal) -- [IsExternalUrl](generated_client.MediaStream.md#isexternalurl) -- [IsForced](generated_client.MediaStream.md#isforced) -- [IsInterlaced](generated_client.MediaStream.md#isinterlaced) -- [IsTextSubtitleStream](generated_client.MediaStream.md#istextsubtitlestream) -- [Language](generated_client.MediaStream.md#language) -- [Level](generated_client.MediaStream.md#level) -- [LocalizedDefault](generated_client.MediaStream.md#localizeddefault) -- [LocalizedExternal](generated_client.MediaStream.md#localizedexternal) -- [LocalizedForced](generated_client.MediaStream.md#localizedforced) -- [LocalizedUndefined](generated_client.MediaStream.md#localizedundefined) -- [NalLengthSize](generated_client.MediaStream.md#nallengthsize) -- [PacketLength](generated_client.MediaStream.md#packetlength) -- [Path](generated_client.MediaStream.md#path) -- [PixelFormat](generated_client.MediaStream.md#pixelformat) -- [Profile](generated_client.MediaStream.md#profile) -- [RealFrameRate](generated_client.MediaStream.md#realframerate) -- [RefFrames](generated_client.MediaStream.md#refframes) -- [RpuPresentFlag](generated_client.MediaStream.md#rpupresentflag) -- [SampleRate](generated_client.MediaStream.md#samplerate) -- [Score](generated_client.MediaStream.md#score) -- [SupportsExternalStream](generated_client.MediaStream.md#supportsexternalstream) -- [TimeBase](generated_client.MediaStream.md#timebase) -- [Title](generated_client.MediaStream.md#title) -- [Type](generated_client.MediaStream.md#type) -- [VideoDoViTitle](generated_client.MediaStream.md#videodovititle) -- [VideoRange](generated_client.MediaStream.md#videorange) -- [VideoRangeType](generated_client.MediaStream.md#videorangetype) -- [Width](generated_client.MediaStream.md#width) - -## Properties - -### AspectRatio - -• `Optional` **AspectRatio**: ``null`` \| `string` - -Gets or sets the aspect ratio. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:300](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L300) - -___ - -### AverageFrameRate - -• `Optional` **AverageFrameRate**: ``null`` \| `number` - -Gets or sets the average frame rate. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:276](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L276) - -___ - -### BitDepth - -• `Optional` **BitDepth**: ``null`` \| `number` - -Gets or sets the bit depth. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:222](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L222) - -___ - -### BitRate - -• `Optional` **BitRate**: ``null`` \| `number` - -Gets or sets the bit rate. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:216](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L216) - -___ - -### BlPresentFlag - -• `Optional` **BlPresentFlag**: ``null`` \| `number` - -Gets or sets the Dolby Vision bl present flag. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:108](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L108) - -___ - -### ChannelLayout - -• `Optional` **ChannelLayout**: ``null`` \| `string` - -Gets or sets the channel layout. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:210](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L210) - -___ - -### Channels - -• `Optional` **Channels**: ``null`` \| `number` - -Gets or sets the channels. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:240](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L240) - -___ - -### Codec - -• `Optional` **Codec**: ``null`` \| `string` - -Gets or sets the codec. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L30) - -___ - -### CodecTag - -• `Optional` **CodecTag**: ``null`` \| `string` - -Gets or sets the codec tag. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L36) - -___ - -### CodecTimeBase - -• `Optional` **CodecTimeBase**: ``null`` \| `string` - -Gets or sets the codec time base. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:132](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L132) - -___ - -### ColorPrimaries - -• `Optional` **ColorPrimaries**: ``null`` \| `string` - -Gets or sets the color primaries. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L66) - -___ - -### ColorRange - -• `Optional` **ColorRange**: ``null`` \| `string` - -Gets or sets the color range. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L48) - -___ - -### ColorSpace - -• `Optional` **ColorSpace**: ``null`` \| `string` - -Gets or sets the color space. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L54) - -___ - -### ColorTransfer - -• `Optional` **ColorTransfer**: ``null`` \| `string` - -Gets or sets the color transfer. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L60) - -___ - -### Comment - -• `Optional` **Comment**: ``null`` \| `string` - -Gets or sets the comment. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:120](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L120) - -___ - -### DeliveryMethod - -• `Optional` **DeliveryMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:324](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L324) - -___ - -### DeliveryUrl - -• `Optional` **DeliveryUrl**: ``null`` \| `string` - -Gets or sets the delivery URL. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:330](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L330) - -___ - -### DisplayTitle - -• `Optional` **DisplayTitle**: ``null`` \| `string` - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:186](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L186) - -___ - -### DvBlSignalCompatibilityId - -• `Optional` **DvBlSignalCompatibilityId**: ``null`` \| `number` - -Gets or sets the Dolby Vision bl signal compatibility id. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:114](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L114) - -___ - -### DvLevel - -• `Optional` **DvLevel**: ``null`` \| `number` - -Gets or sets the Dolby Vision level. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:90](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L90) - -___ - -### DvProfile - -• `Optional` **DvProfile**: ``null`` \| `number` - -Gets or sets the Dolby Vision profile. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L84) - -___ - -### DvVersionMajor - -• `Optional` **DvVersionMajor**: ``null`` \| `number` - -Gets or sets the Dolby Vision version major. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L72) - -___ - -### DvVersionMinor - -• `Optional` **DvVersionMinor**: ``null`` \| `number` - -Gets or sets the Dolby Vision version minor. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L78) - -___ - -### ElPresentFlag - -• `Optional` **ElPresentFlag**: ``null`` \| `number` - -Gets or sets the Dolby Vision el present flag. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:102](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L102) - -___ - -### Height - -• `Optional` **Height**: ``null`` \| `number` - -Gets or sets the height. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:264](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L264) - -___ - -### Index - -• `Optional` **Index**: `number` - -Gets or sets the index. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:306](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L306) - -___ - -### IsAVC - -• `Optional` **IsAVC**: ``null`` \| `boolean` - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:204](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L204) - -___ - -### IsAnamorphic - -• `Optional` **IsAnamorphic**: ``null`` \| `boolean` - -Gets or sets whether this instance is anamorphic. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:372](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L372) - -___ - -### IsDefault - -• `Optional` **IsDefault**: `boolean` - -Gets or sets a value indicating whether this instance is default. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:252](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L252) - -___ - -### IsExternal - -• `Optional` **IsExternal**: `boolean` - -Gets or sets a value indicating whether this instance is external. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:318](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L318) - -___ - -### IsExternalUrl - -• `Optional` **IsExternalUrl**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this instance is external URL. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:336](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L336) - -___ - -### IsForced - -• `Optional` **IsForced**: `boolean` - -Gets or sets a value indicating whether this instance is forced. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:258](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L258) - -___ - -### IsInterlaced - -• `Optional` **IsInterlaced**: `boolean` - -Gets or sets a value indicating whether this instance is interlaced. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:198](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L198) - -___ - -### IsTextSubtitleStream - -• `Optional` **IsTextSubtitleStream**: `boolean` - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:342](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L342) - -___ - -### Language - -• `Optional` **Language**: ``null`` \| `string` - -Gets or sets the language. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L42) - -___ - -### Level - -• `Optional` **Level**: ``null`` \| `number` - -Gets or sets the level. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:366](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L366) - -___ - -### LocalizedDefault - -• `Optional` **LocalizedDefault**: ``null`` \| `string` - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:168](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L168) - -___ - -### LocalizedExternal - -• `Optional` **LocalizedExternal**: ``null`` \| `string` - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:180](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L180) - -___ - -### LocalizedForced - -• `Optional` **LocalizedForced**: ``null`` \| `string` - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:174](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L174) - -___ - -### LocalizedUndefined - -• `Optional` **LocalizedUndefined**: ``null`` \| `string` - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:162](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L162) - -___ - -### NalLengthSize - -• `Optional` **NalLengthSize**: ``null`` \| `string` - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:192](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L192) - -___ - -### PacketLength - -• `Optional` **PacketLength**: ``null`` \| `number` - -Gets or sets the length of the packet. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:234](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L234) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the filename. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:354](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L354) - -___ - -### PixelFormat - -• `Optional` **PixelFormat**: ``null`` \| `string` - -Gets or sets the pixel format. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:360](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L360) - -___ - -### Profile - -• `Optional` **Profile**: ``null`` \| `string` - -Gets or sets the profile. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:288](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L288) - -___ - -### RealFrameRate - -• `Optional` **RealFrameRate**: ``null`` \| `number` - -Gets or sets the real frame rate. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:282](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L282) - -___ - -### RefFrames - -• `Optional` **RefFrames**: ``null`` \| `number` - -Gets or sets the reference frames. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:228](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L228) - -___ - -### RpuPresentFlag - -• `Optional` **RpuPresentFlag**: ``null`` \| `number` - -Gets or sets the Dolby Vision rpu present flag. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:96](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L96) - -___ - -### SampleRate - -• `Optional` **SampleRate**: ``null`` \| `number` - -Gets or sets the sample rate. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:246](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L246) - -___ - -### Score - -• `Optional` **Score**: ``null`` \| `number` - -Gets or sets the score. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:312](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L312) - -___ - -### SupportsExternalStream - -• `Optional` **SupportsExternalStream**: `boolean` - -Gets or sets a value indicating whether [supports external stream]. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:348](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L348) - -___ - -### TimeBase - -• `Optional` **TimeBase**: ``null`` \| `string` - -Gets or sets the time base. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:126](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L126) - -___ - -### Title - -• `Optional` **Title**: ``null`` \| `string` - -Gets or sets the title. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:138](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L138) - -___ - -### Type - -• `Optional` **Type**: [`MediaStreamType`](../enums/generated_client.MediaStreamType.md) - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:294](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L294) - -___ - -### VideoDoViTitle - -• `Optional` **VideoDoViTitle**: ``null`` \| `string` - -Gets the video dovi title. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:156](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L156) - -___ - -### VideoRange - -• `Optional` **VideoRange**: ``null`` \| `string` - -Gets the video range. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:144](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L144) - -___ - -### VideoRangeType - -• `Optional` **VideoRangeType**: ``null`` \| `string` - -Gets the video range type. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:150](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L150) - -___ - -### Width - -• `Optional` **Width**: ``null`` \| `number` - -Gets or sets the width. - -**`memberof`** MediaStream - -#### Defined in - -[generated-client/models/media-stream.ts:270](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-stream.ts#L270) diff --git a/docs/interfaces/generated_client.MediaUpdateInfoDto.md b/docs/interfaces/generated_client.MediaUpdateInfoDto.md deleted file mode 100644 index f7791644d..000000000 --- a/docs/interfaces/generated_client.MediaUpdateInfoDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaUpdateInfoDto - -# Interface: MediaUpdateInfoDto - -[generated-client](../modules/generated_client.md).MediaUpdateInfoDto - -Media Update Info Dto. - -**`export`** - -**`interface`** MediaUpdateInfoDto - -## Table of contents - -### Properties - -- [Updates](generated_client.MediaUpdateInfoDto.md#updates) - -## Properties - -### Updates - -• `Optional` **Updates**: [`MediaUpdateInfoPathDto`](generated_client.MediaUpdateInfoPathDto.md)[] - -Gets or sets the list of updates. - -**`memberof`** MediaUpdateInfoDto - -#### Defined in - -[generated-client/models/media-update-info-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-update-info-dto.ts#L29) diff --git a/docs/interfaces/generated_client.MediaUpdateInfoPathDto.md b/docs/interfaces/generated_client.MediaUpdateInfoPathDto.md deleted file mode 100644 index e114adc6d..000000000 --- a/docs/interfaces/generated_client.MediaUpdateInfoPathDto.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaUpdateInfoPathDto - -# Interface: MediaUpdateInfoPathDto - -[generated-client](../modules/generated_client.md).MediaUpdateInfoPathDto - -The media update info path. - -**`export`** - -**`interface`** MediaUpdateInfoPathDto - -## Table of contents - -### Properties - -- [Path](generated_client.MediaUpdateInfoPathDto.md#path) -- [UpdateType](generated_client.MediaUpdateInfoPathDto.md#updatetype) - -## Properties - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets media path. - -**`memberof`** MediaUpdateInfoPathDto - -#### Defined in - -[generated-client/models/media-update-info-path-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-update-info-path-dto.ts#L28) - -___ - -### UpdateType - -• `Optional` **UpdateType**: ``null`` \| `string` - -Gets or sets media update type. Created, Modified, Deleted. - -**`memberof`** MediaUpdateInfoPathDto - -#### Defined in - -[generated-client/models/media-update-info-path-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-update-info-path-dto.ts#L34) diff --git a/docs/interfaces/generated_client.MediaUrl.md b/docs/interfaces/generated_client.MediaUrl.md deleted file mode 100644 index 02e4c5648..000000000 --- a/docs/interfaces/generated_client.MediaUrl.md +++ /dev/null @@ -1,40 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaUrl - -# Interface: MediaUrl - -[generated-client](../modules/generated_client.md).MediaUrl - -**`export`** - -**`interface`** MediaUrl - -## Table of contents - -### Properties - -- [Name](generated_client.MediaUrl.md#name) -- [Url](generated_client.MediaUrl.md#url) - -## Properties - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -**`memberof`** MediaUrl - -#### Defined in - -[generated-client/models/media-url.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-url.ts#L34) - -___ - -### Url - -• `Optional` **Url**: ``null`` \| `string` - -**`memberof`** MediaUrl - -#### Defined in - -[generated-client/models/media-url.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/media-url.ts#L28) diff --git a/docs/interfaces/generated_client.MessageCommand.md b/docs/interfaces/generated_client.MessageCommand.md deleted file mode 100644 index 5d62cc343..000000000 --- a/docs/interfaces/generated_client.MessageCommand.md +++ /dev/null @@ -1,53 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MessageCommand - -# Interface: MessageCommand - -[generated-client](../modules/generated_client.md).MessageCommand - -**`export`** - -**`interface`** MessageCommand - -## Table of contents - -### Properties - -- [Header](generated_client.MessageCommand.md#header) -- [Text](generated_client.MessageCommand.md#text) -- [TimeoutMs](generated_client.MessageCommand.md#timeoutms) - -## Properties - -### Header - -• `Optional` **Header**: ``null`` \| `string` - -**`memberof`** MessageCommand - -#### Defined in - -[generated-client/models/message-command.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/message-command.ts#L28) - -___ - -### Text - -• **Text**: `string` - -**`memberof`** MessageCommand - -#### Defined in - -[generated-client/models/message-command.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/message-command.ts#L34) - -___ - -### TimeoutMs - -• `Optional` **TimeoutMs**: ``null`` \| `number` - -**`memberof`** MessageCommand - -#### Defined in - -[generated-client/models/message-command.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/message-command.ts#L40) diff --git a/docs/interfaces/generated_client.MetadataConfiguration.md b/docs/interfaces/generated_client.MetadataConfiguration.md deleted file mode 100644 index 84a524cf8..000000000 --- a/docs/interfaces/generated_client.MetadataConfiguration.md +++ /dev/null @@ -1,27 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MetadataConfiguration - -# Interface: MetadataConfiguration - -[generated-client](../modules/generated_client.md).MetadataConfiguration - -**`export`** - -**`interface`** MetadataConfiguration - -## Table of contents - -### Properties - -- [UseFileCreationTimeForDateAdded](generated_client.MetadataConfiguration.md#usefilecreationtimefordateadded) - -## Properties - -### UseFileCreationTimeForDateAdded - -• `Optional` **UseFileCreationTimeForDateAdded**: `boolean` - -**`memberof`** MetadataConfiguration - -#### Defined in - -[generated-client/models/metadata-configuration.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-configuration.ts#L28) diff --git a/docs/interfaces/generated_client.MetadataEditorInfo.md b/docs/interfaces/generated_client.MetadataEditorInfo.md deleted file mode 100644 index cdf04c010..000000000 --- a/docs/interfaces/generated_client.MetadataEditorInfo.md +++ /dev/null @@ -1,92 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MetadataEditorInfo - -# Interface: MetadataEditorInfo - -[generated-client](../modules/generated_client.md).MetadataEditorInfo - -**`export`** - -**`interface`** MetadataEditorInfo - -## Table of contents - -### Properties - -- [ContentType](generated_client.MetadataEditorInfo.md#contenttype) -- [ContentTypeOptions](generated_client.MetadataEditorInfo.md#contenttypeoptions) -- [Countries](generated_client.MetadataEditorInfo.md#countries) -- [Cultures](generated_client.MetadataEditorInfo.md#cultures) -- [ExternalIdInfos](generated_client.MetadataEditorInfo.md#externalidinfos) -- [ParentalRatingOptions](generated_client.MetadataEditorInfo.md#parentalratingoptions) - -## Properties - -### ContentType - -• `Optional` **ContentType**: ``null`` \| `string` - -**`memberof`** MetadataEditorInfo - -#### Defined in - -[generated-client/models/metadata-editor-info.ts:57](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-editor-info.ts#L57) - -___ - -### ContentTypeOptions - -• `Optional` **ContentTypeOptions**: [`NameValuePair`](generated_client.NameValuePair.md)[] - -**`memberof`** MetadataEditorInfo - -#### Defined in - -[generated-client/models/metadata-editor-info.ts:63](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-editor-info.ts#L63) - -___ - -### Countries - -• `Optional` **Countries**: [`CountryInfo`](generated_client.CountryInfo.md)[] - -**`memberof`** MetadataEditorInfo - -#### Defined in - -[generated-client/models/metadata-editor-info.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-editor-info.ts#L39) - -___ - -### Cultures - -• `Optional` **Cultures**: [`CultureDto`](generated_client.CultureDto.md)[] - -**`memberof`** MetadataEditorInfo - -#### Defined in - -[generated-client/models/metadata-editor-info.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-editor-info.ts#L45) - -___ - -### ExternalIdInfos - -• `Optional` **ExternalIdInfos**: [`ExternalIdInfo`](generated_client.ExternalIdInfo.md)[] - -**`memberof`** MetadataEditorInfo - -#### Defined in - -[generated-client/models/metadata-editor-info.ts:51](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-editor-info.ts#L51) - -___ - -### ParentalRatingOptions - -• `Optional` **ParentalRatingOptions**: [`ParentalRating`](generated_client.ParentalRating.md)[] - -**`memberof`** MetadataEditorInfo - -#### Defined in - -[generated-client/models/metadata-editor-info.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-editor-info.ts#L33) diff --git a/docs/interfaces/generated_client.MetadataOptions.md b/docs/interfaces/generated_client.MetadataOptions.md deleted file mode 100644 index 3401bd89f..000000000 --- a/docs/interfaces/generated_client.MetadataOptions.md +++ /dev/null @@ -1,107 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MetadataOptions - -# Interface: MetadataOptions - -[generated-client](../modules/generated_client.md).MetadataOptions - -Class MetadataOptions. - -**`export`** - -**`interface`** MetadataOptions - -## Table of contents - -### Properties - -- [DisabledImageFetchers](generated_client.MetadataOptions.md#disabledimagefetchers) -- [DisabledMetadataFetchers](generated_client.MetadataOptions.md#disabledmetadatafetchers) -- [DisabledMetadataSavers](generated_client.MetadataOptions.md#disabledmetadatasavers) -- [ImageFetcherOrder](generated_client.MetadataOptions.md#imagefetcherorder) -- [ItemType](generated_client.MetadataOptions.md#itemtype) -- [LocalMetadataReaderOrder](generated_client.MetadataOptions.md#localmetadatareaderorder) -- [MetadataFetcherOrder](generated_client.MetadataOptions.md#metadatafetcherorder) - -## Properties - -### DisabledImageFetchers - -• `Optional` **DisabledImageFetchers**: ``null`` \| `string`[] - -**`memberof`** MetadataOptions - -#### Defined in - -[generated-client/models/metadata-options.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-options.ts#L58) - -___ - -### DisabledMetadataFetchers - -• `Optional` **DisabledMetadataFetchers**: ``null`` \| `string`[] - -**`memberof`** MetadataOptions - -#### Defined in - -[generated-client/models/metadata-options.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-options.ts#L46) - -___ - -### DisabledMetadataSavers - -• `Optional` **DisabledMetadataSavers**: ``null`` \| `string`[] - -**`memberof`** MetadataOptions - -#### Defined in - -[generated-client/models/metadata-options.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-options.ts#L34) - -___ - -### ImageFetcherOrder - -• `Optional` **ImageFetcherOrder**: ``null`` \| `string`[] - -**`memberof`** MetadataOptions - -#### Defined in - -[generated-client/models/metadata-options.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-options.ts#L64) - -___ - -### ItemType - -• `Optional` **ItemType**: ``null`` \| `string` - -**`memberof`** MetadataOptions - -#### Defined in - -[generated-client/models/metadata-options.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-options.ts#L28) - -___ - -### LocalMetadataReaderOrder - -• `Optional` **LocalMetadataReaderOrder**: ``null`` \| `string`[] - -**`memberof`** MetadataOptions - -#### Defined in - -[generated-client/models/metadata-options.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-options.ts#L40) - -___ - -### MetadataFetcherOrder - -• `Optional` **MetadataFetcherOrder**: ``null`` \| `string`[] - -**`memberof`** MetadataOptions - -#### Defined in - -[generated-client/models/metadata-options.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/metadata-options.ts#L52) diff --git a/docs/interfaces/generated_client.MovePlaylistItemRequestDto.md b/docs/interfaces/generated_client.MovePlaylistItemRequestDto.md deleted file mode 100644 index 7c0936dd2..000000000 --- a/docs/interfaces/generated_client.MovePlaylistItemRequestDto.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MovePlaylistItemRequestDto - -# Interface: MovePlaylistItemRequestDto - -[generated-client](../modules/generated_client.md).MovePlaylistItemRequestDto - -Class MovePlaylistItemRequestDto. - -**`export`** - -**`interface`** MovePlaylistItemRequestDto - -## Table of contents - -### Properties - -- [NewIndex](generated_client.MovePlaylistItemRequestDto.md#newindex) -- [PlaylistItemId](generated_client.MovePlaylistItemRequestDto.md#playlistitemid) - -## Properties - -### NewIndex - -• `Optional` **NewIndex**: `number` - -Gets or sets the new position. - -**`memberof`** MovePlaylistItemRequestDto - -#### Defined in - -[generated-client/models/move-playlist-item-request-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/move-playlist-item-request-dto.ts#L34) - -___ - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: `string` - -Gets or sets the playlist identifier of the item. - -**`memberof`** MovePlaylistItemRequestDto - -#### Defined in - -[generated-client/models/move-playlist-item-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/move-playlist-item-request-dto.ts#L28) diff --git a/docs/interfaces/generated_client.MovieInfo.md b/docs/interfaces/generated_client.MovieInfo.md deleted file mode 100644 index 4ec8f27d2..000000000 --- a/docs/interfaces/generated_client.MovieInfo.md +++ /dev/null @@ -1,171 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MovieInfo - -# Interface: MovieInfo - -[generated-client](../modules/generated_client.md).MovieInfo - -**`export`** - -**`interface`** MovieInfo - -## Table of contents - -### Properties - -- [IndexNumber](generated_client.MovieInfo.md#indexnumber) -- [IsAutomated](generated_client.MovieInfo.md#isautomated) -- [MetadataCountryCode](generated_client.MovieInfo.md#metadatacountrycode) -- [MetadataLanguage](generated_client.MovieInfo.md#metadatalanguage) -- [Name](generated_client.MovieInfo.md#name) -- [OriginalTitle](generated_client.MovieInfo.md#originaltitle) -- [ParentIndexNumber](generated_client.MovieInfo.md#parentindexnumber) -- [Path](generated_client.MovieInfo.md#path) -- [PremiereDate](generated_client.MovieInfo.md#premieredate) -- [ProviderIds](generated_client.MovieInfo.md#providerids) -- [Year](generated_client.MovieInfo.md#year) - -## Properties - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -**`memberof`** MovieInfo - -#### Defined in - -[generated-client/models/movie-info.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info.ts#L70) - -___ - -### IsAutomated - -• `Optional` **IsAutomated**: `boolean` - -**`memberof`** MovieInfo - -#### Defined in - -[generated-client/models/movie-info.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info.ts#L88) - -___ - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: ``null`` \| `string` - -Gets or sets the metadata country code. - -**`memberof`** MovieInfo - -#### Defined in - -[generated-client/models/movie-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info.ts#L52) - -___ - -### MetadataLanguage - -• `Optional` **MetadataLanguage**: ``null`` \| `string` - -Gets or sets the metadata language. - -**`memberof`** MovieInfo - -#### Defined in - -[generated-client/models/movie-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info.ts#L46) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** MovieInfo - -#### Defined in - -[generated-client/models/movie-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info.ts#L28) - -___ - -### OriginalTitle - -• `Optional` **OriginalTitle**: ``null`` \| `string` - -Gets or sets the original title. - -**`memberof`** MovieInfo - -#### Defined in - -[generated-client/models/movie-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info.ts#L34) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -**`memberof`** MovieInfo - -#### Defined in - -[generated-client/models/movie-info.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info.ts#L76) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** MovieInfo - -#### Defined in - -[generated-client/models/movie-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info.ts#L40) - -___ - -### PremiereDate - -• `Optional` **PremiereDate**: ``null`` \| `string` - -**`memberof`** MovieInfo - -#### Defined in - -[generated-client/models/movie-info.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info.ts#L82) - -___ - -### ProviderIds - -• `Optional` **ProviderIds**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the provider ids. - -**`memberof`** MovieInfo - -#### Defined in - -[generated-client/models/movie-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info.ts#L58) - -___ - -### Year - -• `Optional` **Year**: ``null`` \| `number` - -Gets or sets the year. - -**`memberof`** MovieInfo - -#### Defined in - -[generated-client/models/movie-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info.ts#L64) diff --git a/docs/interfaces/generated_client.MovieInfoRemoteSearchQuery.md b/docs/interfaces/generated_client.MovieInfoRemoteSearchQuery.md deleted file mode 100644 index a9f30e658..000000000 --- a/docs/interfaces/generated_client.MovieInfoRemoteSearchQuery.md +++ /dev/null @@ -1,70 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MovieInfoRemoteSearchQuery - -# Interface: MovieInfoRemoteSearchQuery - -[generated-client](../modules/generated_client.md).MovieInfoRemoteSearchQuery - -**`export`** - -**`interface`** MovieInfoRemoteSearchQuery - -## Table of contents - -### Properties - -- [IncludeDisabledProviders](generated_client.MovieInfoRemoteSearchQuery.md#includedisabledproviders) -- [ItemId](generated_client.MovieInfoRemoteSearchQuery.md#itemid) -- [SearchInfo](generated_client.MovieInfoRemoteSearchQuery.md#searchinfo) -- [SearchProviderName](generated_client.MovieInfoRemoteSearchQuery.md#searchprovidername) - -## Properties - -### IncludeDisabledProviders - -• `Optional` **IncludeDisabledProviders**: `boolean` - -Gets or sets a value indicating whether disabled providers should be included. - -**`memberof`** MovieInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/movie-info-remote-search-query.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info-remote-search-query.ts#L47) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -**`memberof`** MovieInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/movie-info-remote-search-query.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info-remote-search-query.ts#L35) - -___ - -### SearchInfo - -• `Optional` **SearchInfo**: [`MovieInfo`](generated_client.MovieInfo.md) - -**`memberof`** MovieInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/movie-info-remote-search-query.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info-remote-search-query.ts#L29) - -___ - -### SearchProviderName - -• `Optional` **SearchProviderName**: ``null`` \| `string` - -Gets or sets the provider name to search within if set. - -**`memberof`** MovieInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/movie-info-remote-search-query.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/movie-info-remote-search-query.ts#L41) diff --git a/docs/interfaces/generated_client.MoviesApiGetMovieRecommendationsRequest.md b/docs/interfaces/generated_client.MoviesApiGetMovieRecommendationsRequest.md deleted file mode 100644 index d2c5fb287..000000000 --- a/docs/interfaces/generated_client.MoviesApiGetMovieRecommendationsRequest.md +++ /dev/null @@ -1,91 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MoviesApiGetMovieRecommendationsRequest - -# Interface: MoviesApiGetMovieRecommendationsRequest - -[generated-client](../modules/generated_client.md).MoviesApiGetMovieRecommendationsRequest - -Request parameters for getMovieRecommendations operation in MoviesApi. - -**`export`** - -**`interface`** MoviesApiGetMovieRecommendationsRequest - -## Table of contents - -### Properties - -- [categoryLimit](generated_client.MoviesApiGetMovieRecommendationsRequest.md#categorylimit) -- [fields](generated_client.MoviesApiGetMovieRecommendationsRequest.md#fields) -- [itemLimit](generated_client.MoviesApiGetMovieRecommendationsRequest.md#itemlimit) -- [parentId](generated_client.MoviesApiGetMovieRecommendationsRequest.md#parentid) -- [userId](generated_client.MoviesApiGetMovieRecommendationsRequest.md#userid) - -## Properties - -### categoryLimit - -• `Optional` `Readonly` **categoryLimit**: `number` - -The max number of categories to return. - -**`memberof`** MoviesApiGetMovieRecommendations - -#### Defined in - -[generated-client/api/movies-api.ts:175](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/movies-api.ts#L175) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. The fields to return. - -**`memberof`** MoviesApiGetMovieRecommendations - -#### Defined in - -[generated-client/api/movies-api.ts:168](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/movies-api.ts#L168) - -___ - -### itemLimit - -• `Optional` `Readonly` **itemLimit**: `number` - -The max number of items to return per category. - -**`memberof`** MoviesApiGetMovieRecommendations - -#### Defined in - -[generated-client/api/movies-api.ts:182](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/movies-api.ts#L182) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** MoviesApiGetMovieRecommendations - -#### Defined in - -[generated-client/api/movies-api.ts:161](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/movies-api.ts#L161) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** MoviesApiGetMovieRecommendations - -#### Defined in - -[generated-client/api/movies-api.ts:154](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/movies-api.ts#L154) diff --git a/docs/interfaces/generated_client.MusicGenresApiGetMusicGenreRequest.md b/docs/interfaces/generated_client.MusicGenresApiGetMusicGenreRequest.md deleted file mode 100644 index dc5bd1e8e..000000000 --- a/docs/interfaces/generated_client.MusicGenresApiGetMusicGenreRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MusicGenresApiGetMusicGenreRequest - -# Interface: MusicGenresApiGetMusicGenreRequest - -[generated-client](../modules/generated_client.md).MusicGenresApiGetMusicGenreRequest - -Request parameters for getMusicGenre operation in MusicGenresApi. - -**`export`** - -**`interface`** MusicGenresApiGetMusicGenreRequest - -## Table of contents - -### Properties - -- [genreName](generated_client.MusicGenresApiGetMusicGenreRequest.md#genrename) -- [userId](generated_client.MusicGenresApiGetMusicGenreRequest.md#userid) - -## Properties - -### genreName - -• `Readonly` **genreName**: `string` - -The genre name. - -**`memberof`** MusicGenresApiGetMusicGenre - -#### Defined in - -[generated-client/api/music-genres-api.ts:321](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L321) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** MusicGenresApiGetMusicGenre - -#### Defined in - -[generated-client/api/music-genres-api.ts:328](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L328) diff --git a/docs/interfaces/generated_client.MusicGenresApiGetMusicGenresRequest.md b/docs/interfaces/generated_client.MusicGenresApiGetMusicGenresRequest.md deleted file mode 100644 index 0242d9f70..000000000 --- a/docs/interfaces/generated_client.MusicGenresApiGetMusicGenresRequest.md +++ /dev/null @@ -1,286 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MusicGenresApiGetMusicGenresRequest - -# Interface: MusicGenresApiGetMusicGenresRequest - -[generated-client](../modules/generated_client.md).MusicGenresApiGetMusicGenresRequest - -Request parameters for getMusicGenres operation in MusicGenresApi. - -**`export`** - -**`interface`** MusicGenresApiGetMusicGenresRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.MusicGenresApiGetMusicGenresRequest.md#enableimagetypes) -- [enableImages](generated_client.MusicGenresApiGetMusicGenresRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.MusicGenresApiGetMusicGenresRequest.md#enabletotalrecordcount) -- [excludeItemTypes](generated_client.MusicGenresApiGetMusicGenresRequest.md#excludeitemtypes) -- [fields](generated_client.MusicGenresApiGetMusicGenresRequest.md#fields) -- [imageTypeLimit](generated_client.MusicGenresApiGetMusicGenresRequest.md#imagetypelimit) -- [includeItemTypes](generated_client.MusicGenresApiGetMusicGenresRequest.md#includeitemtypes) -- [isFavorite](generated_client.MusicGenresApiGetMusicGenresRequest.md#isfavorite) -- [limit](generated_client.MusicGenresApiGetMusicGenresRequest.md#limit) -- [nameLessThan](generated_client.MusicGenresApiGetMusicGenresRequest.md#namelessthan) -- [nameStartsWith](generated_client.MusicGenresApiGetMusicGenresRequest.md#namestartswith) -- [nameStartsWithOrGreater](generated_client.MusicGenresApiGetMusicGenresRequest.md#namestartswithorgreater) -- [parentId](generated_client.MusicGenresApiGetMusicGenresRequest.md#parentid) -- [searchTerm](generated_client.MusicGenresApiGetMusicGenresRequest.md#searchterm) -- [sortBy](generated_client.MusicGenresApiGetMusicGenresRequest.md#sortby) -- [sortOrder](generated_client.MusicGenresApiGetMusicGenresRequest.md#sortorder) -- [startIndex](generated_client.MusicGenresApiGetMusicGenresRequest.md#startindex) -- [userId](generated_client.MusicGenresApiGetMusicGenresRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:405](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L405) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional, include image information in output. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:454](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L454) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Optional. Include total record count. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:461](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L461) - -___ - -### excludeItemTypes - -• `Optional` `Readonly` **excludeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:377](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L377) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:370](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L370) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional, the max number of images to return, per image type. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:398](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L398) - -___ - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:384](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L384) - -___ - -### isFavorite - -• `Optional` `Readonly` **isFavorite**: `boolean` - -Optional filter by items that are marked as favorite, or not. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:391](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L391) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:349](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L349) - -___ - -### nameLessThan - -• `Optional` `Readonly` **nameLessThan**: `string` - -Optional filter by items whose name is equally or lesser than a given input string. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:433](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L433) - -___ - -### nameStartsWith - -• `Optional` `Readonly` **nameStartsWith**: `string` - -Optional filter by items whose name is sorted equally than a given input string. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:426](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L426) - -___ - -### nameStartsWithOrGreater - -• `Optional` `Readonly` **nameStartsWithOrGreater**: `string` - -Optional filter by items whose name is sorted equally or greater than a given input string. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:419](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L419) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:363](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L363) - -___ - -### searchTerm - -• `Optional` `Readonly` **searchTerm**: `string` - -The search term. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:356](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L356) - -___ - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string`[] - -Optional. Specify one or more sort orders, comma delimited. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:440](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L440) - -___ - -### sortOrder - -• `Optional` `Readonly` **sortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md)[] - -Sort Order - Ascending,Descending. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:447](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L447) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:342](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L342) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -User id. - -**`memberof`** MusicGenresApiGetMusicGenres - -#### Defined in - -[generated-client/api/music-genres-api.ts:412](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L412) diff --git a/docs/interfaces/generated_client.MusicVideoInfo.md b/docs/interfaces/generated_client.MusicVideoInfo.md deleted file mode 100644 index 91a154394..000000000 --- a/docs/interfaces/generated_client.MusicVideoInfo.md +++ /dev/null @@ -1,184 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MusicVideoInfo - -# Interface: MusicVideoInfo - -[generated-client](../modules/generated_client.md).MusicVideoInfo - -**`export`** - -**`interface`** MusicVideoInfo - -## Table of contents - -### Properties - -- [Artists](generated_client.MusicVideoInfo.md#artists) -- [IndexNumber](generated_client.MusicVideoInfo.md#indexnumber) -- [IsAutomated](generated_client.MusicVideoInfo.md#isautomated) -- [MetadataCountryCode](generated_client.MusicVideoInfo.md#metadatacountrycode) -- [MetadataLanguage](generated_client.MusicVideoInfo.md#metadatalanguage) -- [Name](generated_client.MusicVideoInfo.md#name) -- [OriginalTitle](generated_client.MusicVideoInfo.md#originaltitle) -- [ParentIndexNumber](generated_client.MusicVideoInfo.md#parentindexnumber) -- [Path](generated_client.MusicVideoInfo.md#path) -- [PremiereDate](generated_client.MusicVideoInfo.md#premieredate) -- [ProviderIds](generated_client.MusicVideoInfo.md#providerids) -- [Year](generated_client.MusicVideoInfo.md#year) - -## Properties - -### Artists - -• `Optional` **Artists**: ``null`` \| `string`[] - -**`memberof`** MusicVideoInfo - -#### Defined in - -[generated-client/models/music-video-info.ts:94](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info.ts#L94) - -___ - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -**`memberof`** MusicVideoInfo - -#### Defined in - -[generated-client/models/music-video-info.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info.ts#L70) - -___ - -### IsAutomated - -• `Optional` **IsAutomated**: `boolean` - -**`memberof`** MusicVideoInfo - -#### Defined in - -[generated-client/models/music-video-info.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info.ts#L88) - -___ - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: ``null`` \| `string` - -Gets or sets the metadata country code. - -**`memberof`** MusicVideoInfo - -#### Defined in - -[generated-client/models/music-video-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info.ts#L52) - -___ - -### MetadataLanguage - -• `Optional` **MetadataLanguage**: ``null`` \| `string` - -Gets or sets the metadata language. - -**`memberof`** MusicVideoInfo - -#### Defined in - -[generated-client/models/music-video-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info.ts#L46) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** MusicVideoInfo - -#### Defined in - -[generated-client/models/music-video-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info.ts#L28) - -___ - -### OriginalTitle - -• `Optional` **OriginalTitle**: ``null`` \| `string` - -Gets or sets the original title. - -**`memberof`** MusicVideoInfo - -#### Defined in - -[generated-client/models/music-video-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info.ts#L34) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -**`memberof`** MusicVideoInfo - -#### Defined in - -[generated-client/models/music-video-info.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info.ts#L76) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** MusicVideoInfo - -#### Defined in - -[generated-client/models/music-video-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info.ts#L40) - -___ - -### PremiereDate - -• `Optional` **PremiereDate**: ``null`` \| `string` - -**`memberof`** MusicVideoInfo - -#### Defined in - -[generated-client/models/music-video-info.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info.ts#L82) - -___ - -### ProviderIds - -• `Optional` **ProviderIds**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the provider ids. - -**`memberof`** MusicVideoInfo - -#### Defined in - -[generated-client/models/music-video-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info.ts#L58) - -___ - -### Year - -• `Optional` **Year**: ``null`` \| `number` - -Gets or sets the year. - -**`memberof`** MusicVideoInfo - -#### Defined in - -[generated-client/models/music-video-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info.ts#L64) diff --git a/docs/interfaces/generated_client.MusicVideoInfoRemoteSearchQuery.md b/docs/interfaces/generated_client.MusicVideoInfoRemoteSearchQuery.md deleted file mode 100644 index 87e2c6b3f..000000000 --- a/docs/interfaces/generated_client.MusicVideoInfoRemoteSearchQuery.md +++ /dev/null @@ -1,70 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MusicVideoInfoRemoteSearchQuery - -# Interface: MusicVideoInfoRemoteSearchQuery - -[generated-client](../modules/generated_client.md).MusicVideoInfoRemoteSearchQuery - -**`export`** - -**`interface`** MusicVideoInfoRemoteSearchQuery - -## Table of contents - -### Properties - -- [IncludeDisabledProviders](generated_client.MusicVideoInfoRemoteSearchQuery.md#includedisabledproviders) -- [ItemId](generated_client.MusicVideoInfoRemoteSearchQuery.md#itemid) -- [SearchInfo](generated_client.MusicVideoInfoRemoteSearchQuery.md#searchinfo) -- [SearchProviderName](generated_client.MusicVideoInfoRemoteSearchQuery.md#searchprovidername) - -## Properties - -### IncludeDisabledProviders - -• `Optional` **IncludeDisabledProviders**: `boolean` - -Gets or sets a value indicating whether disabled providers should be included. - -**`memberof`** MusicVideoInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/music-video-info-remote-search-query.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info-remote-search-query.ts#L47) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -**`memberof`** MusicVideoInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/music-video-info-remote-search-query.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info-remote-search-query.ts#L35) - -___ - -### SearchInfo - -• `Optional` **SearchInfo**: [`MusicVideoInfo`](generated_client.MusicVideoInfo.md) - -**`memberof`** MusicVideoInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/music-video-info-remote-search-query.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info-remote-search-query.ts#L29) - -___ - -### SearchProviderName - -• `Optional` **SearchProviderName**: ``null`` \| `string` - -Gets or sets the provider name to search within if set. - -**`memberof`** MusicVideoInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/music-video-info-remote-search-query.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/music-video-info-remote-search-query.ts#L41) diff --git a/docs/interfaces/generated_client.NameGuidPair.md b/docs/interfaces/generated_client.NameGuidPair.md deleted file mode 100644 index e00417828..000000000 --- a/docs/interfaces/generated_client.NameGuidPair.md +++ /dev/null @@ -1,40 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NameGuidPair - -# Interface: NameGuidPair - -[generated-client](../modules/generated_client.md).NameGuidPair - -**`export`** - -**`interface`** NameGuidPair - -## Table of contents - -### Properties - -- [Id](generated_client.NameGuidPair.md#id) -- [Name](generated_client.NameGuidPair.md#name) - -## Properties - -### Id - -• `Optional` **Id**: `string` - -**`memberof`** NameGuidPair - -#### Defined in - -[generated-client/models/name-guid-pair.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/name-guid-pair.ts#L34) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -**`memberof`** NameGuidPair - -#### Defined in - -[generated-client/models/name-guid-pair.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/name-guid-pair.ts#L28) diff --git a/docs/interfaces/generated_client.NameIdPair.md b/docs/interfaces/generated_client.NameIdPair.md deleted file mode 100644 index cac6c3ffb..000000000 --- a/docs/interfaces/generated_client.NameIdPair.md +++ /dev/null @@ -1,44 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NameIdPair - -# Interface: NameIdPair - -[generated-client](../modules/generated_client.md).NameIdPair - -**`export`** - -**`interface`** NameIdPair - -## Table of contents - -### Properties - -- [Id](generated_client.NameIdPair.md#id) -- [Name](generated_client.NameIdPair.md#name) - -## Properties - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets the identifier. - -**`memberof`** NameIdPair - -#### Defined in - -[generated-client/models/name-id-pair.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/name-id-pair.ts#L34) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** NameIdPair - -#### Defined in - -[generated-client/models/name-id-pair.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/name-id-pair.ts#L28) diff --git a/docs/interfaces/generated_client.NameValuePair.md b/docs/interfaces/generated_client.NameValuePair.md deleted file mode 100644 index 806f9b192..000000000 --- a/docs/interfaces/generated_client.NameValuePair.md +++ /dev/null @@ -1,44 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NameValuePair - -# Interface: NameValuePair - -[generated-client](../modules/generated_client.md).NameValuePair - -**`export`** - -**`interface`** NameValuePair - -## Table of contents - -### Properties - -- [Name](generated_client.NameValuePair.md#name) -- [Value](generated_client.NameValuePair.md#value) - -## Properties - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** NameValuePair - -#### Defined in - -[generated-client/models/name-value-pair.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/name-value-pair.ts#L28) - -___ - -### Value - -• `Optional` **Value**: ``null`` \| `string` - -Gets or sets the value. - -**`memberof`** NameValuePair - -#### Defined in - -[generated-client/models/name-value-pair.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/name-value-pair.ts#L34) diff --git a/docs/interfaces/generated_client.NetworkConfiguration.md b/docs/interfaces/generated_client.NetworkConfiguration.md deleted file mode 100644 index 9781d0077..000000000 --- a/docs/interfaces/generated_client.NetworkConfiguration.md +++ /dev/null @@ -1,526 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NetworkConfiguration - -# Interface: NetworkConfiguration - -[generated-client](../modules/generated_client.md).NetworkConfiguration - -Defines the Jellyfin.Networking.Configuration.NetworkConfiguration. - -**`export`** - -**`interface`** NetworkConfiguration - -## Table of contents - -### Properties - -- [AutoDiscovery](generated_client.NetworkConfiguration.md#autodiscovery) -- [AutoDiscoveryTracing](generated_client.NetworkConfiguration.md#autodiscoverytracing) -- [BaseUrl](generated_client.NetworkConfiguration.md#baseurl) -- [CertificatePassword](generated_client.NetworkConfiguration.md#certificatepassword) -- [CertificatePath](generated_client.NetworkConfiguration.md#certificatepath) -- [EnableHttps](generated_client.NetworkConfiguration.md#enablehttps) -- [EnableIPV4](generated_client.NetworkConfiguration.md#enableipv4) -- [EnableIPV6](generated_client.NetworkConfiguration.md#enableipv6) -- [EnableMultiSocketBinding](generated_client.NetworkConfiguration.md#enablemultisocketbinding) -- [EnablePublishedServerUriByRequest](generated_client.NetworkConfiguration.md#enablepublishedserveruribyrequest) -- [EnableRemoteAccess](generated_client.NetworkConfiguration.md#enableremoteaccess) -- [EnableSSDPTracing](generated_client.NetworkConfiguration.md#enablessdptracing) -- [EnableUPnP](generated_client.NetworkConfiguration.md#enableupnp) -- [GatewayMonitorPeriod](generated_client.NetworkConfiguration.md#gatewaymonitorperiod) -- [HDHomerunPortRange](generated_client.NetworkConfiguration.md#hdhomerunportrange) -- [HttpServerPortNumber](generated_client.NetworkConfiguration.md#httpserverportnumber) -- [HttpsPortNumber](generated_client.NetworkConfiguration.md#httpsportnumber) -- [IgnoreVirtualInterfaces](generated_client.NetworkConfiguration.md#ignorevirtualinterfaces) -- [IsRemoteIPFilterBlacklist](generated_client.NetworkConfiguration.md#isremoteipfilterblacklist) -- [KnownProxies](generated_client.NetworkConfiguration.md#knownproxies) -- [LocalNetworkAddresses](generated_client.NetworkConfiguration.md#localnetworkaddresses) -- [LocalNetworkSubnets](generated_client.NetworkConfiguration.md#localnetworksubnets) -- [PublicHttpsPort](generated_client.NetworkConfiguration.md#publichttpsport) -- [PublicPort](generated_client.NetworkConfiguration.md#publicport) -- [PublishedServerUriBySubnet](generated_client.NetworkConfiguration.md#publishedserveruribysubnet) -- [RemoteIPFilter](generated_client.NetworkConfiguration.md#remoteipfilter) -- [RequireHttps](generated_client.NetworkConfiguration.md#requirehttps) -- [SSDPTracingFilter](generated_client.NetworkConfiguration.md#ssdptracingfilter) -- [TrustAllIP6Interfaces](generated_client.NetworkConfiguration.md#trustallip6interfaces) -- [UDPPortRange](generated_client.NetworkConfiguration.md#udpportrange) -- [UDPSendCount](generated_client.NetworkConfiguration.md#udpsendcount) -- [UDPSendDelay](generated_client.NetworkConfiguration.md#udpsenddelay) -- [UPnPCreateHttpPortMap](generated_client.NetworkConfiguration.md#upnpcreatehttpportmap) -- [VirtualInterfaceNames](generated_client.NetworkConfiguration.md#virtualinterfacenames) - -## Properties - -### AutoDiscovery - -• `Optional` **AutoDiscovery**: `boolean` - -Gets or sets a value indicating whether Autodiscovery is enabled. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:178](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L178) - -___ - -### AutoDiscoveryTracing - -• `Optional` **AutoDiscoveryTracing**: `boolean` - -Gets or sets a value indicating whether Autodiscovery tracing is enabled. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:172](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L172) - -___ - -### BaseUrl - -• `Optional` **BaseUrl**: `string` - -Gets or sets a value used to specify the URL prefix that your Jellyfin instance can be accessed at. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L46) - -___ - -### CertificatePassword - -• `Optional` **CertificatePassword**: `string` - -Gets or sets the password required to access the X.509 certificate data in the file specified by Jellyfin.Networking.Configuration.NetworkConfiguration.CertificatePath. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L40) - -___ - -### CertificatePath - -• `Optional` **CertificatePath**: `string` - -Gets or sets the filesystem path of an X.509 certificate to use for SSL. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L34) - -___ - -### EnableHttps - -• `Optional` **EnableHttps**: `boolean` - -Gets or sets a value indicating whether to use HTTPS. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L70) - -___ - -### EnableIPV4 - -• `Optional` **EnableIPV4**: `boolean` - -Gets or sets a value indicating whether gets or sets IPV4 capability. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:100](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L100) - -___ - -### EnableIPV6 - -• `Optional` **EnableIPV6**: `boolean` - -Gets or sets a value indicating whether gets or sets IPV6 capability. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:94](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L94) - -___ - -### EnableMultiSocketBinding - -• `Optional` **EnableMultiSocketBinding**: `boolean` - -Gets a value indicating whether multi-socket binding is available. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:148](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L148) - -___ - -### EnablePublishedServerUriByRequest - -• `Optional` **EnablePublishedServerUriByRequest**: `boolean` - -Gets or sets a value indicating whether the published server uri is based on information in HTTP requests. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:226](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L226) - -___ - -### EnableRemoteAccess - -• `Optional` **EnableRemoteAccess**: `boolean` - -Gets or sets a value indicating whether access outside of the LAN is permitted. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:202](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L202) - -___ - -### EnableSSDPTracing - -• `Optional` **EnableSSDPTracing**: `boolean` - -Gets or sets a value indicating whether detailed SSDP logs are sent to the console/log. \"Emby.Dlna\": \"Debug\" must be set in logging.default.json for this property to have any effect. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:106](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L106) - -___ - -### EnableUPnP - -• `Optional` **EnableUPnP**: `boolean` - -Gets or sets a value indicating whether to enable automatic port forwarding. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:196](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L196) - -___ - -### GatewayMonitorPeriod - -• `Optional` **GatewayMonitorPeriod**: `number` - -Gets or sets the time (in seconds) between the pings of SSDP gateway monitor. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:142](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L142) - -___ - -### HDHomerunPortRange - -• `Optional` **HDHomerunPortRange**: `string` - -Gets or sets the ports that HDHomerun uses. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:160](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L160) - -___ - -### HttpServerPortNumber - -• `Optional` **HttpServerPortNumber**: `number` - -Gets or sets the HTTP server port number. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L58) - -___ - -### HttpsPortNumber - -• `Optional` **HttpsPortNumber**: `number` - -Gets or sets the HTTPS server port number. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L64) - -___ - -### IgnoreVirtualInterfaces - -• `Optional` **IgnoreVirtualInterfaces**: `boolean` - -Gets or sets a value indicating whether address names that match Jellyfin.Networking.Configuration.NetworkConfiguration.VirtualInterfaceNames should be Ignore for the purposes of binding. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:130](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L130) - -___ - -### IsRemoteIPFilterBlacklist - -• `Optional` **IsRemoteIPFilterBlacklist**: `boolean` - -Gets or sets a value indicating whether contains a blacklist or a whitelist. Default is a whitelist. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:190](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L190) - -___ - -### KnownProxies - -• `Optional` **KnownProxies**: `string`[] - -Gets or sets the known proxies. If the proxy is a network, it\'s added to the KnownNetworks. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:220](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L220) - -___ - -### LocalNetworkAddresses - -• `Optional` **LocalNetworkAddresses**: `string`[] - -Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be used. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:214](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L214) - -___ - -### LocalNetworkSubnets - -• `Optional` **LocalNetworkSubnets**: `string`[] - -Gets or sets the subnets that are deemed to make up the LAN. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:208](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L208) - -___ - -### PublicHttpsPort - -• `Optional` **PublicHttpsPort**: `number` - -Gets or sets the public HTTPS port. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L52) - -___ - -### PublicPort - -• `Optional` **PublicPort**: `number` - -Gets or sets the public mapped port. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L76) - -___ - -### PublishedServerUriBySubnet - -• `Optional` **PublishedServerUriBySubnet**: `string`[] - -Gets or sets the PublishedServerUriBySubnet Gets or sets PublishedServerUri to advertise for specific subnets. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:166](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L166) - -___ - -### RemoteIPFilter - -• `Optional` **RemoteIPFilter**: `string`[] - -Gets or sets the filter for remote IP connectivity. Used in conjuntion with . - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:184](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L184) - -___ - -### RequireHttps - -• `Optional` **RequireHttps**: `boolean` - -Gets or sets a value indicating whether the server should force connections over HTTPS. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L28) - -___ - -### SSDPTracingFilter - -• `Optional` **SSDPTracingFilter**: `string` - -Gets or sets the SSDPTracingFilter Gets or sets a value indicating whether an IP address is to be used to filter the detailed ssdp logs that are being sent to the console/log. If the setting \"Emby.Dlna\": \"Debug\" msut be set in logging.default.json for this property to work. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:112](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L112) - -___ - -### TrustAllIP6Interfaces - -• `Optional` **TrustAllIP6Interfaces**: `boolean` - -Gets or sets a value indicating whether all IPv6 interfaces should be treated as on the internal network. Depending on the address range implemented ULA ranges might not be used. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:154](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L154) - -___ - -### UDPPortRange - -• `Optional` **UDPPortRange**: `string` - -Gets or sets the UDPPortRange. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L88) - -___ - -### UDPSendCount - -• `Optional` **UDPSendCount**: `number` - -Gets or sets the number of times SSDP UDP messages are sent. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:118](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L118) - -___ - -### UDPSendDelay - -• `Optional` **UDPSendDelay**: `number` - -Gets or sets the delay between each groups of SSDP messages (in ms). - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:124](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L124) - -___ - -### UPnPCreateHttpPortMap - -• `Optional` **UPnPCreateHttpPortMap**: `boolean` - -Gets or sets a value indicating whether the http port should be mapped as part of UPnP automatic port forwarding. - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L82) - -___ - -### VirtualInterfaceNames - -• `Optional` **VirtualInterfaceNames**: `string` - -Gets or sets a value indicating the interfaces that should be ignored. The list can be comma separated. . - -**`memberof`** NetworkConfiguration - -#### Defined in - -[generated-client/models/network-configuration.ts:136](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/network-configuration.ts#L136) diff --git a/docs/interfaces/generated_client.NewGroupRequestDto.md b/docs/interfaces/generated_client.NewGroupRequestDto.md deleted file mode 100644 index 217ab2f93..000000000 --- a/docs/interfaces/generated_client.NewGroupRequestDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NewGroupRequestDto - -# Interface: NewGroupRequestDto - -[generated-client](../modules/generated_client.md).NewGroupRequestDto - -Class NewGroupRequestDto. - -**`export`** - -**`interface`** NewGroupRequestDto - -## Table of contents - -### Properties - -- [GroupName](generated_client.NewGroupRequestDto.md#groupname) - -## Properties - -### GroupName - -• `Optional` **GroupName**: `string` - -Gets or sets the group name. - -**`memberof`** NewGroupRequestDto - -#### Defined in - -[generated-client/models/new-group-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/new-group-request-dto.ts#L28) diff --git a/docs/interfaces/generated_client.NextItemRequestDto.md b/docs/interfaces/generated_client.NextItemRequestDto.md deleted file mode 100644 index 7b0d6bb84..000000000 --- a/docs/interfaces/generated_client.NextItemRequestDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NextItemRequestDto - -# Interface: NextItemRequestDto - -[generated-client](../modules/generated_client.md).NextItemRequestDto - -Class NextItemRequestDto. - -**`export`** - -**`interface`** NextItemRequestDto - -## Table of contents - -### Properties - -- [PlaylistItemId](generated_client.NextItemRequestDto.md#playlistitemid) - -## Properties - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: `string` - -Gets or sets the playing item identifier. - -**`memberof`** NextItemRequestDto - -#### Defined in - -[generated-client/models/next-item-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/next-item-request-dto.ts#L28) diff --git a/docs/interfaces/generated_client.NotificationDto.md b/docs/interfaces/generated_client.NotificationDto.md deleted file mode 100644 index 4f0acff0e..000000000 --- a/docs/interfaces/generated_client.NotificationDto.md +++ /dev/null @@ -1,134 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationDto - -# Interface: NotificationDto - -[generated-client](../modules/generated_client.md).NotificationDto - -The notification DTO. - -**`export`** - -**`interface`** NotificationDto - -## Table of contents - -### Properties - -- [Date](generated_client.NotificationDto.md#date) -- [Description](generated_client.NotificationDto.md#description) -- [Id](generated_client.NotificationDto.md#id) -- [IsRead](generated_client.NotificationDto.md#isread) -- [Level](generated_client.NotificationDto.md#level) -- [Name](generated_client.NotificationDto.md#name) -- [Url](generated_client.NotificationDto.md#url) -- [UserId](generated_client.NotificationDto.md#userid) - -## Properties - -### Date - -• `Optional` **Date**: `string` - -Gets or sets the notification date. - -**`memberof`** NotificationDto - -#### Defined in - -[generated-client/models/notification-dto.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-dto.ts#L41) - -___ - -### Description - -• `Optional` **Description**: `string` - -Gets or sets the notification\'s description. Defaults to an empty string. - -**`memberof`** NotificationDto - -#### Defined in - -[generated-client/models/notification-dto.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-dto.ts#L59) - -___ - -### Id - -• `Optional` **Id**: `string` - -Gets or sets the notification ID. Defaults to an empty string. - -**`memberof`** NotificationDto - -#### Defined in - -[generated-client/models/notification-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-dto.ts#L29) - -___ - -### IsRead - -• `Optional` **IsRead**: `boolean` - -Gets or sets a value indicating whether the notification has been read. Defaults to false. - -**`memberof`** NotificationDto - -#### Defined in - -[generated-client/models/notification-dto.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-dto.ts#L47) - -___ - -### Level - -• `Optional` **Level**: [`NotificationLevel`](../enums/generated_client.NotificationLevel.md) - -**`memberof`** NotificationDto - -#### Defined in - -[generated-client/models/notification-dto.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-dto.ts#L71) - -___ - -### Name - -• `Optional` **Name**: `string` - -Gets or sets the notification\'s name. Defaults to an empty string. - -**`memberof`** NotificationDto - -#### Defined in - -[generated-client/models/notification-dto.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-dto.ts#L53) - -___ - -### Url - -• `Optional` **Url**: `string` - -Gets or sets the notification\'s URL. Defaults to an empty string. - -**`memberof`** NotificationDto - -#### Defined in - -[generated-client/models/notification-dto.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-dto.ts#L65) - -___ - -### UserId - -• `Optional` **UserId**: `string` - -Gets or sets the notification\'s user ID. Defaults to an empty string. - -**`memberof`** NotificationDto - -#### Defined in - -[generated-client/models/notification-dto.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-dto.ts#L35) diff --git a/docs/interfaces/generated_client.NotificationOption.md b/docs/interfaces/generated_client.NotificationOption.md deleted file mode 100644 index 50f30b435..000000000 --- a/docs/interfaces/generated_client.NotificationOption.md +++ /dev/null @@ -1,100 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationOption - -# Interface: NotificationOption - -[generated-client](../modules/generated_client.md).NotificationOption - -**`export`** - -**`interface`** NotificationOption - -## Table of contents - -### Properties - -- [DisabledMonitorUsers](generated_client.NotificationOption.md#disabledmonitorusers) -- [DisabledServices](generated_client.NotificationOption.md#disabledservices) -- [Enabled](generated_client.NotificationOption.md#enabled) -- [SendToUserMode](generated_client.NotificationOption.md#sendtousermode) -- [SendToUsers](generated_client.NotificationOption.md#sendtousers) -- [Type](generated_client.NotificationOption.md#type) - -## Properties - -### DisabledMonitorUsers - -• `Optional` **DisabledMonitorUsers**: `string`[] - -Gets or sets user Ids to not monitor (it\'s opt out). - -**`memberof`** NotificationOption - -#### Defined in - -[generated-client/models/notification-option.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-option.ts#L35) - -___ - -### DisabledServices - -• `Optional` **DisabledServices**: `string`[] - -Gets or sets the disabled services. - -**`memberof`** NotificationOption - -#### Defined in - -[generated-client/models/notification-option.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-option.ts#L53) - -___ - -### Enabled - -• `Optional` **Enabled**: `boolean` - -Gets or sets a value indicating whether this MediaBrowser.Model.Notifications.NotificationOption is enabled. - -**`memberof`** NotificationOption - -#### Defined in - -[generated-client/models/notification-option.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-option.ts#L47) - -___ - -### SendToUserMode - -• `Optional` **SendToUserMode**: [`SendToUserType`](../enums/generated_client.SendToUserType.md) - -**`memberof`** NotificationOption - -#### Defined in - -[generated-client/models/notification-option.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-option.ts#L59) - -___ - -### SendToUsers - -• `Optional` **SendToUsers**: `string`[] - -Gets or sets user Ids to send to (if SendToUserMode == Custom). - -**`memberof`** NotificationOption - -#### Defined in - -[generated-client/models/notification-option.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-option.ts#L41) - -___ - -### Type - -• `Optional` **Type**: ``null`` \| `string` - -**`memberof`** NotificationOption - -#### Defined in - -[generated-client/models/notification-option.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-option.ts#L29) diff --git a/docs/interfaces/generated_client.NotificationOptions.md b/docs/interfaces/generated_client.NotificationOptions.md deleted file mode 100644 index 87b9a1b77..000000000 --- a/docs/interfaces/generated_client.NotificationOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationOptions - -# Interface: NotificationOptions - -[generated-client](../modules/generated_client.md).NotificationOptions - -**`export`** - -**`interface`** NotificationOptions - -## Table of contents - -### Properties - -- [Options](generated_client.NotificationOptions.md#options) - -## Properties - -### Options - -• `Optional` **Options**: ``null`` \| [`NotificationOption`](generated_client.NotificationOption.md)[] - -**`memberof`** NotificationOptions - -#### Defined in - -[generated-client/models/notification-options.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-options.ts#L29) diff --git a/docs/interfaces/generated_client.NotificationResultDto.md b/docs/interfaces/generated_client.NotificationResultDto.md deleted file mode 100644 index 3f9af1100..000000000 --- a/docs/interfaces/generated_client.NotificationResultDto.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationResultDto - -# Interface: NotificationResultDto - -[generated-client](../modules/generated_client.md).NotificationResultDto - -A list of notifications with the total record count for pagination. - -**`export`** - -**`interface`** NotificationResultDto - -## Table of contents - -### Properties - -- [Notifications](generated_client.NotificationResultDto.md#notifications) -- [TotalRecordCount](generated_client.NotificationResultDto.md#totalrecordcount) - -## Properties - -### Notifications - -• `Optional` **Notifications**: [`NotificationDto`](generated_client.NotificationDto.md)[] - -Gets or sets the current page of notifications. - -**`memberof`** NotificationResultDto - -#### Defined in - -[generated-client/models/notification-result-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-result-dto.ts#L29) - -___ - -### TotalRecordCount - -• `Optional` **TotalRecordCount**: `number` - -Gets or sets the total number of notifications. - -**`memberof`** NotificationResultDto - -#### Defined in - -[generated-client/models/notification-result-dto.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-result-dto.ts#L35) diff --git a/docs/interfaces/generated_client.NotificationTypeInfo.md b/docs/interfaces/generated_client.NotificationTypeInfo.md deleted file mode 100644 index c8e10bc2f..000000000 --- a/docs/interfaces/generated_client.NotificationTypeInfo.md +++ /dev/null @@ -1,79 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationTypeInfo - -# Interface: NotificationTypeInfo - -[generated-client](../modules/generated_client.md).NotificationTypeInfo - -**`export`** - -**`interface`** NotificationTypeInfo - -## Table of contents - -### Properties - -- [Category](generated_client.NotificationTypeInfo.md#category) -- [Enabled](generated_client.NotificationTypeInfo.md#enabled) -- [IsBasedOnUserEvent](generated_client.NotificationTypeInfo.md#isbasedonuserevent) -- [Name](generated_client.NotificationTypeInfo.md#name) -- [Type](generated_client.NotificationTypeInfo.md#type) - -## Properties - -### Category - -• `Optional` **Category**: ``null`` \| `string` - -**`memberof`** NotificationTypeInfo - -#### Defined in - -[generated-client/models/notification-type-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-type-info.ts#L46) - -___ - -### Enabled - -• `Optional` **Enabled**: `boolean` - -**`memberof`** NotificationTypeInfo - -#### Defined in - -[generated-client/models/notification-type-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-type-info.ts#L40) - -___ - -### IsBasedOnUserEvent - -• `Optional` **IsBasedOnUserEvent**: `boolean` - -**`memberof`** NotificationTypeInfo - -#### Defined in - -[generated-client/models/notification-type-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-type-info.ts#L52) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -**`memberof`** NotificationTypeInfo - -#### Defined in - -[generated-client/models/notification-type-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-type-info.ts#L34) - -___ - -### Type - -• `Optional` **Type**: ``null`` \| `string` - -**`memberof`** NotificationTypeInfo - -#### Defined in - -[generated-client/models/notification-type-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notification-type-info.ts#L28) diff --git a/docs/interfaces/generated_client.NotificationsApiCreateAdminNotificationRequest.md b/docs/interfaces/generated_client.NotificationsApiCreateAdminNotificationRequest.md deleted file mode 100644 index 11ead6933..000000000 --- a/docs/interfaces/generated_client.NotificationsApiCreateAdminNotificationRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationsApiCreateAdminNotificationRequest - -# Interface: NotificationsApiCreateAdminNotificationRequest - -[generated-client](../modules/generated_client.md).NotificationsApiCreateAdminNotificationRequest - -Request parameters for createAdminNotification operation in NotificationsApi. - -**`export`** - -**`interface`** NotificationsApiCreateAdminNotificationRequest - -## Table of contents - -### Properties - -- [adminNotificationDto](generated_client.NotificationsApiCreateAdminNotificationRequest.md#adminnotificationdto) - -## Properties - -### adminNotificationDto - -• `Readonly` **adminNotificationDto**: [`AdminNotificationDto`](generated_client.AdminNotificationDto.md) - -The notification request. - -**`memberof`** NotificationsApiCreateAdminNotification - -#### Defined in - -[generated-client/api/notifications-api.ts:469](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L469) diff --git a/docs/interfaces/generated_client.NotificationsApiGetNotificationsRequest.md b/docs/interfaces/generated_client.NotificationsApiGetNotificationsRequest.md deleted file mode 100644 index 17c9024ee..000000000 --- a/docs/interfaces/generated_client.NotificationsApiGetNotificationsRequest.md +++ /dev/null @@ -1,29 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationsApiGetNotificationsRequest - -# Interface: NotificationsApiGetNotificationsRequest - -[generated-client](../modules/generated_client.md).NotificationsApiGetNotificationsRequest - -Request parameters for getNotifications operation in NotificationsApi. - -**`export`** - -**`interface`** NotificationsApiGetNotificationsRequest - -## Table of contents - -### Properties - -- [userId](generated_client.NotificationsApiGetNotificationsRequest.md#userid) - -## Properties - -### userId - -• `Readonly` **userId**: `string` - -**`memberof`** NotificationsApiGetNotifications - -#### Defined in - -[generated-client/api/notifications-api.ts:483](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L483) diff --git a/docs/interfaces/generated_client.NotificationsApiGetNotificationsSummaryRequest.md b/docs/interfaces/generated_client.NotificationsApiGetNotificationsSummaryRequest.md deleted file mode 100644 index 111b0de3d..000000000 --- a/docs/interfaces/generated_client.NotificationsApiGetNotificationsSummaryRequest.md +++ /dev/null @@ -1,29 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationsApiGetNotificationsSummaryRequest - -# Interface: NotificationsApiGetNotificationsSummaryRequest - -[generated-client](../modules/generated_client.md).NotificationsApiGetNotificationsSummaryRequest - -Request parameters for getNotificationsSummary operation in NotificationsApi. - -**`export`** - -**`interface`** NotificationsApiGetNotificationsSummaryRequest - -## Table of contents - -### Properties - -- [userId](generated_client.NotificationsApiGetNotificationsSummaryRequest.md#userid) - -## Properties - -### userId - -• `Readonly` **userId**: `string` - -**`memberof`** NotificationsApiGetNotificationsSummary - -#### Defined in - -[generated-client/api/notifications-api.ts:497](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L497) diff --git a/docs/interfaces/generated_client.NotificationsApiSetReadRequest.md b/docs/interfaces/generated_client.NotificationsApiSetReadRequest.md deleted file mode 100644 index 1a1eb16bb..000000000 --- a/docs/interfaces/generated_client.NotificationsApiSetReadRequest.md +++ /dev/null @@ -1,29 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationsApiSetReadRequest - -# Interface: NotificationsApiSetReadRequest - -[generated-client](../modules/generated_client.md).NotificationsApiSetReadRequest - -Request parameters for setRead operation in NotificationsApi. - -**`export`** - -**`interface`** NotificationsApiSetReadRequest - -## Table of contents - -### Properties - -- [userId](generated_client.NotificationsApiSetReadRequest.md#userid) - -## Properties - -### userId - -• `Readonly` **userId**: `string` - -**`memberof`** NotificationsApiSetRead - -#### Defined in - -[generated-client/api/notifications-api.ts:511](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L511) diff --git a/docs/interfaces/generated_client.NotificationsApiSetUnreadRequest.md b/docs/interfaces/generated_client.NotificationsApiSetUnreadRequest.md deleted file mode 100644 index 9594fde74..000000000 --- a/docs/interfaces/generated_client.NotificationsApiSetUnreadRequest.md +++ /dev/null @@ -1,29 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationsApiSetUnreadRequest - -# Interface: NotificationsApiSetUnreadRequest - -[generated-client](../modules/generated_client.md).NotificationsApiSetUnreadRequest - -Request parameters for setUnread operation in NotificationsApi. - -**`export`** - -**`interface`** NotificationsApiSetUnreadRequest - -## Table of contents - -### Properties - -- [userId](generated_client.NotificationsApiSetUnreadRequest.md#userid) - -## Properties - -### userId - -• `Readonly` **userId**: `string` - -**`memberof`** NotificationsApiSetUnread - -#### Defined in - -[generated-client/api/notifications-api.ts:525](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L525) diff --git a/docs/interfaces/generated_client.NotificationsSummaryDto.md b/docs/interfaces/generated_client.NotificationsSummaryDto.md deleted file mode 100644 index a77cb219f..000000000 --- a/docs/interfaces/generated_client.NotificationsSummaryDto.md +++ /dev/null @@ -1,44 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationsSummaryDto - -# Interface: NotificationsSummaryDto - -[generated-client](../modules/generated_client.md).NotificationsSummaryDto - -The notification summary DTO. - -**`export`** - -**`interface`** NotificationsSummaryDto - -## Table of contents - -### Properties - -- [MaxUnreadNotificationLevel](generated_client.NotificationsSummaryDto.md#maxunreadnotificationlevel) -- [UnreadCount](generated_client.NotificationsSummaryDto.md#unreadcount) - -## Properties - -### MaxUnreadNotificationLevel - -• `Optional` **MaxUnreadNotificationLevel**: [`NotificationLevel`](../enums/generated_client.NotificationLevel.md) - -**`memberof`** NotificationsSummaryDto - -#### Defined in - -[generated-client/models/notifications-summary-dto.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notifications-summary-dto.ts#L35) - -___ - -### UnreadCount - -• `Optional` **UnreadCount**: `number` - -Gets or sets the number of unread notifications. - -**`memberof`** NotificationsSummaryDto - -#### Defined in - -[generated-client/models/notifications-summary-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/notifications-summary-dto.ts#L29) diff --git a/docs/interfaces/generated_client.ObjectGroupUpdate.md b/docs/interfaces/generated_client.ObjectGroupUpdate.md deleted file mode 100644 index 8965f7591..000000000 --- a/docs/interfaces/generated_client.ObjectGroupUpdate.md +++ /dev/null @@ -1,59 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ObjectGroupUpdate - -# Interface: ObjectGroupUpdate - -[generated-client](../modules/generated_client.md).ObjectGroupUpdate - -Class GroupUpdate. - -**`export`** - -**`interface`** ObjectGroupUpdate - -## Table of contents - -### Properties - -- [Data](generated_client.ObjectGroupUpdate.md#data) -- [GroupId](generated_client.ObjectGroupUpdate.md#groupid) -- [Type](generated_client.ObjectGroupUpdate.md#type) - -## Properties - -### Data - -• `Optional` **Data**: `any` - -Gets the update data. - -**`memberof`** ObjectGroupUpdate - -#### Defined in - -[generated-client/models/object-group-update.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/object-group-update.ts#L41) - -___ - -### GroupId - -• `Optional` **GroupId**: `string` - -Gets the group identifier. - -**`memberof`** ObjectGroupUpdate - -#### Defined in - -[generated-client/models/object-group-update.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/object-group-update.ts#L29) - -___ - -### Type - -• `Optional` **Type**: [`GroupUpdateType`](../enums/generated_client.GroupUpdateType.md) - -**`memberof`** ObjectGroupUpdate - -#### Defined in - -[generated-client/models/object-group-update.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/object-group-update.ts#L35) diff --git a/docs/interfaces/generated_client.OpenLiveStreamDto.md b/docs/interfaces/generated_client.OpenLiveStreamDto.md deleted file mode 100644 index 1510b6b79..000000000 --- a/docs/interfaces/generated_client.OpenLiveStreamDto.md +++ /dev/null @@ -1,209 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / OpenLiveStreamDto - -# Interface: OpenLiveStreamDto - -[generated-client](../modules/generated_client.md).OpenLiveStreamDto - -Open live stream dto. - -**`export`** - -**`interface`** OpenLiveStreamDto - -## Table of contents - -### Properties - -- [AudioStreamIndex](generated_client.OpenLiveStreamDto.md#audiostreamindex) -- [DeviceProfile](generated_client.OpenLiveStreamDto.md#deviceprofile) -- [DirectPlayProtocols](generated_client.OpenLiveStreamDto.md#directplayprotocols) -- [EnableDirectPlay](generated_client.OpenLiveStreamDto.md#enabledirectplay) -- [EnableDirectStream](generated_client.OpenLiveStreamDto.md#enabledirectstream) -- [ItemId](generated_client.OpenLiveStreamDto.md#itemid) -- [MaxAudioChannels](generated_client.OpenLiveStreamDto.md#maxaudiochannels) -- [MaxStreamingBitrate](generated_client.OpenLiveStreamDto.md#maxstreamingbitrate) -- [OpenToken](generated_client.OpenLiveStreamDto.md#opentoken) -- [PlaySessionId](generated_client.OpenLiveStreamDto.md#playsessionid) -- [StartTimeTicks](generated_client.OpenLiveStreamDto.md#starttimeticks) -- [SubtitleStreamIndex](generated_client.OpenLiveStreamDto.md#subtitlestreamindex) -- [UserId](generated_client.OpenLiveStreamDto.md#userid) - -## Properties - -### AudioStreamIndex - -• `Optional` **AudioStreamIndex**: ``null`` \| `number` - -Gets or sets the audio stream index. - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L60) - -___ - -### DeviceProfile - -• `Optional` **DeviceProfile**: [`DeviceProfile`](generated_client.DeviceProfile.md) - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:96](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L96) - -___ - -### DirectPlayProtocols - -• `Optional` **DirectPlayProtocols**: [`MediaProtocol`](../enums/generated_client.MediaProtocol.md)[] - -Gets or sets the device play protocols. - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:102](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L102) - -___ - -### EnableDirectPlay - -• `Optional` **EnableDirectPlay**: ``null`` \| `boolean` - -Gets or sets a value indicating whether to enable direct play. - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L84) - -___ - -### EnableDirectStream - -• `Optional` **EnableDirectStream**: ``null`` \| `boolean` - -Gets or sets a value indicating whether to enale direct stream. - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:90](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L90) - -___ - -### ItemId - -• `Optional` **ItemId**: ``null`` \| `string` - -Gets or sets the item id. - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L78) - -___ - -### MaxAudioChannels - -• `Optional` **MaxAudioChannels**: ``null`` \| `number` - -Gets or sets the max audio channels. - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L72) - -___ - -### MaxStreamingBitrate - -• `Optional` **MaxStreamingBitrate**: ``null`` \| `number` - -Gets or sets the max streaming bitrate. - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L48) - -___ - -### OpenToken - -• `Optional` **OpenToken**: ``null`` \| `string` - -Gets or sets the open token. - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L30) - -___ - -### PlaySessionId - -• `Optional` **PlaySessionId**: ``null`` \| `string` - -Gets or sets the play session id. - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L42) - -___ - -### StartTimeTicks - -• `Optional` **StartTimeTicks**: ``null`` \| `number` - -Gets or sets the start time in ticks. - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L54) - -___ - -### SubtitleStreamIndex - -• `Optional` **SubtitleStreamIndex**: ``null`` \| `number` - -Gets or sets the subtitle stream index. - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L66) - -___ - -### UserId - -• `Optional` **UserId**: ``null`` \| `string` - -Gets or sets the user id. - -**`memberof`** OpenLiveStreamDto - -#### Defined in - -[generated-client/models/open-live-stream-dto.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/open-live-stream-dto.ts#L36) diff --git a/docs/interfaces/generated_client.PackageApiCancelPackageInstallationRequest.md b/docs/interfaces/generated_client.PackageApiCancelPackageInstallationRequest.md deleted file mode 100644 index 3d8265973..000000000 --- a/docs/interfaces/generated_client.PackageApiCancelPackageInstallationRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PackageApiCancelPackageInstallationRequest - -# Interface: PackageApiCancelPackageInstallationRequest - -[generated-client](../modules/generated_client.md).PackageApiCancelPackageInstallationRequest - -Request parameters for cancelPackageInstallation operation in PackageApi. - -**`export`** - -**`interface`** PackageApiCancelPackageInstallationRequest - -## Table of contents - -### Properties - -- [packageId](generated_client.PackageApiCancelPackageInstallationRequest.md#packageid) - -## Properties - -### packageId - -• `Readonly` **packageId**: `string` - -Installation Id. - -**`memberof`** PackageApiCancelPackageInstallation - -#### Defined in - -[generated-client/api/package-api.ts:435](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L435) diff --git a/docs/interfaces/generated_client.PackageApiGetPackageInfoRequest.md b/docs/interfaces/generated_client.PackageApiGetPackageInfoRequest.md deleted file mode 100644 index 2565456f3..000000000 --- a/docs/interfaces/generated_client.PackageApiGetPackageInfoRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PackageApiGetPackageInfoRequest - -# Interface: PackageApiGetPackageInfoRequest - -[generated-client](../modules/generated_client.md).PackageApiGetPackageInfoRequest - -Request parameters for getPackageInfo operation in PackageApi. - -**`export`** - -**`interface`** PackageApiGetPackageInfoRequest - -## Table of contents - -### Properties - -- [assemblyGuid](generated_client.PackageApiGetPackageInfoRequest.md#assemblyguid) -- [name](generated_client.PackageApiGetPackageInfoRequest.md#name) - -## Properties - -### assemblyGuid - -• `Optional` `Readonly` **assemblyGuid**: `string` - -The GUID of the associated assembly. - -**`memberof`** PackageApiGetPackageInfo - -#### Defined in - -[generated-client/api/package-api.ts:456](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L456) - -___ - -### name - -• `Readonly` **name**: `string` - -The name of the package. - -**`memberof`** PackageApiGetPackageInfo - -#### Defined in - -[generated-client/api/package-api.ts:449](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L449) diff --git a/docs/interfaces/generated_client.PackageApiInstallPackageRequest.md b/docs/interfaces/generated_client.PackageApiInstallPackageRequest.md deleted file mode 100644 index bd7062c06..000000000 --- a/docs/interfaces/generated_client.PackageApiInstallPackageRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PackageApiInstallPackageRequest - -# Interface: PackageApiInstallPackageRequest - -[generated-client](../modules/generated_client.md).PackageApiInstallPackageRequest - -Request parameters for installPackage operation in PackageApi. - -**`export`** - -**`interface`** PackageApiInstallPackageRequest - -## Table of contents - -### Properties - -- [assemblyGuid](generated_client.PackageApiInstallPackageRequest.md#assemblyguid) -- [name](generated_client.PackageApiInstallPackageRequest.md#name) -- [repositoryUrl](generated_client.PackageApiInstallPackageRequest.md#repositoryurl) -- [version](generated_client.PackageApiInstallPackageRequest.md#version) - -## Properties - -### assemblyGuid - -• `Optional` `Readonly` **assemblyGuid**: `string` - -GUID of the associated assembly. - -**`memberof`** PackageApiInstallPackage - -#### Defined in - -[generated-client/api/package-api.ts:477](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L477) - -___ - -### name - -• `Readonly` **name**: `string` - -Package name. - -**`memberof`** PackageApiInstallPackage - -#### Defined in - -[generated-client/api/package-api.ts:470](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L470) - -___ - -### repositoryUrl - -• `Optional` `Readonly` **repositoryUrl**: `string` - -Optional. Specify the repository to install from. - -**`memberof`** PackageApiInstallPackage - -#### Defined in - -[generated-client/api/package-api.ts:491](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L491) - -___ - -### version - -• `Optional` `Readonly` **version**: `string` - -Optional version. Defaults to latest version. - -**`memberof`** PackageApiInstallPackage - -#### Defined in - -[generated-client/api/package-api.ts:484](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L484) diff --git a/docs/interfaces/generated_client.PackageApiSetRepositoriesRequest.md b/docs/interfaces/generated_client.PackageApiSetRepositoriesRequest.md deleted file mode 100644 index 709b67b0b..000000000 --- a/docs/interfaces/generated_client.PackageApiSetRepositoriesRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PackageApiSetRepositoriesRequest - -# Interface: PackageApiSetRepositoriesRequest - -[generated-client](../modules/generated_client.md).PackageApiSetRepositoriesRequest - -Request parameters for setRepositories operation in PackageApi. - -**`export`** - -**`interface`** PackageApiSetRepositoriesRequest - -## Table of contents - -### Properties - -- [repositoryInfo](generated_client.PackageApiSetRepositoriesRequest.md#repositoryinfo) - -## Properties - -### repositoryInfo - -• `Readonly` **repositoryInfo**: [`RepositoryInfo`](generated_client.RepositoryInfo.md)[] - -The list of package repositories. - -**`memberof`** PackageApiSetRepositories - -#### Defined in - -[generated-client/api/package-api.ts:505](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L505) diff --git a/docs/interfaces/generated_client.PackageInfo.md b/docs/interfaces/generated_client.PackageInfo.md deleted file mode 100644 index cd81e7d3b..000000000 --- a/docs/interfaces/generated_client.PackageInfo.md +++ /dev/null @@ -1,136 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PackageInfo - -# Interface: PackageInfo - -[generated-client](../modules/generated_client.md).PackageInfo - -Class PackageInfo. - -**`export`** - -**`interface`** PackageInfo - -## Table of contents - -### Properties - -- [category](generated_client.PackageInfo.md#category) -- [description](generated_client.PackageInfo.md#description) -- [guid](generated_client.PackageInfo.md#guid) -- [imageUrl](generated_client.PackageInfo.md#imageurl) -- [name](generated_client.PackageInfo.md#name) -- [overview](generated_client.PackageInfo.md#overview) -- [owner](generated_client.PackageInfo.md#owner) -- [versions](generated_client.PackageInfo.md#versions) - -## Properties - -### category - -• `Optional` **category**: `string` - -Gets or sets the category. - -**`memberof`** PackageInfo - -#### Defined in - -[generated-client/models/package-info.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/package-info.ts#L53) - -___ - -### description - -• `Optional` **description**: `string` - -Gets or sets a long description of the plugin containing features or helpful explanations. - -**`memberof`** PackageInfo - -#### Defined in - -[generated-client/models/package-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/package-info.ts#L35) - -___ - -### guid - -• `Optional` **guid**: `string` - -Gets or sets the guid of the assembly associated with this plugin. This is used to identify the proper item for automatic updates. - -**`memberof`** PackageInfo - -#### Defined in - -[generated-client/models/package-info.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/package-info.ts#L59) - -___ - -### imageUrl - -• `Optional` **imageUrl**: ``null`` \| `string` - -Gets or sets the image url for the package. - -**`memberof`** PackageInfo - -#### Defined in - -[generated-client/models/package-info.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/package-info.ts#L71) - -___ - -### name - -• `Optional` **name**: `string` - -Gets or sets the name. - -**`memberof`** PackageInfo - -#### Defined in - -[generated-client/models/package-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/package-info.ts#L29) - -___ - -### overview - -• `Optional` **overview**: `string` - -Gets or sets a short overview of what the plugin does. - -**`memberof`** PackageInfo - -#### Defined in - -[generated-client/models/package-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/package-info.ts#L41) - -___ - -### owner - -• `Optional` **owner**: `string` - -Gets or sets the owner. - -**`memberof`** PackageInfo - -#### Defined in - -[generated-client/models/package-info.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/package-info.ts#L47) - -___ - -### versions - -• `Optional` **versions**: [`VersionInfo`](generated_client.VersionInfo.md)[] - -Gets or sets the versions. - -**`memberof`** PackageInfo - -#### Defined in - -[generated-client/models/package-info.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/package-info.ts#L65) diff --git a/docs/interfaces/generated_client.ParentalRating.md b/docs/interfaces/generated_client.ParentalRating.md deleted file mode 100644 index 7fb4d5af1..000000000 --- a/docs/interfaces/generated_client.ParentalRating.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ParentalRating - -# Interface: ParentalRating - -[generated-client](../modules/generated_client.md).ParentalRating - -Class ParentalRating. - -**`export`** - -**`interface`** ParentalRating - -## Table of contents - -### Properties - -- [Name](generated_client.ParentalRating.md#name) -- [Value](generated_client.ParentalRating.md#value) - -## Properties - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** ParentalRating - -#### Defined in - -[generated-client/models/parental-rating.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/parental-rating.ts#L28) - -___ - -### Value - -• `Optional` **Value**: `number` - -Gets or sets the value. - -**`memberof`** ParentalRating - -#### Defined in - -[generated-client/models/parental-rating.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/parental-rating.ts#L34) diff --git a/docs/interfaces/generated_client.PathSubstitution.md b/docs/interfaces/generated_client.PathSubstitution.md deleted file mode 100644 index 7d099a4e0..000000000 --- a/docs/interfaces/generated_client.PathSubstitution.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PathSubstitution - -# Interface: PathSubstitution - -[generated-client](../modules/generated_client.md).PathSubstitution - -Defines the MediaBrowser.Model.Configuration.PathSubstitution. - -**`export`** - -**`interface`** PathSubstitution - -## Table of contents - -### Properties - -- [From](generated_client.PathSubstitution.md#from) -- [To](generated_client.PathSubstitution.md#to) - -## Properties - -### From - -• `Optional` **From**: `string` - -Gets or sets the value to substitute. - -**`memberof`** PathSubstitution - -#### Defined in - -[generated-client/models/path-substitution.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/path-substitution.ts#L28) - -___ - -### To - -• `Optional` **To**: `string` - -Gets or sets the value to substitution with. - -**`memberof`** PathSubstitution - -#### Defined in - -[generated-client/models/path-substitution.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/path-substitution.ts#L34) diff --git a/docs/interfaces/generated_client.PersonLookupInfo.md b/docs/interfaces/generated_client.PersonLookupInfo.md deleted file mode 100644 index 4e9e40e20..000000000 --- a/docs/interfaces/generated_client.PersonLookupInfo.md +++ /dev/null @@ -1,171 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PersonLookupInfo - -# Interface: PersonLookupInfo - -[generated-client](../modules/generated_client.md).PersonLookupInfo - -**`export`** - -**`interface`** PersonLookupInfo - -## Table of contents - -### Properties - -- [IndexNumber](generated_client.PersonLookupInfo.md#indexnumber) -- [IsAutomated](generated_client.PersonLookupInfo.md#isautomated) -- [MetadataCountryCode](generated_client.PersonLookupInfo.md#metadatacountrycode) -- [MetadataLanguage](generated_client.PersonLookupInfo.md#metadatalanguage) -- [Name](generated_client.PersonLookupInfo.md#name) -- [OriginalTitle](generated_client.PersonLookupInfo.md#originaltitle) -- [ParentIndexNumber](generated_client.PersonLookupInfo.md#parentindexnumber) -- [Path](generated_client.PersonLookupInfo.md#path) -- [PremiereDate](generated_client.PersonLookupInfo.md#premieredate) -- [ProviderIds](generated_client.PersonLookupInfo.md#providerids) -- [Year](generated_client.PersonLookupInfo.md#year) - -## Properties - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -**`memberof`** PersonLookupInfo - -#### Defined in - -[generated-client/models/person-lookup-info.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info.ts#L70) - -___ - -### IsAutomated - -• `Optional` **IsAutomated**: `boolean` - -**`memberof`** PersonLookupInfo - -#### Defined in - -[generated-client/models/person-lookup-info.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info.ts#L88) - -___ - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: ``null`` \| `string` - -Gets or sets the metadata country code. - -**`memberof`** PersonLookupInfo - -#### Defined in - -[generated-client/models/person-lookup-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info.ts#L52) - -___ - -### MetadataLanguage - -• `Optional` **MetadataLanguage**: ``null`` \| `string` - -Gets or sets the metadata language. - -**`memberof`** PersonLookupInfo - -#### Defined in - -[generated-client/models/person-lookup-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info.ts#L46) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** PersonLookupInfo - -#### Defined in - -[generated-client/models/person-lookup-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info.ts#L28) - -___ - -### OriginalTitle - -• `Optional` **OriginalTitle**: ``null`` \| `string` - -Gets or sets the original title. - -**`memberof`** PersonLookupInfo - -#### Defined in - -[generated-client/models/person-lookup-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info.ts#L34) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -**`memberof`** PersonLookupInfo - -#### Defined in - -[generated-client/models/person-lookup-info.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info.ts#L76) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** PersonLookupInfo - -#### Defined in - -[generated-client/models/person-lookup-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info.ts#L40) - -___ - -### PremiereDate - -• `Optional` **PremiereDate**: ``null`` \| `string` - -**`memberof`** PersonLookupInfo - -#### Defined in - -[generated-client/models/person-lookup-info.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info.ts#L82) - -___ - -### ProviderIds - -• `Optional` **ProviderIds**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the provider ids. - -**`memberof`** PersonLookupInfo - -#### Defined in - -[generated-client/models/person-lookup-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info.ts#L58) - -___ - -### Year - -• `Optional` **Year**: ``null`` \| `number` - -Gets or sets the year. - -**`memberof`** PersonLookupInfo - -#### Defined in - -[generated-client/models/person-lookup-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info.ts#L64) diff --git a/docs/interfaces/generated_client.PersonLookupInfoRemoteSearchQuery.md b/docs/interfaces/generated_client.PersonLookupInfoRemoteSearchQuery.md deleted file mode 100644 index c35c7bada..000000000 --- a/docs/interfaces/generated_client.PersonLookupInfoRemoteSearchQuery.md +++ /dev/null @@ -1,70 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PersonLookupInfoRemoteSearchQuery - -# Interface: PersonLookupInfoRemoteSearchQuery - -[generated-client](../modules/generated_client.md).PersonLookupInfoRemoteSearchQuery - -**`export`** - -**`interface`** PersonLookupInfoRemoteSearchQuery - -## Table of contents - -### Properties - -- [IncludeDisabledProviders](generated_client.PersonLookupInfoRemoteSearchQuery.md#includedisabledproviders) -- [ItemId](generated_client.PersonLookupInfoRemoteSearchQuery.md#itemid) -- [SearchInfo](generated_client.PersonLookupInfoRemoteSearchQuery.md#searchinfo) -- [SearchProviderName](generated_client.PersonLookupInfoRemoteSearchQuery.md#searchprovidername) - -## Properties - -### IncludeDisabledProviders - -• `Optional` **IncludeDisabledProviders**: `boolean` - -Gets or sets a value indicating whether disabled providers should be included. - -**`memberof`** PersonLookupInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/person-lookup-info-remote-search-query.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info-remote-search-query.ts#L47) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -**`memberof`** PersonLookupInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/person-lookup-info-remote-search-query.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info-remote-search-query.ts#L35) - -___ - -### SearchInfo - -• `Optional` **SearchInfo**: [`PersonLookupInfo`](generated_client.PersonLookupInfo.md) - -**`memberof`** PersonLookupInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/person-lookup-info-remote-search-query.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info-remote-search-query.ts#L29) - -___ - -### SearchProviderName - -• `Optional` **SearchProviderName**: ``null`` \| `string` - -Gets or sets the provider name to search within if set. - -**`memberof`** PersonLookupInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/person-lookup-info-remote-search-query.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/person-lookup-info-remote-search-query.ts#L41) diff --git a/docs/interfaces/generated_client.PersonsApiGetPersonRequest.md b/docs/interfaces/generated_client.PersonsApiGetPersonRequest.md deleted file mode 100644 index 321666045..000000000 --- a/docs/interfaces/generated_client.PersonsApiGetPersonRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PersonsApiGetPersonRequest - -# Interface: PersonsApiGetPersonRequest - -[generated-client](../modules/generated_client.md).PersonsApiGetPersonRequest - -Request parameters for getPerson operation in PersonsApi. - -**`export`** - -**`interface`** PersonsApiGetPersonRequest - -## Table of contents - -### Properties - -- [name](generated_client.PersonsApiGetPersonRequest.md#name) -- [userId](generated_client.PersonsApiGetPersonRequest.md#userid) - -## Properties - -### name - -• `Readonly` **name**: `string` - -Person name. - -**`memberof`** PersonsApiGetPerson - -#### Defined in - -[generated-client/api/persons-api.ts:283](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L283) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** PersonsApiGetPerson - -#### Defined in - -[generated-client/api/persons-api.ts:290](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L290) diff --git a/docs/interfaces/generated_client.PersonsApiGetPersonsRequest.md b/docs/interfaces/generated_client.PersonsApiGetPersonsRequest.md deleted file mode 100644 index e430e8420..000000000 --- a/docs/interfaces/generated_client.PersonsApiGetPersonsRequest.md +++ /dev/null @@ -1,211 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PersonsApiGetPersonsRequest - -# Interface: PersonsApiGetPersonsRequest - -[generated-client](../modules/generated_client.md).PersonsApiGetPersonsRequest - -Request parameters for getPersons operation in PersonsApi. - -**`export`** - -**`interface`** PersonsApiGetPersonsRequest - -## Table of contents - -### Properties - -- [appearsInItemId](generated_client.PersonsApiGetPersonsRequest.md#appearsinitemid) -- [enableImageTypes](generated_client.PersonsApiGetPersonsRequest.md#enableimagetypes) -- [enableImages](generated_client.PersonsApiGetPersonsRequest.md#enableimages) -- [enableUserData](generated_client.PersonsApiGetPersonsRequest.md#enableuserdata) -- [excludePersonTypes](generated_client.PersonsApiGetPersonsRequest.md#excludepersontypes) -- [fields](generated_client.PersonsApiGetPersonsRequest.md#fields) -- [filters](generated_client.PersonsApiGetPersonsRequest.md#filters) -- [imageTypeLimit](generated_client.PersonsApiGetPersonsRequest.md#imagetypelimit) -- [isFavorite](generated_client.PersonsApiGetPersonsRequest.md#isfavorite) -- [limit](generated_client.PersonsApiGetPersonsRequest.md#limit) -- [personTypes](generated_client.PersonsApiGetPersonsRequest.md#persontypes) -- [searchTerm](generated_client.PersonsApiGetPersonsRequest.md#searchterm) -- [userId](generated_client.PersonsApiGetPersonsRequest.md#userid) - -## Properties - -### appearsInItemId - -• `Optional` `Readonly` **appearsInItemId**: `string` - -Optional. If specified, person results will be filtered on items related to said persons. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:374](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L374) - -___ - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:353](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L353) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional, include image information in output. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:388](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L388) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional, include user data. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:339](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L339) - -___ - -### excludePersonTypes - -• `Optional` `Readonly` **excludePersonTypes**: `string`[] - -Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:360](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L360) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:318](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L318) - -___ - -### filters - -• `Optional` `Readonly` **filters**: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[] - -Optional. Specify additional filters to apply. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:325](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L325) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional, the max number of images to return, per image type. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:346](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L346) - -___ - -### isFavorite - -• `Optional` `Readonly` **isFavorite**: `boolean` - -Optional filter by items that are marked as favorite, or not. userId is required. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:332](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L332) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:304](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L304) - -___ - -### personTypes - -• `Optional` `Readonly` **personTypes**: `string`[] - -Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:367](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L367) - -___ - -### searchTerm - -• `Optional` `Readonly` **searchTerm**: `string` - -The search term. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:311](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L311) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -User id. - -**`memberof`** PersonsApiGetPersons - -#### Defined in - -[generated-client/api/persons-api.ts:381](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L381) diff --git a/docs/interfaces/generated_client.PinRedeemResult.md b/docs/interfaces/generated_client.PinRedeemResult.md deleted file mode 100644 index 4838ef877..000000000 --- a/docs/interfaces/generated_client.PinRedeemResult.md +++ /dev/null @@ -1,44 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PinRedeemResult - -# Interface: PinRedeemResult - -[generated-client](../modules/generated_client.md).PinRedeemResult - -**`export`** - -**`interface`** PinRedeemResult - -## Table of contents - -### Properties - -- [Success](generated_client.PinRedeemResult.md#success) -- [UsersReset](generated_client.PinRedeemResult.md#usersreset) - -## Properties - -### Success - -• `Optional` **Success**: `boolean` - -Gets or sets a value indicating whether this MediaBrowser.Model.Users.PinRedeemResult is success. - -**`memberof`** PinRedeemResult - -#### Defined in - -[generated-client/models/pin-redeem-result.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/pin-redeem-result.ts#L28) - -___ - -### UsersReset - -• `Optional` **UsersReset**: `string`[] - -Gets or sets the users reset. - -**`memberof`** PinRedeemResult - -#### Defined in - -[generated-client/models/pin-redeem-result.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/pin-redeem-result.ts#L34) diff --git a/docs/interfaces/generated_client.PingRequestDto.md b/docs/interfaces/generated_client.PingRequestDto.md deleted file mode 100644 index 053d1c6ce..000000000 --- a/docs/interfaces/generated_client.PingRequestDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PingRequestDto - -# Interface: PingRequestDto - -[generated-client](../modules/generated_client.md).PingRequestDto - -Class PingRequestDto. - -**`export`** - -**`interface`** PingRequestDto - -## Table of contents - -### Properties - -- [Ping](generated_client.PingRequestDto.md#ping) - -## Properties - -### Ping - -• `Optional` **Ping**: `number` - -Gets or sets the ping time. - -**`memberof`** PingRequestDto - -#### Defined in - -[generated-client/models/ping-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ping-request-dto.ts#L28) diff --git a/docs/interfaces/generated_client.PlayRequest.md b/docs/interfaces/generated_client.PlayRequest.md deleted file mode 100644 index a1125af35..000000000 --- a/docs/interfaces/generated_client.PlayRequest.md +++ /dev/null @@ -1,126 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlayRequest - -# Interface: PlayRequest - -[generated-client](../modules/generated_client.md).PlayRequest - -Class PlayRequest. - -**`export`** - -**`interface`** PlayRequest - -## Table of contents - -### Properties - -- [AudioStreamIndex](generated_client.PlayRequest.md#audiostreamindex) -- [ControllingUserId](generated_client.PlayRequest.md#controllinguserid) -- [ItemIds](generated_client.PlayRequest.md#itemids) -- [MediaSourceId](generated_client.PlayRequest.md#mediasourceid) -- [PlayCommand](generated_client.PlayRequest.md#playcommand) -- [StartIndex](generated_client.PlayRequest.md#startindex) -- [StartPositionTicks](generated_client.PlayRequest.md#startpositionticks) -- [SubtitleStreamIndex](generated_client.PlayRequest.md#subtitlestreamindex) - -## Properties - -### AudioStreamIndex - -• `Optional` **AudioStreamIndex**: ``null`` \| `number` - -**`memberof`** PlayRequest - -#### Defined in - -[generated-client/models/play-request.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-request.ts#L59) - -___ - -### ControllingUserId - -• `Optional` **ControllingUserId**: `string` - -Gets or sets the controlling user identifier. - -**`memberof`** PlayRequest - -#### Defined in - -[generated-client/models/play-request.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-request.ts#L47) - -___ - -### ItemIds - -• `Optional` **ItemIds**: ``null`` \| `string`[] - -Gets or sets the item ids. - -**`memberof`** PlayRequest - -#### Defined in - -[generated-client/models/play-request.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-request.ts#L29) - -___ - -### MediaSourceId - -• `Optional` **MediaSourceId**: ``null`` \| `string` - -**`memberof`** PlayRequest - -#### Defined in - -[generated-client/models/play-request.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-request.ts#L65) - -___ - -### PlayCommand - -• `Optional` **PlayCommand**: [`PlayCommand`](../enums/generated_client.PlayCommand.md) - -**`memberof`** PlayRequest - -#### Defined in - -[generated-client/models/play-request.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-request.ts#L41) - -___ - -### StartIndex - -• `Optional` **StartIndex**: ``null`` \| `number` - -**`memberof`** PlayRequest - -#### Defined in - -[generated-client/models/play-request.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-request.ts#L71) - -___ - -### StartPositionTicks - -• `Optional` **StartPositionTicks**: ``null`` \| `number` - -Gets or sets the start position ticks that the first item should be played at. - -**`memberof`** PlayRequest - -#### Defined in - -[generated-client/models/play-request.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-request.ts#L35) - -___ - -### SubtitleStreamIndex - -• `Optional` **SubtitleStreamIndex**: ``null`` \| `number` - -**`memberof`** PlayRequest - -#### Defined in - -[generated-client/models/play-request.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-request.ts#L53) diff --git a/docs/interfaces/generated_client.PlayRequestDto.md b/docs/interfaces/generated_client.PlayRequestDto.md deleted file mode 100644 index 8424710e9..000000000 --- a/docs/interfaces/generated_client.PlayRequestDto.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlayRequestDto - -# Interface: PlayRequestDto - -[generated-client](../modules/generated_client.md).PlayRequestDto - -Class PlayRequestDto. - -**`export`** - -**`interface`** PlayRequestDto - -## Table of contents - -### Properties - -- [PlayingItemPosition](generated_client.PlayRequestDto.md#playingitemposition) -- [PlayingQueue](generated_client.PlayRequestDto.md#playingqueue) -- [StartPositionTicks](generated_client.PlayRequestDto.md#startpositionticks) - -## Properties - -### PlayingItemPosition - -• `Optional` **PlayingItemPosition**: `number` - -Gets or sets the position of the playing item in the queue. - -**`memberof`** PlayRequestDto - -#### Defined in - -[generated-client/models/play-request-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-request-dto.ts#L34) - -___ - -### PlayingQueue - -• `Optional` **PlayingQueue**: `string`[] - -Gets or sets the playing queue. - -**`memberof`** PlayRequestDto - -#### Defined in - -[generated-client/models/play-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-request-dto.ts#L28) - -___ - -### StartPositionTicks - -• `Optional` **StartPositionTicks**: `number` - -Gets or sets the start position ticks. - -**`memberof`** PlayRequestDto - -#### Defined in - -[generated-client/models/play-request-dto.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/play-request-dto.ts#L40) diff --git a/docs/interfaces/generated_client.PlaybackInfoDto.md b/docs/interfaces/generated_client.PlaybackInfoDto.md deleted file mode 100644 index ae2a974e0..000000000 --- a/docs/interfaces/generated_client.PlaybackInfoDto.md +++ /dev/null @@ -1,239 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaybackInfoDto - -# Interface: PlaybackInfoDto - -[generated-client](../modules/generated_client.md).PlaybackInfoDto - -Plabyback info dto. - -**`export`** - -**`interface`** PlaybackInfoDto - -## Table of contents - -### Properties - -- [AllowAudioStreamCopy](generated_client.PlaybackInfoDto.md#allowaudiostreamcopy) -- [AllowVideoStreamCopy](generated_client.PlaybackInfoDto.md#allowvideostreamcopy) -- [AudioStreamIndex](generated_client.PlaybackInfoDto.md#audiostreamindex) -- [AutoOpenLiveStream](generated_client.PlaybackInfoDto.md#autoopenlivestream) -- [DeviceProfile](generated_client.PlaybackInfoDto.md#deviceprofile) -- [EnableDirectPlay](generated_client.PlaybackInfoDto.md#enabledirectplay) -- [EnableDirectStream](generated_client.PlaybackInfoDto.md#enabledirectstream) -- [EnableTranscoding](generated_client.PlaybackInfoDto.md#enabletranscoding) -- [LiveStreamId](generated_client.PlaybackInfoDto.md#livestreamid) -- [MaxAudioChannels](generated_client.PlaybackInfoDto.md#maxaudiochannels) -- [MaxStreamingBitrate](generated_client.PlaybackInfoDto.md#maxstreamingbitrate) -- [MediaSourceId](generated_client.PlaybackInfoDto.md#mediasourceid) -- [StartTimeTicks](generated_client.PlaybackInfoDto.md#starttimeticks) -- [SubtitleStreamIndex](generated_client.PlaybackInfoDto.md#subtitlestreamindex) -- [UserId](generated_client.PlaybackInfoDto.md#userid) - -## Properties - -### AllowAudioStreamCopy - -• `Optional` **AllowAudioStreamCopy**: ``null`` \| `boolean` - -Gets or sets a value indicating whether to allow audio stream copy. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:107](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L107) - -___ - -### AllowVideoStreamCopy - -• `Optional` **AllowVideoStreamCopy**: ``null`` \| `boolean` - -Gets or sets a value indicating whether to enable video stream copy. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:101](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L101) - -___ - -### AudioStreamIndex - -• `Optional` **AudioStreamIndex**: ``null`` \| `number` - -Gets or sets the audio stream index. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L47) - -___ - -### AutoOpenLiveStream - -• `Optional` **AutoOpenLiveStream**: ``null`` \| `boolean` - -Gets or sets a value indicating whether to auto open the live stream. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:113](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L113) - -___ - -### DeviceProfile - -• `Optional` **DeviceProfile**: [`DeviceProfile`](generated_client.DeviceProfile.md) - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L77) - -___ - -### EnableDirectPlay - -• `Optional` **EnableDirectPlay**: ``null`` \| `boolean` - -Gets or sets a value indicating whether to enable direct play. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:83](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L83) - -___ - -### EnableDirectStream - -• `Optional` **EnableDirectStream**: ``null`` \| `boolean` - -Gets or sets a value indicating whether to enable direct stream. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:89](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L89) - -___ - -### EnableTranscoding - -• `Optional` **EnableTranscoding**: ``null`` \| `boolean` - -Gets or sets a value indicating whether to enable transcoding. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:95](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L95) - -___ - -### LiveStreamId - -• `Optional` **LiveStreamId**: ``null`` \| `string` - -Gets or sets the live stream id. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L71) - -___ - -### MaxAudioChannels - -• `Optional` **MaxAudioChannels**: ``null`` \| `number` - -Gets or sets the max audio channels. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L59) - -___ - -### MaxStreamingBitrate - -• `Optional` **MaxStreamingBitrate**: ``null`` \| `number` - -Gets or sets the max streaming bitrate. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L35) - -___ - -### MediaSourceId - -• `Optional` **MediaSourceId**: ``null`` \| `string` - -Gets or sets the media source id. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L65) - -___ - -### StartTimeTicks - -• `Optional` **StartTimeTicks**: ``null`` \| `number` - -Gets or sets the start time in ticks. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L41) - -___ - -### SubtitleStreamIndex - -• `Optional` **SubtitleStreamIndex**: ``null`` \| `number` - -Gets or sets the subtitle stream index. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L53) - -___ - -### UserId - -• `Optional` **UserId**: ``null`` \| `string` - -Gets or sets the playback userId. - -**`memberof`** PlaybackInfoDto - -#### Defined in - -[generated-client/models/playback-info-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-dto.ts#L29) diff --git a/docs/interfaces/generated_client.PlaybackInfoResponse.md b/docs/interfaces/generated_client.PlaybackInfoResponse.md deleted file mode 100644 index 61a433517..000000000 --- a/docs/interfaces/generated_client.PlaybackInfoResponse.md +++ /dev/null @@ -1,59 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaybackInfoResponse - -# Interface: PlaybackInfoResponse - -[generated-client](../modules/generated_client.md).PlaybackInfoResponse - -Class PlaybackInfoResponse. - -**`export`** - -**`interface`** PlaybackInfoResponse - -## Table of contents - -### Properties - -- [ErrorCode](generated_client.PlaybackInfoResponse.md#errorcode) -- [MediaSources](generated_client.PlaybackInfoResponse.md#mediasources) -- [PlaySessionId](generated_client.PlaybackInfoResponse.md#playsessionid) - -## Properties - -### ErrorCode - -• `Optional` **ErrorCode**: [`PlaybackErrorCode`](../enums/generated_client.PlaybackErrorCode.md) - -**`memberof`** PlaybackInfoResponse - -#### Defined in - -[generated-client/models/playback-info-response.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-response.ts#L42) - -___ - -### MediaSources - -• `Optional` **MediaSources**: [`MediaSourceInfo`](generated_client.MediaSourceInfo.md)[] - -Gets or sets the media sources. - -**`memberof`** PlaybackInfoResponse - -#### Defined in - -[generated-client/models/playback-info-response.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-response.ts#L30) - -___ - -### PlaySessionId - -• `Optional` **PlaySessionId**: ``null`` \| `string` - -Gets or sets the play session identifier. - -**`memberof`** PlaybackInfoResponse - -#### Defined in - -[generated-client/models/playback-info-response.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-info-response.ts#L36) diff --git a/docs/interfaces/generated_client.PlaybackProgressInfo.md b/docs/interfaces/generated_client.PlaybackProgressInfo.md deleted file mode 100644 index 5a95c56f4..000000000 --- a/docs/interfaces/generated_client.PlaybackProgressInfo.md +++ /dev/null @@ -1,300 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaybackProgressInfo - -# Interface: PlaybackProgressInfo - -[generated-client](../modules/generated_client.md).PlaybackProgressInfo - -Class PlaybackProgressInfo. - -**`export`** - -**`interface`** PlaybackProgressInfo - -## Table of contents - -### Properties - -- [AspectRatio](generated_client.PlaybackProgressInfo.md#aspectratio) -- [AudioStreamIndex](generated_client.PlaybackProgressInfo.md#audiostreamindex) -- [Brightness](generated_client.PlaybackProgressInfo.md#brightness) -- [CanSeek](generated_client.PlaybackProgressInfo.md#canseek) -- [IsMuted](generated_client.PlaybackProgressInfo.md#ismuted) -- [IsPaused](generated_client.PlaybackProgressInfo.md#ispaused) -- [Item](generated_client.PlaybackProgressInfo.md#item) -- [ItemId](generated_client.PlaybackProgressInfo.md#itemid) -- [LiveStreamId](generated_client.PlaybackProgressInfo.md#livestreamid) -- [MediaSourceId](generated_client.PlaybackProgressInfo.md#mediasourceid) -- [NowPlayingQueue](generated_client.PlaybackProgressInfo.md#nowplayingqueue) -- [PlayMethod](generated_client.PlaybackProgressInfo.md#playmethod) -- [PlaySessionId](generated_client.PlaybackProgressInfo.md#playsessionid) -- [PlaybackStartTimeTicks](generated_client.PlaybackProgressInfo.md#playbackstarttimeticks) -- [PlaylistItemId](generated_client.PlaybackProgressInfo.md#playlistitemid) -- [PositionTicks](generated_client.PlaybackProgressInfo.md#positionticks) -- [RepeatMode](generated_client.PlaybackProgressInfo.md#repeatmode) -- [SessionId](generated_client.PlaybackProgressInfo.md#sessionid) -- [SubtitleStreamIndex](generated_client.PlaybackProgressInfo.md#subtitlestreamindex) -- [VolumeLevel](generated_client.PlaybackProgressInfo.md#volumelevel) - -## Properties - -### AspectRatio - -• `Optional` **AspectRatio**: ``null`` \| `string` - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:110](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L110) - -___ - -### AudioStreamIndex - -• `Optional` **AudioStreamIndex**: ``null`` \| `number` - -Gets or sets the index of the audio stream. - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:62](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L62) - -___ - -### Brightness - -• `Optional` **Brightness**: ``null`` \| `number` - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:104](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L104) - -___ - -### CanSeek - -• `Optional` **CanSeek**: `boolean` - -Gets or sets a value indicating whether this instance can seek. - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L32) - -___ - -### IsMuted - -• `Optional` **IsMuted**: `boolean` - -Gets or sets a value indicating whether this instance is muted. - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:80](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L80) - -___ - -### IsPaused - -• `Optional` **IsPaused**: `boolean` - -Gets or sets a value indicating whether this instance is paused. - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:74](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L74) - -___ - -### Item - -• `Optional` **Item**: [`BaseItemDto`](generated_client.BaseItemDto.md) - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:38](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L38) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -Gets or sets the item identifier. - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:44](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L44) - -___ - -### LiveStreamId - -• `Optional` **LiveStreamId**: ``null`` \| `string` - -Gets or sets the live stream identifier. - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:122](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L122) - -___ - -### MediaSourceId - -• `Optional` **MediaSourceId**: ``null`` \| `string` - -Gets or sets the media version identifier. - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:56](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L56) - -___ - -### NowPlayingQueue - -• `Optional` **NowPlayingQueue**: ``null`` \| [`QueueItem`](generated_client.QueueItem.md)[] - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:140](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L140) - -___ - -### PlayMethod - -• `Optional` **PlayMethod**: [`PlayMethod`](../enums/generated_client.PlayMethod.md) - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:116](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L116) - -___ - -### PlaySessionId - -• `Optional` **PlaySessionId**: ``null`` \| `string` - -Gets or sets the play session identifier. - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:128](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L128) - -___ - -### PlaybackStartTimeTicks - -• `Optional` **PlaybackStartTimeTicks**: ``null`` \| `number` - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:92](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L92) - -___ - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: ``null`` \| `string` - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:146](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L146) - -___ - -### PositionTicks - -• `Optional` **PositionTicks**: ``null`` \| `number` - -Gets or sets the position ticks. - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:86](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L86) - -___ - -### RepeatMode - -• `Optional` **RepeatMode**: [`RepeatMode`](../enums/generated_client.RepeatMode.md) - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:134](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L134) - -___ - -### SessionId - -• `Optional` **SessionId**: ``null`` \| `string` - -Gets or sets the session id. - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L50) - -___ - -### SubtitleStreamIndex - -• `Optional` **SubtitleStreamIndex**: ``null`` \| `number` - -Gets or sets the index of the subtitle stream. - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:68](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L68) - -___ - -### VolumeLevel - -• `Optional` **VolumeLevel**: ``null`` \| `number` - -Gets or sets the volume level. - -**`memberof`** PlaybackProgressInfo - -#### Defined in - -[generated-client/models/playback-progress-info.ts:98](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-progress-info.ts#L98) diff --git a/docs/interfaces/generated_client.PlaybackStartInfo.md b/docs/interfaces/generated_client.PlaybackStartInfo.md deleted file mode 100644 index f24392cf2..000000000 --- a/docs/interfaces/generated_client.PlaybackStartInfo.md +++ /dev/null @@ -1,300 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaybackStartInfo - -# Interface: PlaybackStartInfo - -[generated-client](../modules/generated_client.md).PlaybackStartInfo - -Class PlaybackStartInfo. - -**`export`** - -**`interface`** PlaybackStartInfo - -## Table of contents - -### Properties - -- [AspectRatio](generated_client.PlaybackStartInfo.md#aspectratio) -- [AudioStreamIndex](generated_client.PlaybackStartInfo.md#audiostreamindex) -- [Brightness](generated_client.PlaybackStartInfo.md#brightness) -- [CanSeek](generated_client.PlaybackStartInfo.md#canseek) -- [IsMuted](generated_client.PlaybackStartInfo.md#ismuted) -- [IsPaused](generated_client.PlaybackStartInfo.md#ispaused) -- [Item](generated_client.PlaybackStartInfo.md#item) -- [ItemId](generated_client.PlaybackStartInfo.md#itemid) -- [LiveStreamId](generated_client.PlaybackStartInfo.md#livestreamid) -- [MediaSourceId](generated_client.PlaybackStartInfo.md#mediasourceid) -- [NowPlayingQueue](generated_client.PlaybackStartInfo.md#nowplayingqueue) -- [PlayMethod](generated_client.PlaybackStartInfo.md#playmethod) -- [PlaySessionId](generated_client.PlaybackStartInfo.md#playsessionid) -- [PlaybackStartTimeTicks](generated_client.PlaybackStartInfo.md#playbackstarttimeticks) -- [PlaylistItemId](generated_client.PlaybackStartInfo.md#playlistitemid) -- [PositionTicks](generated_client.PlaybackStartInfo.md#positionticks) -- [RepeatMode](generated_client.PlaybackStartInfo.md#repeatmode) -- [SessionId](generated_client.PlaybackStartInfo.md#sessionid) -- [SubtitleStreamIndex](generated_client.PlaybackStartInfo.md#subtitlestreamindex) -- [VolumeLevel](generated_client.PlaybackStartInfo.md#volumelevel) - -## Properties - -### AspectRatio - -• `Optional` **AspectRatio**: ``null`` \| `string` - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:110](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L110) - -___ - -### AudioStreamIndex - -• `Optional` **AudioStreamIndex**: ``null`` \| `number` - -Gets or sets the index of the audio stream. - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:62](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L62) - -___ - -### Brightness - -• `Optional` **Brightness**: ``null`` \| `number` - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:104](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L104) - -___ - -### CanSeek - -• `Optional` **CanSeek**: `boolean` - -Gets or sets a value indicating whether this instance can seek. - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L32) - -___ - -### IsMuted - -• `Optional` **IsMuted**: `boolean` - -Gets or sets a value indicating whether this instance is muted. - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:80](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L80) - -___ - -### IsPaused - -• `Optional` **IsPaused**: `boolean` - -Gets or sets a value indicating whether this instance is paused. - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:74](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L74) - -___ - -### Item - -• `Optional` **Item**: [`BaseItemDto`](generated_client.BaseItemDto.md) - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:38](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L38) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -Gets or sets the item identifier. - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:44](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L44) - -___ - -### LiveStreamId - -• `Optional` **LiveStreamId**: ``null`` \| `string` - -Gets or sets the live stream identifier. - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:122](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L122) - -___ - -### MediaSourceId - -• `Optional` **MediaSourceId**: ``null`` \| `string` - -Gets or sets the media version identifier. - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:56](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L56) - -___ - -### NowPlayingQueue - -• `Optional` **NowPlayingQueue**: ``null`` \| [`QueueItem`](generated_client.QueueItem.md)[] - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:140](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L140) - -___ - -### PlayMethod - -• `Optional` **PlayMethod**: [`PlayMethod`](../enums/generated_client.PlayMethod.md) - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:116](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L116) - -___ - -### PlaySessionId - -• `Optional` **PlaySessionId**: ``null`` \| `string` - -Gets or sets the play session identifier. - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:128](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L128) - -___ - -### PlaybackStartTimeTicks - -• `Optional` **PlaybackStartTimeTicks**: ``null`` \| `number` - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:92](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L92) - -___ - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: ``null`` \| `string` - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:146](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L146) - -___ - -### PositionTicks - -• `Optional` **PositionTicks**: ``null`` \| `number` - -Gets or sets the position ticks. - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:86](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L86) - -___ - -### RepeatMode - -• `Optional` **RepeatMode**: [`RepeatMode`](../enums/generated_client.RepeatMode.md) - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:134](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L134) - -___ - -### SessionId - -• `Optional` **SessionId**: ``null`` \| `string` - -Gets or sets the session id. - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L50) - -___ - -### SubtitleStreamIndex - -• `Optional` **SubtitleStreamIndex**: ``null`` \| `number` - -Gets or sets the index of the subtitle stream. - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:68](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L68) - -___ - -### VolumeLevel - -• `Optional` **VolumeLevel**: ``null`` \| `number` - -Gets or sets the volume level. - -**`memberof`** PlaybackStartInfo - -#### Defined in - -[generated-client/models/playback-start-info.ts:98](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-start-info.ts#L98) diff --git a/docs/interfaces/generated_client.PlaybackStopInfo.md b/docs/interfaces/generated_client.PlaybackStopInfo.md deleted file mode 100644 index 6026f4462..000000000 --- a/docs/interfaces/generated_client.PlaybackStopInfo.md +++ /dev/null @@ -1,173 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaybackStopInfo - -# Interface: PlaybackStopInfo - -[generated-client](../modules/generated_client.md).PlaybackStopInfo - -Class PlaybackStopInfo. - -**`export`** - -**`interface`** PlaybackStopInfo - -## Table of contents - -### Properties - -- [Failed](generated_client.PlaybackStopInfo.md#failed) -- [Item](generated_client.PlaybackStopInfo.md#item) -- [ItemId](generated_client.PlaybackStopInfo.md#itemid) -- [LiveStreamId](generated_client.PlaybackStopInfo.md#livestreamid) -- [MediaSourceId](generated_client.PlaybackStopInfo.md#mediasourceid) -- [NextMediaType](generated_client.PlaybackStopInfo.md#nextmediatype) -- [NowPlayingQueue](generated_client.PlaybackStopInfo.md#nowplayingqueue) -- [PlaySessionId](generated_client.PlaybackStopInfo.md#playsessionid) -- [PlaylistItemId](generated_client.PlaybackStopInfo.md#playlistitemid) -- [PositionTicks](generated_client.PlaybackStopInfo.md#positionticks) -- [SessionId](generated_client.PlaybackStopInfo.md#sessionid) - -## Properties - -### Failed - -• `Optional` **Failed**: `boolean` - -Gets or sets a value indicating whether this MediaBrowser.Model.Session.PlaybackStopInfo is failed. - -**`memberof`** PlaybackStopInfo - -#### Defined in - -[generated-client/models/playback-stop-info.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-stop-info.ts#L72) - -___ - -### Item - -• `Optional` **Item**: [`BaseItemDto`](generated_client.BaseItemDto.md) - -**`memberof`** PlaybackStopInfo - -#### Defined in - -[generated-client/models/playback-stop-info.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-stop-info.ts#L30) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -Gets or sets the item identifier. - -**`memberof`** PlaybackStopInfo - -#### Defined in - -[generated-client/models/playback-stop-info.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-stop-info.ts#L36) - -___ - -### LiveStreamId - -• `Optional` **LiveStreamId**: ``null`` \| `string` - -Gets or sets the live stream identifier. - -**`memberof`** PlaybackStopInfo - -#### Defined in - -[generated-client/models/playback-stop-info.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-stop-info.ts#L60) - -___ - -### MediaSourceId - -• `Optional` **MediaSourceId**: ``null`` \| `string` - -Gets or sets the media version identifier. - -**`memberof`** PlaybackStopInfo - -#### Defined in - -[generated-client/models/playback-stop-info.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-stop-info.ts#L48) - -___ - -### NextMediaType - -• `Optional` **NextMediaType**: ``null`` \| `string` - -**`memberof`** PlaybackStopInfo - -#### Defined in - -[generated-client/models/playback-stop-info.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-stop-info.ts#L78) - -___ - -### NowPlayingQueue - -• `Optional` **NowPlayingQueue**: ``null`` \| [`QueueItem`](generated_client.QueueItem.md)[] - -**`memberof`** PlaybackStopInfo - -#### Defined in - -[generated-client/models/playback-stop-info.ts:90](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-stop-info.ts#L90) - -___ - -### PlaySessionId - -• `Optional` **PlaySessionId**: ``null`` \| `string` - -Gets or sets the play session identifier. - -**`memberof`** PlaybackStopInfo - -#### Defined in - -[generated-client/models/playback-stop-info.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-stop-info.ts#L66) - -___ - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: ``null`` \| `string` - -**`memberof`** PlaybackStopInfo - -#### Defined in - -[generated-client/models/playback-stop-info.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-stop-info.ts#L84) - -___ - -### PositionTicks - -• `Optional` **PositionTicks**: ``null`` \| `number` - -Gets or sets the position ticks. - -**`memberof`** PlaybackStopInfo - -#### Defined in - -[generated-client/models/playback-stop-info.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-stop-info.ts#L54) - -___ - -### SessionId - -• `Optional` **SessionId**: ``null`` \| `string` - -Gets or sets the session id. - -**`memberof`** PlaybackStopInfo - -#### Defined in - -[generated-client/models/playback-stop-info.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playback-stop-info.ts#L42) diff --git a/docs/interfaces/generated_client.PlayerStateInfo.md b/docs/interfaces/generated_client.PlayerStateInfo.md deleted file mode 100644 index f909ef3bd..000000000 --- a/docs/interfaces/generated_client.PlayerStateInfo.md +++ /dev/null @@ -1,175 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlayerStateInfo - -# Interface: PlayerStateInfo - -[generated-client](../modules/generated_client.md).PlayerStateInfo - -**`export`** - -**`interface`** PlayerStateInfo - -## Table of contents - -### Properties - -- [AudioStreamIndex](generated_client.PlayerStateInfo.md#audiostreamindex) -- [CanSeek](generated_client.PlayerStateInfo.md#canseek) -- [IsMuted](generated_client.PlayerStateInfo.md#ismuted) -- [IsPaused](generated_client.PlayerStateInfo.md#ispaused) -- [LiveStreamId](generated_client.PlayerStateInfo.md#livestreamid) -- [MediaSourceId](generated_client.PlayerStateInfo.md#mediasourceid) -- [PlayMethod](generated_client.PlayerStateInfo.md#playmethod) -- [PositionTicks](generated_client.PlayerStateInfo.md#positionticks) -- [RepeatMode](generated_client.PlayerStateInfo.md#repeatmode) -- [SubtitleStreamIndex](generated_client.PlayerStateInfo.md#subtitlestreamindex) -- [VolumeLevel](generated_client.PlayerStateInfo.md#volumelevel) - -## Properties - -### AudioStreamIndex - -• `Optional` **AudioStreamIndex**: ``null`` \| `number` - -Gets or sets the index of the now playing audio stream. - -**`memberof`** PlayerStateInfo - -#### Defined in - -[generated-client/models/player-state-info.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/player-state-info.ts#L60) - -___ - -### CanSeek - -• `Optional` **CanSeek**: `boolean` - -Gets or sets a value indicating whether this instance can seek. - -**`memberof`** PlayerStateInfo - -#### Defined in - -[generated-client/models/player-state-info.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/player-state-info.ts#L36) - -___ - -### IsMuted - -• `Optional` **IsMuted**: `boolean` - -Gets or sets a value indicating whether this instance is muted. - -**`memberof`** PlayerStateInfo - -#### Defined in - -[generated-client/models/player-state-info.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/player-state-info.ts#L48) - -___ - -### IsPaused - -• `Optional` **IsPaused**: `boolean` - -Gets or sets a value indicating whether this instance is paused. - -**`memberof`** PlayerStateInfo - -#### Defined in - -[generated-client/models/player-state-info.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/player-state-info.ts#L42) - -___ - -### LiveStreamId - -• `Optional` **LiveStreamId**: ``null`` \| `string` - -Gets or sets the now playing live stream identifier. - -**`memberof`** PlayerStateInfo - -#### Defined in - -[generated-client/models/player-state-info.ts:90](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/player-state-info.ts#L90) - -___ - -### MediaSourceId - -• `Optional` **MediaSourceId**: ``null`` \| `string` - -Gets or sets the now playing media version identifier. - -**`memberof`** PlayerStateInfo - -#### Defined in - -[generated-client/models/player-state-info.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/player-state-info.ts#L72) - -___ - -### PlayMethod - -• `Optional` **PlayMethod**: [`PlayMethod`](../enums/generated_client.PlayMethod.md) - -**`memberof`** PlayerStateInfo - -#### Defined in - -[generated-client/models/player-state-info.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/player-state-info.ts#L78) - -___ - -### PositionTicks - -• `Optional` **PositionTicks**: ``null`` \| `number` - -Gets or sets the now playing position ticks. - -**`memberof`** PlayerStateInfo - -#### Defined in - -[generated-client/models/player-state-info.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/player-state-info.ts#L30) - -___ - -### RepeatMode - -• `Optional` **RepeatMode**: [`RepeatMode`](../enums/generated_client.RepeatMode.md) - -**`memberof`** PlayerStateInfo - -#### Defined in - -[generated-client/models/player-state-info.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/player-state-info.ts#L84) - -___ - -### SubtitleStreamIndex - -• `Optional` **SubtitleStreamIndex**: ``null`` \| `number` - -Gets or sets the index of the now playing subtitle stream. - -**`memberof`** PlayerStateInfo - -#### Defined in - -[generated-client/models/player-state-info.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/player-state-info.ts#L66) - -___ - -### VolumeLevel - -• `Optional` **VolumeLevel**: ``null`` \| `number` - -Gets or sets the volume level. - -**`memberof`** PlayerStateInfo - -#### Defined in - -[generated-client/models/player-state-info.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/player-state-info.ts#L54) diff --git a/docs/interfaces/generated_client.PlaylistCreationResult.md b/docs/interfaces/generated_client.PlaylistCreationResult.md deleted file mode 100644 index 053145178..000000000 --- a/docs/interfaces/generated_client.PlaylistCreationResult.md +++ /dev/null @@ -1,27 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaylistCreationResult - -# Interface: PlaylistCreationResult - -[generated-client](../modules/generated_client.md).PlaylistCreationResult - -**`export`** - -**`interface`** PlaylistCreationResult - -## Table of contents - -### Properties - -- [Id](generated_client.PlaylistCreationResult.md#id) - -## Properties - -### Id - -• `Optional` **Id**: `string` - -**`memberof`** PlaylistCreationResult - -#### Defined in - -[generated-client/models/playlist-creation-result.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playlist-creation-result.ts#L28) diff --git a/docs/interfaces/generated_client.PlaylistsApiAddToPlaylistRequest.md b/docs/interfaces/generated_client.PlaylistsApiAddToPlaylistRequest.md deleted file mode 100644 index 4ad1834e7..000000000 --- a/docs/interfaces/generated_client.PlaylistsApiAddToPlaylistRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaylistsApiAddToPlaylistRequest - -# Interface: PlaylistsApiAddToPlaylistRequest - -[generated-client](../modules/generated_client.md).PlaylistsApiAddToPlaylistRequest - -Request parameters for addToPlaylist operation in PlaylistsApi. - -**`export`** - -**`interface`** PlaylistsApiAddToPlaylistRequest - -## Table of contents - -### Properties - -- [ids](generated_client.PlaylistsApiAddToPlaylistRequest.md#ids) -- [playlistId](generated_client.PlaylistsApiAddToPlaylistRequest.md#playlistid) -- [userId](generated_client.PlaylistsApiAddToPlaylistRequest.md#userid) - -## Properties - -### ids - -• `Optional` `Readonly` **ids**: `string`[] - -Item id, comma delimited. - -**`memberof`** PlaylistsApiAddToPlaylist - -#### Defined in - -[generated-client/api/playlists-api.ts:489](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L489) - -___ - -### playlistId - -• `Readonly` **playlistId**: `string` - -The playlist id. - -**`memberof`** PlaylistsApiAddToPlaylist - -#### Defined in - -[generated-client/api/playlists-api.ts:482](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L482) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -The userId. - -**`memberof`** PlaylistsApiAddToPlaylist - -#### Defined in - -[generated-client/api/playlists-api.ts:496](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L496) diff --git a/docs/interfaces/generated_client.PlaylistsApiCreatePlaylistRequest.md b/docs/interfaces/generated_client.PlaylistsApiCreatePlaylistRequest.md deleted file mode 100644 index 53f531fd2..000000000 --- a/docs/interfaces/generated_client.PlaylistsApiCreatePlaylistRequest.md +++ /dev/null @@ -1,91 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaylistsApiCreatePlaylistRequest - -# Interface: PlaylistsApiCreatePlaylistRequest - -[generated-client](../modules/generated_client.md).PlaylistsApiCreatePlaylistRequest - -Request parameters for createPlaylist operation in PlaylistsApi. - -**`export`** - -**`interface`** PlaylistsApiCreatePlaylistRequest - -## Table of contents - -### Properties - -- [createPlaylistDto](generated_client.PlaylistsApiCreatePlaylistRequest.md#createplaylistdto) -- [ids](generated_client.PlaylistsApiCreatePlaylistRequest.md#ids) -- [mediaType](generated_client.PlaylistsApiCreatePlaylistRequest.md#mediatype) -- [name](generated_client.PlaylistsApiCreatePlaylistRequest.md#name) -- [userId](generated_client.PlaylistsApiCreatePlaylistRequest.md#userid) - -## Properties - -### createPlaylistDto - -• `Optional` `Readonly` **createPlaylistDto**: [`CreatePlaylistDto`](generated_client.CreatePlaylistDto.md) - -The create playlist payload. - -**`memberof`** PlaylistsApiCreatePlaylist - -#### Defined in - -[generated-client/api/playlists-api.ts:538](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L538) - -___ - -### ids - -• `Optional` `Readonly` **ids**: `string`[] - -The item ids. - -**`memberof`** PlaylistsApiCreatePlaylist - -#### Defined in - -[generated-client/api/playlists-api.ts:517](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L517) - -___ - -### mediaType - -• `Optional` `Readonly` **mediaType**: `string` - -The media type. - -**`memberof`** PlaylistsApiCreatePlaylist - -#### Defined in - -[generated-client/api/playlists-api.ts:531](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L531) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -The playlist name. - -**`memberof`** PlaylistsApiCreatePlaylist - -#### Defined in - -[generated-client/api/playlists-api.ts:510](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L510) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -The user id. - -**`memberof`** PlaylistsApiCreatePlaylist - -#### Defined in - -[generated-client/api/playlists-api.ts:524](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L524) diff --git a/docs/interfaces/generated_client.PlaylistsApiGetPlaylistItemsRequest.md b/docs/interfaces/generated_client.PlaylistsApiGetPlaylistItemsRequest.md deleted file mode 100644 index 611617a77..000000000 --- a/docs/interfaces/generated_client.PlaylistsApiGetPlaylistItemsRequest.md +++ /dev/null @@ -1,151 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaylistsApiGetPlaylistItemsRequest - -# Interface: PlaylistsApiGetPlaylistItemsRequest - -[generated-client](../modules/generated_client.md).PlaylistsApiGetPlaylistItemsRequest - -Request parameters for getPlaylistItems operation in PlaylistsApi. - -**`export`** - -**`interface`** PlaylistsApiGetPlaylistItemsRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.PlaylistsApiGetPlaylistItemsRequest.md#enableimagetypes) -- [enableImages](generated_client.PlaylistsApiGetPlaylistItemsRequest.md#enableimages) -- [enableUserData](generated_client.PlaylistsApiGetPlaylistItemsRequest.md#enableuserdata) -- [fields](generated_client.PlaylistsApiGetPlaylistItemsRequest.md#fields) -- [imageTypeLimit](generated_client.PlaylistsApiGetPlaylistItemsRequest.md#imagetypelimit) -- [limit](generated_client.PlaylistsApiGetPlaylistItemsRequest.md#limit) -- [playlistId](generated_client.PlaylistsApiGetPlaylistItemsRequest.md#playlistid) -- [startIndex](generated_client.PlaylistsApiGetPlaylistItemsRequest.md#startindex) -- [userId](generated_client.PlaylistsApiGetPlaylistItemsRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** PlaylistsApiGetPlaylistItems - -#### Defined in - -[generated-client/api/playlists-api.ts:608](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L608) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** PlaylistsApiGetPlaylistItems - -#### Defined in - -[generated-client/api/playlists-api.ts:587](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L587) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** PlaylistsApiGetPlaylistItems - -#### Defined in - -[generated-client/api/playlists-api.ts:594](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L594) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** PlaylistsApiGetPlaylistItems - -#### Defined in - -[generated-client/api/playlists-api.ts:580](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L580) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** PlaylistsApiGetPlaylistItems - -#### Defined in - -[generated-client/api/playlists-api.ts:601](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L601) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** PlaylistsApiGetPlaylistItems - -#### Defined in - -[generated-client/api/playlists-api.ts:573](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L573) - -___ - -### playlistId - -• `Readonly` **playlistId**: `string` - -The playlist id. - -**`memberof`** PlaylistsApiGetPlaylistItems - -#### Defined in - -[generated-client/api/playlists-api.ts:552](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L552) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** PlaylistsApiGetPlaylistItems - -#### Defined in - -[generated-client/api/playlists-api.ts:566](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L566) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** PlaylistsApiGetPlaylistItems - -#### Defined in - -[generated-client/api/playlists-api.ts:559](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L559) diff --git a/docs/interfaces/generated_client.PlaylistsApiMoveItemRequest.md b/docs/interfaces/generated_client.PlaylistsApiMoveItemRequest.md deleted file mode 100644 index e03368c20..000000000 --- a/docs/interfaces/generated_client.PlaylistsApiMoveItemRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaylistsApiMoveItemRequest - -# Interface: PlaylistsApiMoveItemRequest - -[generated-client](../modules/generated_client.md).PlaylistsApiMoveItemRequest - -Request parameters for moveItem operation in PlaylistsApi. - -**`export`** - -**`interface`** PlaylistsApiMoveItemRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.PlaylistsApiMoveItemRequest.md#itemid) -- [newIndex](generated_client.PlaylistsApiMoveItemRequest.md#newindex) -- [playlistId](generated_client.PlaylistsApiMoveItemRequest.md#playlistid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** PlaylistsApiMoveItem - -#### Defined in - -[generated-client/api/playlists-api.ts:629](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L629) - -___ - -### newIndex - -• `Readonly` **newIndex**: `number` - -The new index. - -**`memberof`** PlaylistsApiMoveItem - -#### Defined in - -[generated-client/api/playlists-api.ts:636](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L636) - -___ - -### playlistId - -• `Readonly` **playlistId**: `string` - -The playlist id. - -**`memberof`** PlaylistsApiMoveItem - -#### Defined in - -[generated-client/api/playlists-api.ts:622](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L622) diff --git a/docs/interfaces/generated_client.PlaylistsApiRemoveFromPlaylistRequest.md b/docs/interfaces/generated_client.PlaylistsApiRemoveFromPlaylistRequest.md deleted file mode 100644 index 6cad71683..000000000 --- a/docs/interfaces/generated_client.PlaylistsApiRemoveFromPlaylistRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaylistsApiRemoveFromPlaylistRequest - -# Interface: PlaylistsApiRemoveFromPlaylistRequest - -[generated-client](../modules/generated_client.md).PlaylistsApiRemoveFromPlaylistRequest - -Request parameters for removeFromPlaylist operation in PlaylistsApi. - -**`export`** - -**`interface`** PlaylistsApiRemoveFromPlaylistRequest - -## Table of contents - -### Properties - -- [entryIds](generated_client.PlaylistsApiRemoveFromPlaylistRequest.md#entryids) -- [playlistId](generated_client.PlaylistsApiRemoveFromPlaylistRequest.md#playlistid) - -## Properties - -### entryIds - -• `Optional` `Readonly` **entryIds**: `string`[] - -The item ids, comma delimited. - -**`memberof`** PlaylistsApiRemoveFromPlaylist - -#### Defined in - -[generated-client/api/playlists-api.ts:657](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L657) - -___ - -### playlistId - -• `Readonly` **playlistId**: `string` - -The playlist id. - -**`memberof`** PlaylistsApiRemoveFromPlaylist - -#### Defined in - -[generated-client/api/playlists-api.ts:650](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L650) diff --git a/docs/interfaces/generated_client.PlaystateApiMarkPlayedItemRequest.md b/docs/interfaces/generated_client.PlaystateApiMarkPlayedItemRequest.md deleted file mode 100644 index 1cd00f384..000000000 --- a/docs/interfaces/generated_client.PlaystateApiMarkPlayedItemRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateApiMarkPlayedItemRequest - -# Interface: PlaystateApiMarkPlayedItemRequest - -[generated-client](../modules/generated_client.md).PlaystateApiMarkPlayedItemRequest - -Request parameters for markPlayedItem operation in PlaystateApi. - -**`export`** - -**`interface`** PlaystateApiMarkPlayedItemRequest - -## Table of contents - -### Properties - -- [datePlayed](generated_client.PlaystateApiMarkPlayedItemRequest.md#dateplayed) -- [itemId](generated_client.PlaystateApiMarkPlayedItemRequest.md#itemid) -- [userId](generated_client.PlaystateApiMarkPlayedItemRequest.md#userid) - -## Properties - -### datePlayed - -• `Optional` `Readonly` **datePlayed**: `string` - -Optional. The date the item was played. - -**`memberof`** PlaystateApiMarkPlayedItem - -#### Defined in - -[generated-client/api/playstate-api.ts:814](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L814) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** PlaystateApiMarkPlayedItem - -#### Defined in - -[generated-client/api/playstate-api.ts:807](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L807) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** PlaystateApiMarkPlayedItem - -#### Defined in - -[generated-client/api/playstate-api.ts:800](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L800) diff --git a/docs/interfaces/generated_client.PlaystateApiMarkUnplayedItemRequest.md b/docs/interfaces/generated_client.PlaystateApiMarkUnplayedItemRequest.md deleted file mode 100644 index 41d62623b..000000000 --- a/docs/interfaces/generated_client.PlaystateApiMarkUnplayedItemRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateApiMarkUnplayedItemRequest - -# Interface: PlaystateApiMarkUnplayedItemRequest - -[generated-client](../modules/generated_client.md).PlaystateApiMarkUnplayedItemRequest - -Request parameters for markUnplayedItem operation in PlaystateApi. - -**`export`** - -**`interface`** PlaystateApiMarkUnplayedItemRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.PlaystateApiMarkUnplayedItemRequest.md#itemid) -- [userId](generated_client.PlaystateApiMarkUnplayedItemRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** PlaystateApiMarkUnplayedItem - -#### Defined in - -[generated-client/api/playstate-api.ts:835](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L835) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** PlaystateApiMarkUnplayedItem - -#### Defined in - -[generated-client/api/playstate-api.ts:828](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L828) diff --git a/docs/interfaces/generated_client.PlaystateApiOnPlaybackProgressRequest.md b/docs/interfaces/generated_client.PlaystateApiOnPlaybackProgressRequest.md deleted file mode 100644 index fd8a85661..000000000 --- a/docs/interfaces/generated_client.PlaystateApiOnPlaybackProgressRequest.md +++ /dev/null @@ -1,211 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateApiOnPlaybackProgressRequest - -# Interface: PlaystateApiOnPlaybackProgressRequest - -[generated-client](../modules/generated_client.md).PlaystateApiOnPlaybackProgressRequest - -Request parameters for onPlaybackProgress operation in PlaystateApi. - -**`export`** - -**`interface`** PlaystateApiOnPlaybackProgressRequest - -## Table of contents - -### Properties - -- [audioStreamIndex](generated_client.PlaystateApiOnPlaybackProgressRequest.md#audiostreamindex) -- [isMuted](generated_client.PlaystateApiOnPlaybackProgressRequest.md#ismuted) -- [isPaused](generated_client.PlaystateApiOnPlaybackProgressRequest.md#ispaused) -- [itemId](generated_client.PlaystateApiOnPlaybackProgressRequest.md#itemid) -- [liveStreamId](generated_client.PlaystateApiOnPlaybackProgressRequest.md#livestreamid) -- [mediaSourceId](generated_client.PlaystateApiOnPlaybackProgressRequest.md#mediasourceid) -- [playMethod](generated_client.PlaystateApiOnPlaybackProgressRequest.md#playmethod) -- [playSessionId](generated_client.PlaystateApiOnPlaybackProgressRequest.md#playsessionid) -- [positionTicks](generated_client.PlaystateApiOnPlaybackProgressRequest.md#positionticks) -- [repeatMode](generated_client.PlaystateApiOnPlaybackProgressRequest.md#repeatmode) -- [subtitleStreamIndex](generated_client.PlaystateApiOnPlaybackProgressRequest.md#subtitlestreamindex) -- [userId](generated_client.PlaystateApiOnPlaybackProgressRequest.md#userid) -- [volumeLevel](generated_client.PlaystateApiOnPlaybackProgressRequest.md#volumelevel) - -## Properties - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -The audio stream index. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:877](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L877) - -___ - -### isMuted - -• `Optional` `Readonly` **isMuted**: `boolean` - -Indicates if the player is muted. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:933](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L933) - -___ - -### isPaused - -• `Optional` `Readonly` **isPaused**: `boolean` - -Indicates if the player is paused. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:926](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L926) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:856](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L856) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:905](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L905) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The id of the MediaSource. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:863](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L863) - -___ - -### playMethod - -• `Optional` `Readonly` **playMethod**: [`PlayMethod`](../enums/generated_client.PlayMethod.md) - -The play method. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:898](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L898) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:912](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L912) - -___ - -### positionTicks - -• `Optional` `Readonly` **positionTicks**: `number` - -Optional. The current position, in ticks. 1 tick = 10000 ms. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:870](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L870) - -___ - -### repeatMode - -• `Optional` `Readonly` **repeatMode**: [`RepeatMode`](../enums/generated_client.RepeatMode.md) - -The repeat mode. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:919](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L919) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -The subtitle stream index. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:884](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L884) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:849](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L849) - -___ - -### volumeLevel - -• `Optional` `Readonly` **volumeLevel**: `number` - -Scale of 0-100. - -**`memberof`** PlaystateApiOnPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:891](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L891) diff --git a/docs/interfaces/generated_client.PlaystateApiOnPlaybackStartRequest.md b/docs/interfaces/generated_client.PlaystateApiOnPlaybackStartRequest.md deleted file mode 100644 index ff6bb9517..000000000 --- a/docs/interfaces/generated_client.PlaystateApiOnPlaybackStartRequest.md +++ /dev/null @@ -1,151 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateApiOnPlaybackStartRequest - -# Interface: PlaystateApiOnPlaybackStartRequest - -[generated-client](../modules/generated_client.md).PlaystateApiOnPlaybackStartRequest - -Request parameters for onPlaybackStart operation in PlaystateApi. - -**`export`** - -**`interface`** PlaystateApiOnPlaybackStartRequest - -## Table of contents - -### Properties - -- [audioStreamIndex](generated_client.PlaystateApiOnPlaybackStartRequest.md#audiostreamindex) -- [canSeek](generated_client.PlaystateApiOnPlaybackStartRequest.md#canseek) -- [itemId](generated_client.PlaystateApiOnPlaybackStartRequest.md#itemid) -- [liveStreamId](generated_client.PlaystateApiOnPlaybackStartRequest.md#livestreamid) -- [mediaSourceId](generated_client.PlaystateApiOnPlaybackStartRequest.md#mediasourceid) -- [playMethod](generated_client.PlaystateApiOnPlaybackStartRequest.md#playmethod) -- [playSessionId](generated_client.PlaystateApiOnPlaybackStartRequest.md#playsessionid) -- [subtitleStreamIndex](generated_client.PlaystateApiOnPlaybackStartRequest.md#subtitlestreamindex) -- [userId](generated_client.PlaystateApiOnPlaybackStartRequest.md#userid) - -## Properties - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -The audio stream index. - -**`memberof`** PlaystateApiOnPlaybackStart - -#### Defined in - -[generated-client/api/playstate-api.ts:968](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L968) - -___ - -### canSeek - -• `Optional` `Readonly` **canSeek**: `boolean` - -Indicates if the client can seek. - -**`memberof`** PlaystateApiOnPlaybackStart - -#### Defined in - -[generated-client/api/playstate-api.ts:1003](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1003) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** PlaystateApiOnPlaybackStart - -#### Defined in - -[generated-client/api/playstate-api.ts:954](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L954) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** PlaystateApiOnPlaybackStart - -#### Defined in - -[generated-client/api/playstate-api.ts:989](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L989) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The id of the MediaSource. - -**`memberof`** PlaystateApiOnPlaybackStart - -#### Defined in - -[generated-client/api/playstate-api.ts:961](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L961) - -___ - -### playMethod - -• `Optional` `Readonly` **playMethod**: [`PlayMethod`](../enums/generated_client.PlayMethod.md) - -The play method. - -**`memberof`** PlaystateApiOnPlaybackStart - -#### Defined in - -[generated-client/api/playstate-api.ts:982](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L982) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** PlaystateApiOnPlaybackStart - -#### Defined in - -[generated-client/api/playstate-api.ts:996](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L996) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -The subtitle stream index. - -**`memberof`** PlaystateApiOnPlaybackStart - -#### Defined in - -[generated-client/api/playstate-api.ts:975](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L975) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** PlaystateApiOnPlaybackStart - -#### Defined in - -[generated-client/api/playstate-api.ts:947](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L947) diff --git a/docs/interfaces/generated_client.PlaystateApiOnPlaybackStoppedRequest.md b/docs/interfaces/generated_client.PlaystateApiOnPlaybackStoppedRequest.md deleted file mode 100644 index 3fa5c4618..000000000 --- a/docs/interfaces/generated_client.PlaystateApiOnPlaybackStoppedRequest.md +++ /dev/null @@ -1,121 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateApiOnPlaybackStoppedRequest - -# Interface: PlaystateApiOnPlaybackStoppedRequest - -[generated-client](../modules/generated_client.md).PlaystateApiOnPlaybackStoppedRequest - -Request parameters for onPlaybackStopped operation in PlaystateApi. - -**`export`** - -**`interface`** PlaystateApiOnPlaybackStoppedRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.PlaystateApiOnPlaybackStoppedRequest.md#itemid) -- [liveStreamId](generated_client.PlaystateApiOnPlaybackStoppedRequest.md#livestreamid) -- [mediaSourceId](generated_client.PlaystateApiOnPlaybackStoppedRequest.md#mediasourceid) -- [nextMediaType](generated_client.PlaystateApiOnPlaybackStoppedRequest.md#nextmediatype) -- [playSessionId](generated_client.PlaystateApiOnPlaybackStoppedRequest.md#playsessionid) -- [positionTicks](generated_client.PlaystateApiOnPlaybackStoppedRequest.md#positionticks) -- [userId](generated_client.PlaystateApiOnPlaybackStoppedRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** PlaystateApiOnPlaybackStopped - -#### Defined in - -[generated-client/api/playstate-api.ts:1024](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1024) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** PlaystateApiOnPlaybackStopped - -#### Defined in - -[generated-client/api/playstate-api.ts:1052](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1052) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The id of the MediaSource. - -**`memberof`** PlaystateApiOnPlaybackStopped - -#### Defined in - -[generated-client/api/playstate-api.ts:1031](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1031) - -___ - -### nextMediaType - -• `Optional` `Readonly` **nextMediaType**: `string` - -The next media type that will play. - -**`memberof`** PlaystateApiOnPlaybackStopped - -#### Defined in - -[generated-client/api/playstate-api.ts:1038](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1038) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** PlaystateApiOnPlaybackStopped - -#### Defined in - -[generated-client/api/playstate-api.ts:1059](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1059) - -___ - -### positionTicks - -• `Optional` `Readonly` **positionTicks**: `number` - -Optional. The position, in ticks, where playback stopped. 1 tick = 10000 ms. - -**`memberof`** PlaystateApiOnPlaybackStopped - -#### Defined in - -[generated-client/api/playstate-api.ts:1045](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1045) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** PlaystateApiOnPlaybackStopped - -#### Defined in - -[generated-client/api/playstate-api.ts:1017](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1017) diff --git a/docs/interfaces/generated_client.PlaystateApiPingPlaybackSessionRequest.md b/docs/interfaces/generated_client.PlaystateApiPingPlaybackSessionRequest.md deleted file mode 100644 index bfc1c63f4..000000000 --- a/docs/interfaces/generated_client.PlaystateApiPingPlaybackSessionRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateApiPingPlaybackSessionRequest - -# Interface: PlaystateApiPingPlaybackSessionRequest - -[generated-client](../modules/generated_client.md).PlaystateApiPingPlaybackSessionRequest - -Request parameters for pingPlaybackSession operation in PlaystateApi. - -**`export`** - -**`interface`** PlaystateApiPingPlaybackSessionRequest - -## Table of contents - -### Properties - -- [playSessionId](generated_client.PlaystateApiPingPlaybackSessionRequest.md#playsessionid) - -## Properties - -### playSessionId - -• `Readonly` **playSessionId**: `string` - -Playback session id. - -**`memberof`** PlaystateApiPingPlaybackSession - -#### Defined in - -[generated-client/api/playstate-api.ts:1073](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1073) diff --git a/docs/interfaces/generated_client.PlaystateApiReportPlaybackProgressRequest.md b/docs/interfaces/generated_client.PlaystateApiReportPlaybackProgressRequest.md deleted file mode 100644 index 06d088d39..000000000 --- a/docs/interfaces/generated_client.PlaystateApiReportPlaybackProgressRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateApiReportPlaybackProgressRequest - -# Interface: PlaystateApiReportPlaybackProgressRequest - -[generated-client](../modules/generated_client.md).PlaystateApiReportPlaybackProgressRequest - -Request parameters for reportPlaybackProgress operation in PlaystateApi. - -**`export`** - -**`interface`** PlaystateApiReportPlaybackProgressRequest - -## Table of contents - -### Properties - -- [playbackProgressInfo](generated_client.PlaystateApiReportPlaybackProgressRequest.md#playbackprogressinfo) - -## Properties - -### playbackProgressInfo - -• `Optional` `Readonly` **playbackProgressInfo**: [`PlaybackProgressInfo`](generated_client.PlaybackProgressInfo.md) - -The playback progress info. - -**`memberof`** PlaystateApiReportPlaybackProgress - -#### Defined in - -[generated-client/api/playstate-api.ts:1087](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1087) diff --git a/docs/interfaces/generated_client.PlaystateApiReportPlaybackStartRequest.md b/docs/interfaces/generated_client.PlaystateApiReportPlaybackStartRequest.md deleted file mode 100644 index 6a6fff2fb..000000000 --- a/docs/interfaces/generated_client.PlaystateApiReportPlaybackStartRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateApiReportPlaybackStartRequest - -# Interface: PlaystateApiReportPlaybackStartRequest - -[generated-client](../modules/generated_client.md).PlaystateApiReportPlaybackStartRequest - -Request parameters for reportPlaybackStart operation in PlaystateApi. - -**`export`** - -**`interface`** PlaystateApiReportPlaybackStartRequest - -## Table of contents - -### Properties - -- [playbackStartInfo](generated_client.PlaystateApiReportPlaybackStartRequest.md#playbackstartinfo) - -## Properties - -### playbackStartInfo - -• `Optional` `Readonly` **playbackStartInfo**: [`PlaybackStartInfo`](generated_client.PlaybackStartInfo.md) - -The playback start info. - -**`memberof`** PlaystateApiReportPlaybackStart - -#### Defined in - -[generated-client/api/playstate-api.ts:1101](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1101) diff --git a/docs/interfaces/generated_client.PlaystateApiReportPlaybackStoppedRequest.md b/docs/interfaces/generated_client.PlaystateApiReportPlaybackStoppedRequest.md deleted file mode 100644 index 6cda87322..000000000 --- a/docs/interfaces/generated_client.PlaystateApiReportPlaybackStoppedRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateApiReportPlaybackStoppedRequest - -# Interface: PlaystateApiReportPlaybackStoppedRequest - -[generated-client](../modules/generated_client.md).PlaystateApiReportPlaybackStoppedRequest - -Request parameters for reportPlaybackStopped operation in PlaystateApi. - -**`export`** - -**`interface`** PlaystateApiReportPlaybackStoppedRequest - -## Table of contents - -### Properties - -- [playbackStopInfo](generated_client.PlaystateApiReportPlaybackStoppedRequest.md#playbackstopinfo) - -## Properties - -### playbackStopInfo - -• `Optional` `Readonly` **playbackStopInfo**: [`PlaybackStopInfo`](generated_client.PlaybackStopInfo.md) - -The playback stop info. - -**`memberof`** PlaystateApiReportPlaybackStopped - -#### Defined in - -[generated-client/api/playstate-api.ts:1115](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1115) diff --git a/docs/interfaces/generated_client.PlaystateRequest.md b/docs/interfaces/generated_client.PlaystateRequest.md deleted file mode 100644 index 0098191c4..000000000 --- a/docs/interfaces/generated_client.PlaystateRequest.md +++ /dev/null @@ -1,55 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateRequest - -# Interface: PlaystateRequest - -[generated-client](../modules/generated_client.md).PlaystateRequest - -**`export`** - -**`interface`** PlaystateRequest - -## Table of contents - -### Properties - -- [Command](generated_client.PlaystateRequest.md#command) -- [ControllingUserId](generated_client.PlaystateRequest.md#controllinguserid) -- [SeekPositionTicks](generated_client.PlaystateRequest.md#seekpositionticks) - -## Properties - -### Command - -• `Optional` **Command**: [`PlaystateCommand`](../enums/generated_client.PlaystateCommand.md) - -**`memberof`** PlaystateRequest - -#### Defined in - -[generated-client/models/playstate-request.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playstate-request.ts#L29) - -___ - -### ControllingUserId - -• `Optional` **ControllingUserId**: ``null`` \| `string` - -Gets or sets the controlling user identifier. - -**`memberof`** PlaystateRequest - -#### Defined in - -[generated-client/models/playstate-request.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playstate-request.ts#L41) - -___ - -### SeekPositionTicks - -• `Optional` **SeekPositionTicks**: ``null`` \| `number` - -**`memberof`** PlaystateRequest - -#### Defined in - -[generated-client/models/playstate-request.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/playstate-request.ts#L35) diff --git a/docs/interfaces/generated_client.PluginInfo.md b/docs/interfaces/generated_client.PluginInfo.md deleted file mode 100644 index 954563cc8..000000000 --- a/docs/interfaces/generated_client.PluginInfo.md +++ /dev/null @@ -1,134 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PluginInfo - -# Interface: PluginInfo - -[generated-client](../modules/generated_client.md).PluginInfo - -This is a serializable stub class that is used by the api to provide information about installed plugins. - -**`export`** - -**`interface`** PluginInfo - -## Table of contents - -### Properties - -- [CanUninstall](generated_client.PluginInfo.md#canuninstall) -- [ConfigurationFileName](generated_client.PluginInfo.md#configurationfilename) -- [Description](generated_client.PluginInfo.md#description) -- [HasImage](generated_client.PluginInfo.md#hasimage) -- [Id](generated_client.PluginInfo.md#id) -- [Name](generated_client.PluginInfo.md#name) -- [Status](generated_client.PluginInfo.md#status) -- [Version](generated_client.PluginInfo.md#version) - -## Properties - -### CanUninstall - -• `Optional` **CanUninstall**: `boolean` - -Gets or sets a value indicating whether the plugin can be uninstalled. - -**`memberof`** PluginInfo - -#### Defined in - -[generated-client/models/plugin-info.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-info.ts#L59) - -___ - -### ConfigurationFileName - -• `Optional` **ConfigurationFileName**: ``null`` \| `string` - -Gets or sets the name of the configuration file. - -**`memberof`** PluginInfo - -#### Defined in - -[generated-client/models/plugin-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-info.ts#L41) - -___ - -### Description - -• `Optional` **Description**: `string` - -Gets or sets the description. - -**`memberof`** PluginInfo - -#### Defined in - -[generated-client/models/plugin-info.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-info.ts#L47) - -___ - -### HasImage - -• `Optional` **HasImage**: `boolean` - -Gets or sets a value indicating whether this plugin has a valid image. - -**`memberof`** PluginInfo - -#### Defined in - -[generated-client/models/plugin-info.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-info.ts#L65) - -___ - -### Id - -• `Optional` **Id**: `string` - -Gets or sets the unique id. - -**`memberof`** PluginInfo - -#### Defined in - -[generated-client/models/plugin-info.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-info.ts#L53) - -___ - -### Name - -• `Optional` **Name**: `string` - -Gets or sets the name. - -**`memberof`** PluginInfo - -#### Defined in - -[generated-client/models/plugin-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-info.ts#L29) - -___ - -### Status - -• `Optional` **Status**: [`PluginStatus`](../enums/generated_client.PluginStatus.md) - -**`memberof`** PluginInfo - -#### Defined in - -[generated-client/models/plugin-info.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-info.ts#L71) - -___ - -### Version - -• `Optional` **Version**: `string` - -Gets or sets the version. - -**`memberof`** PluginInfo - -#### Defined in - -[generated-client/models/plugin-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/plugin-info.ts#L35) diff --git a/docs/interfaces/generated_client.PluginsApiDisablePluginRequest.md b/docs/interfaces/generated_client.PluginsApiDisablePluginRequest.md deleted file mode 100644 index 1c4b7785f..000000000 --- a/docs/interfaces/generated_client.PluginsApiDisablePluginRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PluginsApiDisablePluginRequest - -# Interface: PluginsApiDisablePluginRequest - -[generated-client](../modules/generated_client.md).PluginsApiDisablePluginRequest - -Request parameters for disablePlugin operation in PluginsApi. - -**`export`** - -**`interface`** PluginsApiDisablePluginRequest - -## Table of contents - -### Properties - -- [pluginId](generated_client.PluginsApiDisablePluginRequest.md#pluginid) -- [version](generated_client.PluginsApiDisablePluginRequest.md#version) - -## Properties - -### pluginId - -• `Readonly` **pluginId**: `string` - -Plugin id. - -**`memberof`** PluginsApiDisablePlugin - -#### Defined in - -[generated-client/api/plugins-api.ts:610](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L610) - -___ - -### version - -• `Readonly` **version**: `string` - -Plugin version. - -**`memberof`** PluginsApiDisablePlugin - -#### Defined in - -[generated-client/api/plugins-api.ts:617](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L617) diff --git a/docs/interfaces/generated_client.PluginsApiEnablePluginRequest.md b/docs/interfaces/generated_client.PluginsApiEnablePluginRequest.md deleted file mode 100644 index 889cdb940..000000000 --- a/docs/interfaces/generated_client.PluginsApiEnablePluginRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PluginsApiEnablePluginRequest - -# Interface: PluginsApiEnablePluginRequest - -[generated-client](../modules/generated_client.md).PluginsApiEnablePluginRequest - -Request parameters for enablePlugin operation in PluginsApi. - -**`export`** - -**`interface`** PluginsApiEnablePluginRequest - -## Table of contents - -### Properties - -- [pluginId](generated_client.PluginsApiEnablePluginRequest.md#pluginid) -- [version](generated_client.PluginsApiEnablePluginRequest.md#version) - -## Properties - -### pluginId - -• `Readonly` **pluginId**: `string` - -Plugin id. - -**`memberof`** PluginsApiEnablePlugin - -#### Defined in - -[generated-client/api/plugins-api.ts:631](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L631) - -___ - -### version - -• `Readonly` **version**: `string` - -Plugin version. - -**`memberof`** PluginsApiEnablePlugin - -#### Defined in - -[generated-client/api/plugins-api.ts:638](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L638) diff --git a/docs/interfaces/generated_client.PluginsApiGetPluginConfigurationRequest.md b/docs/interfaces/generated_client.PluginsApiGetPluginConfigurationRequest.md deleted file mode 100644 index f1777b0eb..000000000 --- a/docs/interfaces/generated_client.PluginsApiGetPluginConfigurationRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PluginsApiGetPluginConfigurationRequest - -# Interface: PluginsApiGetPluginConfigurationRequest - -[generated-client](../modules/generated_client.md).PluginsApiGetPluginConfigurationRequest - -Request parameters for getPluginConfiguration operation in PluginsApi. - -**`export`** - -**`interface`** PluginsApiGetPluginConfigurationRequest - -## Table of contents - -### Properties - -- [pluginId](generated_client.PluginsApiGetPluginConfigurationRequest.md#pluginid) - -## Properties - -### pluginId - -• `Readonly` **pluginId**: `string` - -Plugin id. - -**`memberof`** PluginsApiGetPluginConfiguration - -#### Defined in - -[generated-client/api/plugins-api.ts:652](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L652) diff --git a/docs/interfaces/generated_client.PluginsApiGetPluginImageRequest.md b/docs/interfaces/generated_client.PluginsApiGetPluginImageRequest.md deleted file mode 100644 index b3a6541d0..000000000 --- a/docs/interfaces/generated_client.PluginsApiGetPluginImageRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PluginsApiGetPluginImageRequest - -# Interface: PluginsApiGetPluginImageRequest - -[generated-client](../modules/generated_client.md).PluginsApiGetPluginImageRequest - -Request parameters for getPluginImage operation in PluginsApi. - -**`export`** - -**`interface`** PluginsApiGetPluginImageRequest - -## Table of contents - -### Properties - -- [pluginId](generated_client.PluginsApiGetPluginImageRequest.md#pluginid) -- [version](generated_client.PluginsApiGetPluginImageRequest.md#version) - -## Properties - -### pluginId - -• `Readonly` **pluginId**: `string` - -Plugin id. - -**`memberof`** PluginsApiGetPluginImage - -#### Defined in - -[generated-client/api/plugins-api.ts:666](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L666) - -___ - -### version - -• `Readonly` **version**: `string` - -Plugin version. - -**`memberof`** PluginsApiGetPluginImage - -#### Defined in - -[generated-client/api/plugins-api.ts:673](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L673) diff --git a/docs/interfaces/generated_client.PluginsApiGetPluginManifestRequest.md b/docs/interfaces/generated_client.PluginsApiGetPluginManifestRequest.md deleted file mode 100644 index d2d5edeea..000000000 --- a/docs/interfaces/generated_client.PluginsApiGetPluginManifestRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PluginsApiGetPluginManifestRequest - -# Interface: PluginsApiGetPluginManifestRequest - -[generated-client](../modules/generated_client.md).PluginsApiGetPluginManifestRequest - -Request parameters for getPluginManifest operation in PluginsApi. - -**`export`** - -**`interface`** PluginsApiGetPluginManifestRequest - -## Table of contents - -### Properties - -- [pluginId](generated_client.PluginsApiGetPluginManifestRequest.md#pluginid) - -## Properties - -### pluginId - -• `Readonly` **pluginId**: `string` - -Plugin id. - -**`memberof`** PluginsApiGetPluginManifest - -#### Defined in - -[generated-client/api/plugins-api.ts:687](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L687) diff --git a/docs/interfaces/generated_client.PluginsApiUninstallPluginByVersionRequest.md b/docs/interfaces/generated_client.PluginsApiUninstallPluginByVersionRequest.md deleted file mode 100644 index 2b51facf5..000000000 --- a/docs/interfaces/generated_client.PluginsApiUninstallPluginByVersionRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PluginsApiUninstallPluginByVersionRequest - -# Interface: PluginsApiUninstallPluginByVersionRequest - -[generated-client](../modules/generated_client.md).PluginsApiUninstallPluginByVersionRequest - -Request parameters for uninstallPluginByVersion operation in PluginsApi. - -**`export`** - -**`interface`** PluginsApiUninstallPluginByVersionRequest - -## Table of contents - -### Properties - -- [pluginId](generated_client.PluginsApiUninstallPluginByVersionRequest.md#pluginid) -- [version](generated_client.PluginsApiUninstallPluginByVersionRequest.md#version) - -## Properties - -### pluginId - -• `Readonly` **pluginId**: `string` - -Plugin id. - -**`memberof`** PluginsApiUninstallPluginByVersion - -#### Defined in - -[generated-client/api/plugins-api.ts:715](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L715) - -___ - -### version - -• `Readonly` **version**: `string` - -Plugin version. - -**`memberof`** PluginsApiUninstallPluginByVersion - -#### Defined in - -[generated-client/api/plugins-api.ts:722](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L722) diff --git a/docs/interfaces/generated_client.PluginsApiUninstallPluginRequest.md b/docs/interfaces/generated_client.PluginsApiUninstallPluginRequest.md deleted file mode 100644 index 0d55d682d..000000000 --- a/docs/interfaces/generated_client.PluginsApiUninstallPluginRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PluginsApiUninstallPluginRequest - -# Interface: PluginsApiUninstallPluginRequest - -[generated-client](../modules/generated_client.md).PluginsApiUninstallPluginRequest - -Request parameters for uninstallPlugin operation in PluginsApi. - -**`export`** - -**`interface`** PluginsApiUninstallPluginRequest - -## Table of contents - -### Properties - -- [pluginId](generated_client.PluginsApiUninstallPluginRequest.md#pluginid) - -## Properties - -### pluginId - -• `Readonly` **pluginId**: `string` - -Plugin id. - -**`memberof`** PluginsApiUninstallPlugin - -#### Defined in - -[generated-client/api/plugins-api.ts:701](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L701) diff --git a/docs/interfaces/generated_client.PluginsApiUpdatePluginConfigurationRequest.md b/docs/interfaces/generated_client.PluginsApiUpdatePluginConfigurationRequest.md deleted file mode 100644 index 0cd4868de..000000000 --- a/docs/interfaces/generated_client.PluginsApiUpdatePluginConfigurationRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PluginsApiUpdatePluginConfigurationRequest - -# Interface: PluginsApiUpdatePluginConfigurationRequest - -[generated-client](../modules/generated_client.md).PluginsApiUpdatePluginConfigurationRequest - -Request parameters for updatePluginConfiguration operation in PluginsApi. - -**`export`** - -**`interface`** PluginsApiUpdatePluginConfigurationRequest - -## Table of contents - -### Properties - -- [pluginId](generated_client.PluginsApiUpdatePluginConfigurationRequest.md#pluginid) - -## Properties - -### pluginId - -• `Readonly` **pluginId**: `string` - -Plugin id. - -**`memberof`** PluginsApiUpdatePluginConfiguration - -#### Defined in - -[generated-client/api/plugins-api.ts:736](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L736) diff --git a/docs/interfaces/generated_client.PreviousItemRequestDto.md b/docs/interfaces/generated_client.PreviousItemRequestDto.md deleted file mode 100644 index ec05ed026..000000000 --- a/docs/interfaces/generated_client.PreviousItemRequestDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PreviousItemRequestDto - -# Interface: PreviousItemRequestDto - -[generated-client](../modules/generated_client.md).PreviousItemRequestDto - -Class PreviousItemRequestDto. - -**`export`** - -**`interface`** PreviousItemRequestDto - -## Table of contents - -### Properties - -- [PlaylistItemId](generated_client.PreviousItemRequestDto.md#playlistitemid) - -## Properties - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: `string` - -Gets or sets the playing item identifier. - -**`memberof`** PreviousItemRequestDto - -#### Defined in - -[generated-client/models/previous-item-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/previous-item-request-dto.ts#L28) diff --git a/docs/interfaces/generated_client.ProblemDetails.md b/docs/interfaces/generated_client.ProblemDetails.md deleted file mode 100644 index 0de6b3724..000000000 --- a/docs/interfaces/generated_client.ProblemDetails.md +++ /dev/null @@ -1,83 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ProblemDetails - -# Interface: ProblemDetails - -[generated-client](../modules/generated_client.md).ProblemDetails - -**`export`** - -**`interface`** ProblemDetails - -## Indexable - -▪ [key: `string`]: `any` \| `any` - -## Table of contents - -### Properties - -- [detail](generated_client.ProblemDetails.md#detail) -- [instance](generated_client.ProblemDetails.md#instance) -- [status](generated_client.ProblemDetails.md#status) -- [title](generated_client.ProblemDetails.md#title) -- [type](generated_client.ProblemDetails.md#type) - -## Properties - -### detail - -• `Optional` **detail**: ``null`` \| `string` - -**`memberof`** ProblemDetails - -#### Defined in - -[generated-client/models/problem-details.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/problem-details.ts#L48) - -___ - -### instance - -• `Optional` **instance**: ``null`` \| `string` - -**`memberof`** ProblemDetails - -#### Defined in - -[generated-client/models/problem-details.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/problem-details.ts#L54) - -___ - -### status - -• `Optional` **status**: ``null`` \| `number` - -**`memberof`** ProblemDetails - -#### Defined in - -[generated-client/models/problem-details.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/problem-details.ts#L42) - -___ - -### title - -• `Optional` **title**: ``null`` \| `string` - -**`memberof`** ProblemDetails - -#### Defined in - -[generated-client/models/problem-details.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/problem-details.ts#L36) - -___ - -### type - -• `Optional` **type**: ``null`` \| `string` - -**`memberof`** ProblemDetails - -#### Defined in - -[generated-client/models/problem-details.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/problem-details.ts#L30) diff --git a/docs/interfaces/generated_client.ProfileCondition.md b/docs/interfaces/generated_client.ProfileCondition.md deleted file mode 100644 index 3aef3e468..000000000 --- a/docs/interfaces/generated_client.ProfileCondition.md +++ /dev/null @@ -1,66 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ProfileCondition - -# Interface: ProfileCondition - -[generated-client](../modules/generated_client.md).ProfileCondition - -**`export`** - -**`interface`** ProfileCondition - -## Table of contents - -### Properties - -- [Condition](generated_client.ProfileCondition.md#condition) -- [IsRequired](generated_client.ProfileCondition.md#isrequired) -- [Property](generated_client.ProfileCondition.md#property) -- [Value](generated_client.ProfileCondition.md#value) - -## Properties - -### Condition - -• `Optional` **Condition**: [`ProfileConditionType`](../enums/generated_client.ProfileConditionType.md) - -**`memberof`** ProfileCondition - -#### Defined in - -[generated-client/models/profile-condition.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition.ts#L30) - -___ - -### IsRequired - -• `Optional` **IsRequired**: `boolean` - -**`memberof`** ProfileCondition - -#### Defined in - -[generated-client/models/profile-condition.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition.ts#L48) - -___ - -### Property - -• `Optional` **Property**: [`ProfileConditionValue`](../enums/generated_client.ProfileConditionValue.md) - -**`memberof`** ProfileCondition - -#### Defined in - -[generated-client/models/profile-condition.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition.ts#L36) - -___ - -### Value - -• `Optional` **Value**: ``null`` \| `string` - -**`memberof`** ProfileCondition - -#### Defined in - -[generated-client/models/profile-condition.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/profile-condition.ts#L42) diff --git a/docs/interfaces/generated_client.PublicSystemInfo.md b/docs/interfaces/generated_client.PublicSystemInfo.md deleted file mode 100644 index 277d5c431..000000000 --- a/docs/interfaces/generated_client.PublicSystemInfo.md +++ /dev/null @@ -1,119 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PublicSystemInfo - -# Interface: PublicSystemInfo - -[generated-client](../modules/generated_client.md).PublicSystemInfo - -**`export`** - -**`interface`** PublicSystemInfo - -## Table of contents - -### Properties - -- [Id](generated_client.PublicSystemInfo.md#id) -- [LocalAddress](generated_client.PublicSystemInfo.md#localaddress) -- [OperatingSystem](generated_client.PublicSystemInfo.md#operatingsystem) -- [ProductName](generated_client.PublicSystemInfo.md#productname) -- [ServerName](generated_client.PublicSystemInfo.md#servername) -- [StartupWizardCompleted](generated_client.PublicSystemInfo.md#startupwizardcompleted) -- [Version](generated_client.PublicSystemInfo.md#version) - -## Properties - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets the id. - -**`memberof`** PublicSystemInfo - -#### Defined in - -[generated-client/models/public-system-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/public-system-info.ts#L58) - -___ - -### LocalAddress - -• `Optional` **LocalAddress**: ``null`` \| `string` - -Gets or sets the local address. - -**`memberof`** PublicSystemInfo - -#### Defined in - -[generated-client/models/public-system-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/public-system-info.ts#L28) - -___ - -### OperatingSystem - -• `Optional` **OperatingSystem**: ``null`` \| `string` - -Gets or sets the operating system. - -**`memberof`** PublicSystemInfo - -#### Defined in - -[generated-client/models/public-system-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/public-system-info.ts#L52) - -___ - -### ProductName - -• `Optional` **ProductName**: ``null`` \| `string` - -Gets or sets the product name. This is the AssemblyProduct name. - -**`memberof`** PublicSystemInfo - -#### Defined in - -[generated-client/models/public-system-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/public-system-info.ts#L46) - -___ - -### ServerName - -• `Optional` **ServerName**: ``null`` \| `string` - -Gets or sets the name of the server. - -**`memberof`** PublicSystemInfo - -#### Defined in - -[generated-client/models/public-system-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/public-system-info.ts#L34) - -___ - -### StartupWizardCompleted - -• `Optional` **StartupWizardCompleted**: ``null`` \| `boolean` - -Gets or sets a value indicating whether the startup wizard is completed. - -**`memberof`** PublicSystemInfo - -#### Defined in - -[generated-client/models/public-system-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/public-system-info.ts#L64) - -___ - -### Version - -• `Optional` **Version**: ``null`` \| `string` - -Gets or sets the server version. - -**`memberof`** PublicSystemInfo - -#### Defined in - -[generated-client/models/public-system-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/public-system-info.ts#L40) diff --git a/docs/interfaces/generated_client.QueryFilters.md b/docs/interfaces/generated_client.QueryFilters.md deleted file mode 100644 index bcfd36b7c..000000000 --- a/docs/interfaces/generated_client.QueryFilters.md +++ /dev/null @@ -1,40 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / QueryFilters - -# Interface: QueryFilters - -[generated-client](../modules/generated_client.md).QueryFilters - -**`export`** - -**`interface`** QueryFilters - -## Table of contents - -### Properties - -- [Genres](generated_client.QueryFilters.md#genres) -- [Tags](generated_client.QueryFilters.md#tags) - -## Properties - -### Genres - -• `Optional` **Genres**: ``null`` \| [`NameGuidPair`](generated_client.NameGuidPair.md)[] - -**`memberof`** QueryFilters - -#### Defined in - -[generated-client/models/query-filters.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/query-filters.ts#L29) - -___ - -### Tags - -• `Optional` **Tags**: ``null`` \| `string`[] - -**`memberof`** QueryFilters - -#### Defined in - -[generated-client/models/query-filters.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/query-filters.ts#L35) diff --git a/docs/interfaces/generated_client.QueryFiltersLegacy.md b/docs/interfaces/generated_client.QueryFiltersLegacy.md deleted file mode 100644 index 1b0372172..000000000 --- a/docs/interfaces/generated_client.QueryFiltersLegacy.md +++ /dev/null @@ -1,66 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / QueryFiltersLegacy - -# Interface: QueryFiltersLegacy - -[generated-client](../modules/generated_client.md).QueryFiltersLegacy - -**`export`** - -**`interface`** QueryFiltersLegacy - -## Table of contents - -### Properties - -- [Genres](generated_client.QueryFiltersLegacy.md#genres) -- [OfficialRatings](generated_client.QueryFiltersLegacy.md#officialratings) -- [Tags](generated_client.QueryFiltersLegacy.md#tags) -- [Years](generated_client.QueryFiltersLegacy.md#years) - -## Properties - -### Genres - -• `Optional` **Genres**: ``null`` \| `string`[] - -**`memberof`** QueryFiltersLegacy - -#### Defined in - -[generated-client/models/query-filters-legacy.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/query-filters-legacy.ts#L28) - -___ - -### OfficialRatings - -• `Optional` **OfficialRatings**: ``null`` \| `string`[] - -**`memberof`** QueryFiltersLegacy - -#### Defined in - -[generated-client/models/query-filters-legacy.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/query-filters-legacy.ts#L40) - -___ - -### Tags - -• `Optional` **Tags**: ``null`` \| `string`[] - -**`memberof`** QueryFiltersLegacy - -#### Defined in - -[generated-client/models/query-filters-legacy.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/query-filters-legacy.ts#L34) - -___ - -### Years - -• `Optional` **Years**: ``null`` \| `number`[] - -**`memberof`** QueryFiltersLegacy - -#### Defined in - -[generated-client/models/query-filters-legacy.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/query-filters-legacy.ts#L46) diff --git a/docs/interfaces/generated_client.QueueItem.md b/docs/interfaces/generated_client.QueueItem.md deleted file mode 100644 index 6bb9f1d44..000000000 --- a/docs/interfaces/generated_client.QueueItem.md +++ /dev/null @@ -1,40 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / QueueItem - -# Interface: QueueItem - -[generated-client](../modules/generated_client.md).QueueItem - -**`export`** - -**`interface`** QueueItem - -## Table of contents - -### Properties - -- [Id](generated_client.QueueItem.md#id) -- [PlaylistItemId](generated_client.QueueItem.md#playlistitemid) - -## Properties - -### Id - -• `Optional` **Id**: `string` - -**`memberof`** QueueItem - -#### Defined in - -[generated-client/models/queue-item.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/queue-item.ts#L28) - -___ - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: ``null`` \| `string` - -**`memberof`** QueueItem - -#### Defined in - -[generated-client/models/queue-item.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/queue-item.ts#L34) diff --git a/docs/interfaces/generated_client.QueueRequestDto.md b/docs/interfaces/generated_client.QueueRequestDto.md deleted file mode 100644 index 954bd0ba4..000000000 --- a/docs/interfaces/generated_client.QueueRequestDto.md +++ /dev/null @@ -1,44 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / QueueRequestDto - -# Interface: QueueRequestDto - -[generated-client](../modules/generated_client.md).QueueRequestDto - -Class QueueRequestDto. - -**`export`** - -**`interface`** QueueRequestDto - -## Table of contents - -### Properties - -- [ItemIds](generated_client.QueueRequestDto.md#itemids) -- [Mode](generated_client.QueueRequestDto.md#mode) - -## Properties - -### ItemIds - -• `Optional` **ItemIds**: `string`[] - -Gets or sets the items to enqueue. - -**`memberof`** QueueRequestDto - -#### Defined in - -[generated-client/models/queue-request-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/queue-request-dto.ts#L29) - -___ - -### Mode - -• `Optional` **Mode**: [`GroupQueueMode`](../enums/generated_client.GroupQueueMode.md) - -**`memberof`** QueueRequestDto - -#### Defined in - -[generated-client/models/queue-request-dto.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/queue-request-dto.ts#L35) diff --git a/docs/interfaces/generated_client.QuickConnectApiAuthorizeRequest.md b/docs/interfaces/generated_client.QuickConnectApiAuthorizeRequest.md deleted file mode 100644 index ae4ba6d0f..000000000 --- a/docs/interfaces/generated_client.QuickConnectApiAuthorizeRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / QuickConnectApiAuthorizeRequest - -# Interface: QuickConnectApiAuthorizeRequest - -[generated-client](../modules/generated_client.md).QuickConnectApiAuthorizeRequest - -Request parameters for authorize operation in QuickConnectApi. - -**`export`** - -**`interface`** QuickConnectApiAuthorizeRequest - -## Table of contents - -### Properties - -- [code](generated_client.QuickConnectApiAuthorizeRequest.md#code) - -## Properties - -### code - -• `Readonly` **code**: `string` - -Quick connect code to authorize. - -**`memberof`** QuickConnectApiAuthorize - -#### Defined in - -[generated-client/api/quick-connect-api.ts:284](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L284) diff --git a/docs/interfaces/generated_client.QuickConnectApiConnectRequest.md b/docs/interfaces/generated_client.QuickConnectApiConnectRequest.md deleted file mode 100644 index eae041021..000000000 --- a/docs/interfaces/generated_client.QuickConnectApiConnectRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / QuickConnectApiConnectRequest - -# Interface: QuickConnectApiConnectRequest - -[generated-client](../modules/generated_client.md).QuickConnectApiConnectRequest - -Request parameters for connect operation in QuickConnectApi. - -**`export`** - -**`interface`** QuickConnectApiConnectRequest - -## Table of contents - -### Properties - -- [secret](generated_client.QuickConnectApiConnectRequest.md#secret) - -## Properties - -### secret - -• `Readonly` **secret**: `string` - -Secret previously returned from the Initiate endpoint. - -**`memberof`** QuickConnectApiConnect - -#### Defined in - -[generated-client/api/quick-connect-api.ts:298](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L298) diff --git a/docs/interfaces/generated_client.QuickConnectDto.md b/docs/interfaces/generated_client.QuickConnectDto.md deleted file mode 100644 index 82426b87a..000000000 --- a/docs/interfaces/generated_client.QuickConnectDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / QuickConnectDto - -# Interface: QuickConnectDto - -[generated-client](../modules/generated_client.md).QuickConnectDto - -The quick connect request body. - -**`export`** - -**`interface`** QuickConnectDto - -## Table of contents - -### Properties - -- [Secret](generated_client.QuickConnectDto.md#secret) - -## Properties - -### Secret - -• **Secret**: `string` - -Gets or sets the quick connect secret. - -**`memberof`** QuickConnectDto - -#### Defined in - -[generated-client/models/quick-connect-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/quick-connect-dto.ts#L28) diff --git a/docs/interfaces/generated_client.QuickConnectResult.md b/docs/interfaces/generated_client.QuickConnectResult.md deleted file mode 100644 index e48117242..000000000 --- a/docs/interfaces/generated_client.QuickConnectResult.md +++ /dev/null @@ -1,136 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / QuickConnectResult - -# Interface: QuickConnectResult - -[generated-client](../modules/generated_client.md).QuickConnectResult - -Stores the state of an quick connect request. - -**`export`** - -**`interface`** QuickConnectResult - -## Table of contents - -### Properties - -- [AppName](generated_client.QuickConnectResult.md#appname) -- [AppVersion](generated_client.QuickConnectResult.md#appversion) -- [Authenticated](generated_client.QuickConnectResult.md#authenticated) -- [Code](generated_client.QuickConnectResult.md#code) -- [DateAdded](generated_client.QuickConnectResult.md#dateadded) -- [DeviceId](generated_client.QuickConnectResult.md#deviceid) -- [DeviceName](generated_client.QuickConnectResult.md#devicename) -- [Secret](generated_client.QuickConnectResult.md#secret) - -## Properties - -### AppName - -• `Optional` **AppName**: `string` - -Gets the requesting app name. - -**`memberof`** QuickConnectResult - -#### Defined in - -[generated-client/models/quick-connect-result.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/quick-connect-result.ts#L58) - -___ - -### AppVersion - -• `Optional` **AppVersion**: `string` - -Gets the requesting app version. - -**`memberof`** QuickConnectResult - -#### Defined in - -[generated-client/models/quick-connect-result.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/quick-connect-result.ts#L64) - -___ - -### Authenticated - -• `Optional` **Authenticated**: `boolean` - -Gets or sets a value indicating whether this request is authorized. - -**`memberof`** QuickConnectResult - -#### Defined in - -[generated-client/models/quick-connect-result.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/quick-connect-result.ts#L28) - -___ - -### Code - -• `Optional` **Code**: `string` - -Gets the user facing code used so the user can quickly differentiate this request from others. - -**`memberof`** QuickConnectResult - -#### Defined in - -[generated-client/models/quick-connect-result.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/quick-connect-result.ts#L40) - -___ - -### DateAdded - -• `Optional` **DateAdded**: `string` - -Gets or sets the DateTime that this request was created. - -**`memberof`** QuickConnectResult - -#### Defined in - -[generated-client/models/quick-connect-result.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/quick-connect-result.ts#L70) - -___ - -### DeviceId - -• `Optional` **DeviceId**: `string` - -Gets the requesting device id. - -**`memberof`** QuickConnectResult - -#### Defined in - -[generated-client/models/quick-connect-result.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/quick-connect-result.ts#L46) - -___ - -### DeviceName - -• `Optional` **DeviceName**: `string` - -Gets the requesting device name. - -**`memberof`** QuickConnectResult - -#### Defined in - -[generated-client/models/quick-connect-result.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/quick-connect-result.ts#L52) - -___ - -### Secret - -• `Optional` **Secret**: `string` - -Gets the secret value used to uniquely identify this request. Can be used to retrieve authentication information. - -**`memberof`** QuickConnectResult - -#### Defined in - -[generated-client/models/quick-connect-result.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/quick-connect-result.ts#L34) diff --git a/docs/interfaces/generated_client.ReadyRequestDto.md b/docs/interfaces/generated_client.ReadyRequestDto.md deleted file mode 100644 index 4257348fc..000000000 --- a/docs/interfaces/generated_client.ReadyRequestDto.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ReadyRequestDto - -# Interface: ReadyRequestDto - -[generated-client](../modules/generated_client.md).ReadyRequestDto - -Class ReadyRequest. - -**`export`** - -**`interface`** ReadyRequestDto - -## Table of contents - -### Properties - -- [IsPlaying](generated_client.ReadyRequestDto.md#isplaying) -- [PlaylistItemId](generated_client.ReadyRequestDto.md#playlistitemid) -- [PositionTicks](generated_client.ReadyRequestDto.md#positionticks) -- [When](generated_client.ReadyRequestDto.md#when) - -## Properties - -### IsPlaying - -• `Optional` **IsPlaying**: `boolean` - -Gets or sets a value indicating whether the client playback is unpaused. - -**`memberof`** ReadyRequestDto - -#### Defined in - -[generated-client/models/ready-request-dto.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ready-request-dto.ts#L40) - -___ - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: `string` - -Gets or sets the playlist item identifier of the playing item. - -**`memberof`** ReadyRequestDto - -#### Defined in - -[generated-client/models/ready-request-dto.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ready-request-dto.ts#L46) - -___ - -### PositionTicks - -• `Optional` **PositionTicks**: `number` - -Gets or sets the position ticks. - -**`memberof`** ReadyRequestDto - -#### Defined in - -[generated-client/models/ready-request-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ready-request-dto.ts#L34) - -___ - -### When - -• `Optional` **When**: `string` - -Gets or sets when the request has been made by the client. - -**`memberof`** ReadyRequestDto - -#### Defined in - -[generated-client/models/ready-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ready-request-dto.ts#L28) diff --git a/docs/interfaces/generated_client.RecommendationDto.md b/docs/interfaces/generated_client.RecommendationDto.md deleted file mode 100644 index bb592c802..000000000 --- a/docs/interfaces/generated_client.RecommendationDto.md +++ /dev/null @@ -1,66 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RecommendationDto - -# Interface: RecommendationDto - -[generated-client](../modules/generated_client.md).RecommendationDto - -**`export`** - -**`interface`** RecommendationDto - -## Table of contents - -### Properties - -- [BaselineItemName](generated_client.RecommendationDto.md#baselineitemname) -- [CategoryId](generated_client.RecommendationDto.md#categoryid) -- [Items](generated_client.RecommendationDto.md#items) -- [RecommendationType](generated_client.RecommendationDto.md#recommendationtype) - -## Properties - -### BaselineItemName - -• `Optional` **BaselineItemName**: ``null`` \| `string` - -**`memberof`** RecommendationDto - -#### Defined in - -[generated-client/models/recommendation-dto.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recommendation-dto.ts#L42) - -___ - -### CategoryId - -• `Optional` **CategoryId**: `string` - -**`memberof`** RecommendationDto - -#### Defined in - -[generated-client/models/recommendation-dto.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recommendation-dto.ts#L48) - -___ - -### Items - -• `Optional` **Items**: ``null`` \| [`BaseItemDto`](generated_client.BaseItemDto.md)[] - -**`memberof`** RecommendationDto - -#### Defined in - -[generated-client/models/recommendation-dto.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recommendation-dto.ts#L30) - -___ - -### RecommendationType - -• `Optional` **RecommendationType**: [`RecommendationType`](../enums/generated_client.RecommendationType.md) - -**`memberof`** RecommendationDto - -#### Defined in - -[generated-client/models/recommendation-dto.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/recommendation-dto.ts#L36) diff --git a/docs/interfaces/generated_client.RemoteImageApiDownloadRemoteImageRequest.md b/docs/interfaces/generated_client.RemoteImageApiDownloadRemoteImageRequest.md deleted file mode 100644 index 683b9c985..000000000 --- a/docs/interfaces/generated_client.RemoteImageApiDownloadRemoteImageRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RemoteImageApiDownloadRemoteImageRequest - -# Interface: RemoteImageApiDownloadRemoteImageRequest - -[generated-client](../modules/generated_client.md).RemoteImageApiDownloadRemoteImageRequest - -Request parameters for downloadRemoteImage operation in RemoteImageApi. - -**`export`** - -**`interface`** RemoteImageApiDownloadRemoteImageRequest - -## Table of contents - -### Properties - -- [imageUrl](generated_client.RemoteImageApiDownloadRemoteImageRequest.md#imageurl) -- [itemId](generated_client.RemoteImageApiDownloadRemoteImageRequest.md#itemid) -- [type](generated_client.RemoteImageApiDownloadRemoteImageRequest.md#type) - -## Properties - -### imageUrl - -• `Optional` `Readonly` **imageUrl**: `string` - -The image url. - -**`memberof`** RemoteImageApiDownloadRemoteImage - -#### Defined in - -[generated-client/api/remote-image-api.ts:310](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L310) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item Id. - -**`memberof`** RemoteImageApiDownloadRemoteImage - -#### Defined in - -[generated-client/api/remote-image-api.ts:296](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L296) - -___ - -### type - -• `Readonly` **type**: [`ImageType`](../enums/generated_client.ImageType.md) - -The image type. - -**`memberof`** RemoteImageApiDownloadRemoteImage - -#### Defined in - -[generated-client/api/remote-image-api.ts:303](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L303) diff --git a/docs/interfaces/generated_client.RemoteImageApiGetRemoteImageProvidersRequest.md b/docs/interfaces/generated_client.RemoteImageApiGetRemoteImageProvidersRequest.md deleted file mode 100644 index 1a8babd7b..000000000 --- a/docs/interfaces/generated_client.RemoteImageApiGetRemoteImageProvidersRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RemoteImageApiGetRemoteImageProvidersRequest - -# Interface: RemoteImageApiGetRemoteImageProvidersRequest - -[generated-client](../modules/generated_client.md).RemoteImageApiGetRemoteImageProvidersRequest - -Request parameters for getRemoteImageProviders operation in RemoteImageApi. - -**`export`** - -**`interface`** RemoteImageApiGetRemoteImageProvidersRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.RemoteImageApiGetRemoteImageProvidersRequest.md#itemid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item Id. - -**`memberof`** RemoteImageApiGetRemoteImageProviders - -#### Defined in - -[generated-client/api/remote-image-api.ts:324](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L324) diff --git a/docs/interfaces/generated_client.RemoteImageApiGetRemoteImagesRequest.md b/docs/interfaces/generated_client.RemoteImageApiGetRemoteImagesRequest.md deleted file mode 100644 index 7dc389d68..000000000 --- a/docs/interfaces/generated_client.RemoteImageApiGetRemoteImagesRequest.md +++ /dev/null @@ -1,106 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RemoteImageApiGetRemoteImagesRequest - -# Interface: RemoteImageApiGetRemoteImagesRequest - -[generated-client](../modules/generated_client.md).RemoteImageApiGetRemoteImagesRequest - -Request parameters for getRemoteImages operation in RemoteImageApi. - -**`export`** - -**`interface`** RemoteImageApiGetRemoteImagesRequest - -## Table of contents - -### Properties - -- [includeAllLanguages](generated_client.RemoteImageApiGetRemoteImagesRequest.md#includealllanguages) -- [itemId](generated_client.RemoteImageApiGetRemoteImagesRequest.md#itemid) -- [limit](generated_client.RemoteImageApiGetRemoteImagesRequest.md#limit) -- [providerName](generated_client.RemoteImageApiGetRemoteImagesRequest.md#providername) -- [startIndex](generated_client.RemoteImageApiGetRemoteImagesRequest.md#startindex) -- [type](generated_client.RemoteImageApiGetRemoteImagesRequest.md#type) - -## Properties - -### includeAllLanguages - -• `Optional` `Readonly` **includeAllLanguages**: `boolean` - -Optional. Include all languages. - -**`memberof`** RemoteImageApiGetRemoteImages - -#### Defined in - -[generated-client/api/remote-image-api.ts:373](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L373) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -Item Id. - -**`memberof`** RemoteImageApiGetRemoteImages - -#### Defined in - -[generated-client/api/remote-image-api.ts:338](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L338) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** RemoteImageApiGetRemoteImages - -#### Defined in - -[generated-client/api/remote-image-api.ts:359](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L359) - -___ - -### providerName - -• `Optional` `Readonly` **providerName**: `string` - -Optional. The image provider to use. - -**`memberof`** RemoteImageApiGetRemoteImages - -#### Defined in - -[generated-client/api/remote-image-api.ts:366](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L366) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** RemoteImageApiGetRemoteImages - -#### Defined in - -[generated-client/api/remote-image-api.ts:352](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L352) - -___ - -### type - -• `Optional` `Readonly` **type**: [`ImageType`](../enums/generated_client.ImageType.md) - -The image type. - -**`memberof`** RemoteImageApiGetRemoteImages - -#### Defined in - -[generated-client/api/remote-image-api.ts:345](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L345) diff --git a/docs/interfaces/generated_client.RemoteImageInfo.md b/docs/interfaces/generated_client.RemoteImageInfo.md deleted file mode 100644 index 200a1c2da..000000000 --- a/docs/interfaces/generated_client.RemoteImageInfo.md +++ /dev/null @@ -1,162 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RemoteImageInfo - -# Interface: RemoteImageInfo - -[generated-client](../modules/generated_client.md).RemoteImageInfo - -Class RemoteImageInfo. - -**`export`** - -**`interface`** RemoteImageInfo - -## Table of contents - -### Properties - -- [CommunityRating](generated_client.RemoteImageInfo.md#communityrating) -- [Height](generated_client.RemoteImageInfo.md#height) -- [Language](generated_client.RemoteImageInfo.md#language) -- [ProviderName](generated_client.RemoteImageInfo.md#providername) -- [RatingType](generated_client.RemoteImageInfo.md#ratingtype) -- [ThumbnailUrl](generated_client.RemoteImageInfo.md#thumbnailurl) -- [Type](generated_client.RemoteImageInfo.md#type) -- [Url](generated_client.RemoteImageInfo.md#url) -- [VoteCount](generated_client.RemoteImageInfo.md#votecount) -- [Width](generated_client.RemoteImageInfo.md#width) - -## Properties - -### CommunityRating - -• `Optional` **CommunityRating**: ``null`` \| `number` - -Gets or sets the community rating. - -**`memberof`** RemoteImageInfo - -#### Defined in - -[generated-client/models/remote-image-info.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-info.ts#L60) - -___ - -### Height - -• `Optional` **Height**: ``null`` \| `number` - -Gets or sets the height. - -**`memberof`** RemoteImageInfo - -#### Defined in - -[generated-client/models/remote-image-info.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-info.ts#L48) - -___ - -### Language - -• `Optional` **Language**: ``null`` \| `string` - -Gets or sets the language. - -**`memberof`** RemoteImageInfo - -#### Defined in - -[generated-client/models/remote-image-info.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-info.ts#L72) - -___ - -### ProviderName - -• `Optional` **ProviderName**: ``null`` \| `string` - -Gets or sets the name of the provider. - -**`memberof`** RemoteImageInfo - -#### Defined in - -[generated-client/models/remote-image-info.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-info.ts#L30) - -___ - -### RatingType - -• `Optional` **RatingType**: [`RatingType`](../enums/generated_client.RatingType.md) - -**`memberof`** RemoteImageInfo - -#### Defined in - -[generated-client/models/remote-image-info.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-info.ts#L84) - -___ - -### ThumbnailUrl - -• `Optional` **ThumbnailUrl**: ``null`` \| `string` - -Gets or sets a url used for previewing a smaller version. - -**`memberof`** RemoteImageInfo - -#### Defined in - -[generated-client/models/remote-image-info.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-info.ts#L42) - -___ - -### Type - -• `Optional` **Type**: [`ImageType`](../enums/generated_client.ImageType.md) - -**`memberof`** RemoteImageInfo - -#### Defined in - -[generated-client/models/remote-image-info.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-info.ts#L78) - -___ - -### Url - -• `Optional` **Url**: ``null`` \| `string` - -Gets or sets the URL. - -**`memberof`** RemoteImageInfo - -#### Defined in - -[generated-client/models/remote-image-info.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-info.ts#L36) - -___ - -### VoteCount - -• `Optional` **VoteCount**: ``null`` \| `number` - -Gets or sets the vote count. - -**`memberof`** RemoteImageInfo - -#### Defined in - -[generated-client/models/remote-image-info.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-info.ts#L66) - -___ - -### Width - -• `Optional` **Width**: ``null`` \| `number` - -Gets or sets the width. - -**`memberof`** RemoteImageInfo - -#### Defined in - -[generated-client/models/remote-image-info.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-info.ts#L54) diff --git a/docs/interfaces/generated_client.RemoteImageResult.md b/docs/interfaces/generated_client.RemoteImageResult.md deleted file mode 100644 index d5d73939e..000000000 --- a/docs/interfaces/generated_client.RemoteImageResult.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RemoteImageResult - -# Interface: RemoteImageResult - -[generated-client](../modules/generated_client.md).RemoteImageResult - -Class RemoteImageResult. - -**`export`** - -**`interface`** RemoteImageResult - -## Table of contents - -### Properties - -- [Images](generated_client.RemoteImageResult.md#images) -- [Providers](generated_client.RemoteImageResult.md#providers) -- [TotalRecordCount](generated_client.RemoteImageResult.md#totalrecordcount) - -## Properties - -### Images - -• `Optional` **Images**: ``null`` \| [`RemoteImageInfo`](generated_client.RemoteImageInfo.md)[] - -Gets or sets the images. - -**`memberof`** RemoteImageResult - -#### Defined in - -[generated-client/models/remote-image-result.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-result.ts#L29) - -___ - -### Providers - -• `Optional` **Providers**: ``null`` \| `string`[] - -Gets or sets the providers. - -**`memberof`** RemoteImageResult - -#### Defined in - -[generated-client/models/remote-image-result.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-result.ts#L41) - -___ - -### TotalRecordCount - -• `Optional` **TotalRecordCount**: `number` - -Gets or sets the total record count. - -**`memberof`** RemoteImageResult - -#### Defined in - -[generated-client/models/remote-image-result.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-image-result.ts#L35) diff --git a/docs/interfaces/generated_client.RemoteSearchResult.md b/docs/interfaces/generated_client.RemoteSearchResult.md deleted file mode 100644 index db839166c..000000000 --- a/docs/interfaces/generated_client.RemoteSearchResult.md +++ /dev/null @@ -1,176 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RemoteSearchResult - -# Interface: RemoteSearchResult - -[generated-client](../modules/generated_client.md).RemoteSearchResult - -**`export`** - -**`interface`** RemoteSearchResult - -## Table of contents - -### Properties - -- [AlbumArtist](generated_client.RemoteSearchResult.md#albumartist) -- [Artists](generated_client.RemoteSearchResult.md#artists) -- [ImageUrl](generated_client.RemoteSearchResult.md#imageurl) -- [IndexNumber](generated_client.RemoteSearchResult.md#indexnumber) -- [IndexNumberEnd](generated_client.RemoteSearchResult.md#indexnumberend) -- [Name](generated_client.RemoteSearchResult.md#name) -- [Overview](generated_client.RemoteSearchResult.md#overview) -- [ParentIndexNumber](generated_client.RemoteSearchResult.md#parentindexnumber) -- [PremiereDate](generated_client.RemoteSearchResult.md#premieredate) -- [ProductionYear](generated_client.RemoteSearchResult.md#productionyear) -- [ProviderIds](generated_client.RemoteSearchResult.md#providerids) -- [SearchProviderName](generated_client.RemoteSearchResult.md#searchprovidername) - -## Properties - -### AlbumArtist - -• `Optional` **AlbumArtist**: [`RemoteSearchResult`](generated_client.RemoteSearchResult.md) - -**`memberof`** RemoteSearchResult - -#### Defined in - -[generated-client/models/remote-search-result.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-search-result.ts#L88) - -___ - -### Artists - -• `Optional` **Artists**: ``null`` \| [`RemoteSearchResult`](generated_client.RemoteSearchResult.md)[] - -**`memberof`** RemoteSearchResult - -#### Defined in - -[generated-client/models/remote-search-result.ts:94](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-search-result.ts#L94) - -___ - -### ImageUrl - -• `Optional` **ImageUrl**: ``null`` \| `string` - -**`memberof`** RemoteSearchResult - -#### Defined in - -[generated-client/models/remote-search-result.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-search-result.ts#L70) - -___ - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -**`memberof`** RemoteSearchResult - -#### Defined in - -[generated-client/models/remote-search-result.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-search-result.ts#L46) - -___ - -### IndexNumberEnd - -• `Optional` **IndexNumberEnd**: ``null`` \| `number` - -**`memberof`** RemoteSearchResult - -#### Defined in - -[generated-client/models/remote-search-result.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-search-result.ts#L52) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** RemoteSearchResult - -#### Defined in - -[generated-client/models/remote-search-result.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-search-result.ts#L28) - -___ - -### Overview - -• `Optional` **Overview**: ``null`` \| `string` - -**`memberof`** RemoteSearchResult - -#### Defined in - -[generated-client/models/remote-search-result.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-search-result.ts#L82) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -**`memberof`** RemoteSearchResult - -#### Defined in - -[generated-client/models/remote-search-result.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-search-result.ts#L58) - -___ - -### PremiereDate - -• `Optional` **PremiereDate**: ``null`` \| `string` - -**`memberof`** RemoteSearchResult - -#### Defined in - -[generated-client/models/remote-search-result.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-search-result.ts#L64) - -___ - -### ProductionYear - -• `Optional` **ProductionYear**: ``null`` \| `number` - -Gets or sets the year. - -**`memberof`** RemoteSearchResult - -#### Defined in - -[generated-client/models/remote-search-result.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-search-result.ts#L40) - -___ - -### ProviderIds - -• `Optional` **ProviderIds**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the provider ids. - -**`memberof`** RemoteSearchResult - -#### Defined in - -[generated-client/models/remote-search-result.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-search-result.ts#L34) - -___ - -### SearchProviderName - -• `Optional` **SearchProviderName**: ``null`` \| `string` - -**`memberof`** RemoteSearchResult - -#### Defined in - -[generated-client/models/remote-search-result.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-search-result.ts#L76) diff --git a/docs/interfaces/generated_client.RemoteSubtitleInfo.md b/docs/interfaces/generated_client.RemoteSubtitleInfo.md deleted file mode 100644 index 9b1fef909..000000000 --- a/docs/interfaces/generated_client.RemoteSubtitleInfo.md +++ /dev/null @@ -1,157 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RemoteSubtitleInfo - -# Interface: RemoteSubtitleInfo - -[generated-client](../modules/generated_client.md).RemoteSubtitleInfo - -**`export`** - -**`interface`** RemoteSubtitleInfo - -## Table of contents - -### Properties - -- [Author](generated_client.RemoteSubtitleInfo.md#author) -- [Comment](generated_client.RemoteSubtitleInfo.md#comment) -- [CommunityRating](generated_client.RemoteSubtitleInfo.md#communityrating) -- [DateCreated](generated_client.RemoteSubtitleInfo.md#datecreated) -- [DownloadCount](generated_client.RemoteSubtitleInfo.md#downloadcount) -- [Format](generated_client.RemoteSubtitleInfo.md#format) -- [Id](generated_client.RemoteSubtitleInfo.md#id) -- [IsHashMatch](generated_client.RemoteSubtitleInfo.md#ishashmatch) -- [Name](generated_client.RemoteSubtitleInfo.md#name) -- [ProviderName](generated_client.RemoteSubtitleInfo.md#providername) -- [ThreeLetterISOLanguageName](generated_client.RemoteSubtitleInfo.md#threeletterisolanguagename) - -## Properties - -### Author - -• `Optional` **Author**: ``null`` \| `string` - -**`memberof`** RemoteSubtitleInfo - -#### Defined in - -[generated-client/models/remote-subtitle-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-subtitle-info.ts#L58) - -___ - -### Comment - -• `Optional` **Comment**: ``null`` \| `string` - -**`memberof`** RemoteSubtitleInfo - -#### Defined in - -[generated-client/models/remote-subtitle-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-subtitle-info.ts#L64) - -___ - -### CommunityRating - -• `Optional` **CommunityRating**: ``null`` \| `number` - -**`memberof`** RemoteSubtitleInfo - -#### Defined in - -[generated-client/models/remote-subtitle-info.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-subtitle-info.ts#L76) - -___ - -### DateCreated - -• `Optional` **DateCreated**: ``null`` \| `string` - -**`memberof`** RemoteSubtitleInfo - -#### Defined in - -[generated-client/models/remote-subtitle-info.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-subtitle-info.ts#L70) - -___ - -### DownloadCount - -• `Optional` **DownloadCount**: ``null`` \| `number` - -**`memberof`** RemoteSubtitleInfo - -#### Defined in - -[generated-client/models/remote-subtitle-info.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-subtitle-info.ts#L82) - -___ - -### Format - -• `Optional` **Format**: ``null`` \| `string` - -**`memberof`** RemoteSubtitleInfo - -#### Defined in - -[generated-client/models/remote-subtitle-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-subtitle-info.ts#L52) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -**`memberof`** RemoteSubtitleInfo - -#### Defined in - -[generated-client/models/remote-subtitle-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-subtitle-info.ts#L34) - -___ - -### IsHashMatch - -• `Optional` **IsHashMatch**: ``null`` \| `boolean` - -**`memberof`** RemoteSubtitleInfo - -#### Defined in - -[generated-client/models/remote-subtitle-info.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-subtitle-info.ts#L88) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -**`memberof`** RemoteSubtitleInfo - -#### Defined in - -[generated-client/models/remote-subtitle-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-subtitle-info.ts#L46) - -___ - -### ProviderName - -• `Optional` **ProviderName**: ``null`` \| `string` - -**`memberof`** RemoteSubtitleInfo - -#### Defined in - -[generated-client/models/remote-subtitle-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-subtitle-info.ts#L40) - -___ - -### ThreeLetterISOLanguageName - -• `Optional` **ThreeLetterISOLanguageName**: ``null`` \| `string` - -**`memberof`** RemoteSubtitleInfo - -#### Defined in - -[generated-client/models/remote-subtitle-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remote-subtitle-info.ts#L28) diff --git a/docs/interfaces/generated_client.RemoveFromPlaylistRequestDto.md b/docs/interfaces/generated_client.RemoveFromPlaylistRequestDto.md deleted file mode 100644 index f094a1f64..000000000 --- a/docs/interfaces/generated_client.RemoveFromPlaylistRequestDto.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RemoveFromPlaylistRequestDto - -# Interface: RemoveFromPlaylistRequestDto - -[generated-client](../modules/generated_client.md).RemoveFromPlaylistRequestDto - -Class RemoveFromPlaylistRequestDto. - -**`export`** - -**`interface`** RemoveFromPlaylistRequestDto - -## Table of contents - -### Properties - -- [ClearPlayingItem](generated_client.RemoveFromPlaylistRequestDto.md#clearplayingitem) -- [ClearPlaylist](generated_client.RemoveFromPlaylistRequestDto.md#clearplaylist) -- [PlaylistItemIds](generated_client.RemoveFromPlaylistRequestDto.md#playlistitemids) - -## Properties - -### ClearPlayingItem - -• `Optional` **ClearPlayingItem**: `boolean` - -Gets or sets a value indicating whether the playing item should be removed as well. Used only when clearing the playlist. - -**`memberof`** RemoveFromPlaylistRequestDto - -#### Defined in - -[generated-client/models/remove-from-playlist-request-dto.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remove-from-playlist-request-dto.ts#L40) - -___ - -### ClearPlaylist - -• `Optional` **ClearPlaylist**: `boolean` - -Gets or sets a value indicating whether the entire playlist should be cleared. - -**`memberof`** RemoveFromPlaylistRequestDto - -#### Defined in - -[generated-client/models/remove-from-playlist-request-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remove-from-playlist-request-dto.ts#L34) - -___ - -### PlaylistItemIds - -• `Optional` **PlaylistItemIds**: `string`[] - -Gets or sets the playlist identifiers ot the items. Ignored when clearing the playlist. - -**`memberof`** RemoveFromPlaylistRequestDto - -#### Defined in - -[generated-client/models/remove-from-playlist-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/remove-from-playlist-request-dto.ts#L28) diff --git a/docs/interfaces/generated_client.RepositoryInfo.md b/docs/interfaces/generated_client.RepositoryInfo.md deleted file mode 100644 index 85ab36a12..000000000 --- a/docs/interfaces/generated_client.RepositoryInfo.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RepositoryInfo - -# Interface: RepositoryInfo - -[generated-client](../modules/generated_client.md).RepositoryInfo - -Class RepositoryInfo. - -**`export`** - -**`interface`** RepositoryInfo - -## Table of contents - -### Properties - -- [Enabled](generated_client.RepositoryInfo.md#enabled) -- [Name](generated_client.RepositoryInfo.md#name) -- [Url](generated_client.RepositoryInfo.md#url) - -## Properties - -### Enabled - -• `Optional` **Enabled**: `boolean` - -Gets or sets a value indicating whether the repository is enabled. - -**`memberof`** RepositoryInfo - -#### Defined in - -[generated-client/models/repository-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/repository-info.ts#L40) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** RepositoryInfo - -#### Defined in - -[generated-client/models/repository-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/repository-info.ts#L28) - -___ - -### Url - -• `Optional` **Url**: ``null`` \| `string` - -Gets or sets the URL. - -**`memberof`** RepositoryInfo - -#### Defined in - -[generated-client/models/repository-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/repository-info.ts#L34) diff --git a/docs/interfaces/generated_client.ResponseProfile.md b/docs/interfaces/generated_client.ResponseProfile.md deleted file mode 100644 index 17bd4d55b..000000000 --- a/docs/interfaces/generated_client.ResponseProfile.md +++ /dev/null @@ -1,105 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ResponseProfile - -# Interface: ResponseProfile - -[generated-client](../modules/generated_client.md).ResponseProfile - -**`export`** - -**`interface`** ResponseProfile - -## Table of contents - -### Properties - -- [AudioCodec](generated_client.ResponseProfile.md#audiocodec) -- [Conditions](generated_client.ResponseProfile.md#conditions) -- [Container](generated_client.ResponseProfile.md#container) -- [MimeType](generated_client.ResponseProfile.md#mimetype) -- [OrgPn](generated_client.ResponseProfile.md#orgpn) -- [Type](generated_client.ResponseProfile.md#type) -- [VideoCodec](generated_client.ResponseProfile.md#videocodec) - -## Properties - -### AudioCodec - -• `Optional` **AudioCodec**: ``null`` \| `string` - -**`memberof`** ResponseProfile - -#### Defined in - -[generated-client/models/response-profile.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/response-profile.ts#L36) - -___ - -### Conditions - -• `Optional` **Conditions**: ``null`` \| [`ProfileCondition`](generated_client.ProfileCondition.md)[] - -**`memberof`** ResponseProfile - -#### Defined in - -[generated-client/models/response-profile.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/response-profile.ts#L66) - -___ - -### Container - -• `Optional` **Container**: ``null`` \| `string` - -**`memberof`** ResponseProfile - -#### Defined in - -[generated-client/models/response-profile.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/response-profile.ts#L30) - -___ - -### MimeType - -• `Optional` **MimeType**: ``null`` \| `string` - -**`memberof`** ResponseProfile - -#### Defined in - -[generated-client/models/response-profile.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/response-profile.ts#L60) - -___ - -### OrgPn - -• `Optional` **OrgPn**: ``null`` \| `string` - -**`memberof`** ResponseProfile - -#### Defined in - -[generated-client/models/response-profile.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/response-profile.ts#L54) - -___ - -### Type - -• `Optional` **Type**: [`DlnaProfileType`](../enums/generated_client.DlnaProfileType.md) - -**`memberof`** ResponseProfile - -#### Defined in - -[generated-client/models/response-profile.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/response-profile.ts#L48) - -___ - -### VideoCodec - -• `Optional` **VideoCodec**: ``null`` \| `string` - -**`memberof`** ResponseProfile - -#### Defined in - -[generated-client/models/response-profile.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/response-profile.ts#L42) diff --git a/docs/interfaces/generated_client.ScheduledTasksApiGetTaskRequest.md b/docs/interfaces/generated_client.ScheduledTasksApiGetTaskRequest.md deleted file mode 100644 index 8650939b5..000000000 --- a/docs/interfaces/generated_client.ScheduledTasksApiGetTaskRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ScheduledTasksApiGetTaskRequest - -# Interface: ScheduledTasksApiGetTaskRequest - -[generated-client](../modules/generated_client.md).ScheduledTasksApiGetTaskRequest - -Request parameters for getTask operation in ScheduledTasksApi. - -**`export`** - -**`interface`** ScheduledTasksApiGetTaskRequest - -## Table of contents - -### Properties - -- [taskId](generated_client.ScheduledTasksApiGetTaskRequest.md#taskid) - -## Properties - -### taskId - -• `Readonly` **taskId**: `string` - -Task Id. - -**`memberof`** ScheduledTasksApiGetTask - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:375](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L375) diff --git a/docs/interfaces/generated_client.ScheduledTasksApiGetTasksRequest.md b/docs/interfaces/generated_client.ScheduledTasksApiGetTasksRequest.md deleted file mode 100644 index 6261d59bf..000000000 --- a/docs/interfaces/generated_client.ScheduledTasksApiGetTasksRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ScheduledTasksApiGetTasksRequest - -# Interface: ScheduledTasksApiGetTasksRequest - -[generated-client](../modules/generated_client.md).ScheduledTasksApiGetTasksRequest - -Request parameters for getTasks operation in ScheduledTasksApi. - -**`export`** - -**`interface`** ScheduledTasksApiGetTasksRequest - -## Table of contents - -### Properties - -- [isEnabled](generated_client.ScheduledTasksApiGetTasksRequest.md#isenabled) -- [isHidden](generated_client.ScheduledTasksApiGetTasksRequest.md#ishidden) - -## Properties - -### isEnabled - -• `Optional` `Readonly` **isEnabled**: `boolean` - -Optional filter tasks that are enabled, or not. - -**`memberof`** ScheduledTasksApiGetTasks - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:396](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L396) - -___ - -### isHidden - -• `Optional` `Readonly` **isHidden**: `boolean` - -Optional filter tasks that are hidden, or not. - -**`memberof`** ScheduledTasksApiGetTasks - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:389](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L389) diff --git a/docs/interfaces/generated_client.ScheduledTasksApiStartTaskRequest.md b/docs/interfaces/generated_client.ScheduledTasksApiStartTaskRequest.md deleted file mode 100644 index fb47bf510..000000000 --- a/docs/interfaces/generated_client.ScheduledTasksApiStartTaskRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ScheduledTasksApiStartTaskRequest - -# Interface: ScheduledTasksApiStartTaskRequest - -[generated-client](../modules/generated_client.md).ScheduledTasksApiStartTaskRequest - -Request parameters for startTask operation in ScheduledTasksApi. - -**`export`** - -**`interface`** ScheduledTasksApiStartTaskRequest - -## Table of contents - -### Properties - -- [taskId](generated_client.ScheduledTasksApiStartTaskRequest.md#taskid) - -## Properties - -### taskId - -• `Readonly` **taskId**: `string` - -Task Id. - -**`memberof`** ScheduledTasksApiStartTask - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:410](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L410) diff --git a/docs/interfaces/generated_client.ScheduledTasksApiStopTaskRequest.md b/docs/interfaces/generated_client.ScheduledTasksApiStopTaskRequest.md deleted file mode 100644 index 34642d1a5..000000000 --- a/docs/interfaces/generated_client.ScheduledTasksApiStopTaskRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ScheduledTasksApiStopTaskRequest - -# Interface: ScheduledTasksApiStopTaskRequest - -[generated-client](../modules/generated_client.md).ScheduledTasksApiStopTaskRequest - -Request parameters for stopTask operation in ScheduledTasksApi. - -**`export`** - -**`interface`** ScheduledTasksApiStopTaskRequest - -## Table of contents - -### Properties - -- [taskId](generated_client.ScheduledTasksApiStopTaskRequest.md#taskid) - -## Properties - -### taskId - -• `Readonly` **taskId**: `string` - -Task Id. - -**`memberof`** ScheduledTasksApiStopTask - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:424](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L424) diff --git a/docs/interfaces/generated_client.ScheduledTasksApiUpdateTaskRequest.md b/docs/interfaces/generated_client.ScheduledTasksApiUpdateTaskRequest.md deleted file mode 100644 index 93d7f4705..000000000 --- a/docs/interfaces/generated_client.ScheduledTasksApiUpdateTaskRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ScheduledTasksApiUpdateTaskRequest - -# Interface: ScheduledTasksApiUpdateTaskRequest - -[generated-client](../modules/generated_client.md).ScheduledTasksApiUpdateTaskRequest - -Request parameters for updateTask operation in ScheduledTasksApi. - -**`export`** - -**`interface`** ScheduledTasksApiUpdateTaskRequest - -## Table of contents - -### Properties - -- [taskId](generated_client.ScheduledTasksApiUpdateTaskRequest.md#taskid) -- [taskTriggerInfo](generated_client.ScheduledTasksApiUpdateTaskRequest.md#tasktriggerinfo) - -## Properties - -### taskId - -• `Readonly` **taskId**: `string` - -Task Id. - -**`memberof`** ScheduledTasksApiUpdateTask - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:438](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L438) - -___ - -### taskTriggerInfo - -• `Readonly` **taskTriggerInfo**: [`TaskTriggerInfo`](generated_client.TaskTriggerInfo.md)[] - -Triggers. - -**`memberof`** ScheduledTasksApiUpdateTask - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:445](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L445) diff --git a/docs/interfaces/generated_client.SearchApiGetRequest.md b/docs/interfaces/generated_client.SearchApiGetRequest.md deleted file mode 100644 index ecf7f1396..000000000 --- a/docs/interfaces/generated_client.SearchApiGetRequest.md +++ /dev/null @@ -1,286 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SearchApiGetRequest - -# Interface: SearchApiGetRequest - -[generated-client](../modules/generated_client.md).SearchApiGetRequest - -Request parameters for get operation in SearchApi. - -**`export`** - -**`interface`** SearchApiGetRequest - -## Table of contents - -### Properties - -- [excludeItemTypes](generated_client.SearchApiGetRequest.md#excludeitemtypes) -- [includeArtists](generated_client.SearchApiGetRequest.md#includeartists) -- [includeGenres](generated_client.SearchApiGetRequest.md#includegenres) -- [includeItemTypes](generated_client.SearchApiGetRequest.md#includeitemtypes) -- [includeMedia](generated_client.SearchApiGetRequest.md#includemedia) -- [includePeople](generated_client.SearchApiGetRequest.md#includepeople) -- [includeStudios](generated_client.SearchApiGetRequest.md#includestudios) -- [isKids](generated_client.SearchApiGetRequest.md#iskids) -- [isMovie](generated_client.SearchApiGetRequest.md#ismovie) -- [isNews](generated_client.SearchApiGetRequest.md#isnews) -- [isSeries](generated_client.SearchApiGetRequest.md#isseries) -- [isSports](generated_client.SearchApiGetRequest.md#issports) -- [limit](generated_client.SearchApiGetRequest.md#limit) -- [mediaTypes](generated_client.SearchApiGetRequest.md#mediatypes) -- [parentId](generated_client.SearchApiGetRequest.md#parentid) -- [searchTerm](generated_client.SearchApiGetRequest.md#searchterm) -- [startIndex](generated_client.SearchApiGetRequest.md#startindex) -- [userId](generated_client.SearchApiGetRequest.md#userid) - -## Properties - -### excludeItemTypes - -• `Optional` `Readonly` **excludeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -If specified, results with these item types are filtered out. This allows multiple, comma delimeted. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:282](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L282) - -___ - -### includeArtists - -• `Optional` `Readonly` **includeArtists**: `boolean` - -Optional filter whether to include artists. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:366](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L366) - -___ - -### includeGenres - -• `Optional` `Readonly` **includeGenres**: `boolean` - -Optional filter whether to include genres. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:352](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L352) - -___ - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -If specified, only results with the specified item types are returned. This allows multiple, comma delimeted. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:275](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L275) - -___ - -### includeMedia - -• `Optional` `Readonly` **includeMedia**: `boolean` - -Optional filter whether to include media. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:345](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L345) - -___ - -### includePeople - -• `Optional` `Readonly` **includePeople**: `boolean` - -Optional filter whether to include people. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:338](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L338) - -___ - -### includeStudios - -• `Optional` `Readonly` **includeStudios**: `boolean` - -Optional filter whether to include studios. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:359](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L359) - -___ - -### isKids - -• `Optional` `Readonly` **isKids**: `boolean` - -Optional filter for kids. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:324](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L324) - -___ - -### isMovie - -• `Optional` `Readonly` **isMovie**: `boolean` - -Optional filter for movies. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:303](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L303) - -___ - -### isNews - -• `Optional` `Readonly` **isNews**: `boolean` - -Optional filter for news. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:317](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L317) - -___ - -### isSeries - -• `Optional` `Readonly` **isSeries**: `boolean` - -Optional filter for series. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:310](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L310) - -___ - -### isSports - -• `Optional` `Readonly` **isSports**: `boolean` - -Optional filter for sports. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:331](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L331) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:261](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L261) - -___ - -### mediaTypes - -• `Optional` `Readonly` **mediaTypes**: `string`[] - -If specified, only results with the specified media types are returned. This allows multiple, comma delimeted. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:289](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L289) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -If specified, only children of the parent are returned. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:296](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L296) - -___ - -### searchTerm - -• `Readonly` **searchTerm**: `string` - -The search term to filter on. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:247](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L247) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:254](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L254) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Supply a user id to search within a user\'s library or omit to search all. - -**`memberof`** SearchApiGet - -#### Defined in - -[generated-client/api/search-api.ts:268](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L268) diff --git a/docs/interfaces/generated_client.SearchHint.md b/docs/interfaces/generated_client.SearchHint.md deleted file mode 100644 index 0aa4370d0..000000000 --- a/docs/interfaces/generated_client.SearchHint.md +++ /dev/null @@ -1,439 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SearchHint - -# Interface: SearchHint - -[generated-client](../modules/generated_client.md).SearchHint - -Class SearchHintResult. - -**`export`** - -**`interface`** SearchHint - -## Table of contents - -### Properties - -- [Album](generated_client.SearchHint.md#album) -- [AlbumArtist](generated_client.SearchHint.md#albumartist) -- [AlbumId](generated_client.SearchHint.md#albumid) -- [Artists](generated_client.SearchHint.md#artists) -- [BackdropImageItemId](generated_client.SearchHint.md#backdropimageitemid) -- [BackdropImageTag](generated_client.SearchHint.md#backdropimagetag) -- [ChannelId](generated_client.SearchHint.md#channelid) -- [ChannelName](generated_client.SearchHint.md#channelname) -- [EndDate](generated_client.SearchHint.md#enddate) -- [EpisodeCount](generated_client.SearchHint.md#episodecount) -- [Id](generated_client.SearchHint.md#id) -- [IndexNumber](generated_client.SearchHint.md#indexnumber) -- [IsFolder](generated_client.SearchHint.md#isfolder) -- [ItemId](generated_client.SearchHint.md#itemid) -- [MatchedTerm](generated_client.SearchHint.md#matchedterm) -- [MediaType](generated_client.SearchHint.md#mediatype) -- [Name](generated_client.SearchHint.md#name) -- [ParentIndexNumber](generated_client.SearchHint.md#parentindexnumber) -- [PrimaryImageAspectRatio](generated_client.SearchHint.md#primaryimageaspectratio) -- [PrimaryImageTag](generated_client.SearchHint.md#primaryimagetag) -- [ProductionYear](generated_client.SearchHint.md#productionyear) -- [RunTimeTicks](generated_client.SearchHint.md#runtimeticks) -- [Series](generated_client.SearchHint.md#series) -- [SongCount](generated_client.SearchHint.md#songcount) -- [StartDate](generated_client.SearchHint.md#startdate) -- [Status](generated_client.SearchHint.md#status) -- [ThumbImageItemId](generated_client.SearchHint.md#thumbimageitemid) -- [ThumbImageTag](generated_client.SearchHint.md#thumbimagetag) -- [Type](generated_client.SearchHint.md#type) - -## Properties - -### Album - -• `Optional` **Album**: ``null`` \| `string` - -Gets or sets the album. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:148](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L148) - -___ - -### AlbumArtist - -• `Optional` **AlbumArtist**: ``null`` \| `string` - -Gets or sets the album artist. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:160](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L160) - -___ - -### AlbumId - -• `Optional` **AlbumId**: `string` - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:154](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L154) - -___ - -### Artists - -• `Optional` **Artists**: ``null`` \| `string`[] - -Gets or sets the artists. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:166](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L166) - -___ - -### BackdropImageItemId - -• `Optional` **BackdropImageItemId**: ``null`` \| `string` - -Gets or sets the backdrop image item identifier. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:94](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L94) - -___ - -### BackdropImageTag - -• `Optional` **BackdropImageTag**: ``null`` \| `string` - -Gets or sets the backdrop image tag. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L88) - -___ - -### ChannelId - -• `Optional` **ChannelId**: `string` - -Gets or sets the channel identifier. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:184](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L184) - -___ - -### ChannelName - -• `Optional` **ChannelName**: ``null`` \| `string` - -Gets or sets the name of the channel. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:190](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L190) - -___ - -### EndDate - -• `Optional` **EndDate**: ``null`` \| `string` - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:130](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L130) - -___ - -### EpisodeCount - -• `Optional` **EpisodeCount**: ``null`` \| `number` - -Gets or sets the episode count. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:178](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L178) - -___ - -### Id - -• `Optional` **Id**: `string` - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L34) - -___ - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -Gets or sets the index number. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L52) - -___ - -### IsFolder - -• `Optional` **IsFolder**: ``null`` \| `boolean` - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:106](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L106) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -Gets or sets the item id. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L28) - -___ - -### MatchedTerm - -• `Optional` **MatchedTerm**: ``null`` \| `string` - -Gets or sets the matched term. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L46) - -___ - -### MediaType - -• `Optional` **MediaType**: ``null`` \| `string` - -Gets or sets the type of the media. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:118](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L118) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L40) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -Gets or sets the parent index number. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L64) - -___ - -### PrimaryImageAspectRatio - -• `Optional` **PrimaryImageAspectRatio**: ``null`` \| `number` - -Gets or sets the primary image aspect ratio. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:196](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L196) - -___ - -### PrimaryImageTag - -• `Optional` **PrimaryImageTag**: ``null`` \| `string` - -Gets or sets the image tag. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L70) - -___ - -### ProductionYear - -• `Optional` **ProductionYear**: ``null`` \| `number` - -Gets or sets the production year. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L58) - -___ - -### RunTimeTicks - -• `Optional` **RunTimeTicks**: ``null`` \| `number` - -Gets or sets the run time ticks. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:112](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L112) - -___ - -### Series - -• `Optional` **Series**: ``null`` \| `string` - -Gets or sets the series. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:136](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L136) - -___ - -### SongCount - -• `Optional` **SongCount**: ``null`` \| `number` - -Gets or sets the song count. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:172](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L172) - -___ - -### StartDate - -• `Optional` **StartDate**: ``null`` \| `string` - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:124](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L124) - -___ - -### Status - -• `Optional` **Status**: ``null`` \| `string` - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:142](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L142) - -___ - -### ThumbImageItemId - -• `Optional` **ThumbImageItemId**: ``null`` \| `string` - -Gets or sets the thumb image item identifier. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L82) - -___ - -### ThumbImageTag - -• `Optional` **ThumbImageTag**: ``null`` \| `string` - -Gets or sets the thumb image tag. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L76) - -___ - -### Type - -• `Optional` **Type**: ``null`` \| `string` - -Gets or sets the type. - -**`memberof`** SearchHint - -#### Defined in - -[generated-client/models/search-hint.ts:100](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint.ts#L100) diff --git a/docs/interfaces/generated_client.SearchHintResult.md b/docs/interfaces/generated_client.SearchHintResult.md deleted file mode 100644 index 68df5313d..000000000 --- a/docs/interfaces/generated_client.SearchHintResult.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SearchHintResult - -# Interface: SearchHintResult - -[generated-client](../modules/generated_client.md).SearchHintResult - -Class SearchHintResult. - -**`export`** - -**`interface`** SearchHintResult - -## Table of contents - -### Properties - -- [SearchHints](generated_client.SearchHintResult.md#searchhints) -- [TotalRecordCount](generated_client.SearchHintResult.md#totalrecordcount) - -## Properties - -### SearchHints - -• `Optional` **SearchHints**: [`SearchHint`](generated_client.SearchHint.md)[] - -Gets the search hints. - -**`memberof`** SearchHintResult - -#### Defined in - -[generated-client/models/search-hint-result.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint-result.ts#L29) - -___ - -### TotalRecordCount - -• `Optional` **TotalRecordCount**: `number` - -Gets the total record count. - -**`memberof`** SearchHintResult - -#### Defined in - -[generated-client/models/search-hint-result.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/search-hint-result.ts#L35) diff --git a/docs/interfaces/generated_client.SeekRequestDto.md b/docs/interfaces/generated_client.SeekRequestDto.md deleted file mode 100644 index 8458e9b75..000000000 --- a/docs/interfaces/generated_client.SeekRequestDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SeekRequestDto - -# Interface: SeekRequestDto - -[generated-client](../modules/generated_client.md).SeekRequestDto - -Class SeekRequestDto. - -**`export`** - -**`interface`** SeekRequestDto - -## Table of contents - -### Properties - -- [PositionTicks](generated_client.SeekRequestDto.md#positionticks) - -## Properties - -### PositionTicks - -• `Optional` **PositionTicks**: `number` - -Gets or sets the position ticks. - -**`memberof`** SeekRequestDto - -#### Defined in - -[generated-client/models/seek-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/seek-request-dto.ts#L28) diff --git a/docs/interfaces/generated_client.SendCommand.md b/docs/interfaces/generated_client.SendCommand.md deleted file mode 100644 index 7e1a801b5..000000000 --- a/docs/interfaces/generated_client.SendCommand.md +++ /dev/null @@ -1,104 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SendCommand - -# Interface: SendCommand - -[generated-client](../modules/generated_client.md).SendCommand - -Class SendCommand. - -**`export`** - -**`interface`** SendCommand - -## Table of contents - -### Properties - -- [Command](generated_client.SendCommand.md#command) -- [EmittedAt](generated_client.SendCommand.md#emittedat) -- [GroupId](generated_client.SendCommand.md#groupid) -- [PlaylistItemId](generated_client.SendCommand.md#playlistitemid) -- [PositionTicks](generated_client.SendCommand.md#positionticks) -- [When](generated_client.SendCommand.md#when) - -## Properties - -### Command - -• `Optional` **Command**: [`SendCommandType`](../enums/generated_client.SendCommandType.md) - -**`memberof`** SendCommand - -#### Defined in - -[generated-client/models/send-command.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-command.ts#L53) - -___ - -### EmittedAt - -• `Optional` **EmittedAt**: `string` - -Gets the UTC time when this command has been emitted. - -**`memberof`** SendCommand - -#### Defined in - -[generated-client/models/send-command.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-command.ts#L59) - -___ - -### GroupId - -• `Optional` **GroupId**: `string` - -Gets the group identifier. - -**`memberof`** SendCommand - -#### Defined in - -[generated-client/models/send-command.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-command.ts#L29) - -___ - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: `string` - -Gets the playlist identifier of the playing item. - -**`memberof`** SendCommand - -#### Defined in - -[generated-client/models/send-command.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-command.ts#L35) - -___ - -### PositionTicks - -• `Optional` **PositionTicks**: ``null`` \| `number` - -Gets the position ticks. - -**`memberof`** SendCommand - -#### Defined in - -[generated-client/models/send-command.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-command.ts#L47) - -___ - -### When - -• `Optional` **When**: `string` - -Gets or sets the UTC time when to execute the command. - -**`memberof`** SendCommand - -#### Defined in - -[generated-client/models/send-command.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/send-command.ts#L41) diff --git a/docs/interfaces/generated_client.SeriesInfo.md b/docs/interfaces/generated_client.SeriesInfo.md deleted file mode 100644 index 02e33052b..000000000 --- a/docs/interfaces/generated_client.SeriesInfo.md +++ /dev/null @@ -1,171 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SeriesInfo - -# Interface: SeriesInfo - -[generated-client](../modules/generated_client.md).SeriesInfo - -**`export`** - -**`interface`** SeriesInfo - -## Table of contents - -### Properties - -- [IndexNumber](generated_client.SeriesInfo.md#indexnumber) -- [IsAutomated](generated_client.SeriesInfo.md#isautomated) -- [MetadataCountryCode](generated_client.SeriesInfo.md#metadatacountrycode) -- [MetadataLanguage](generated_client.SeriesInfo.md#metadatalanguage) -- [Name](generated_client.SeriesInfo.md#name) -- [OriginalTitle](generated_client.SeriesInfo.md#originaltitle) -- [ParentIndexNumber](generated_client.SeriesInfo.md#parentindexnumber) -- [Path](generated_client.SeriesInfo.md#path) -- [PremiereDate](generated_client.SeriesInfo.md#premieredate) -- [ProviderIds](generated_client.SeriesInfo.md#providerids) -- [Year](generated_client.SeriesInfo.md#year) - -## Properties - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -**`memberof`** SeriesInfo - -#### Defined in - -[generated-client/models/series-info.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info.ts#L70) - -___ - -### IsAutomated - -• `Optional` **IsAutomated**: `boolean` - -**`memberof`** SeriesInfo - -#### Defined in - -[generated-client/models/series-info.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info.ts#L88) - -___ - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: ``null`` \| `string` - -Gets or sets the metadata country code. - -**`memberof`** SeriesInfo - -#### Defined in - -[generated-client/models/series-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info.ts#L52) - -___ - -### MetadataLanguage - -• `Optional` **MetadataLanguage**: ``null`` \| `string` - -Gets or sets the metadata language. - -**`memberof`** SeriesInfo - -#### Defined in - -[generated-client/models/series-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info.ts#L46) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** SeriesInfo - -#### Defined in - -[generated-client/models/series-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info.ts#L28) - -___ - -### OriginalTitle - -• `Optional` **OriginalTitle**: ``null`` \| `string` - -Gets or sets the original title. - -**`memberof`** SeriesInfo - -#### Defined in - -[generated-client/models/series-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info.ts#L34) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -**`memberof`** SeriesInfo - -#### Defined in - -[generated-client/models/series-info.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info.ts#L76) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** SeriesInfo - -#### Defined in - -[generated-client/models/series-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info.ts#L40) - -___ - -### PremiereDate - -• `Optional` **PremiereDate**: ``null`` \| `string` - -**`memberof`** SeriesInfo - -#### Defined in - -[generated-client/models/series-info.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info.ts#L82) - -___ - -### ProviderIds - -• `Optional` **ProviderIds**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the provider ids. - -**`memberof`** SeriesInfo - -#### Defined in - -[generated-client/models/series-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info.ts#L58) - -___ - -### Year - -• `Optional` **Year**: ``null`` \| `number` - -Gets or sets the year. - -**`memberof`** SeriesInfo - -#### Defined in - -[generated-client/models/series-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info.ts#L64) diff --git a/docs/interfaces/generated_client.SeriesInfoRemoteSearchQuery.md b/docs/interfaces/generated_client.SeriesInfoRemoteSearchQuery.md deleted file mode 100644 index 9d09e113f..000000000 --- a/docs/interfaces/generated_client.SeriesInfoRemoteSearchQuery.md +++ /dev/null @@ -1,70 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SeriesInfoRemoteSearchQuery - -# Interface: SeriesInfoRemoteSearchQuery - -[generated-client](../modules/generated_client.md).SeriesInfoRemoteSearchQuery - -**`export`** - -**`interface`** SeriesInfoRemoteSearchQuery - -## Table of contents - -### Properties - -- [IncludeDisabledProviders](generated_client.SeriesInfoRemoteSearchQuery.md#includedisabledproviders) -- [ItemId](generated_client.SeriesInfoRemoteSearchQuery.md#itemid) -- [SearchInfo](generated_client.SeriesInfoRemoteSearchQuery.md#searchinfo) -- [SearchProviderName](generated_client.SeriesInfoRemoteSearchQuery.md#searchprovidername) - -## Properties - -### IncludeDisabledProviders - -• `Optional` **IncludeDisabledProviders**: `boolean` - -Gets or sets a value indicating whether disabled providers should be included. - -**`memberof`** SeriesInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/series-info-remote-search-query.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info-remote-search-query.ts#L47) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -**`memberof`** SeriesInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/series-info-remote-search-query.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info-remote-search-query.ts#L35) - -___ - -### SearchInfo - -• `Optional` **SearchInfo**: [`SeriesInfo`](generated_client.SeriesInfo.md) - -**`memberof`** SeriesInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/series-info-remote-search-query.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info-remote-search-query.ts#L29) - -___ - -### SearchProviderName - -• `Optional` **SearchProviderName**: ``null`` \| `string` - -Gets or sets the provider name to search within if set. - -**`memberof`** SeriesInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/series-info-remote-search-query.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-info-remote-search-query.ts#L41) diff --git a/docs/interfaces/generated_client.SeriesTimerInfoDto.md b/docs/interfaces/generated_client.SeriesTimerInfoDto.md deleted file mode 100644 index 6e2101950..000000000 --- a/docs/interfaces/generated_client.SeriesTimerInfoDto.md +++ /dev/null @@ -1,529 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SeriesTimerInfoDto - -# Interface: SeriesTimerInfoDto - -[generated-client](../modules/generated_client.md).SeriesTimerInfoDto - -Class SeriesTimerInfoDto. - -**`export`** - -**`interface`** SeriesTimerInfoDto - -## Table of contents - -### Properties - -- [ChannelId](generated_client.SeriesTimerInfoDto.md#channelid) -- [ChannelName](generated_client.SeriesTimerInfoDto.md#channelname) -- [ChannelPrimaryImageTag](generated_client.SeriesTimerInfoDto.md#channelprimaryimagetag) -- [DayPattern](generated_client.SeriesTimerInfoDto.md#daypattern) -- [Days](generated_client.SeriesTimerInfoDto.md#days) -- [EndDate](generated_client.SeriesTimerInfoDto.md#enddate) -- [ExternalChannelId](generated_client.SeriesTimerInfoDto.md#externalchannelid) -- [ExternalId](generated_client.SeriesTimerInfoDto.md#externalid) -- [ExternalProgramId](generated_client.SeriesTimerInfoDto.md#externalprogramid) -- [Id](generated_client.SeriesTimerInfoDto.md#id) -- [ImageTags](generated_client.SeriesTimerInfoDto.md#imagetags) -- [IsPostPaddingRequired](generated_client.SeriesTimerInfoDto.md#ispostpaddingrequired) -- [IsPrePaddingRequired](generated_client.SeriesTimerInfoDto.md#isprepaddingrequired) -- [KeepUntil](generated_client.SeriesTimerInfoDto.md#keepuntil) -- [KeepUpTo](generated_client.SeriesTimerInfoDto.md#keepupto) -- [Name](generated_client.SeriesTimerInfoDto.md#name) -- [Overview](generated_client.SeriesTimerInfoDto.md#overview) -- [ParentBackdropImageTags](generated_client.SeriesTimerInfoDto.md#parentbackdropimagetags) -- [ParentBackdropItemId](generated_client.SeriesTimerInfoDto.md#parentbackdropitemid) -- [ParentPrimaryImageItemId](generated_client.SeriesTimerInfoDto.md#parentprimaryimageitemid) -- [ParentPrimaryImageTag](generated_client.SeriesTimerInfoDto.md#parentprimaryimagetag) -- [ParentThumbImageTag](generated_client.SeriesTimerInfoDto.md#parentthumbimagetag) -- [ParentThumbItemId](generated_client.SeriesTimerInfoDto.md#parentthumbitemid) -- [PostPaddingSeconds](generated_client.SeriesTimerInfoDto.md#postpaddingseconds) -- [PrePaddingSeconds](generated_client.SeriesTimerInfoDto.md#prepaddingseconds) -- [Priority](generated_client.SeriesTimerInfoDto.md#priority) -- [ProgramId](generated_client.SeriesTimerInfoDto.md#programid) -- [RecordAnyChannel](generated_client.SeriesTimerInfoDto.md#recordanychannel) -- [RecordAnyTime](generated_client.SeriesTimerInfoDto.md#recordanytime) -- [RecordNewOnly](generated_client.SeriesTimerInfoDto.md#recordnewonly) -- [ServerId](generated_client.SeriesTimerInfoDto.md#serverid) -- [ServiceName](generated_client.SeriesTimerInfoDto.md#servicename) -- [SkipEpisodesInLibrary](generated_client.SeriesTimerInfoDto.md#skipepisodesinlibrary) -- [StartDate](generated_client.SeriesTimerInfoDto.md#startdate) -- [Type](generated_client.SeriesTimerInfoDto.md#type) - -## Properties - -### ChannelId - -• `Optional` **ChannelId**: `string` - -Gets or sets the channel id of the recording. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L55) - -___ - -### ChannelName - -• `Optional` **ChannelName**: ``null`` \| `string` - -Gets or sets the channel name of the recording. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:67](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L67) - -___ - -### ChannelPrimaryImageTag - -• `Optional` **ChannelPrimaryImageTag**: ``null`` \| `string` - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:73](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L73) - -___ - -### DayPattern - -• `Optional` **DayPattern**: [`DayPattern`](../enums/generated_client.DayPattern.md) - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:205](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L205) - -___ - -### Days - -• `Optional` **Days**: ``null`` \| [`DayOfWeek`](../enums/generated_client.DayOfWeek.md)[] - -Gets or sets the days. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:199](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L199) - -___ - -### EndDate - -• `Optional` **EndDate**: `string` - -Gets or sets the end date of the recording, in UTC. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:109](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L109) - -___ - -### ExternalChannelId - -• `Optional` **ExternalChannelId**: ``null`` \| `string` - -Gets or sets the external channel identifier. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:61](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L61) - -___ - -### ExternalId - -• `Optional` **ExternalId**: ``null`` \| `string` - -Gets or sets the external identifier. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L49) - -___ - -### ExternalProgramId - -• `Optional` **ExternalProgramId**: ``null`` \| `string` - -Gets or sets the external program identifier. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:85](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L85) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets the Id of the recording. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L31) - -___ - -### ImageTags - -• `Optional` **ImageTags**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the image tags. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:211](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L211) - -___ - -### IsPostPaddingRequired - -• `Optional` **IsPostPaddingRequired**: `boolean` - -Gets or sets a value indicating whether this instance is post padding required. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:157](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L157) - -___ - -### IsPrePaddingRequired - -• `Optional` **IsPrePaddingRequired**: `boolean` - -Gets or sets a value indicating whether this instance is pre padding required. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:139](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L139) - -___ - -### KeepUntil - -• `Optional` **KeepUntil**: [`KeepUntil`](../enums/generated_client.KeepUntil.md) - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:163](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L163) - -___ - -### KeepUpTo - -• `Optional` **KeepUpTo**: `number` - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:187](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L187) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name of the recording. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:91](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L91) - -___ - -### Overview - -• `Optional` **Overview**: ``null`` \| `string` - -Gets or sets the description of the recording. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:97](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L97) - -___ - -### ParentBackdropImageTags - -• `Optional` **ParentBackdropImageTags**: ``null`` \| `string`[] - -Gets or sets the parent backdrop image tags. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:151](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L151) - -___ - -### ParentBackdropItemId - -• `Optional` **ParentBackdropItemId**: ``null`` \| `string` - -Gets or sets the Id of the Parent that has a backdrop if the item does not have one. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:145](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L145) - -___ - -### ParentPrimaryImageItemId - -• `Optional` **ParentPrimaryImageItemId**: ``null`` \| `string` - -Gets or sets the parent primary image item identifier. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:229](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L229) - -___ - -### ParentPrimaryImageTag - -• `Optional` **ParentPrimaryImageTag**: ``null`` \| `string` - -Gets or sets the parent primary image tag. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:235](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L235) - -___ - -### ParentThumbImageTag - -• `Optional` **ParentThumbImageTag**: ``null`` \| `string` - -Gets or sets the parent thumb image tag. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:223](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L223) - -___ - -### ParentThumbItemId - -• `Optional` **ParentThumbItemId**: ``null`` \| `string` - -Gets or sets the parent thumb item id. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:217](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L217) - -___ - -### PostPaddingSeconds - -• `Optional` **PostPaddingSeconds**: `number` - -Gets or sets the post padding seconds. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:133](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L133) - -___ - -### PrePaddingSeconds - -• `Optional` **PrePaddingSeconds**: `number` - -Gets or sets the pre padding seconds. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:127](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L127) - -___ - -### Priority - -• `Optional` **Priority**: `number` - -Gets or sets the priority. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:121](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L121) - -___ - -### ProgramId - -• `Optional` **ProgramId**: ``null`` \| `string` - -Gets or sets the program identifier. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:79](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L79) - -___ - -### RecordAnyChannel - -• `Optional` **RecordAnyChannel**: `boolean` - -Gets or sets a value indicating whether [record any channel]. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L181) - -___ - -### RecordAnyTime - -• `Optional` **RecordAnyTime**: `boolean` - -Gets or sets a value indicating whether [record any time]. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:169](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L169) - -___ - -### RecordNewOnly - -• `Optional` **RecordNewOnly**: `boolean` - -Gets or sets a value indicating whether [record new only]. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:193](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L193) - -___ - -### ServerId - -• `Optional` **ServerId**: ``null`` \| `string` - -Gets or sets the server identifier. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L43) - -___ - -### ServiceName - -• `Optional` **ServiceName**: ``null`` \| `string` - -Gets or sets the name of the service. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:115](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L115) - -___ - -### SkipEpisodesInLibrary - -• `Optional` **SkipEpisodesInLibrary**: `boolean` - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:175](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L175) - -___ - -### StartDate - -• `Optional` **StartDate**: `string` - -Gets or sets the start date of the recording, in UTC. - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:103](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L103) - -___ - -### Type - -• `Optional` **Type**: ``null`` \| `string` - -**`memberof`** SeriesTimerInfoDto - -#### Defined in - -[generated-client/models/series-timer-info-dto.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto.ts#L37) diff --git a/docs/interfaces/generated_client.SeriesTimerInfoDtoQueryResult.md b/docs/interfaces/generated_client.SeriesTimerInfoDtoQueryResult.md deleted file mode 100644 index cff7d9445..000000000 --- a/docs/interfaces/generated_client.SeriesTimerInfoDtoQueryResult.md +++ /dev/null @@ -1,59 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SeriesTimerInfoDtoQueryResult - -# Interface: SeriesTimerInfoDtoQueryResult - -[generated-client](../modules/generated_client.md).SeriesTimerInfoDtoQueryResult - -**`export`** - -**`interface`** SeriesTimerInfoDtoQueryResult - -## Table of contents - -### Properties - -- [Items](generated_client.SeriesTimerInfoDtoQueryResult.md#items) -- [StartIndex](generated_client.SeriesTimerInfoDtoQueryResult.md#startindex) -- [TotalRecordCount](generated_client.SeriesTimerInfoDtoQueryResult.md#totalrecordcount) - -## Properties - -### Items - -• `Optional` **Items**: ``null`` \| [`SeriesTimerInfoDto`](generated_client.SeriesTimerInfoDto.md)[] - -Gets or sets the items. - -**`memberof`** SeriesTimerInfoDtoQueryResult - -#### Defined in - -[generated-client/models/series-timer-info-dto-query-result.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto-query-result.ts#L29) - -___ - -### StartIndex - -• `Optional` **StartIndex**: `number` - -Gets or sets the index of the first record in Items. - -**`memberof`** SeriesTimerInfoDtoQueryResult - -#### Defined in - -[generated-client/models/series-timer-info-dto-query-result.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto-query-result.ts#L41) - -___ - -### TotalRecordCount - -• `Optional` **TotalRecordCount**: `number` - -Gets or sets the total number of records available. - -**`memberof`** SeriesTimerInfoDtoQueryResult - -#### Defined in - -[generated-client/models/series-timer-info-dto-query-result.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/series-timer-info-dto-query-result.ts#L35) diff --git a/docs/interfaces/generated_client.ServerConfiguration.md b/docs/interfaces/generated_client.ServerConfiguration.md deleted file mode 100644 index 215afc2dd..000000000 --- a/docs/interfaces/generated_client.ServerConfiguration.md +++ /dev/null @@ -1,698 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ServerConfiguration - -# Interface: ServerConfiguration - -[generated-client](../modules/generated_client.md).ServerConfiguration - -Represents the server configuration. - -**`export`** - -**`interface`** ServerConfiguration - -## Table of contents - -### Properties - -- [ActivityLogRetentionDays](generated_client.ServerConfiguration.md#activitylogretentiondays) -- [AllowClientLogUpload](generated_client.ServerConfiguration.md#allowclientlogupload) -- [CachePath](generated_client.ServerConfiguration.md#cachepath) -- [CodecsUsed](generated_client.ServerConfiguration.md#codecsused) -- [ContentTypes](generated_client.ServerConfiguration.md#contenttypes) -- [CorsHosts](generated_client.ServerConfiguration.md#corshosts) -- [DisableLiveTvChannelUserDataName](generated_client.ServerConfiguration.md#disablelivetvchanneluserdataname) -- [DisplaySpecialsWithinSeasons](generated_client.ServerConfiguration.md#displayspecialswithinseasons) -- [EnableCaseSensitiveItemIds](generated_client.ServerConfiguration.md#enablecasesensitiveitemids) -- [EnableExternalContentInSuggestions](generated_client.ServerConfiguration.md#enableexternalcontentinsuggestions) -- [EnableFolderView](generated_client.ServerConfiguration.md#enablefolderview) -- [EnableGroupingIntoCollections](generated_client.ServerConfiguration.md#enablegroupingintocollections) -- [EnableMetrics](generated_client.ServerConfiguration.md#enablemetrics) -- [EnableNormalizedItemByNameIds](generated_client.ServerConfiguration.md#enablenormalizeditembynameids) -- [EnableSlowResponseWarning](generated_client.ServerConfiguration.md#enableslowresponsewarning) -- [ImageExtractionTimeoutMs](generated_client.ServerConfiguration.md#imageextractiontimeoutms) -- [ImageSavingConvention](generated_client.ServerConfiguration.md#imagesavingconvention) -- [IsPortAuthorized](generated_client.ServerConfiguration.md#isportauthorized) -- [IsStartupWizardCompleted](generated_client.ServerConfiguration.md#isstartupwizardcompleted) -- [LibraryMetadataRefreshConcurrency](generated_client.ServerConfiguration.md#librarymetadatarefreshconcurrency) -- [LibraryMonitorDelay](generated_client.ServerConfiguration.md#librarymonitordelay) -- [LibraryScanFanoutConcurrency](generated_client.ServerConfiguration.md#libraryscanfanoutconcurrency) -- [LogFileRetentionDays](generated_client.ServerConfiguration.md#logfileretentiondays) -- [MaxAudiobookResume](generated_client.ServerConfiguration.md#maxaudiobookresume) -- [MaxResumePct](generated_client.ServerConfiguration.md#maxresumepct) -- [MetadataCountryCode](generated_client.ServerConfiguration.md#metadatacountrycode) -- [MetadataNetworkPath](generated_client.ServerConfiguration.md#metadatanetworkpath) -- [MetadataOptions](generated_client.ServerConfiguration.md#metadataoptions) -- [MetadataPath](generated_client.ServerConfiguration.md#metadatapath) -- [MinAudiobookResume](generated_client.ServerConfiguration.md#minaudiobookresume) -- [MinResumeDurationSeconds](generated_client.ServerConfiguration.md#minresumedurationseconds) -- [MinResumePct](generated_client.ServerConfiguration.md#minresumepct) -- [PathSubstitutions](generated_client.ServerConfiguration.md#pathsubstitutions) -- [PluginRepositories](generated_client.ServerConfiguration.md#pluginrepositories) -- [PreferredMetadataLanguage](generated_client.ServerConfiguration.md#preferredmetadatalanguage) -- [PreviousVersion](generated_client.ServerConfiguration.md#previousversion) -- [PreviousVersionStr](generated_client.ServerConfiguration.md#previousversionstr) -- [QuickConnectAvailable](generated_client.ServerConfiguration.md#quickconnectavailable) -- [RemoteClientBitrateLimit](generated_client.ServerConfiguration.md#remoteclientbitratelimit) -- [RemoveOldPlugins](generated_client.ServerConfiguration.md#removeoldplugins) -- [SaveMetadataHidden](generated_client.ServerConfiguration.md#savemetadatahidden) -- [ServerName](generated_client.ServerConfiguration.md#servername) -- [SkipDeserializationForBasicTypes](generated_client.ServerConfiguration.md#skipdeserializationforbasictypes) -- [SlowResponseThresholdMs](generated_client.ServerConfiguration.md#slowresponsethresholdms) -- [SortRemoveCharacters](generated_client.ServerConfiguration.md#sortremovecharacters) -- [SortRemoveWords](generated_client.ServerConfiguration.md#sortremovewords) -- [SortReplaceCharacters](generated_client.ServerConfiguration.md#sortreplacecharacters) -- [UICulture](generated_client.ServerConfiguration.md#uiculture) - -## Properties - -### ActivityLogRetentionDays - -• `Optional` **ActivityLogRetentionDays**: ``null`` \| `number` - -Gets or sets the number of days we should retain activity logs. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:291](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L291) - -___ - -### AllowClientLogUpload - -• `Optional` **AllowClientLogUpload**: `boolean` - -Gets or sets a value indicating whether clients should be allowed to upload logs. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:315](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L315) - -___ - -### CachePath - -• `Optional` **CachePath**: ``null`` \| `string` - -Gets or sets the cache path. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L45) - -___ - -### CodecsUsed - -• `Optional` **CodecsUsed**: `string`[] - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:243](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L243) - -___ - -### ContentTypes - -• `Optional` **ContentTypes**: [`NameValuePair`](generated_client.NameValuePair.md)[] - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:213](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L213) - -___ - -### CorsHosts - -• `Optional` **CorsHosts**: `string`[] - -Gets or sets the cors hosts. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:285](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L285) - -___ - -### DisableLiveTvChannelUserDataName - -• `Optional` **DisableLiveTvChannelUserDataName**: `boolean` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:93](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L93) - -___ - -### DisplaySpecialsWithinSeasons - -• `Optional` **DisplaySpecialsWithinSeasons**: `boolean` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:237](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L237) - -___ - -### EnableCaseSensitiveItemIds - -• `Optional` **EnableCaseSensitiveItemIds**: `boolean` - -Gets or sets a value indicating whether [enable case sensitive item ids]. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:87](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L87) - -___ - -### EnableExternalContentInSuggestions - -• `Optional` **EnableExternalContentInSuggestions**: `boolean` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:255](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L255) - -___ - -### EnableFolderView - -• `Optional` **EnableFolderView**: `boolean` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:225](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L225) - -___ - -### EnableGroupingIntoCollections - -• `Optional` **EnableGroupingIntoCollections**: `boolean` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:231](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L231) - -___ - -### EnableMetrics - -• `Optional` **EnableMetrics**: `boolean` - -Gets or sets a value indicating whether to enable prometheus metrics exporting. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:63](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L63) - -___ - -### EnableNormalizedItemByNameIds - -• `Optional` **EnableNormalizedItemByNameIds**: `boolean` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:69](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L69) - -___ - -### EnableSlowResponseWarning - -• `Optional` **EnableSlowResponseWarning**: `boolean` - -Gets or sets a value indicating whether slow server responses should be logged as a warning. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:273](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L273) - -___ - -### ImageExtractionTimeoutMs - -• `Optional` **ImageExtractionTimeoutMs**: `number` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:261](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L261) - -___ - -### ImageSavingConvention - -• `Optional` **ImageSavingConvention**: [`ImageSavingConvention`](../enums/generated_client.ImageSavingConvention.md) - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:177](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L177) - -___ - -### IsPortAuthorized - -• `Optional` **IsPortAuthorized**: `boolean` - -Gets or sets a value indicating whether this instance is port authorized. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:75](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L75) - -___ - -### IsStartupWizardCompleted - -• `Optional` **IsStartupWizardCompleted**: `boolean` - -Gets or sets a value indicating whether this instance is first run. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L39) - -___ - -### LibraryMetadataRefreshConcurrency - -• `Optional` **LibraryMetadataRefreshConcurrency**: `number` - -Gets or sets the how many metadata refreshes can run concurrently. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:303](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L303) - -___ - -### LibraryMonitorDelay - -• `Optional` **LibraryMonitorDelay**: `number` - -Gets or sets the delay in seconds that we will wait after a file system change to try and discover what has been added/removed Some delay is necessary with some items because their creation is not atomic. It involves the creation of several different directories and files. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:171](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L171) - -___ - -### LibraryScanFanoutConcurrency - -• `Optional` **LibraryScanFanoutConcurrency**: `number` - -Gets or sets the how the library scan fans out. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:297](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L297) - -___ - -### LogFileRetentionDays - -• `Optional` **LogFileRetentionDays**: `number` - -Gets or sets the number of days we should retain log files. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L33) - -___ - -### MaxAudiobookResume - -• `Optional` **MaxAudiobookResume**: `number` - -Gets or sets the remaining minutes of a book that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:165](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L165) - -___ - -### MaxResumePct - -• `Optional` **MaxResumePct**: `number` - -Gets or sets the maximum percentage of an item that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:147](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L147) - -___ - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: `string` - -Gets or sets the metadata country code. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:117](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L117) - -___ - -### MetadataNetworkPath - -• `Optional` **MetadataNetworkPath**: `string` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:105](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L105) - -___ - -### MetadataOptions - -• `Optional` **MetadataOptions**: [`MetadataOptions`](generated_client.MetadataOptions.md)[] - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:183](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L183) - -___ - -### MetadataPath - -• `Optional` **MetadataPath**: `string` - -Gets or sets the metadata path. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:99](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L99) - -___ - -### MinAudiobookResume - -• `Optional` **MinAudiobookResume**: `number` - -Gets or sets the minimum minutes of a book that must be played in order for playstate to be updated. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:159](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L159) - -___ - -### MinResumeDurationSeconds - -• `Optional` **MinResumeDurationSeconds**: `number` - -Gets or sets the minimum duration that an item must have in order to be eligible for playstate updates.. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:153](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L153) - -___ - -### MinResumePct - -• `Optional` **MinResumePct**: `number` - -Gets or sets the minimum percentage of an item that must be played in order for playstate to be updated. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:141](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L141) - -___ - -### PathSubstitutions - -• `Optional` **PathSubstitutions**: [`PathSubstitution`](generated_client.PathSubstitution.md)[] - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:267](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L267) - -___ - -### PluginRepositories - -• `Optional` **PluginRepositories**: [`RepositoryInfo`](generated_client.RepositoryInfo.md)[] - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:249](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L249) - -___ - -### PreferredMetadataLanguage - -• `Optional` **PreferredMetadataLanguage**: `string` - -Gets or sets the preferred metadata language. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:111](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L111) - -___ - -### PreviousVersion - -• `Optional` **PreviousVersion**: ``null`` \| `string` - -Gets or sets the last known version that was ran using the configuration. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:51](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L51) - -___ - -### PreviousVersionStr - -• `Optional` **PreviousVersionStr**: ``null`` \| `string` - -Gets or sets the stringified PreviousVersion to be stored/loaded, because System.Version itself isn\'t xml-serializable. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:57](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L57) - -___ - -### QuickConnectAvailable - -• `Optional` **QuickConnectAvailable**: `boolean` - -Gets or sets a value indicating whether quick connect is available for use on this server. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:81](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L81) - -___ - -### RemoteClientBitrateLimit - -• `Optional` **RemoteClientBitrateLimit**: `number` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:219](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L219) - -___ - -### RemoveOldPlugins - -• `Optional` **RemoveOldPlugins**: `boolean` - -Gets or sets a value indicating whether older plugins should automatically be deleted from the plugin folder. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:309](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L309) - -___ - -### SaveMetadataHidden - -• `Optional` **SaveMetadataHidden**: `boolean` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:207](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L207) - -___ - -### ServerName - -• `Optional` **ServerName**: `string` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:195](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L195) - -___ - -### SkipDeserializationForBasicTypes - -• `Optional` **SkipDeserializationForBasicTypes**: `boolean` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:189](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L189) - -___ - -### SlowResponseThresholdMs - -• `Optional` **SlowResponseThresholdMs**: `number` - -Gets or sets the threshold for the slow response time warning in ms. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:279](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L279) - -___ - -### SortRemoveCharacters - -• `Optional` **SortRemoveCharacters**: `string`[] - -Gets or sets characters to be removed from strings to create a sort name. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:129](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L129) - -___ - -### SortRemoveWords - -• `Optional` **SortRemoveWords**: `string`[] - -Gets or sets words to be removed from strings to create a sort name. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:135](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L135) - -___ - -### SortReplaceCharacters - -• `Optional` **SortReplaceCharacters**: `string`[] - -Gets or sets characters to be replaced with a \' \' in strings to create a sort name. - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:123](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L123) - -___ - -### UICulture - -• `Optional` **UICulture**: `string` - -**`memberof`** ServerConfiguration - -#### Defined in - -[generated-client/models/server-configuration.ts:201](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-configuration.ts#L201) diff --git a/docs/interfaces/generated_client.ServerDiscoveryInfo.md b/docs/interfaces/generated_client.ServerDiscoveryInfo.md deleted file mode 100644 index 524f9e1dc..000000000 --- a/docs/interfaces/generated_client.ServerDiscoveryInfo.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ServerDiscoveryInfo - -# Interface: ServerDiscoveryInfo - -[generated-client](../modules/generated_client.md).ServerDiscoveryInfo - -The server discovery info model. - -**`export`** - -**`interface`** ServerDiscoveryInfo - -## Table of contents - -### Properties - -- [Address](generated_client.ServerDiscoveryInfo.md#address) -- [EndpointAddress](generated_client.ServerDiscoveryInfo.md#endpointaddress) -- [Id](generated_client.ServerDiscoveryInfo.md#id) -- [Name](generated_client.ServerDiscoveryInfo.md#name) - -## Properties - -### Address - -• `Optional` **Address**: `string` - -Gets the address. - -**`memberof`** ServerDiscoveryInfo - -#### Defined in - -[generated-client/models/server-discovery-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-discovery-info.ts#L28) - -___ - -### EndpointAddress - -• `Optional` **EndpointAddress**: ``null`` \| `string` - -Gets the endpoint address. - -**`memberof`** ServerDiscoveryInfo - -#### Defined in - -[generated-client/models/server-discovery-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-discovery-info.ts#L46) - -___ - -### Id - -• `Optional` **Id**: `string` - -Gets the server identifier. - -**`memberof`** ServerDiscoveryInfo - -#### Defined in - -[generated-client/models/server-discovery-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-discovery-info.ts#L34) - -___ - -### Name - -• `Optional` **Name**: `string` - -Gets the name. - -**`memberof`** ServerDiscoveryInfo - -#### Defined in - -[generated-client/models/server-discovery-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/server-discovery-info.ts#L40) diff --git a/docs/interfaces/generated_client.SessionApiAddUserToSessionRequest.md b/docs/interfaces/generated_client.SessionApiAddUserToSessionRequest.md deleted file mode 100644 index d13418702..000000000 --- a/docs/interfaces/generated_client.SessionApiAddUserToSessionRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiAddUserToSessionRequest - -# Interface: SessionApiAddUserToSessionRequest - -[generated-client](../modules/generated_client.md).SessionApiAddUserToSessionRequest - -Request parameters for addUserToSession operation in SessionApi. - -**`export`** - -**`interface`** SessionApiAddUserToSessionRequest - -## Table of contents - -### Properties - -- [sessionId](generated_client.SessionApiAddUserToSessionRequest.md#sessionid) -- [userId](generated_client.SessionApiAddUserToSessionRequest.md#userid) - -## Properties - -### sessionId - -• `Readonly` **sessionId**: `string` - -The session id. - -**`memberof`** SessionApiAddUserToSession - -#### Defined in - -[generated-client/api/session-api.ts:1201](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1201) - -___ - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** SessionApiAddUserToSession - -#### Defined in - -[generated-client/api/session-api.ts:1208](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1208) diff --git a/docs/interfaces/generated_client.SessionApiDisplayContentRequest.md b/docs/interfaces/generated_client.SessionApiDisplayContentRequest.md deleted file mode 100644 index 8c573d3d3..000000000 --- a/docs/interfaces/generated_client.SessionApiDisplayContentRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiDisplayContentRequest - -# Interface: SessionApiDisplayContentRequest - -[generated-client](../modules/generated_client.md).SessionApiDisplayContentRequest - -Request parameters for displayContent operation in SessionApi. - -**`export`** - -**`interface`** SessionApiDisplayContentRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.SessionApiDisplayContentRequest.md#itemid) -- [itemName](generated_client.SessionApiDisplayContentRequest.md#itemname) -- [itemType](generated_client.SessionApiDisplayContentRequest.md#itemtype) -- [sessionId](generated_client.SessionApiDisplayContentRequest.md#sessionid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The Id of the item. - -**`memberof`** SessionApiDisplayContent - -#### Defined in - -[generated-client/api/session-api.ts:1236](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1236) - -___ - -### itemName - -• `Readonly` **itemName**: `string` - -The name of the item. - -**`memberof`** SessionApiDisplayContent - -#### Defined in - -[generated-client/api/session-api.ts:1243](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1243) - -___ - -### itemType - -• `Readonly` **itemType**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md) - -The type of item to browse to. - -**`memberof`** SessionApiDisplayContent - -#### Defined in - -[generated-client/api/session-api.ts:1229](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1229) - -___ - -### sessionId - -• `Readonly` **sessionId**: `string` - -The session Id. - -**`memberof`** SessionApiDisplayContent - -#### Defined in - -[generated-client/api/session-api.ts:1222](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1222) diff --git a/docs/interfaces/generated_client.SessionApiGetSessionsRequest.md b/docs/interfaces/generated_client.SessionApiGetSessionsRequest.md deleted file mode 100644 index 3944769fb..000000000 --- a/docs/interfaces/generated_client.SessionApiGetSessionsRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiGetSessionsRequest - -# Interface: SessionApiGetSessionsRequest - -[generated-client](../modules/generated_client.md).SessionApiGetSessionsRequest - -Request parameters for getSessions operation in SessionApi. - -**`export`** - -**`interface`** SessionApiGetSessionsRequest - -## Table of contents - -### Properties - -- [activeWithinSeconds](generated_client.SessionApiGetSessionsRequest.md#activewithinseconds) -- [controllableByUserId](generated_client.SessionApiGetSessionsRequest.md#controllablebyuserid) -- [deviceId](generated_client.SessionApiGetSessionsRequest.md#deviceid) - -## Properties - -### activeWithinSeconds - -• `Optional` `Readonly` **activeWithinSeconds**: `number` - -Optional. Filter by sessions that were active in the last n seconds. - -**`memberof`** SessionApiGetSessions - -#### Defined in - -[generated-client/api/session-api.ts:1271](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1271) - -___ - -### controllableByUserId - -• `Optional` `Readonly` **controllableByUserId**: `string` - -Filter by sessions that a given user is allowed to remote control. - -**`memberof`** SessionApiGetSessions - -#### Defined in - -[generated-client/api/session-api.ts:1257](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1257) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -Filter by device Id. - -**`memberof`** SessionApiGetSessions - -#### Defined in - -[generated-client/api/session-api.ts:1264](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1264) diff --git a/docs/interfaces/generated_client.SessionApiPlayRequest.md b/docs/interfaces/generated_client.SessionApiPlayRequest.md deleted file mode 100644 index 46bdb27ff..000000000 --- a/docs/interfaces/generated_client.SessionApiPlayRequest.md +++ /dev/null @@ -1,136 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiPlayRequest - -# Interface: SessionApiPlayRequest - -[generated-client](../modules/generated_client.md).SessionApiPlayRequest - -Request parameters for play operation in SessionApi. - -**`export`** - -**`interface`** SessionApiPlayRequest - -## Table of contents - -### Properties - -- [audioStreamIndex](generated_client.SessionApiPlayRequest.md#audiostreamindex) -- [itemIds](generated_client.SessionApiPlayRequest.md#itemids) -- [mediaSourceId](generated_client.SessionApiPlayRequest.md#mediasourceid) -- [playCommand](generated_client.SessionApiPlayRequest.md#playcommand) -- [sessionId](generated_client.SessionApiPlayRequest.md#sessionid) -- [startIndex](generated_client.SessionApiPlayRequest.md#startindex) -- [startPositionTicks](generated_client.SessionApiPlayRequest.md#startpositionticks) -- [subtitleStreamIndex](generated_client.SessionApiPlayRequest.md#subtitlestreamindex) - -## Properties - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to play. - -**`memberof`** SessionApiPlay - -#### Defined in - -[generated-client/api/session-api.ts:1320](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1320) - -___ - -### itemIds - -• `Readonly` **itemIds**: `string`[] - -The ids of the items to play, comma delimited. - -**`memberof`** SessionApiPlay - -#### Defined in - -[generated-client/api/session-api.ts:1299](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1299) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -Optional. The media source id. - -**`memberof`** SessionApiPlay - -#### Defined in - -[generated-client/api/session-api.ts:1313](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1313) - -___ - -### playCommand - -• `Readonly` **playCommand**: [`PlayCommand`](../enums/generated_client.PlayCommand.md) - -The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now. - -**`memberof`** SessionApiPlay - -#### Defined in - -[generated-client/api/session-api.ts:1292](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1292) - -___ - -### sessionId - -• `Readonly` **sessionId**: `string` - -The session id. - -**`memberof`** SessionApiPlay - -#### Defined in - -[generated-client/api/session-api.ts:1285](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1285) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The start index. - -**`memberof`** SessionApiPlay - -#### Defined in - -[generated-client/api/session-api.ts:1334](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1334) - -___ - -### startPositionTicks - -• `Optional` `Readonly` **startPositionTicks**: `number` - -The starting position of the first item. - -**`memberof`** SessionApiPlay - -#### Defined in - -[generated-client/api/session-api.ts:1306](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1306) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to play. - -**`memberof`** SessionApiPlay - -#### Defined in - -[generated-client/api/session-api.ts:1327](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1327) diff --git a/docs/interfaces/generated_client.SessionApiPostCapabilitiesRequest.md b/docs/interfaces/generated_client.SessionApiPostCapabilitiesRequest.md deleted file mode 100644 index 812246bbb..000000000 --- a/docs/interfaces/generated_client.SessionApiPostCapabilitiesRequest.md +++ /dev/null @@ -1,106 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiPostCapabilitiesRequest - -# Interface: SessionApiPostCapabilitiesRequest - -[generated-client](../modules/generated_client.md).SessionApiPostCapabilitiesRequest - -Request parameters for postCapabilities operation in SessionApi. - -**`export`** - -**`interface`** SessionApiPostCapabilitiesRequest - -## Table of contents - -### Properties - -- [id](generated_client.SessionApiPostCapabilitiesRequest.md#id) -- [playableMediaTypes](generated_client.SessionApiPostCapabilitiesRequest.md#playablemediatypes) -- [supportedCommands](generated_client.SessionApiPostCapabilitiesRequest.md#supportedcommands) -- [supportsMediaControl](generated_client.SessionApiPostCapabilitiesRequest.md#supportsmediacontrol) -- [supportsPersistentIdentifier](generated_client.SessionApiPostCapabilitiesRequest.md#supportspersistentidentifier) -- [supportsSync](generated_client.SessionApiPostCapabilitiesRequest.md#supportssync) - -## Properties - -### id - -• `Optional` `Readonly` **id**: `string` - -The session id. - -**`memberof`** SessionApiPostCapabilities - -#### Defined in - -[generated-client/api/session-api.ts:1348](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1348) - -___ - -### playableMediaTypes - -• `Optional` `Readonly` **playableMediaTypes**: `string`[] - -A list of playable media types, comma delimited. Audio, Video, Book, Photo. - -**`memberof`** SessionApiPostCapabilities - -#### Defined in - -[generated-client/api/session-api.ts:1355](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1355) - -___ - -### supportedCommands - -• `Optional` `Readonly` **supportedCommands**: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md)[] - -A list of supported remote control commands, comma delimited. - -**`memberof`** SessionApiPostCapabilities - -#### Defined in - -[generated-client/api/session-api.ts:1362](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1362) - -___ - -### supportsMediaControl - -• `Optional` `Readonly` **supportsMediaControl**: `boolean` - -Determines whether media can be played remotely.. - -**`memberof`** SessionApiPostCapabilities - -#### Defined in - -[generated-client/api/session-api.ts:1369](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1369) - -___ - -### supportsPersistentIdentifier - -• `Optional` `Readonly` **supportsPersistentIdentifier**: `boolean` - -Determines whether the device supports a unique identifier. - -**`memberof`** SessionApiPostCapabilities - -#### Defined in - -[generated-client/api/session-api.ts:1383](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1383) - -___ - -### supportsSync - -• `Optional` `Readonly` **supportsSync**: `boolean` - -Determines whether sync is supported. - -**`memberof`** SessionApiPostCapabilities - -#### Defined in - -[generated-client/api/session-api.ts:1376](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1376) diff --git a/docs/interfaces/generated_client.SessionApiPostFullCapabilitiesRequest.md b/docs/interfaces/generated_client.SessionApiPostFullCapabilitiesRequest.md deleted file mode 100644 index dff403331..000000000 --- a/docs/interfaces/generated_client.SessionApiPostFullCapabilitiesRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiPostFullCapabilitiesRequest - -# Interface: SessionApiPostFullCapabilitiesRequest - -[generated-client](../modules/generated_client.md).SessionApiPostFullCapabilitiesRequest - -Request parameters for postFullCapabilities operation in SessionApi. - -**`export`** - -**`interface`** SessionApiPostFullCapabilitiesRequest - -## Table of contents - -### Properties - -- [clientCapabilitiesDto](generated_client.SessionApiPostFullCapabilitiesRequest.md#clientcapabilitiesdto) -- [id](generated_client.SessionApiPostFullCapabilitiesRequest.md#id) - -## Properties - -### clientCapabilitiesDto - -• `Readonly` **clientCapabilitiesDto**: [`ClientCapabilitiesDto`](generated_client.ClientCapabilitiesDto.md) - -The MediaBrowser.Model.Session.ClientCapabilities. - -**`memberof`** SessionApiPostFullCapabilities - -#### Defined in - -[generated-client/api/session-api.ts:1397](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1397) - -___ - -### id - -• `Optional` `Readonly` **id**: `string` - -The session id. - -**`memberof`** SessionApiPostFullCapabilities - -#### Defined in - -[generated-client/api/session-api.ts:1404](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1404) diff --git a/docs/interfaces/generated_client.SessionApiRemoveUserFromSessionRequest.md b/docs/interfaces/generated_client.SessionApiRemoveUserFromSessionRequest.md deleted file mode 100644 index eb9d03914..000000000 --- a/docs/interfaces/generated_client.SessionApiRemoveUserFromSessionRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiRemoveUserFromSessionRequest - -# Interface: SessionApiRemoveUserFromSessionRequest - -[generated-client](../modules/generated_client.md).SessionApiRemoveUserFromSessionRequest - -Request parameters for removeUserFromSession operation in SessionApi. - -**`export`** - -**`interface`** SessionApiRemoveUserFromSessionRequest - -## Table of contents - -### Properties - -- [sessionId](generated_client.SessionApiRemoveUserFromSessionRequest.md#sessionid) -- [userId](generated_client.SessionApiRemoveUserFromSessionRequest.md#userid) - -## Properties - -### sessionId - -• `Readonly` **sessionId**: `string` - -The session id. - -**`memberof`** SessionApiRemoveUserFromSession - -#### Defined in - -[generated-client/api/session-api.ts:1418](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1418) - -___ - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** SessionApiRemoveUserFromSession - -#### Defined in - -[generated-client/api/session-api.ts:1425](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1425) diff --git a/docs/interfaces/generated_client.SessionApiReportViewingRequest.md b/docs/interfaces/generated_client.SessionApiReportViewingRequest.md deleted file mode 100644 index 0fae1b2f3..000000000 --- a/docs/interfaces/generated_client.SessionApiReportViewingRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiReportViewingRequest - -# Interface: SessionApiReportViewingRequest - -[generated-client](../modules/generated_client.md).SessionApiReportViewingRequest - -Request parameters for reportViewing operation in SessionApi. - -**`export`** - -**`interface`** SessionApiReportViewingRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.SessionApiReportViewingRequest.md#itemid) -- [sessionId](generated_client.SessionApiReportViewingRequest.md#sessionid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** SessionApiReportViewing - -#### Defined in - -[generated-client/api/session-api.ts:1439](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1439) - -___ - -### sessionId - -• `Optional` `Readonly` **sessionId**: `string` - -The session id. - -**`memberof`** SessionApiReportViewing - -#### Defined in - -[generated-client/api/session-api.ts:1446](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1446) diff --git a/docs/interfaces/generated_client.SessionApiSendFullGeneralCommandRequest.md b/docs/interfaces/generated_client.SessionApiSendFullGeneralCommandRequest.md deleted file mode 100644 index 43ab51cbc..000000000 --- a/docs/interfaces/generated_client.SessionApiSendFullGeneralCommandRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiSendFullGeneralCommandRequest - -# Interface: SessionApiSendFullGeneralCommandRequest - -[generated-client](../modules/generated_client.md).SessionApiSendFullGeneralCommandRequest - -Request parameters for sendFullGeneralCommand operation in SessionApi. - -**`export`** - -**`interface`** SessionApiSendFullGeneralCommandRequest - -## Table of contents - -### Properties - -- [generalCommand](generated_client.SessionApiSendFullGeneralCommandRequest.md#generalcommand) -- [sessionId](generated_client.SessionApiSendFullGeneralCommandRequest.md#sessionid) - -## Properties - -### generalCommand - -• `Readonly` **generalCommand**: [`GeneralCommand`](generated_client.GeneralCommand.md) - -The MediaBrowser.Model.Session.GeneralCommand. - -**`memberof`** SessionApiSendFullGeneralCommand - -#### Defined in - -[generated-client/api/session-api.ts:1467](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1467) - -___ - -### sessionId - -• `Readonly` **sessionId**: `string` - -The session id. - -**`memberof`** SessionApiSendFullGeneralCommand - -#### Defined in - -[generated-client/api/session-api.ts:1460](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1460) diff --git a/docs/interfaces/generated_client.SessionApiSendGeneralCommandRequest.md b/docs/interfaces/generated_client.SessionApiSendGeneralCommandRequest.md deleted file mode 100644 index 69ef002d3..000000000 --- a/docs/interfaces/generated_client.SessionApiSendGeneralCommandRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiSendGeneralCommandRequest - -# Interface: SessionApiSendGeneralCommandRequest - -[generated-client](../modules/generated_client.md).SessionApiSendGeneralCommandRequest - -Request parameters for sendGeneralCommand operation in SessionApi. - -**`export`** - -**`interface`** SessionApiSendGeneralCommandRequest - -## Table of contents - -### Properties - -- [command](generated_client.SessionApiSendGeneralCommandRequest.md#command) -- [sessionId](generated_client.SessionApiSendGeneralCommandRequest.md#sessionid) - -## Properties - -### command - -• `Readonly` **command**: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md) - -The command to send. - -**`memberof`** SessionApiSendGeneralCommand - -#### Defined in - -[generated-client/api/session-api.ts:1488](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1488) - -___ - -### sessionId - -• `Readonly` **sessionId**: `string` - -The session id. - -**`memberof`** SessionApiSendGeneralCommand - -#### Defined in - -[generated-client/api/session-api.ts:1481](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1481) diff --git a/docs/interfaces/generated_client.SessionApiSendMessageCommandRequest.md b/docs/interfaces/generated_client.SessionApiSendMessageCommandRequest.md deleted file mode 100644 index 81af7429a..000000000 --- a/docs/interfaces/generated_client.SessionApiSendMessageCommandRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiSendMessageCommandRequest - -# Interface: SessionApiSendMessageCommandRequest - -[generated-client](../modules/generated_client.md).SessionApiSendMessageCommandRequest - -Request parameters for sendMessageCommand operation in SessionApi. - -**`export`** - -**`interface`** SessionApiSendMessageCommandRequest - -## Table of contents - -### Properties - -- [messageCommand](generated_client.SessionApiSendMessageCommandRequest.md#messagecommand) -- [sessionId](generated_client.SessionApiSendMessageCommandRequest.md#sessionid) - -## Properties - -### messageCommand - -• `Readonly` **messageCommand**: [`MessageCommand`](generated_client.MessageCommand.md) - -The MediaBrowser.Model.Session.MessageCommand object containing Header, Message Text, and TimeoutMs. - -**`memberof`** SessionApiSendMessageCommand - -#### Defined in - -[generated-client/api/session-api.ts:1509](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1509) - -___ - -### sessionId - -• `Readonly` **sessionId**: `string` - -The session id. - -**`memberof`** SessionApiSendMessageCommand - -#### Defined in - -[generated-client/api/session-api.ts:1502](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1502) diff --git a/docs/interfaces/generated_client.SessionApiSendPlaystateCommandRequest.md b/docs/interfaces/generated_client.SessionApiSendPlaystateCommandRequest.md deleted file mode 100644 index 0d1fcc1b7..000000000 --- a/docs/interfaces/generated_client.SessionApiSendPlaystateCommandRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiSendPlaystateCommandRequest - -# Interface: SessionApiSendPlaystateCommandRequest - -[generated-client](../modules/generated_client.md).SessionApiSendPlaystateCommandRequest - -Request parameters for sendPlaystateCommand operation in SessionApi. - -**`export`** - -**`interface`** SessionApiSendPlaystateCommandRequest - -## Table of contents - -### Properties - -- [command](generated_client.SessionApiSendPlaystateCommandRequest.md#command) -- [controllingUserId](generated_client.SessionApiSendPlaystateCommandRequest.md#controllinguserid) -- [seekPositionTicks](generated_client.SessionApiSendPlaystateCommandRequest.md#seekpositionticks) -- [sessionId](generated_client.SessionApiSendPlaystateCommandRequest.md#sessionid) - -## Properties - -### command - -• `Readonly` **command**: [`PlaystateCommand`](../enums/generated_client.PlaystateCommand.md) - -The MediaBrowser.Model.Session.PlaystateCommand. - -**`memberof`** SessionApiSendPlaystateCommand - -#### Defined in - -[generated-client/api/session-api.ts:1530](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1530) - -___ - -### controllingUserId - -• `Optional` `Readonly` **controllingUserId**: `string` - -The optional controlling user id. - -**`memberof`** SessionApiSendPlaystateCommand - -#### Defined in - -[generated-client/api/session-api.ts:1544](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1544) - -___ - -### seekPositionTicks - -• `Optional` `Readonly` **seekPositionTicks**: `number` - -The optional position ticks. - -**`memberof`** SessionApiSendPlaystateCommand - -#### Defined in - -[generated-client/api/session-api.ts:1537](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1537) - -___ - -### sessionId - -• `Readonly` **sessionId**: `string` - -The session id. - -**`memberof`** SessionApiSendPlaystateCommand - -#### Defined in - -[generated-client/api/session-api.ts:1523](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1523) diff --git a/docs/interfaces/generated_client.SessionApiSendSystemCommandRequest.md b/docs/interfaces/generated_client.SessionApiSendSystemCommandRequest.md deleted file mode 100644 index 75d75f016..000000000 --- a/docs/interfaces/generated_client.SessionApiSendSystemCommandRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApiSendSystemCommandRequest - -# Interface: SessionApiSendSystemCommandRequest - -[generated-client](../modules/generated_client.md).SessionApiSendSystemCommandRequest - -Request parameters for sendSystemCommand operation in SessionApi. - -**`export`** - -**`interface`** SessionApiSendSystemCommandRequest - -## Table of contents - -### Properties - -- [command](generated_client.SessionApiSendSystemCommandRequest.md#command) -- [sessionId](generated_client.SessionApiSendSystemCommandRequest.md#sessionid) - -## Properties - -### command - -• `Readonly` **command**: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md) - -The command to send. - -**`memberof`** SessionApiSendSystemCommand - -#### Defined in - -[generated-client/api/session-api.ts:1565](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1565) - -___ - -### sessionId - -• `Readonly` **sessionId**: `string` - -The session id. - -**`memberof`** SessionApiSendSystemCommand - -#### Defined in - -[generated-client/api/session-api.ts:1558](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1558) diff --git a/docs/interfaces/generated_client.SessionInfo.md b/docs/interfaces/generated_client.SessionInfo.md deleted file mode 100644 index f28c2f83e..000000000 --- a/docs/interfaces/generated_client.SessionInfo.md +++ /dev/null @@ -1,421 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionInfo - -# Interface: SessionInfo - -[generated-client](../modules/generated_client.md).SessionInfo - -Class SessionInfo. - -**`export`** - -**`interface`** SessionInfo - -## Table of contents - -### Properties - -- [AdditionalUsers](generated_client.SessionInfo.md#additionalusers) -- [ApplicationVersion](generated_client.SessionInfo.md#applicationversion) -- [Capabilities](generated_client.SessionInfo.md#capabilities) -- [Client](generated_client.SessionInfo.md#client) -- [DeviceId](generated_client.SessionInfo.md#deviceid) -- [DeviceName](generated_client.SessionInfo.md#devicename) -- [DeviceType](generated_client.SessionInfo.md#devicetype) -- [FullNowPlayingItem](generated_client.SessionInfo.md#fullnowplayingitem) -- [HasCustomDeviceName](generated_client.SessionInfo.md#hascustomdevicename) -- [Id](generated_client.SessionInfo.md#id) -- [IsActive](generated_client.SessionInfo.md#isactive) -- [LastActivityDate](generated_client.SessionInfo.md#lastactivitydate) -- [LastPlaybackCheckIn](generated_client.SessionInfo.md#lastplaybackcheckin) -- [NowPlayingItem](generated_client.SessionInfo.md#nowplayingitem) -- [NowPlayingQueue](generated_client.SessionInfo.md#nowplayingqueue) -- [NowPlayingQueueFullItems](generated_client.SessionInfo.md#nowplayingqueuefullitems) -- [NowViewingItem](generated_client.SessionInfo.md#nowviewingitem) -- [PlayState](generated_client.SessionInfo.md#playstate) -- [PlayableMediaTypes](generated_client.SessionInfo.md#playablemediatypes) -- [PlaylistItemId](generated_client.SessionInfo.md#playlistitemid) -- [RemoteEndPoint](generated_client.SessionInfo.md#remoteendpoint) -- [ServerId](generated_client.SessionInfo.md#serverid) -- [SupportedCommands](generated_client.SessionInfo.md#supportedcommands) -- [SupportsMediaControl](generated_client.SessionInfo.md#supportsmediacontrol) -- [SupportsRemoteControl](generated_client.SessionInfo.md#supportsremotecontrol) -- [TranscodingInfo](generated_client.SessionInfo.md#transcodinginfo) -- [UserId](generated_client.SessionInfo.md#userid) -- [UserName](generated_client.SessionInfo.md#username) -- [UserPrimaryImageTag](generated_client.SessionInfo.md#userprimaryimagetag) - -## Properties - -### AdditionalUsers - -• `Optional` **AdditionalUsers**: ``null`` \| [`SessionUserInfo`](generated_client.SessionUserInfo.md)[] - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L42) - -___ - -### ApplicationVersion - -• `Optional` **ApplicationVersion**: ``null`` \| `string` - -Gets or sets the application version. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:138](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L138) - -___ - -### Capabilities - -• `Optional` **Capabilities**: [`ClientCapabilities`](generated_client.ClientCapabilities.md) - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L48) - -___ - -### Client - -• `Optional` **Client**: ``null`` \| `string` - -Gets or sets the type of the client. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L84) - -___ - -### DeviceId - -• `Optional` **DeviceId**: ``null`` \| `string` - -Gets or sets the device id. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:132](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L132) - -___ - -### DeviceName - -• `Optional` **DeviceName**: ``null`` \| `string` - -Gets or sets the name of the device. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:102](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L102) - -___ - -### DeviceType - -• `Optional` **DeviceType**: ``null`` \| `string` - -Gets or sets the type of the device. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:108](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L108) - -___ - -### FullNowPlayingItem - -• `Optional` **FullNowPlayingItem**: [`BaseItem`](generated_client.BaseItem.md) - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:120](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L120) - -___ - -### HasCustomDeviceName - -• `Optional` **HasCustomDeviceName**: `boolean` - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:180](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L180) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets the id. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L66) - -___ - -### IsActive - -• `Optional` **IsActive**: `boolean` - -Gets a value indicating whether this instance is active. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:150](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L150) - -___ - -### LastActivityDate - -• `Optional` **LastActivityDate**: `string` - -Gets or sets the last activity date. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:90](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L90) - -___ - -### LastPlaybackCheckIn - -• `Optional` **LastPlaybackCheckIn**: `string` - -Gets or sets the last playback check in. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:96](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L96) - -___ - -### NowPlayingItem - -• `Optional` **NowPlayingItem**: [`BaseItemDto`](generated_client.BaseItemDto.md) - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:114](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L114) - -___ - -### NowPlayingQueue - -• `Optional` **NowPlayingQueue**: ``null`` \| [`QueueItem`](generated_client.QueueItem.md)[] - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:168](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L168) - -___ - -### NowPlayingQueueFullItems - -• `Optional` **NowPlayingQueueFullItems**: ``null`` \| [`BaseItemDto`](generated_client.BaseItemDto.md)[] - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:174](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L174) - -___ - -### NowViewingItem - -• `Optional` **NowViewingItem**: [`BaseItemDto`](generated_client.BaseItemDto.md) - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:126](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L126) - -___ - -### PlayState - -• `Optional` **PlayState**: [`PlayerStateInfo`](generated_client.PlayerStateInfo.md) - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L36) - -___ - -### PlayableMediaTypes - -• `Optional` **PlayableMediaTypes**: ``null`` \| `string`[] - -Gets the playable media types. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L60) - -___ - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: ``null`` \| `string` - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:186](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L186) - -___ - -### RemoteEndPoint - -• `Optional` **RemoteEndPoint**: ``null`` \| `string` - -Gets or sets the remote end point. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L54) - -___ - -### ServerId - -• `Optional` **ServerId**: ``null`` \| `string` - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:192](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L192) - -___ - -### SupportedCommands - -• `Optional` **SupportedCommands**: ``null`` \| [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md)[] - -Gets the supported commands. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:204](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L204) - -___ - -### SupportsMediaControl - -• `Optional` **SupportsMediaControl**: `boolean` - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:156](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L156) - -___ - -### SupportsRemoteControl - -• `Optional` **SupportsRemoteControl**: `boolean` - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:162](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L162) - -___ - -### TranscodingInfo - -• `Optional` **TranscodingInfo**: [`TranscodingInfo`](generated_client.TranscodingInfo.md) - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:144](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L144) - -___ - -### UserId - -• `Optional` **UserId**: `string` - -Gets or sets the user id. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L72) - -___ - -### UserName - -• `Optional` **UserName**: ``null`` \| `string` - -Gets or sets the username. - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L78) - -___ - -### UserPrimaryImageTag - -• `Optional` **UserPrimaryImageTag**: ``null`` \| `string` - -**`memberof`** SessionInfo - -#### Defined in - -[generated-client/models/session-info.ts:198](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-info.ts#L198) diff --git a/docs/interfaces/generated_client.SessionUserInfo.md b/docs/interfaces/generated_client.SessionUserInfo.md deleted file mode 100644 index 2d806d8b6..000000000 --- a/docs/interfaces/generated_client.SessionUserInfo.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionUserInfo - -# Interface: SessionUserInfo - -[generated-client](../modules/generated_client.md).SessionUserInfo - -Class SessionUserInfo. - -**`export`** - -**`interface`** SessionUserInfo - -## Table of contents - -### Properties - -- [UserId](generated_client.SessionUserInfo.md#userid) -- [UserName](generated_client.SessionUserInfo.md#username) - -## Properties - -### UserId - -• `Optional` **UserId**: `string` - -Gets or sets the user identifier. - -**`memberof`** SessionUserInfo - -#### Defined in - -[generated-client/models/session-user-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-user-info.ts#L28) - -___ - -### UserName - -• `Optional` **UserName**: ``null`` \| `string` - -Gets or sets the name of the user. - -**`memberof`** SessionUserInfo - -#### Defined in - -[generated-client/models/session-user-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/session-user-info.ts#L34) diff --git a/docs/interfaces/generated_client.SetChannelMappingDto.md b/docs/interfaces/generated_client.SetChannelMappingDto.md deleted file mode 100644 index 746c45b01..000000000 --- a/docs/interfaces/generated_client.SetChannelMappingDto.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SetChannelMappingDto - -# Interface: SetChannelMappingDto - -[generated-client](../modules/generated_client.md).SetChannelMappingDto - -Set channel mapping dto. - -**`export`** - -**`interface`** SetChannelMappingDto - -## Table of contents - -### Properties - -- [ProviderChannelId](generated_client.SetChannelMappingDto.md#providerchannelid) -- [ProviderId](generated_client.SetChannelMappingDto.md#providerid) -- [TunerChannelId](generated_client.SetChannelMappingDto.md#tunerchannelid) - -## Properties - -### ProviderChannelId - -• **ProviderChannelId**: `string` - -Gets or sets the provider channel id. - -**`memberof`** SetChannelMappingDto - -#### Defined in - -[generated-client/models/set-channel-mapping-dto.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/set-channel-mapping-dto.ts#L40) - -___ - -### ProviderId - -• **ProviderId**: `string` - -Gets or sets the provider id. - -**`memberof`** SetChannelMappingDto - -#### Defined in - -[generated-client/models/set-channel-mapping-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/set-channel-mapping-dto.ts#L28) - -___ - -### TunerChannelId - -• **TunerChannelId**: `string` - -Gets or sets the tuner channel id. - -**`memberof`** SetChannelMappingDto - -#### Defined in - -[generated-client/models/set-channel-mapping-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/set-channel-mapping-dto.ts#L34) diff --git a/docs/interfaces/generated_client.SetPlaylistItemRequestDto.md b/docs/interfaces/generated_client.SetPlaylistItemRequestDto.md deleted file mode 100644 index c5f79a2ee..000000000 --- a/docs/interfaces/generated_client.SetPlaylistItemRequestDto.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SetPlaylistItemRequestDto - -# Interface: SetPlaylistItemRequestDto - -[generated-client](../modules/generated_client.md).SetPlaylistItemRequestDto - -Class SetPlaylistItemRequestDto. - -**`export`** - -**`interface`** SetPlaylistItemRequestDto - -## Table of contents - -### Properties - -- [PlaylistItemId](generated_client.SetPlaylistItemRequestDto.md#playlistitemid) - -## Properties - -### PlaylistItemId - -• `Optional` **PlaylistItemId**: `string` - -Gets or sets the playlist identifier of the playing item. - -**`memberof`** SetPlaylistItemRequestDto - -#### Defined in - -[generated-client/models/set-playlist-item-request-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/set-playlist-item-request-dto.ts#L28) diff --git a/docs/interfaces/generated_client.SetRepeatModeRequestDto.md b/docs/interfaces/generated_client.SetRepeatModeRequestDto.md deleted file mode 100644 index 532dc74e4..000000000 --- a/docs/interfaces/generated_client.SetRepeatModeRequestDto.md +++ /dev/null @@ -1,29 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SetRepeatModeRequestDto - -# Interface: SetRepeatModeRequestDto - -[generated-client](../modules/generated_client.md).SetRepeatModeRequestDto - -Class SetRepeatModeRequestDto. - -**`export`** - -**`interface`** SetRepeatModeRequestDto - -## Table of contents - -### Properties - -- [Mode](generated_client.SetRepeatModeRequestDto.md#mode) - -## Properties - -### Mode - -• `Optional` **Mode**: [`GroupRepeatMode`](../enums/generated_client.GroupRepeatMode.md) - -**`memberof`** SetRepeatModeRequestDto - -#### Defined in - -[generated-client/models/set-repeat-mode-request-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/set-repeat-mode-request-dto.ts#L29) diff --git a/docs/interfaces/generated_client.SetShuffleModeRequestDto.md b/docs/interfaces/generated_client.SetShuffleModeRequestDto.md deleted file mode 100644 index 1d06172fc..000000000 --- a/docs/interfaces/generated_client.SetShuffleModeRequestDto.md +++ /dev/null @@ -1,29 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SetShuffleModeRequestDto - -# Interface: SetShuffleModeRequestDto - -[generated-client](../modules/generated_client.md).SetShuffleModeRequestDto - -Class SetShuffleModeRequestDto. - -**`export`** - -**`interface`** SetShuffleModeRequestDto - -## Table of contents - -### Properties - -- [Mode](generated_client.SetShuffleModeRequestDto.md#mode) - -## Properties - -### Mode - -• `Optional` **Mode**: [`GroupShuffleMode`](../enums/generated_client.GroupShuffleMode.md) - -**`memberof`** SetShuffleModeRequestDto - -#### Defined in - -[generated-client/models/set-shuffle-mode-request-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/set-shuffle-mode-request-dto.ts#L29) diff --git a/docs/interfaces/generated_client.SongInfo.md b/docs/interfaces/generated_client.SongInfo.md deleted file mode 100644 index 03b1d5f60..000000000 --- a/docs/interfaces/generated_client.SongInfo.md +++ /dev/null @@ -1,210 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SongInfo - -# Interface: SongInfo - -[generated-client](../modules/generated_client.md).SongInfo - -**`export`** - -**`interface`** SongInfo - -## Table of contents - -### Properties - -- [Album](generated_client.SongInfo.md#album) -- [AlbumArtists](generated_client.SongInfo.md#albumartists) -- [Artists](generated_client.SongInfo.md#artists) -- [IndexNumber](generated_client.SongInfo.md#indexnumber) -- [IsAutomated](generated_client.SongInfo.md#isautomated) -- [MetadataCountryCode](generated_client.SongInfo.md#metadatacountrycode) -- [MetadataLanguage](generated_client.SongInfo.md#metadatalanguage) -- [Name](generated_client.SongInfo.md#name) -- [OriginalTitle](generated_client.SongInfo.md#originaltitle) -- [ParentIndexNumber](generated_client.SongInfo.md#parentindexnumber) -- [Path](generated_client.SongInfo.md#path) -- [PremiereDate](generated_client.SongInfo.md#premieredate) -- [ProviderIds](generated_client.SongInfo.md#providerids) -- [Year](generated_client.SongInfo.md#year) - -## Properties - -### Album - -• `Optional` **Album**: ``null`` \| `string` - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:100](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L100) - -___ - -### AlbumArtists - -• `Optional` **AlbumArtists**: ``null`` \| `string`[] - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:94](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L94) - -___ - -### Artists - -• `Optional` **Artists**: ``null`` \| `string`[] - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:106](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L106) - -___ - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L70) - -___ - -### IsAutomated - -• `Optional` **IsAutomated**: `boolean` - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L88) - -___ - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: ``null`` \| `string` - -Gets or sets the metadata country code. - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L52) - -___ - -### MetadataLanguage - -• `Optional` **MetadataLanguage**: ``null`` \| `string` - -Gets or sets the metadata language. - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L46) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L28) - -___ - -### OriginalTitle - -• `Optional` **OriginalTitle**: ``null`` \| `string` - -Gets or sets the original title. - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L34) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L76) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L40) - -___ - -### PremiereDate - -• `Optional` **PremiereDate**: ``null`` \| `string` - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L82) - -___ - -### ProviderIds - -• `Optional` **ProviderIds**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the provider ids. - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L58) - -___ - -### Year - -• `Optional` **Year**: ``null`` \| `number` - -Gets or sets the year. - -**`memberof`** SongInfo - -#### Defined in - -[generated-client/models/song-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/song-info.ts#L64) diff --git a/docs/interfaces/generated_client.SpecialViewOptionDto.md b/docs/interfaces/generated_client.SpecialViewOptionDto.md deleted file mode 100644 index 3806dd76a..000000000 --- a/docs/interfaces/generated_client.SpecialViewOptionDto.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SpecialViewOptionDto - -# Interface: SpecialViewOptionDto - -[generated-client](../modules/generated_client.md).SpecialViewOptionDto - -Special view option dto. - -**`export`** - -**`interface`** SpecialViewOptionDto - -## Table of contents - -### Properties - -- [Id](generated_client.SpecialViewOptionDto.md#id) -- [Name](generated_client.SpecialViewOptionDto.md#name) - -## Properties - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets view option id. - -**`memberof`** SpecialViewOptionDto - -#### Defined in - -[generated-client/models/special-view-option-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/special-view-option-dto.ts#L34) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets view option name. - -**`memberof`** SpecialViewOptionDto - -#### Defined in - -[generated-client/models/special-view-option-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/special-view-option-dto.ts#L28) diff --git a/docs/interfaces/generated_client.StartupApiSetRemoteAccessRequest.md b/docs/interfaces/generated_client.StartupApiSetRemoteAccessRequest.md deleted file mode 100644 index 89c29ac74..000000000 --- a/docs/interfaces/generated_client.StartupApiSetRemoteAccessRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / StartupApiSetRemoteAccessRequest - -# Interface: StartupApiSetRemoteAccessRequest - -[generated-client](../modules/generated_client.md).StartupApiSetRemoteAccessRequest - -Request parameters for setRemoteAccess operation in StartupApi. - -**`export`** - -**`interface`** StartupApiSetRemoteAccessRequest - -## Table of contents - -### Properties - -- [startupRemoteAccessDto](generated_client.StartupApiSetRemoteAccessRequest.md#startupremoteaccessdto) - -## Properties - -### startupRemoteAccessDto - -• `Readonly` **startupRemoteAccessDto**: [`StartupRemoteAccessDto`](generated_client.StartupRemoteAccessDto.md) - -The startup remote access dto. - -**`memberof`** StartupApiSetRemoteAccess - -#### Defined in - -[generated-client/api/startup-api.ts:455](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L455) diff --git a/docs/interfaces/generated_client.StartupApiUpdateInitialConfigurationRequest.md b/docs/interfaces/generated_client.StartupApiUpdateInitialConfigurationRequest.md deleted file mode 100644 index 0da83f478..000000000 --- a/docs/interfaces/generated_client.StartupApiUpdateInitialConfigurationRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / StartupApiUpdateInitialConfigurationRequest - -# Interface: StartupApiUpdateInitialConfigurationRequest - -[generated-client](../modules/generated_client.md).StartupApiUpdateInitialConfigurationRequest - -Request parameters for updateInitialConfiguration operation in StartupApi. - -**`export`** - -**`interface`** StartupApiUpdateInitialConfigurationRequest - -## Table of contents - -### Properties - -- [startupConfigurationDto](generated_client.StartupApiUpdateInitialConfigurationRequest.md#startupconfigurationdto) - -## Properties - -### startupConfigurationDto - -• `Readonly` **startupConfigurationDto**: [`StartupConfigurationDto`](generated_client.StartupConfigurationDto.md) - -The updated startup configuration. - -**`memberof`** StartupApiUpdateInitialConfiguration - -#### Defined in - -[generated-client/api/startup-api.ts:469](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L469) diff --git a/docs/interfaces/generated_client.StartupApiUpdateStartupUserRequest.md b/docs/interfaces/generated_client.StartupApiUpdateStartupUserRequest.md deleted file mode 100644 index 9847972d9..000000000 --- a/docs/interfaces/generated_client.StartupApiUpdateStartupUserRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / StartupApiUpdateStartupUserRequest - -# Interface: StartupApiUpdateStartupUserRequest - -[generated-client](../modules/generated_client.md).StartupApiUpdateStartupUserRequest - -Request parameters for updateStartupUser operation in StartupApi. - -**`export`** - -**`interface`** StartupApiUpdateStartupUserRequest - -## Table of contents - -### Properties - -- [startupUserDto](generated_client.StartupApiUpdateStartupUserRequest.md#startupuserdto) - -## Properties - -### startupUserDto - -• `Optional` `Readonly` **startupUserDto**: [`StartupUserDto`](generated_client.StartupUserDto.md) - -The DTO containing username and password. - -**`memberof`** StartupApiUpdateStartupUser - -#### Defined in - -[generated-client/api/startup-api.ts:483](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L483) diff --git a/docs/interfaces/generated_client.StartupConfigurationDto.md b/docs/interfaces/generated_client.StartupConfigurationDto.md deleted file mode 100644 index aaf142caf..000000000 --- a/docs/interfaces/generated_client.StartupConfigurationDto.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / StartupConfigurationDto - -# Interface: StartupConfigurationDto - -[generated-client](../modules/generated_client.md).StartupConfigurationDto - -The startup configuration DTO. - -**`export`** - -**`interface`** StartupConfigurationDto - -## Table of contents - -### Properties - -- [MetadataCountryCode](generated_client.StartupConfigurationDto.md#metadatacountrycode) -- [PreferredMetadataLanguage](generated_client.StartupConfigurationDto.md#preferredmetadatalanguage) -- [UICulture](generated_client.StartupConfigurationDto.md#uiculture) - -## Properties - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: ``null`` \| `string` - -Gets or sets the metadata country code. - -**`memberof`** StartupConfigurationDto - -#### Defined in - -[generated-client/models/startup-configuration-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/startup-configuration-dto.ts#L34) - -___ - -### PreferredMetadataLanguage - -• `Optional` **PreferredMetadataLanguage**: ``null`` \| `string` - -Gets or sets the preferred language for the metadata. - -**`memberof`** StartupConfigurationDto - -#### Defined in - -[generated-client/models/startup-configuration-dto.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/startup-configuration-dto.ts#L40) - -___ - -### UICulture - -• `Optional` **UICulture**: ``null`` \| `string` - -Gets or sets UI language culture. - -**`memberof`** StartupConfigurationDto - -#### Defined in - -[generated-client/models/startup-configuration-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/startup-configuration-dto.ts#L28) diff --git a/docs/interfaces/generated_client.StartupRemoteAccessDto.md b/docs/interfaces/generated_client.StartupRemoteAccessDto.md deleted file mode 100644 index 6fc823a8b..000000000 --- a/docs/interfaces/generated_client.StartupRemoteAccessDto.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / StartupRemoteAccessDto - -# Interface: StartupRemoteAccessDto - -[generated-client](../modules/generated_client.md).StartupRemoteAccessDto - -Startup remote access dto. - -**`export`** - -**`interface`** StartupRemoteAccessDto - -## Table of contents - -### Properties - -- [EnableAutomaticPortMapping](generated_client.StartupRemoteAccessDto.md#enableautomaticportmapping) -- [EnableRemoteAccess](generated_client.StartupRemoteAccessDto.md#enableremoteaccess) - -## Properties - -### EnableAutomaticPortMapping - -• **EnableAutomaticPortMapping**: `boolean` - -Gets or sets a value indicating whether enable automatic port mapping. - -**`memberof`** StartupRemoteAccessDto - -#### Defined in - -[generated-client/models/startup-remote-access-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/startup-remote-access-dto.ts#L34) - -___ - -### EnableRemoteAccess - -• **EnableRemoteAccess**: `boolean` - -Gets or sets a value indicating whether enable remote access. - -**`memberof`** StartupRemoteAccessDto - -#### Defined in - -[generated-client/models/startup-remote-access-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/startup-remote-access-dto.ts#L28) diff --git a/docs/interfaces/generated_client.StartupUserDto.md b/docs/interfaces/generated_client.StartupUserDto.md deleted file mode 100644 index 374b79585..000000000 --- a/docs/interfaces/generated_client.StartupUserDto.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / StartupUserDto - -# Interface: StartupUserDto - -[generated-client](../modules/generated_client.md).StartupUserDto - -The startup user DTO. - -**`export`** - -**`interface`** StartupUserDto - -## Table of contents - -### Properties - -- [Name](generated_client.StartupUserDto.md#name) -- [Password](generated_client.StartupUserDto.md#password) - -## Properties - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the username. - -**`memberof`** StartupUserDto - -#### Defined in - -[generated-client/models/startup-user-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/startup-user-dto.ts#L28) - -___ - -### Password - -• `Optional` **Password**: ``null`` \| `string` - -Gets or sets the user\'s password. - -**`memberof`** StartupUserDto - -#### Defined in - -[generated-client/models/startup-user-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/startup-user-dto.ts#L34) diff --git a/docs/interfaces/generated_client.StudiosApiGetStudioRequest.md b/docs/interfaces/generated_client.StudiosApiGetStudioRequest.md deleted file mode 100644 index 8d47b997b..000000000 --- a/docs/interfaces/generated_client.StudiosApiGetStudioRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / StudiosApiGetStudioRequest - -# Interface: StudiosApiGetStudioRequest - -[generated-client](../modules/generated_client.md).StudiosApiGetStudioRequest - -Request parameters for getStudio operation in StudiosApi. - -**`export`** - -**`interface`** StudiosApiGetStudioRequest - -## Table of contents - -### Properties - -- [name](generated_client.StudiosApiGetStudioRequest.md#name) -- [userId](generated_client.StudiosApiGetStudioRequest.md#userid) - -## Properties - -### name - -• `Readonly` **name**: `string` - -Studio name. - -**`memberof`** StudiosApiGetStudio - -#### Defined in - -[generated-client/api/studios-api.ts:309](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L309) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** StudiosApiGetStudio - -#### Defined in - -[generated-client/api/studios-api.ts:316](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L316) diff --git a/docs/interfaces/generated_client.StudiosApiGetStudiosRequest.md b/docs/interfaces/generated_client.StudiosApiGetStudiosRequest.md deleted file mode 100644 index 212daf040..000000000 --- a/docs/interfaces/generated_client.StudiosApiGetStudiosRequest.md +++ /dev/null @@ -1,271 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / StudiosApiGetStudiosRequest - -# Interface: StudiosApiGetStudiosRequest - -[generated-client](../modules/generated_client.md).StudiosApiGetStudiosRequest - -Request parameters for getStudios operation in StudiosApi. - -**`export`** - -**`interface`** StudiosApiGetStudiosRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.StudiosApiGetStudiosRequest.md#enableimagetypes) -- [enableImages](generated_client.StudiosApiGetStudiosRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.StudiosApiGetStudiosRequest.md#enabletotalrecordcount) -- [enableUserData](generated_client.StudiosApiGetStudiosRequest.md#enableuserdata) -- [excludeItemTypes](generated_client.StudiosApiGetStudiosRequest.md#excludeitemtypes) -- [fields](generated_client.StudiosApiGetStudiosRequest.md#fields) -- [imageTypeLimit](generated_client.StudiosApiGetStudiosRequest.md#imagetypelimit) -- [includeItemTypes](generated_client.StudiosApiGetStudiosRequest.md#includeitemtypes) -- [isFavorite](generated_client.StudiosApiGetStudiosRequest.md#isfavorite) -- [limit](generated_client.StudiosApiGetStudiosRequest.md#limit) -- [nameLessThan](generated_client.StudiosApiGetStudiosRequest.md#namelessthan) -- [nameStartsWith](generated_client.StudiosApiGetStudiosRequest.md#namestartswith) -- [nameStartsWithOrGreater](generated_client.StudiosApiGetStudiosRequest.md#namestartswithorgreater) -- [parentId](generated_client.StudiosApiGetStudiosRequest.md#parentid) -- [searchTerm](generated_client.StudiosApiGetStudiosRequest.md#searchterm) -- [startIndex](generated_client.StudiosApiGetStudiosRequest.md#startindex) -- [userId](generated_client.StudiosApiGetStudiosRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:400](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L400) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional, include image information in output. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:435](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L435) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Total record count. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:442](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L442) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional, include user data. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:386](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L386) - -___ - -### excludeItemTypes - -• `Optional` `Readonly` **excludeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:365](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L365) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:358](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L358) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional, the max number of images to return, per image type. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:393](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L393) - -___ - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:372](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L372) - -___ - -### isFavorite - -• `Optional` `Readonly` **isFavorite**: `boolean` - -Optional filter by items that are marked as favorite, or not. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:379](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L379) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:337](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L337) - -___ - -### nameLessThan - -• `Optional` `Readonly` **nameLessThan**: `string` - -Optional filter by items whose name is equally or lesser than a given input string. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:428](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L428) - -___ - -### nameStartsWith - -• `Optional` `Readonly` **nameStartsWith**: `string` - -Optional filter by items whose name is sorted equally than a given input string. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:421](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L421) - -___ - -### nameStartsWithOrGreater - -• `Optional` `Readonly` **nameStartsWithOrGreater**: `string` - -Optional filter by items whose name is sorted equally or greater than a given input string. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:414](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L414) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:351](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L351) - -___ - -### searchTerm - -• `Optional` `Readonly` **searchTerm**: `string` - -Optional. Search term. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:344](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L344) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:330](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L330) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -User id. - -**`memberof`** StudiosApiGetStudios - -#### Defined in - -[generated-client/api/studios-api.ts:407](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L407) diff --git a/docs/interfaces/generated_client.SubtitleApiDeleteSubtitleRequest.md b/docs/interfaces/generated_client.SubtitleApiDeleteSubtitleRequest.md deleted file mode 100644 index 47a822710..000000000 --- a/docs/interfaces/generated_client.SubtitleApiDeleteSubtitleRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleApiDeleteSubtitleRequest - -# Interface: SubtitleApiDeleteSubtitleRequest - -[generated-client](../modules/generated_client.md).SubtitleApiDeleteSubtitleRequest - -Request parameters for deleteSubtitle operation in SubtitleApi. - -**`export`** - -**`interface`** SubtitleApiDeleteSubtitleRequest - -## Table of contents - -### Properties - -- [index](generated_client.SubtitleApiDeleteSubtitleRequest.md#index) -- [itemId](generated_client.SubtitleApiDeleteSubtitleRequest.md#itemid) - -## Properties - -### index - -• `Readonly` **index**: `number` - -The index of the subtitle file. - -**`memberof`** SubtitleApiDeleteSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:854](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L854) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** SubtitleApiDeleteSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:847](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L847) diff --git a/docs/interfaces/generated_client.SubtitleApiDownloadRemoteSubtitlesRequest.md b/docs/interfaces/generated_client.SubtitleApiDownloadRemoteSubtitlesRequest.md deleted file mode 100644 index f97358fc4..000000000 --- a/docs/interfaces/generated_client.SubtitleApiDownloadRemoteSubtitlesRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleApiDownloadRemoteSubtitlesRequest - -# Interface: SubtitleApiDownloadRemoteSubtitlesRequest - -[generated-client](../modules/generated_client.md).SubtitleApiDownloadRemoteSubtitlesRequest - -Request parameters for downloadRemoteSubtitles operation in SubtitleApi. - -**`export`** - -**`interface`** SubtitleApiDownloadRemoteSubtitlesRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.SubtitleApiDownloadRemoteSubtitlesRequest.md#itemid) -- [subtitleId](generated_client.SubtitleApiDownloadRemoteSubtitlesRequest.md#subtitleid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** SubtitleApiDownloadRemoteSubtitles - -#### Defined in - -[generated-client/api/subtitle-api.ts:868](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L868) - -___ - -### subtitleId - -• `Readonly` **subtitleId**: `string` - -The subtitle id. - -**`memberof`** SubtitleApiDownloadRemoteSubtitles - -#### Defined in - -[generated-client/api/subtitle-api.ts:875](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L875) diff --git a/docs/interfaces/generated_client.SubtitleApiGetFallbackFontRequest.md b/docs/interfaces/generated_client.SubtitleApiGetFallbackFontRequest.md deleted file mode 100644 index 006c452bd..000000000 --- a/docs/interfaces/generated_client.SubtitleApiGetFallbackFontRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleApiGetFallbackFontRequest - -# Interface: SubtitleApiGetFallbackFontRequest - -[generated-client](../modules/generated_client.md).SubtitleApiGetFallbackFontRequest - -Request parameters for getFallbackFont operation in SubtitleApi. - -**`export`** - -**`interface`** SubtitleApiGetFallbackFontRequest - -## Table of contents - -### Properties - -- [name](generated_client.SubtitleApiGetFallbackFontRequest.md#name) - -## Properties - -### name - -• `Readonly` **name**: `string` - -The name of the fallback font file to get. - -**`memberof`** SubtitleApiGetFallbackFont - -#### Defined in - -[generated-client/api/subtitle-api.ts:889](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L889) diff --git a/docs/interfaces/generated_client.SubtitleApiGetRemoteSubtitlesRequest.md b/docs/interfaces/generated_client.SubtitleApiGetRemoteSubtitlesRequest.md deleted file mode 100644 index 42eb2ac81..000000000 --- a/docs/interfaces/generated_client.SubtitleApiGetRemoteSubtitlesRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleApiGetRemoteSubtitlesRequest - -# Interface: SubtitleApiGetRemoteSubtitlesRequest - -[generated-client](../modules/generated_client.md).SubtitleApiGetRemoteSubtitlesRequest - -Request parameters for getRemoteSubtitles operation in SubtitleApi. - -**`export`** - -**`interface`** SubtitleApiGetRemoteSubtitlesRequest - -## Table of contents - -### Properties - -- [id](generated_client.SubtitleApiGetRemoteSubtitlesRequest.md#id) - -## Properties - -### id - -• `Readonly` **id**: `string` - -The item id. - -**`memberof`** SubtitleApiGetRemoteSubtitles - -#### Defined in - -[generated-client/api/subtitle-api.ts:903](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L903) diff --git a/docs/interfaces/generated_client.SubtitleApiGetSubtitlePlaylistRequest.md b/docs/interfaces/generated_client.SubtitleApiGetSubtitlePlaylistRequest.md deleted file mode 100644 index 01568e562..000000000 --- a/docs/interfaces/generated_client.SubtitleApiGetSubtitlePlaylistRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleApiGetSubtitlePlaylistRequest - -# Interface: SubtitleApiGetSubtitlePlaylistRequest - -[generated-client](../modules/generated_client.md).SubtitleApiGetSubtitlePlaylistRequest - -Request parameters for getSubtitlePlaylist operation in SubtitleApi. - -**`export`** - -**`interface`** SubtitleApiGetSubtitlePlaylistRequest - -## Table of contents - -### Properties - -- [index](generated_client.SubtitleApiGetSubtitlePlaylistRequest.md#index) -- [itemId](generated_client.SubtitleApiGetSubtitlePlaylistRequest.md#itemid) -- [mediaSourceId](generated_client.SubtitleApiGetSubtitlePlaylistRequest.md#mediasourceid) -- [segmentLength](generated_client.SubtitleApiGetSubtitlePlaylistRequest.md#segmentlength) - -## Properties - -### index - -• `Readonly` **index**: `number` - -The subtitle stream index. - -**`memberof`** SubtitleApiGetSubtitlePlaylist - -#### Defined in - -[generated-client/api/subtitle-api.ts:1015](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1015) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** SubtitleApiGetSubtitlePlaylist - -#### Defined in - -[generated-client/api/subtitle-api.ts:1008](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1008) - -___ - -### mediaSourceId - -• `Readonly` **mediaSourceId**: `string` - -The media source id. - -**`memberof`** SubtitleApiGetSubtitlePlaylist - -#### Defined in - -[generated-client/api/subtitle-api.ts:1022](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1022) - -___ - -### segmentLength - -• `Readonly` **segmentLength**: `number` - -The subtitle segment length. - -**`memberof`** SubtitleApiGetSubtitlePlaylist - -#### Defined in - -[generated-client/api/subtitle-api.ts:1029](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1029) diff --git a/docs/interfaces/generated_client.SubtitleApiGetSubtitleRequest.md b/docs/interfaces/generated_client.SubtitleApiGetSubtitleRequest.md deleted file mode 100644 index e14f0b04e..000000000 --- a/docs/interfaces/generated_client.SubtitleApiGetSubtitleRequest.md +++ /dev/null @@ -1,196 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleApiGetSubtitleRequest - -# Interface: SubtitleApiGetSubtitleRequest - -[generated-client](../modules/generated_client.md).SubtitleApiGetSubtitleRequest - -Request parameters for getSubtitle operation in SubtitleApi. - -**`export`** - -**`interface`** SubtitleApiGetSubtitleRequest - -## Table of contents - -### Properties - -- [addVttTimeMap](generated_client.SubtitleApiGetSubtitleRequest.md#addvtttimemap) -- [copyTimestamps](generated_client.SubtitleApiGetSubtitleRequest.md#copytimestamps) -- [endPositionTicks](generated_client.SubtitleApiGetSubtitleRequest.md#endpositionticks) -- [format](generated_client.SubtitleApiGetSubtitleRequest.md#format) -- [index](generated_client.SubtitleApiGetSubtitleRequest.md#index) -- [itemId](generated_client.SubtitleApiGetSubtitleRequest.md#itemid) -- [mediaSourceId](generated_client.SubtitleApiGetSubtitleRequest.md#mediasourceid) -- [routeFormat](generated_client.SubtitleApiGetSubtitleRequest.md#routeformat) -- [routeIndex](generated_client.SubtitleApiGetSubtitleRequest.md#routeindex) -- [routeItemId](generated_client.SubtitleApiGetSubtitleRequest.md#routeitemid) -- [routeMediaSourceId](generated_client.SubtitleApiGetSubtitleRequest.md#routemediasourceid) -- [startPositionTicks](generated_client.SubtitleApiGetSubtitleRequest.md#startpositionticks) - -## Properties - -### addVttTimeMap - -• `Optional` `Readonly` **addVttTimeMap**: `boolean` - -Optional. Whether to add a VTT time map. - -**`memberof`** SubtitleApiGetSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:987](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L987) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Optional. Whether to copy the timestamps. - -**`memberof`** SubtitleApiGetSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:980](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L980) - -___ - -### endPositionTicks - -• `Optional` `Readonly` **endPositionTicks**: `number` - -Optional. The end position of the subtitle in ticks. - -**`memberof`** SubtitleApiGetSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:973](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L973) - -___ - -### format - -• `Optional` `Readonly` **format**: `string` - -The format of the returned subtitle. - -**`memberof`** SubtitleApiGetSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:966](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L966) - -___ - -### index - -• `Optional` `Readonly` **index**: `number` - -The subtitle stream index. - -**`memberof`** SubtitleApiGetSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:959](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L959) - -___ - -### itemId - -• `Optional` `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** SubtitleApiGetSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:945](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L945) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media source id. - -**`memberof`** SubtitleApiGetSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:952](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L952) - -___ - -### routeFormat - -• `Readonly` **routeFormat**: `string` - -The (route) format of the returned subtitle. - -**`memberof`** SubtitleApiGetSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:938](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L938) - -___ - -### routeIndex - -• `Readonly` **routeIndex**: `number` - -The (route) subtitle stream index. - -**`memberof`** SubtitleApiGetSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:931](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L931) - -___ - -### routeItemId - -• `Readonly` **routeItemId**: `string` - -The (route) item id. - -**`memberof`** SubtitleApiGetSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:917](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L917) - -___ - -### routeMediaSourceId - -• `Readonly` **routeMediaSourceId**: `string` - -The (route) media source id. - -**`memberof`** SubtitleApiGetSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:924](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L924) - -___ - -### startPositionTicks - -• `Optional` `Readonly` **startPositionTicks**: `number` - -The start position of the subtitle in ticks. - -**`memberof`** SubtitleApiGetSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:994](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L994) diff --git a/docs/interfaces/generated_client.SubtitleApiGetSubtitleWithTicksRequest.md b/docs/interfaces/generated_client.SubtitleApiGetSubtitleWithTicksRequest.md deleted file mode 100644 index deeea781e..000000000 --- a/docs/interfaces/generated_client.SubtitleApiGetSubtitleWithTicksRequest.md +++ /dev/null @@ -1,211 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleApiGetSubtitleWithTicksRequest - -# Interface: SubtitleApiGetSubtitleWithTicksRequest - -[generated-client](../modules/generated_client.md).SubtitleApiGetSubtitleWithTicksRequest - -Request parameters for getSubtitleWithTicks operation in SubtitleApi. - -**`export`** - -**`interface`** SubtitleApiGetSubtitleWithTicksRequest - -## Table of contents - -### Properties - -- [addVttTimeMap](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#addvtttimemap) -- [copyTimestamps](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#copytimestamps) -- [endPositionTicks](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#endpositionticks) -- [format](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#format) -- [index](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#index) -- [itemId](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#itemid) -- [mediaSourceId](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#mediasourceid) -- [routeFormat](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#routeformat) -- [routeIndex](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#routeindex) -- [routeItemId](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#routeitemid) -- [routeMediaSourceId](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#routemediasourceid) -- [routeStartPositionTicks](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#routestartpositionticks) -- [startPositionTicks](generated_client.SubtitleApiGetSubtitleWithTicksRequest.md#startpositionticks) - -## Properties - -### addVttTimeMap - -• `Optional` `Readonly` **addVttTimeMap**: `boolean` - -Optional. Whether to add a VTT time map. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1127](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1127) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Optional. Whether to copy the timestamps. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1120](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1120) - -___ - -### endPositionTicks - -• `Optional` `Readonly` **endPositionTicks**: `number` - -Optional. The end position of the subtitle in ticks. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1113](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1113) - -___ - -### format - -• `Optional` `Readonly` **format**: `string` - -The format of the returned subtitle. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1106](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1106) - -___ - -### index - -• `Optional` `Readonly` **index**: `number` - -The subtitle stream index. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1092](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1092) - -___ - -### itemId - -• `Optional` `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1078](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1078) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media source id. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1085](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1085) - -___ - -### routeFormat - -• `Readonly` **routeFormat**: `string` - -The (route) format of the returned subtitle. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1071](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1071) - -___ - -### routeIndex - -• `Readonly` **routeIndex**: `number` - -The (route) subtitle stream index. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1057](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1057) - -___ - -### routeItemId - -• `Readonly` **routeItemId**: `string` - -The (route) item id. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1043](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1043) - -___ - -### routeMediaSourceId - -• `Readonly` **routeMediaSourceId**: `string` - -The (route) media source id. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1050](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1050) - -___ - -### routeStartPositionTicks - -• `Readonly` **routeStartPositionTicks**: `number` - -The (route) start position of the subtitle in ticks. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1064](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1064) - -___ - -### startPositionTicks - -• `Optional` `Readonly` **startPositionTicks**: `number` - -The start position of the subtitle in ticks. - -**`memberof`** SubtitleApiGetSubtitleWithTicks - -#### Defined in - -[generated-client/api/subtitle-api.ts:1099](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1099) diff --git a/docs/interfaces/generated_client.SubtitleApiSearchRemoteSubtitlesRequest.md b/docs/interfaces/generated_client.SubtitleApiSearchRemoteSubtitlesRequest.md deleted file mode 100644 index 0b2460157..000000000 --- a/docs/interfaces/generated_client.SubtitleApiSearchRemoteSubtitlesRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleApiSearchRemoteSubtitlesRequest - -# Interface: SubtitleApiSearchRemoteSubtitlesRequest - -[generated-client](../modules/generated_client.md).SubtitleApiSearchRemoteSubtitlesRequest - -Request parameters for searchRemoteSubtitles operation in SubtitleApi. - -**`export`** - -**`interface`** SubtitleApiSearchRemoteSubtitlesRequest - -## Table of contents - -### Properties - -- [isPerfectMatch](generated_client.SubtitleApiSearchRemoteSubtitlesRequest.md#isperfectmatch) -- [itemId](generated_client.SubtitleApiSearchRemoteSubtitlesRequest.md#itemid) -- [language](generated_client.SubtitleApiSearchRemoteSubtitlesRequest.md#language) - -## Properties - -### isPerfectMatch - -• `Optional` `Readonly` **isPerfectMatch**: `boolean` - -Optional. Only show subtitles which are a perfect match. - -**`memberof`** SubtitleApiSearchRemoteSubtitles - -#### Defined in - -[generated-client/api/subtitle-api.ts:1155](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1155) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** SubtitleApiSearchRemoteSubtitles - -#### Defined in - -[generated-client/api/subtitle-api.ts:1141](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1141) - -___ - -### language - -• `Readonly` **language**: `string` - -The language of the subtitles. - -**`memberof`** SubtitleApiSearchRemoteSubtitles - -#### Defined in - -[generated-client/api/subtitle-api.ts:1148](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1148) diff --git a/docs/interfaces/generated_client.SubtitleApiUploadSubtitleRequest.md b/docs/interfaces/generated_client.SubtitleApiUploadSubtitleRequest.md deleted file mode 100644 index a324d4b04..000000000 --- a/docs/interfaces/generated_client.SubtitleApiUploadSubtitleRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleApiUploadSubtitleRequest - -# Interface: SubtitleApiUploadSubtitleRequest - -[generated-client](../modules/generated_client.md).SubtitleApiUploadSubtitleRequest - -Request parameters for uploadSubtitle operation in SubtitleApi. - -**`export`** - -**`interface`** SubtitleApiUploadSubtitleRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.SubtitleApiUploadSubtitleRequest.md#itemid) -- [uploadSubtitleDto](generated_client.SubtitleApiUploadSubtitleRequest.md#uploadsubtitledto) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item the subtitle belongs to. - -**`memberof`** SubtitleApiUploadSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:1169](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1169) - -___ - -### uploadSubtitleDto - -• `Readonly` **uploadSubtitleDto**: [`UploadSubtitleDto`](generated_client.UploadSubtitleDto.md) - -The request body. - -**`memberof`** SubtitleApiUploadSubtitle - -#### Defined in - -[generated-client/api/subtitle-api.ts:1176](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1176) diff --git a/docs/interfaces/generated_client.SubtitleOptions.md b/docs/interfaces/generated_client.SubtitleOptions.md deleted file mode 100644 index d376a4105..000000000 --- a/docs/interfaces/generated_client.SubtitleOptions.md +++ /dev/null @@ -1,131 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleOptions - -# Interface: SubtitleOptions - -[generated-client](../modules/generated_client.md).SubtitleOptions - -**`export`** - -**`interface`** SubtitleOptions - -## Table of contents - -### Properties - -- [DownloadEpisodeSubtitles](generated_client.SubtitleOptions.md#downloadepisodesubtitles) -- [DownloadLanguages](generated_client.SubtitleOptions.md#downloadlanguages) -- [DownloadMovieSubtitles](generated_client.SubtitleOptions.md#downloadmoviesubtitles) -- [IsOpenSubtitleVipAccount](generated_client.SubtitleOptions.md#isopensubtitlevipaccount) -- [OpenSubtitlesPasswordHash](generated_client.SubtitleOptions.md#opensubtitlespasswordhash) -- [OpenSubtitlesUsername](generated_client.SubtitleOptions.md#opensubtitlesusername) -- [RequirePerfectMatch](generated_client.SubtitleOptions.md#requireperfectmatch) -- [SkipIfAudioTrackMatches](generated_client.SubtitleOptions.md#skipifaudiotrackmatches) -- [SkipIfEmbeddedSubtitlesPresent](generated_client.SubtitleOptions.md#skipifembeddedsubtitlespresent) - -## Properties - -### DownloadEpisodeSubtitles - -• `Optional` **DownloadEpisodeSubtitles**: `boolean` - -**`memberof`** SubtitleOptions - -#### Defined in - -[generated-client/models/subtitle-options.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-options.ts#L52) - -___ - -### DownloadLanguages - -• `Optional` **DownloadLanguages**: ``null`` \| `string`[] - -**`memberof`** SubtitleOptions - -#### Defined in - -[generated-client/models/subtitle-options.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-options.ts#L40) - -___ - -### DownloadMovieSubtitles - -• `Optional` **DownloadMovieSubtitles**: `boolean` - -**`memberof`** SubtitleOptions - -#### Defined in - -[generated-client/models/subtitle-options.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-options.ts#L46) - -___ - -### IsOpenSubtitleVipAccount - -• `Optional` **IsOpenSubtitleVipAccount**: `boolean` - -**`memberof`** SubtitleOptions - -#### Defined in - -[generated-client/models/subtitle-options.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-options.ts#L70) - -___ - -### OpenSubtitlesPasswordHash - -• `Optional` **OpenSubtitlesPasswordHash**: ``null`` \| `string` - -**`memberof`** SubtitleOptions - -#### Defined in - -[generated-client/models/subtitle-options.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-options.ts#L64) - -___ - -### OpenSubtitlesUsername - -• `Optional` **OpenSubtitlesUsername**: ``null`` \| `string` - -**`memberof`** SubtitleOptions - -#### Defined in - -[generated-client/models/subtitle-options.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-options.ts#L58) - -___ - -### RequirePerfectMatch - -• `Optional` **RequirePerfectMatch**: `boolean` - -**`memberof`** SubtitleOptions - -#### Defined in - -[generated-client/models/subtitle-options.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-options.ts#L76) - -___ - -### SkipIfAudioTrackMatches - -• `Optional` **SkipIfAudioTrackMatches**: `boolean` - -**`memberof`** SubtitleOptions - -#### Defined in - -[generated-client/models/subtitle-options.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-options.ts#L34) - -___ - -### SkipIfEmbeddedSubtitlesPresent - -• `Optional` **SkipIfEmbeddedSubtitlesPresent**: `boolean` - -**`memberof`** SubtitleOptions - -#### Defined in - -[generated-client/models/subtitle-options.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-options.ts#L28) diff --git a/docs/interfaces/generated_client.SubtitleProfile.md b/docs/interfaces/generated_client.SubtitleProfile.md deleted file mode 100644 index 6a5181f7e..000000000 --- a/docs/interfaces/generated_client.SubtitleProfile.md +++ /dev/null @@ -1,79 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleProfile - -# Interface: SubtitleProfile - -[generated-client](../modules/generated_client.md).SubtitleProfile - -**`export`** - -**`interface`** SubtitleProfile - -## Table of contents - -### Properties - -- [Container](generated_client.SubtitleProfile.md#container) -- [DidlMode](generated_client.SubtitleProfile.md#didlmode) -- [Format](generated_client.SubtitleProfile.md#format) -- [Language](generated_client.SubtitleProfile.md#language) -- [Method](generated_client.SubtitleProfile.md#method) - -## Properties - -### Container - -• `Optional` **Container**: ``null`` \| `string` - -**`memberof`** SubtitleProfile - -#### Defined in - -[generated-client/models/subtitle-profile.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-profile.ts#L53) - -___ - -### DidlMode - -• `Optional` **DidlMode**: ``null`` \| `string` - -**`memberof`** SubtitleProfile - -#### Defined in - -[generated-client/models/subtitle-profile.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-profile.ts#L41) - -___ - -### Format - -• `Optional` **Format**: ``null`` \| `string` - -**`memberof`** SubtitleProfile - -#### Defined in - -[generated-client/models/subtitle-profile.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-profile.ts#L29) - -___ - -### Language - -• `Optional` **Language**: ``null`` \| `string` - -**`memberof`** SubtitleProfile - -#### Defined in - -[generated-client/models/subtitle-profile.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-profile.ts#L47) - -___ - -### Method - -• `Optional` **Method**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -**`memberof`** SubtitleProfile - -#### Defined in - -[generated-client/models/subtitle-profile.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/subtitle-profile.ts#L35) diff --git a/docs/interfaces/generated_client.SuggestionsApiGetSuggestionsRequest.md b/docs/interfaces/generated_client.SuggestionsApiGetSuggestionsRequest.md deleted file mode 100644 index 1a9fec72b..000000000 --- a/docs/interfaces/generated_client.SuggestionsApiGetSuggestionsRequest.md +++ /dev/null @@ -1,106 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SuggestionsApiGetSuggestionsRequest - -# Interface: SuggestionsApiGetSuggestionsRequest - -[generated-client](../modules/generated_client.md).SuggestionsApiGetSuggestionsRequest - -Request parameters for getSuggestions operation in SuggestionsApi. - -**`export`** - -**`interface`** SuggestionsApiGetSuggestionsRequest - -## Table of contents - -### Properties - -- [enableTotalRecordCount](generated_client.SuggestionsApiGetSuggestionsRequest.md#enabletotalrecordcount) -- [limit](generated_client.SuggestionsApiGetSuggestionsRequest.md#limit) -- [mediaType](generated_client.SuggestionsApiGetSuggestionsRequest.md#mediatype) -- [startIndex](generated_client.SuggestionsApiGetSuggestionsRequest.md#startindex) -- [type](generated_client.SuggestionsApiGetSuggestionsRequest.md#type) -- [userId](generated_client.SuggestionsApiGetSuggestionsRequest.md#userid) - -## Properties - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Whether to enable the total record count. - -**`memberof`** SuggestionsApiGetSuggestions - -#### Defined in - -[generated-client/api/suggestions-api.ts:195](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/suggestions-api.ts#L195) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The limit. - -**`memberof`** SuggestionsApiGetSuggestions - -#### Defined in - -[generated-client/api/suggestions-api.ts:188](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/suggestions-api.ts#L188) - -___ - -### mediaType - -• `Optional` `Readonly` **mediaType**: `string`[] - -The media types. - -**`memberof`** SuggestionsApiGetSuggestions - -#### Defined in - -[generated-client/api/suggestions-api.ts:167](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/suggestions-api.ts#L167) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The start index. - -**`memberof`** SuggestionsApiGetSuggestions - -#### Defined in - -[generated-client/api/suggestions-api.ts:181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/suggestions-api.ts#L181) - -___ - -### type - -• `Optional` `Readonly` **type**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -The type. - -**`memberof`** SuggestionsApiGetSuggestions - -#### Defined in - -[generated-client/api/suggestions-api.ts:174](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/suggestions-api.ts#L174) - -___ - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** SuggestionsApiGetSuggestions - -#### Defined in - -[generated-client/api/suggestions-api.ts:160](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/suggestions-api.ts#L160) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlayBufferingRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlayBufferingRequest.md deleted file mode 100644 index f35664405..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlayBufferingRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlayBufferingRequest - -# Interface: SyncPlayApiSyncPlayBufferingRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlayBufferingRequest - -Request parameters for syncPlayBuffering operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlayBufferingRequest - -## Table of contents - -### Properties - -- [bufferRequestDto](generated_client.SyncPlayApiSyncPlayBufferingRequest.md#bufferrequestdto) - -## Properties - -### bufferRequestDto - -• `Readonly` **bufferRequestDto**: [`BufferRequestDto`](generated_client.BufferRequestDto.md) - -The player status. - -**`memberof`** SyncPlayApiSyncPlayBuffering - -#### Defined in - -[generated-client/api/sync-play-api.ts:1317](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1317) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlayCreateGroupRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlayCreateGroupRequest.md deleted file mode 100644 index b9597dc10..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlayCreateGroupRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlayCreateGroupRequest - -# Interface: SyncPlayApiSyncPlayCreateGroupRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlayCreateGroupRequest - -Request parameters for syncPlayCreateGroup operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlayCreateGroupRequest - -## Table of contents - -### Properties - -- [newGroupRequestDto](generated_client.SyncPlayApiSyncPlayCreateGroupRequest.md#newgrouprequestdto) - -## Properties - -### newGroupRequestDto - -• `Readonly` **newGroupRequestDto**: [`NewGroupRequestDto`](generated_client.NewGroupRequestDto.md) - -The settings of the new group. - -**`memberof`** SyncPlayApiSyncPlayCreateGroup - -#### Defined in - -[generated-client/api/sync-play-api.ts:1331](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1331) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlayJoinGroupRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlayJoinGroupRequest.md deleted file mode 100644 index 1ad5db881..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlayJoinGroupRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlayJoinGroupRequest - -# Interface: SyncPlayApiSyncPlayJoinGroupRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlayJoinGroupRequest - -Request parameters for syncPlayJoinGroup operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlayJoinGroupRequest - -## Table of contents - -### Properties - -- [joinGroupRequestDto](generated_client.SyncPlayApiSyncPlayJoinGroupRequest.md#joingrouprequestdto) - -## Properties - -### joinGroupRequestDto - -• `Readonly` **joinGroupRequestDto**: [`JoinGroupRequestDto`](generated_client.JoinGroupRequestDto.md) - -The group to join. - -**`memberof`** SyncPlayApiSyncPlayJoinGroup - -#### Defined in - -[generated-client/api/sync-play-api.ts:1345](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1345) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlayMovePlaylistItemRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlayMovePlaylistItemRequest.md deleted file mode 100644 index e9105381a..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlayMovePlaylistItemRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlayMovePlaylistItemRequest - -# Interface: SyncPlayApiSyncPlayMovePlaylistItemRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlayMovePlaylistItemRequest - -Request parameters for syncPlayMovePlaylistItem operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlayMovePlaylistItemRequest - -## Table of contents - -### Properties - -- [movePlaylistItemRequestDto](generated_client.SyncPlayApiSyncPlayMovePlaylistItemRequest.md#moveplaylistitemrequestdto) - -## Properties - -### movePlaylistItemRequestDto - -• `Readonly` **movePlaylistItemRequestDto**: [`MovePlaylistItemRequestDto`](generated_client.MovePlaylistItemRequestDto.md) - -The new position for the item. - -**`memberof`** SyncPlayApiSyncPlayMovePlaylistItem - -#### Defined in - -[generated-client/api/sync-play-api.ts:1359](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1359) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlayNextItemRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlayNextItemRequest.md deleted file mode 100644 index 6821dd49a..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlayNextItemRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlayNextItemRequest - -# Interface: SyncPlayApiSyncPlayNextItemRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlayNextItemRequest - -Request parameters for syncPlayNextItem operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlayNextItemRequest - -## Table of contents - -### Properties - -- [nextItemRequestDto](generated_client.SyncPlayApiSyncPlayNextItemRequest.md#nextitemrequestdto) - -## Properties - -### nextItemRequestDto - -• `Readonly` **nextItemRequestDto**: [`NextItemRequestDto`](generated_client.NextItemRequestDto.md) - -The current item information. - -**`memberof`** SyncPlayApiSyncPlayNextItem - -#### Defined in - -[generated-client/api/sync-play-api.ts:1373](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1373) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlayPingRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlayPingRequest.md deleted file mode 100644 index 9ff629e83..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlayPingRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlayPingRequest - -# Interface: SyncPlayApiSyncPlayPingRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlayPingRequest - -Request parameters for syncPlayPing operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlayPingRequest - -## Table of contents - -### Properties - -- [pingRequestDto](generated_client.SyncPlayApiSyncPlayPingRequest.md#pingrequestdto) - -## Properties - -### pingRequestDto - -• `Readonly` **pingRequestDto**: [`PingRequestDto`](generated_client.PingRequestDto.md) - -The new ping. - -**`memberof`** SyncPlayApiSyncPlayPing - -#### Defined in - -[generated-client/api/sync-play-api.ts:1387](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1387) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlayPreviousItemRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlayPreviousItemRequest.md deleted file mode 100644 index 8597afd2a..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlayPreviousItemRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlayPreviousItemRequest - -# Interface: SyncPlayApiSyncPlayPreviousItemRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlayPreviousItemRequest - -Request parameters for syncPlayPreviousItem operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlayPreviousItemRequest - -## Table of contents - -### Properties - -- [previousItemRequestDto](generated_client.SyncPlayApiSyncPlayPreviousItemRequest.md#previousitemrequestdto) - -## Properties - -### previousItemRequestDto - -• `Readonly` **previousItemRequestDto**: [`PreviousItemRequestDto`](generated_client.PreviousItemRequestDto.md) - -The current item information. - -**`memberof`** SyncPlayApiSyncPlayPreviousItem - -#### Defined in - -[generated-client/api/sync-play-api.ts:1401](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1401) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlayQueueRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlayQueueRequest.md deleted file mode 100644 index 8318cee89..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlayQueueRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlayQueueRequest - -# Interface: SyncPlayApiSyncPlayQueueRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlayQueueRequest - -Request parameters for syncPlayQueue operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlayQueueRequest - -## Table of contents - -### Properties - -- [queueRequestDto](generated_client.SyncPlayApiSyncPlayQueueRequest.md#queuerequestdto) - -## Properties - -### queueRequestDto - -• `Readonly` **queueRequestDto**: [`QueueRequestDto`](generated_client.QueueRequestDto.md) - -The items to add. - -**`memberof`** SyncPlayApiSyncPlayQueue - -#### Defined in - -[generated-client/api/sync-play-api.ts:1415](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1415) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlayReadyRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlayReadyRequest.md deleted file mode 100644 index 2fac422f8..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlayReadyRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlayReadyRequest - -# Interface: SyncPlayApiSyncPlayReadyRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlayReadyRequest - -Request parameters for syncPlayReady operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlayReadyRequest - -## Table of contents - -### Properties - -- [readyRequestDto](generated_client.SyncPlayApiSyncPlayReadyRequest.md#readyrequestdto) - -## Properties - -### readyRequestDto - -• `Readonly` **readyRequestDto**: [`ReadyRequestDto`](generated_client.ReadyRequestDto.md) - -The player status. - -**`memberof`** SyncPlayApiSyncPlayReady - -#### Defined in - -[generated-client/api/sync-play-api.ts:1429](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1429) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlayRemoveFromPlaylistRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlayRemoveFromPlaylistRequest.md deleted file mode 100644 index a0b5bc764..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlayRemoveFromPlaylistRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlayRemoveFromPlaylistRequest - -# Interface: SyncPlayApiSyncPlayRemoveFromPlaylistRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlayRemoveFromPlaylistRequest - -Request parameters for syncPlayRemoveFromPlaylist operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlayRemoveFromPlaylistRequest - -## Table of contents - -### Properties - -- [removeFromPlaylistRequestDto](generated_client.SyncPlayApiSyncPlayRemoveFromPlaylistRequest.md#removefromplaylistrequestdto) - -## Properties - -### removeFromPlaylistRequestDto - -• `Readonly` **removeFromPlaylistRequestDto**: [`RemoveFromPlaylistRequestDto`](generated_client.RemoveFromPlaylistRequestDto.md) - -The items to remove. - -**`memberof`** SyncPlayApiSyncPlayRemoveFromPlaylist - -#### Defined in - -[generated-client/api/sync-play-api.ts:1443](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1443) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlaySeekRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlaySeekRequest.md deleted file mode 100644 index 32f6ed3b1..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlaySeekRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlaySeekRequest - -# Interface: SyncPlayApiSyncPlaySeekRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlaySeekRequest - -Request parameters for syncPlaySeek operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlaySeekRequest - -## Table of contents - -### Properties - -- [seekRequestDto](generated_client.SyncPlayApiSyncPlaySeekRequest.md#seekrequestdto) - -## Properties - -### seekRequestDto - -• `Readonly` **seekRequestDto**: [`SeekRequestDto`](generated_client.SeekRequestDto.md) - -The new playback position. - -**`memberof`** SyncPlayApiSyncPlaySeek - -#### Defined in - -[generated-client/api/sync-play-api.ts:1457](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1457) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetIgnoreWaitRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetIgnoreWaitRequest.md deleted file mode 100644 index 80043e2e8..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetIgnoreWaitRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlaySetIgnoreWaitRequest - -# Interface: SyncPlayApiSyncPlaySetIgnoreWaitRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlaySetIgnoreWaitRequest - -Request parameters for syncPlaySetIgnoreWait operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlaySetIgnoreWaitRequest - -## Table of contents - -### Properties - -- [ignoreWaitRequestDto](generated_client.SyncPlayApiSyncPlaySetIgnoreWaitRequest.md#ignorewaitrequestdto) - -## Properties - -### ignoreWaitRequestDto - -• `Readonly` **ignoreWaitRequestDto**: [`IgnoreWaitRequestDto`](generated_client.IgnoreWaitRequestDto.md) - -The settings to set. - -**`memberof`** SyncPlayApiSyncPlaySetIgnoreWait - -#### Defined in - -[generated-client/api/sync-play-api.ts:1471](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1471) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetNewQueueRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetNewQueueRequest.md deleted file mode 100644 index db6758395..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetNewQueueRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlaySetNewQueueRequest - -# Interface: SyncPlayApiSyncPlaySetNewQueueRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlaySetNewQueueRequest - -Request parameters for syncPlaySetNewQueue operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlaySetNewQueueRequest - -## Table of contents - -### Properties - -- [playRequestDto](generated_client.SyncPlayApiSyncPlaySetNewQueueRequest.md#playrequestdto) - -## Properties - -### playRequestDto - -• `Readonly` **playRequestDto**: [`PlayRequestDto`](generated_client.PlayRequestDto.md) - -The new playlist to play in the group. - -**`memberof`** SyncPlayApiSyncPlaySetNewQueue - -#### Defined in - -[generated-client/api/sync-play-api.ts:1485](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1485) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetPlaylistItemRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetPlaylistItemRequest.md deleted file mode 100644 index 3441bed05..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetPlaylistItemRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlaySetPlaylistItemRequest - -# Interface: SyncPlayApiSyncPlaySetPlaylistItemRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlaySetPlaylistItemRequest - -Request parameters for syncPlaySetPlaylistItem operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlaySetPlaylistItemRequest - -## Table of contents - -### Properties - -- [setPlaylistItemRequestDto](generated_client.SyncPlayApiSyncPlaySetPlaylistItemRequest.md#setplaylistitemrequestdto) - -## Properties - -### setPlaylistItemRequestDto - -• `Readonly` **setPlaylistItemRequestDto**: [`SetPlaylistItemRequestDto`](generated_client.SetPlaylistItemRequestDto.md) - -The new item to play. - -**`memberof`** SyncPlayApiSyncPlaySetPlaylistItem - -#### Defined in - -[generated-client/api/sync-play-api.ts:1499](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1499) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetRepeatModeRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetRepeatModeRequest.md deleted file mode 100644 index 02022964b..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetRepeatModeRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlaySetRepeatModeRequest - -# Interface: SyncPlayApiSyncPlaySetRepeatModeRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlaySetRepeatModeRequest - -Request parameters for syncPlaySetRepeatMode operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlaySetRepeatModeRequest - -## Table of contents - -### Properties - -- [setRepeatModeRequestDto](generated_client.SyncPlayApiSyncPlaySetRepeatModeRequest.md#setrepeatmoderequestdto) - -## Properties - -### setRepeatModeRequestDto - -• `Readonly` **setRepeatModeRequestDto**: [`SetRepeatModeRequestDto`](generated_client.SetRepeatModeRequestDto.md) - -The new repeat mode. - -**`memberof`** SyncPlayApiSyncPlaySetRepeatMode - -#### Defined in - -[generated-client/api/sync-play-api.ts:1513](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1513) diff --git a/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetShuffleModeRequest.md b/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetShuffleModeRequest.md deleted file mode 100644 index 9ef9a300b..000000000 --- a/docs/interfaces/generated_client.SyncPlayApiSyncPlaySetShuffleModeRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApiSyncPlaySetShuffleModeRequest - -# Interface: SyncPlayApiSyncPlaySetShuffleModeRequest - -[generated-client](../modules/generated_client.md).SyncPlayApiSyncPlaySetShuffleModeRequest - -Request parameters for syncPlaySetShuffleMode operation in SyncPlayApi. - -**`export`** - -**`interface`** SyncPlayApiSyncPlaySetShuffleModeRequest - -## Table of contents - -### Properties - -- [setShuffleModeRequestDto](generated_client.SyncPlayApiSyncPlaySetShuffleModeRequest.md#setshufflemoderequestdto) - -## Properties - -### setShuffleModeRequestDto - -• `Readonly` **setShuffleModeRequestDto**: [`SetShuffleModeRequestDto`](generated_client.SetShuffleModeRequestDto.md) - -The new shuffle mode. - -**`memberof`** SyncPlayApiSyncPlaySetShuffleMode - -#### Defined in - -[generated-client/api/sync-play-api.ts:1527](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1527) diff --git a/docs/interfaces/generated_client.SystemApiGetLogFileRequest.md b/docs/interfaces/generated_client.SystemApiGetLogFileRequest.md deleted file mode 100644 index 989a36307..000000000 --- a/docs/interfaces/generated_client.SystemApiGetLogFileRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SystemApiGetLogFileRequest - -# Interface: SystemApiGetLogFileRequest - -[generated-client](../modules/generated_client.md).SystemApiGetLogFileRequest - -Request parameters for getLogFile operation in SystemApi. - -**`export`** - -**`interface`** SystemApiGetLogFileRequest - -## Table of contents - -### Properties - -- [name](generated_client.SystemApiGetLogFileRequest.md#name) - -## Properties - -### name - -• `Readonly` **name**: `string` - -The name of the log file to get. - -**`memberof`** SystemApiGetLogFile - -#### Defined in - -[generated-client/api/system-api.ts:596](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L596) diff --git a/docs/interfaces/generated_client.SystemInfo.md b/docs/interfaces/generated_client.SystemInfo.md deleted file mode 100644 index 45f5dde79..000000000 --- a/docs/interfaces/generated_client.SystemInfo.md +++ /dev/null @@ -1,400 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SystemInfo - -# Interface: SystemInfo - -[generated-client](../modules/generated_client.md).SystemInfo - -Class SystemInfo. - -**`export`** - -**`interface`** SystemInfo - -## Table of contents - -### Properties - -- [CachePath](generated_client.SystemInfo.md#cachepath) -- [CanLaunchWebBrowser](generated_client.SystemInfo.md#canlaunchwebbrowser) -- [CanSelfRestart](generated_client.SystemInfo.md#canselfrestart) -- [CompletedInstallations](generated_client.SystemInfo.md#completedinstallations) -- [EncoderLocation](generated_client.SystemInfo.md#encoderlocation) -- [HasPendingRestart](generated_client.SystemInfo.md#haspendingrestart) -- [HasUpdateAvailable](generated_client.SystemInfo.md#hasupdateavailable) -- [Id](generated_client.SystemInfo.md#id) -- [InternalMetadataPath](generated_client.SystemInfo.md#internalmetadatapath) -- [IsShuttingDown](generated_client.SystemInfo.md#isshuttingdown) -- [ItemsByNamePath](generated_client.SystemInfo.md#itemsbynamepath) -- [LocalAddress](generated_client.SystemInfo.md#localaddress) -- [LogPath](generated_client.SystemInfo.md#logpath) -- [OperatingSystem](generated_client.SystemInfo.md#operatingsystem) -- [OperatingSystemDisplayName](generated_client.SystemInfo.md#operatingsystemdisplayname) -- [PackageName](generated_client.SystemInfo.md#packagename) -- [ProductName](generated_client.SystemInfo.md#productname) -- [ProgramDataPath](generated_client.SystemInfo.md#programdatapath) -- [ServerName](generated_client.SystemInfo.md#servername) -- [StartupWizardCompleted](generated_client.SystemInfo.md#startupwizardcompleted) -- [SupportsLibraryMonitor](generated_client.SystemInfo.md#supportslibrarymonitor) -- [SystemArchitecture](generated_client.SystemInfo.md#systemarchitecture) -- [TranscodingTempPath](generated_client.SystemInfo.md#transcodingtemppath) -- [Version](generated_client.SystemInfo.md#version) -- [WebPath](generated_client.SystemInfo.md#webpath) -- [WebSocketPortNumber](generated_client.SystemInfo.md#websocketportnumber) - -## Properties - -### CachePath - -• `Optional` **CachePath**: ``null`` \| `string` - -Gets or sets the cache path. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:145](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L145) - -___ - -### CanLaunchWebBrowser - -• `Optional` **CanLaunchWebBrowser**: `boolean` - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:121](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L121) - -___ - -### CanSelfRestart - -• `Optional` **CanSelfRestart**: `boolean` - -Gets or sets a value indicating whether this instance can self restart. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:115](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L115) - -___ - -### CompletedInstallations - -• `Optional` **CompletedInstallations**: ``null`` \| [`InstallationInfo`](generated_client.InstallationInfo.md)[] - -Gets or sets the completed installations. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:109](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L109) - -___ - -### EncoderLocation - -• `Optional` **EncoderLocation**: [`FFmpegLocation`](../enums/generated_client.FFmpegLocation.md) - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:176](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L176) - -___ - -### HasPendingRestart - -• `Optional` **HasPendingRestart**: `boolean` - -Gets or sets a value indicating whether this instance has pending restart. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:85](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L85) - -___ - -### HasUpdateAvailable - -• `Optional` **HasUpdateAvailable**: `boolean` - -Gets or sets a value indicating whether this instance has update available. - -**`memberof`** SystemInfo - -**`deprecated`** - -#### Defined in - -[generated-client/models/system-info.ts:170](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L170) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets the id. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:61](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L61) - -___ - -### InternalMetadataPath - -• `Optional` **InternalMetadataPath**: ``null`` \| `string` - -Gets or sets the internal metadata path. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:157](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L157) - -___ - -### IsShuttingDown - -• `Optional` **IsShuttingDown**: `boolean` - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:91](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L91) - -___ - -### ItemsByNamePath - -• `Optional` **ItemsByNamePath**: ``null`` \| `string` - -Gets or sets the items by name path. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:139](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L139) - -___ - -### LocalAddress - -• `Optional` **LocalAddress**: ``null`` \| `string` - -Gets or sets the local address. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L31) - -___ - -### LogPath - -• `Optional` **LogPath**: ``null`` \| `string` - -Gets or sets the log path. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:151](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L151) - -___ - -### OperatingSystem - -• `Optional` **OperatingSystem**: ``null`` \| `string` - -Gets or sets the operating system. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L55) - -___ - -### OperatingSystemDisplayName - -• `Optional` **OperatingSystemDisplayName**: ``null`` \| `string` - -Gets or sets the display name of the operating system. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:73](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L73) - -___ - -### PackageName - -• `Optional` **PackageName**: ``null`` \| `string` - -Gets or sets the package name. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:79](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L79) - -___ - -### ProductName - -• `Optional` **ProductName**: ``null`` \| `string` - -Gets or sets the product name. This is the AssemblyProduct name. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L49) - -___ - -### ProgramDataPath - -• `Optional` **ProgramDataPath**: ``null`` \| `string` - -Gets or sets the program data path. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:127](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L127) - -___ - -### ServerName - -• `Optional` **ServerName**: ``null`` \| `string` - -Gets or sets the name of the server. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L37) - -___ - -### StartupWizardCompleted - -• `Optional` **StartupWizardCompleted**: ``null`` \| `boolean` - -Gets or sets a value indicating whether the startup wizard is completed. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:67](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L67) - -___ - -### SupportsLibraryMonitor - -• `Optional` **SupportsLibraryMonitor**: `boolean` - -Gets or sets a value indicating whether [supports library monitor]. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:97](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L97) - -___ - -### SystemArchitecture - -• `Optional` **SystemArchitecture**: [`Architecture`](../enums/generated_client.Architecture.md) - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:182](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L182) - -___ - -### TranscodingTempPath - -• `Optional` **TranscodingTempPath**: ``null`` \| `string` - -Gets or sets the transcode path. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:163](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L163) - -___ - -### Version - -• `Optional` **Version**: ``null`` \| `string` - -Gets or sets the server version. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L43) - -___ - -### WebPath - -• `Optional` **WebPath**: ``null`` \| `string` - -Gets or sets the web UI resources path. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:133](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L133) - -___ - -### WebSocketPortNumber - -• `Optional` **WebSocketPortNumber**: `number` - -Gets or sets the web socket port number. - -**`memberof`** SystemInfo - -#### Defined in - -[generated-client/models/system-info.ts:103](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/system-info.ts#L103) diff --git a/docs/interfaces/generated_client.TaskInfo.md b/docs/interfaces/generated_client.TaskInfo.md deleted file mode 100644 index 6b4c933e5..000000000 --- a/docs/interfaces/generated_client.TaskInfo.md +++ /dev/null @@ -1,162 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TaskInfo - -# Interface: TaskInfo - -[generated-client](../modules/generated_client.md).TaskInfo - -Class TaskInfo. - -**`export`** - -**`interface`** TaskInfo - -## Table of contents - -### Properties - -- [Category](generated_client.TaskInfo.md#category) -- [CurrentProgressPercentage](generated_client.TaskInfo.md#currentprogresspercentage) -- [Description](generated_client.TaskInfo.md#description) -- [Id](generated_client.TaskInfo.md#id) -- [IsHidden](generated_client.TaskInfo.md#ishidden) -- [Key](generated_client.TaskInfo.md#key) -- [LastExecutionResult](generated_client.TaskInfo.md#lastexecutionresult) -- [Name](generated_client.TaskInfo.md#name) -- [State](generated_client.TaskInfo.md#state) -- [Triggers](generated_client.TaskInfo.md#triggers) - -## Properties - -### Category - -• `Optional` **Category**: ``null`` \| `string` - -Gets or sets the category. - -**`memberof`** TaskInfo - -#### Defined in - -[generated-client/models/task-info.ts:73](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-info.ts#L73) - -___ - -### CurrentProgressPercentage - -• `Optional` **CurrentProgressPercentage**: ``null`` \| `number` - -Gets or sets the progress. - -**`memberof`** TaskInfo - -#### Defined in - -[generated-client/models/task-info.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-info.ts#L43) - -___ - -### Description - -• `Optional` **Description**: ``null`` \| `string` - -Gets or sets the description. - -**`memberof`** TaskInfo - -#### Defined in - -[generated-client/models/task-info.ts:67](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-info.ts#L67) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets the id. - -**`memberof`** TaskInfo - -#### Defined in - -[generated-client/models/task-info.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-info.ts#L49) - -___ - -### IsHidden - -• `Optional` **IsHidden**: `boolean` - -Gets or sets a value indicating whether this instance is hidden. - -**`memberof`** TaskInfo - -#### Defined in - -[generated-client/models/task-info.ts:79](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-info.ts#L79) - -___ - -### Key - -• `Optional` **Key**: ``null`` \| `string` - -Gets or sets the key. - -**`memberof`** TaskInfo - -#### Defined in - -[generated-client/models/task-info.ts:85](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-info.ts#L85) - -___ - -### LastExecutionResult - -• `Optional` **LastExecutionResult**: [`TaskResult`](generated_client.TaskResult.md) - -**`memberof`** TaskInfo - -#### Defined in - -[generated-client/models/task-info.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-info.ts#L55) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** TaskInfo - -#### Defined in - -[generated-client/models/task-info.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-info.ts#L31) - -___ - -### State - -• `Optional` **State**: [`TaskState`](../enums/generated_client.TaskState.md) - -**`memberof`** TaskInfo - -#### Defined in - -[generated-client/models/task-info.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-info.ts#L37) - -___ - -### Triggers - -• `Optional` **Triggers**: ``null`` \| [`TaskTriggerInfo`](generated_client.TaskTriggerInfo.md)[] - -Gets or sets the triggers. - -**`memberof`** TaskInfo - -#### Defined in - -[generated-client/models/task-info.ts:61](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-info.ts#L61) diff --git a/docs/interfaces/generated_client.TaskResult.md b/docs/interfaces/generated_client.TaskResult.md deleted file mode 100644 index d01c5551a..000000000 --- a/docs/interfaces/generated_client.TaskResult.md +++ /dev/null @@ -1,134 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TaskResult - -# Interface: TaskResult - -[generated-client](../modules/generated_client.md).TaskResult - -Class TaskExecutionInfo. - -**`export`** - -**`interface`** TaskResult - -## Table of contents - -### Properties - -- [EndTimeUtc](generated_client.TaskResult.md#endtimeutc) -- [ErrorMessage](generated_client.TaskResult.md#errormessage) -- [Id](generated_client.TaskResult.md#id) -- [Key](generated_client.TaskResult.md#key) -- [LongErrorMessage](generated_client.TaskResult.md#longerrormessage) -- [Name](generated_client.TaskResult.md#name) -- [StartTimeUtc](generated_client.TaskResult.md#starttimeutc) -- [Status](generated_client.TaskResult.md#status) - -## Properties - -### EndTimeUtc - -• `Optional` **EndTimeUtc**: `string` - -Gets or sets the end time UTC. - -**`memberof`** TaskResult - -#### Defined in - -[generated-client/models/task-result.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-result.ts#L35) - -___ - -### ErrorMessage - -• `Optional` **ErrorMessage**: ``null`` \| `string` - -Gets or sets the error message. - -**`memberof`** TaskResult - -#### Defined in - -[generated-client/models/task-result.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-result.ts#L65) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets the id. - -**`memberof`** TaskResult - -#### Defined in - -[generated-client/models/task-result.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-result.ts#L59) - -___ - -### Key - -• `Optional` **Key**: ``null`` \| `string` - -Gets or sets the key. - -**`memberof`** TaskResult - -#### Defined in - -[generated-client/models/task-result.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-result.ts#L53) - -___ - -### LongErrorMessage - -• `Optional` **LongErrorMessage**: ``null`` \| `string` - -Gets or sets the long error message. - -**`memberof`** TaskResult - -#### Defined in - -[generated-client/models/task-result.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-result.ts#L71) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** TaskResult - -#### Defined in - -[generated-client/models/task-result.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-result.ts#L47) - -___ - -### StartTimeUtc - -• `Optional` **StartTimeUtc**: `string` - -Gets or sets the start time UTC. - -**`memberof`** TaskResult - -#### Defined in - -[generated-client/models/task-result.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-result.ts#L29) - -___ - -### Status - -• `Optional` **Status**: [`TaskCompletionStatus`](../enums/generated_client.TaskCompletionStatus.md) - -**`memberof`** TaskResult - -#### Defined in - -[generated-client/models/task-result.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-result.ts#L41) diff --git a/docs/interfaces/generated_client.TaskTriggerInfo.md b/docs/interfaces/generated_client.TaskTriggerInfo.md deleted file mode 100644 index 53122ac9e..000000000 --- a/docs/interfaces/generated_client.TaskTriggerInfo.md +++ /dev/null @@ -1,89 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TaskTriggerInfo - -# Interface: TaskTriggerInfo - -[generated-client](../modules/generated_client.md).TaskTriggerInfo - -Class TaskTriggerInfo. - -**`export`** - -**`interface`** TaskTriggerInfo - -## Table of contents - -### Properties - -- [DayOfWeek](generated_client.TaskTriggerInfo.md#dayofweek) -- [IntervalTicks](generated_client.TaskTriggerInfo.md#intervalticks) -- [MaxRuntimeTicks](generated_client.TaskTriggerInfo.md#maxruntimeticks) -- [TimeOfDayTicks](generated_client.TaskTriggerInfo.md#timeofdayticks) -- [Type](generated_client.TaskTriggerInfo.md#type) - -## Properties - -### DayOfWeek - -• `Optional` **DayOfWeek**: [`DayOfWeek`](../enums/generated_client.DayOfWeek.md) - -**`memberof`** TaskTriggerInfo - -#### Defined in - -[generated-client/models/task-trigger-info.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-trigger-info.ts#L47) - -___ - -### IntervalTicks - -• `Optional` **IntervalTicks**: ``null`` \| `number` - -Gets or sets the interval. - -**`memberof`** TaskTriggerInfo - -#### Defined in - -[generated-client/models/task-trigger-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-trigger-info.ts#L41) - -___ - -### MaxRuntimeTicks - -• `Optional` **MaxRuntimeTicks**: ``null`` \| `number` - -Gets or sets the maximum runtime ticks. - -**`memberof`** TaskTriggerInfo - -#### Defined in - -[generated-client/models/task-trigger-info.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-trigger-info.ts#L53) - -___ - -### TimeOfDayTicks - -• `Optional` **TimeOfDayTicks**: ``null`` \| `number` - -Gets or sets the time of day. - -**`memberof`** TaskTriggerInfo - -#### Defined in - -[generated-client/models/task-trigger-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-trigger-info.ts#L35) - -___ - -### Type - -• `Optional` **Type**: ``null`` \| `string` - -Gets or sets the type. - -**`memberof`** TaskTriggerInfo - -#### Defined in - -[generated-client/models/task-trigger-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/task-trigger-info.ts#L29) diff --git a/docs/interfaces/generated_client.ThemeMediaResult.md b/docs/interfaces/generated_client.ThemeMediaResult.md deleted file mode 100644 index ab2943016..000000000 --- a/docs/interfaces/generated_client.ThemeMediaResult.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ThemeMediaResult - -# Interface: ThemeMediaResult - -[generated-client](../modules/generated_client.md).ThemeMediaResult - -Class ThemeMediaResult. - -**`export`** - -**`interface`** ThemeMediaResult - -## Table of contents - -### Properties - -- [Items](generated_client.ThemeMediaResult.md#items) -- [OwnerId](generated_client.ThemeMediaResult.md#ownerid) -- [StartIndex](generated_client.ThemeMediaResult.md#startindex) -- [TotalRecordCount](generated_client.ThemeMediaResult.md#totalrecordcount) - -## Properties - -### Items - -• `Optional` **Items**: ``null`` \| [`BaseItemDto`](generated_client.BaseItemDto.md)[] - -Gets or sets the items. - -**`memberof`** ThemeMediaResult - -#### Defined in - -[generated-client/models/theme-media-result.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/theme-media-result.ts#L29) - -___ - -### OwnerId - -• `Optional` **OwnerId**: `string` - -Gets or sets the owner id. - -**`memberof`** ThemeMediaResult - -#### Defined in - -[generated-client/models/theme-media-result.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/theme-media-result.ts#L47) - -___ - -### StartIndex - -• `Optional` **StartIndex**: `number` - -Gets or sets the index of the first record in Items. - -**`memberof`** ThemeMediaResult - -#### Defined in - -[generated-client/models/theme-media-result.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/theme-media-result.ts#L41) - -___ - -### TotalRecordCount - -• `Optional` **TotalRecordCount**: `number` - -Gets or sets the total number of records available. - -**`memberof`** ThemeMediaResult - -#### Defined in - -[generated-client/models/theme-media-result.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/theme-media-result.ts#L35) diff --git a/docs/interfaces/generated_client.TimerEventInfo.md b/docs/interfaces/generated_client.TimerEventInfo.md deleted file mode 100644 index 5041354f0..000000000 --- a/docs/interfaces/generated_client.TimerEventInfo.md +++ /dev/null @@ -1,40 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TimerEventInfo - -# Interface: TimerEventInfo - -[generated-client](../modules/generated_client.md).TimerEventInfo - -**`export`** - -**`interface`** TimerEventInfo - -## Table of contents - -### Properties - -- [Id](generated_client.TimerEventInfo.md#id) -- [ProgramId](generated_client.TimerEventInfo.md#programid) - -## Properties - -### Id - -• `Optional` **Id**: `string` - -**`memberof`** TimerEventInfo - -#### Defined in - -[generated-client/models/timer-event-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-event-info.ts#L28) - -___ - -### ProgramId - -• `Optional` **ProgramId**: ``null`` \| `string` - -**`memberof`** TimerEventInfo - -#### Defined in - -[generated-client/models/timer-event-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-event-info.ts#L34) diff --git a/docs/interfaces/generated_client.TimerInfoDto.md b/docs/interfaces/generated_client.TimerInfoDto.md deleted file mode 100644 index fc96e29a7..000000000 --- a/docs/interfaces/generated_client.TimerInfoDto.md +++ /dev/null @@ -1,424 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TimerInfoDto - -# Interface: TimerInfoDto - -[generated-client](../modules/generated_client.md).TimerInfoDto - -**`export`** - -**`interface`** TimerInfoDto - -## Table of contents - -### Properties - -- [ChannelId](generated_client.TimerInfoDto.md#channelid) -- [ChannelName](generated_client.TimerInfoDto.md#channelname) -- [ChannelPrimaryImageTag](generated_client.TimerInfoDto.md#channelprimaryimagetag) -- [EndDate](generated_client.TimerInfoDto.md#enddate) -- [ExternalChannelId](generated_client.TimerInfoDto.md#externalchannelid) -- [ExternalId](generated_client.TimerInfoDto.md#externalid) -- [ExternalProgramId](generated_client.TimerInfoDto.md#externalprogramid) -- [ExternalSeriesTimerId](generated_client.TimerInfoDto.md#externalseriestimerid) -- [Id](generated_client.TimerInfoDto.md#id) -- [IsPostPaddingRequired](generated_client.TimerInfoDto.md#ispostpaddingrequired) -- [IsPrePaddingRequired](generated_client.TimerInfoDto.md#isprepaddingrequired) -- [KeepUntil](generated_client.TimerInfoDto.md#keepuntil) -- [Name](generated_client.TimerInfoDto.md#name) -- [Overview](generated_client.TimerInfoDto.md#overview) -- [ParentBackdropImageTags](generated_client.TimerInfoDto.md#parentbackdropimagetags) -- [ParentBackdropItemId](generated_client.TimerInfoDto.md#parentbackdropitemid) -- [PostPaddingSeconds](generated_client.TimerInfoDto.md#postpaddingseconds) -- [PrePaddingSeconds](generated_client.TimerInfoDto.md#prepaddingseconds) -- [Priority](generated_client.TimerInfoDto.md#priority) -- [ProgramId](generated_client.TimerInfoDto.md#programid) -- [ProgramInfo](generated_client.TimerInfoDto.md#programinfo) -- [RunTimeTicks](generated_client.TimerInfoDto.md#runtimeticks) -- [SeriesTimerId](generated_client.TimerInfoDto.md#seriestimerid) -- [ServerId](generated_client.TimerInfoDto.md#serverid) -- [ServiceName](generated_client.TimerInfoDto.md#servicename) -- [StartDate](generated_client.TimerInfoDto.md#startdate) -- [Status](generated_client.TimerInfoDto.md#status) -- [Type](generated_client.TimerInfoDto.md#type) - -## Properties - -### ChannelId - -• `Optional` **ChannelId**: `string` - -Gets or sets the channel id of the recording. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L55) - -___ - -### ChannelName - -• `Optional` **ChannelName**: ``null`` \| `string` - -Gets or sets the channel name of the recording. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:67](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L67) - -___ - -### ChannelPrimaryImageTag - -• `Optional` **ChannelPrimaryImageTag**: ``null`` \| `string` - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:73](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L73) - -___ - -### EndDate - -• `Optional` **EndDate**: `string` - -Gets or sets the end date of the recording, in UTC. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:109](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L109) - -___ - -### ExternalChannelId - -• `Optional` **ExternalChannelId**: ``null`` \| `string` - -Gets or sets the external channel identifier. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:61](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L61) - -___ - -### ExternalId - -• `Optional` **ExternalId**: ``null`` \| `string` - -Gets or sets the external identifier. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L49) - -___ - -### ExternalProgramId - -• `Optional` **ExternalProgramId**: ``null`` \| `string` - -Gets or sets the external program identifier. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:85](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L85) - -___ - -### ExternalSeriesTimerId - -• `Optional` **ExternalSeriesTimerId**: ``null`` \| `string` - -Gets or sets the external series timer identifier. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L181) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -Gets or sets the Id of the recording. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L31) - -___ - -### IsPostPaddingRequired - -• `Optional` **IsPostPaddingRequired**: `boolean` - -Gets or sets a value indicating whether this instance is post padding required. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:157](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L157) - -___ - -### IsPrePaddingRequired - -• `Optional` **IsPrePaddingRequired**: `boolean` - -Gets or sets a value indicating whether this instance is pre padding required. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:139](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L139) - -___ - -### KeepUntil - -• `Optional` **KeepUntil**: [`KeepUntil`](../enums/generated_client.KeepUntil.md) - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:163](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L163) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name of the recording. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:91](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L91) - -___ - -### Overview - -• `Optional` **Overview**: ``null`` \| `string` - -Gets or sets the description of the recording. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:97](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L97) - -___ - -### ParentBackdropImageTags - -• `Optional` **ParentBackdropImageTags**: ``null`` \| `string`[] - -Gets or sets the parent backdrop image tags. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:151](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L151) - -___ - -### ParentBackdropItemId - -• `Optional` **ParentBackdropItemId**: ``null`` \| `string` - -Gets or sets the Id of the Parent that has a backdrop if the item does not have one. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:145](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L145) - -___ - -### PostPaddingSeconds - -• `Optional` **PostPaddingSeconds**: `number` - -Gets or sets the post padding seconds. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:133](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L133) - -___ - -### PrePaddingSeconds - -• `Optional` **PrePaddingSeconds**: `number` - -Gets or sets the pre padding seconds. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:127](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L127) - -___ - -### Priority - -• `Optional` **Priority**: `number` - -Gets or sets the priority. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:121](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L121) - -___ - -### ProgramId - -• `Optional` **ProgramId**: ``null`` \| `string` - -Gets or sets the program identifier. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:79](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L79) - -___ - -### ProgramInfo - -• `Optional` **ProgramInfo**: [`BaseItemDto`](generated_client.BaseItemDto.md) - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:193](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L193) - -___ - -### RunTimeTicks - -• `Optional` **RunTimeTicks**: ``null`` \| `number` - -Gets or sets the run time ticks. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:187](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L187) - -___ - -### SeriesTimerId - -• `Optional` **SeriesTimerId**: ``null`` \| `string` - -Gets or sets the series timer identifier. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:175](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L175) - -___ - -### ServerId - -• `Optional` **ServerId**: ``null`` \| `string` - -Gets or sets the server identifier. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L43) - -___ - -### ServiceName - -• `Optional` **ServiceName**: ``null`` \| `string` - -Gets or sets the name of the service. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:115](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L115) - -___ - -### StartDate - -• `Optional` **StartDate**: `string` - -Gets or sets the start date of the recording, in UTC. - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:103](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L103) - -___ - -### Status - -• `Optional` **Status**: [`RecordingStatus`](../enums/generated_client.RecordingStatus.md) - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:169](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L169) - -___ - -### Type - -• `Optional` **Type**: ``null`` \| `string` - -**`memberof`** TimerInfoDto - -#### Defined in - -[generated-client/models/timer-info-dto.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto.ts#L37) diff --git a/docs/interfaces/generated_client.TimerInfoDtoQueryResult.md b/docs/interfaces/generated_client.TimerInfoDtoQueryResult.md deleted file mode 100644 index 90ff83ca1..000000000 --- a/docs/interfaces/generated_client.TimerInfoDtoQueryResult.md +++ /dev/null @@ -1,59 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TimerInfoDtoQueryResult - -# Interface: TimerInfoDtoQueryResult - -[generated-client](../modules/generated_client.md).TimerInfoDtoQueryResult - -**`export`** - -**`interface`** TimerInfoDtoQueryResult - -## Table of contents - -### Properties - -- [Items](generated_client.TimerInfoDtoQueryResult.md#items) -- [StartIndex](generated_client.TimerInfoDtoQueryResult.md#startindex) -- [TotalRecordCount](generated_client.TimerInfoDtoQueryResult.md#totalrecordcount) - -## Properties - -### Items - -• `Optional` **Items**: ``null`` \| [`TimerInfoDto`](generated_client.TimerInfoDto.md)[] - -Gets or sets the items. - -**`memberof`** TimerInfoDtoQueryResult - -#### Defined in - -[generated-client/models/timer-info-dto-query-result.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto-query-result.ts#L29) - -___ - -### StartIndex - -• `Optional` **StartIndex**: `number` - -Gets or sets the index of the first record in Items. - -**`memberof`** TimerInfoDtoQueryResult - -#### Defined in - -[generated-client/models/timer-info-dto-query-result.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto-query-result.ts#L41) - -___ - -### TotalRecordCount - -• `Optional` **TotalRecordCount**: `number` - -Gets or sets the total number of records available. - -**`memberof`** TimerInfoDtoQueryResult - -#### Defined in - -[generated-client/models/timer-info-dto-query-result.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/timer-info-dto-query-result.ts#L35) diff --git a/docs/interfaces/generated_client.TrailerInfo.md b/docs/interfaces/generated_client.TrailerInfo.md deleted file mode 100644 index 472f91df5..000000000 --- a/docs/interfaces/generated_client.TrailerInfo.md +++ /dev/null @@ -1,171 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TrailerInfo - -# Interface: TrailerInfo - -[generated-client](../modules/generated_client.md).TrailerInfo - -**`export`** - -**`interface`** TrailerInfo - -## Table of contents - -### Properties - -- [IndexNumber](generated_client.TrailerInfo.md#indexnumber) -- [IsAutomated](generated_client.TrailerInfo.md#isautomated) -- [MetadataCountryCode](generated_client.TrailerInfo.md#metadatacountrycode) -- [MetadataLanguage](generated_client.TrailerInfo.md#metadatalanguage) -- [Name](generated_client.TrailerInfo.md#name) -- [OriginalTitle](generated_client.TrailerInfo.md#originaltitle) -- [ParentIndexNumber](generated_client.TrailerInfo.md#parentindexnumber) -- [Path](generated_client.TrailerInfo.md#path) -- [PremiereDate](generated_client.TrailerInfo.md#premieredate) -- [ProviderIds](generated_client.TrailerInfo.md#providerids) -- [Year](generated_client.TrailerInfo.md#year) - -## Properties - -### IndexNumber - -• `Optional` **IndexNumber**: ``null`` \| `number` - -**`memberof`** TrailerInfo - -#### Defined in - -[generated-client/models/trailer-info.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info.ts#L70) - -___ - -### IsAutomated - -• `Optional` **IsAutomated**: `boolean` - -**`memberof`** TrailerInfo - -#### Defined in - -[generated-client/models/trailer-info.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info.ts#L88) - -___ - -### MetadataCountryCode - -• `Optional` **MetadataCountryCode**: ``null`` \| `string` - -Gets or sets the metadata country code. - -**`memberof`** TrailerInfo - -#### Defined in - -[generated-client/models/trailer-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info.ts#L52) - -___ - -### MetadataLanguage - -• `Optional` **MetadataLanguage**: ``null`` \| `string` - -Gets or sets the metadata language. - -**`memberof`** TrailerInfo - -#### Defined in - -[generated-client/models/trailer-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info.ts#L46) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** TrailerInfo - -#### Defined in - -[generated-client/models/trailer-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info.ts#L28) - -___ - -### OriginalTitle - -• `Optional` **OriginalTitle**: ``null`` \| `string` - -Gets or sets the original title. - -**`memberof`** TrailerInfo - -#### Defined in - -[generated-client/models/trailer-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info.ts#L34) - -___ - -### ParentIndexNumber - -• `Optional` **ParentIndexNumber**: ``null`` \| `number` - -**`memberof`** TrailerInfo - -#### Defined in - -[generated-client/models/trailer-info.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info.ts#L76) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** TrailerInfo - -#### Defined in - -[generated-client/models/trailer-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info.ts#L40) - -___ - -### PremiereDate - -• `Optional` **PremiereDate**: ``null`` \| `string` - -**`memberof`** TrailerInfo - -#### Defined in - -[generated-client/models/trailer-info.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info.ts#L82) - -___ - -### ProviderIds - -• `Optional` **ProviderIds**: ``null`` \| { `[key: string]`: `string`; } - -Gets or sets the provider ids. - -**`memberof`** TrailerInfo - -#### Defined in - -[generated-client/models/trailer-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info.ts#L58) - -___ - -### Year - -• `Optional` **Year**: ``null`` \| `number` - -Gets or sets the year. - -**`memberof`** TrailerInfo - -#### Defined in - -[generated-client/models/trailer-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info.ts#L64) diff --git a/docs/interfaces/generated_client.TrailerInfoRemoteSearchQuery.md b/docs/interfaces/generated_client.TrailerInfoRemoteSearchQuery.md deleted file mode 100644 index ffe710d57..000000000 --- a/docs/interfaces/generated_client.TrailerInfoRemoteSearchQuery.md +++ /dev/null @@ -1,70 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TrailerInfoRemoteSearchQuery - -# Interface: TrailerInfoRemoteSearchQuery - -[generated-client](../modules/generated_client.md).TrailerInfoRemoteSearchQuery - -**`export`** - -**`interface`** TrailerInfoRemoteSearchQuery - -## Table of contents - -### Properties - -- [IncludeDisabledProviders](generated_client.TrailerInfoRemoteSearchQuery.md#includedisabledproviders) -- [ItemId](generated_client.TrailerInfoRemoteSearchQuery.md#itemid) -- [SearchInfo](generated_client.TrailerInfoRemoteSearchQuery.md#searchinfo) -- [SearchProviderName](generated_client.TrailerInfoRemoteSearchQuery.md#searchprovidername) - -## Properties - -### IncludeDisabledProviders - -• `Optional` **IncludeDisabledProviders**: `boolean` - -Gets or sets a value indicating whether disabled providers should be included. - -**`memberof`** TrailerInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/trailer-info-remote-search-query.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info-remote-search-query.ts#L47) - -___ - -### ItemId - -• `Optional` **ItemId**: `string` - -**`memberof`** TrailerInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/trailer-info-remote-search-query.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info-remote-search-query.ts#L35) - -___ - -### SearchInfo - -• `Optional` **SearchInfo**: [`TrailerInfo`](generated_client.TrailerInfo.md) - -**`memberof`** TrailerInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/trailer-info-remote-search-query.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info-remote-search-query.ts#L29) - -___ - -### SearchProviderName - -• `Optional` **SearchProviderName**: ``null`` \| `string` - -Gets or sets the provider name to search within if set. - -**`memberof`** TrailerInfoRemoteSearchQuery - -#### Defined in - -[generated-client/models/trailer-info-remote-search-query.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/trailer-info-remote-search-query.ts#L41) diff --git a/docs/interfaces/generated_client.TrailersApiGetTrailersRequest.md b/docs/interfaces/generated_client.TrailersApiGetTrailersRequest.md deleted file mode 100644 index 1a8a64acb..000000000 --- a/docs/interfaces/generated_client.TrailersApiGetTrailersRequest.md +++ /dev/null @@ -1,1276 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TrailersApiGetTrailersRequest - -# Interface: TrailersApiGetTrailersRequest - -[generated-client](../modules/generated_client.md).TrailersApiGetTrailersRequest - -Request parameters for getTrailers operation in TrailersApi. - -**`export`** - -**`interface`** TrailersApiGetTrailersRequest - -## Table of contents - -### Properties - -- [adjacentTo](generated_client.TrailersApiGetTrailersRequest.md#adjacentto) -- [albumArtistIds](generated_client.TrailersApiGetTrailersRequest.md#albumartistids) -- [albumIds](generated_client.TrailersApiGetTrailersRequest.md#albumids) -- [albums](generated_client.TrailersApiGetTrailersRequest.md#albums) -- [artistIds](generated_client.TrailersApiGetTrailersRequest.md#artistids) -- [artists](generated_client.TrailersApiGetTrailersRequest.md#artists) -- [collapseBoxSetItems](generated_client.TrailersApiGetTrailersRequest.md#collapseboxsetitems) -- [contributingArtistIds](generated_client.TrailersApiGetTrailersRequest.md#contributingartistids) -- [enableImageTypes](generated_client.TrailersApiGetTrailersRequest.md#enableimagetypes) -- [enableImages](generated_client.TrailersApiGetTrailersRequest.md#enableimages) -- [enableTotalRecordCount](generated_client.TrailersApiGetTrailersRequest.md#enabletotalrecordcount) -- [enableUserData](generated_client.TrailersApiGetTrailersRequest.md#enableuserdata) -- [excludeArtistIds](generated_client.TrailersApiGetTrailersRequest.md#excludeartistids) -- [excludeItemIds](generated_client.TrailersApiGetTrailersRequest.md#excludeitemids) -- [excludeItemTypes](generated_client.TrailersApiGetTrailersRequest.md#excludeitemtypes) -- [excludeLocationTypes](generated_client.TrailersApiGetTrailersRequest.md#excludelocationtypes) -- [fields](generated_client.TrailersApiGetTrailersRequest.md#fields) -- [filters](generated_client.TrailersApiGetTrailersRequest.md#filters) -- [genreIds](generated_client.TrailersApiGetTrailersRequest.md#genreids) -- [genres](generated_client.TrailersApiGetTrailersRequest.md#genres) -- [hasImdbId](generated_client.TrailersApiGetTrailersRequest.md#hasimdbid) -- [hasOfficialRating](generated_client.TrailersApiGetTrailersRequest.md#hasofficialrating) -- [hasOverview](generated_client.TrailersApiGetTrailersRequest.md#hasoverview) -- [hasParentalRating](generated_client.TrailersApiGetTrailersRequest.md#hasparentalrating) -- [hasSpecialFeature](generated_client.TrailersApiGetTrailersRequest.md#hasspecialfeature) -- [hasSubtitles](generated_client.TrailersApiGetTrailersRequest.md#hassubtitles) -- [hasThemeSong](generated_client.TrailersApiGetTrailersRequest.md#hasthemesong) -- [hasThemeVideo](generated_client.TrailersApiGetTrailersRequest.md#hasthemevideo) -- [hasTmdbId](generated_client.TrailersApiGetTrailersRequest.md#hastmdbid) -- [hasTrailer](generated_client.TrailersApiGetTrailersRequest.md#hastrailer) -- [hasTvdbId](generated_client.TrailersApiGetTrailersRequest.md#hastvdbid) -- [ids](generated_client.TrailersApiGetTrailersRequest.md#ids) -- [imageTypeLimit](generated_client.TrailersApiGetTrailersRequest.md#imagetypelimit) -- [imageTypes](generated_client.TrailersApiGetTrailersRequest.md#imagetypes) -- [is3D](generated_client.TrailersApiGetTrailersRequest.md#is3d) -- [is4K](generated_client.TrailersApiGetTrailersRequest.md#is4k) -- [isFavorite](generated_client.TrailersApiGetTrailersRequest.md#isfavorite) -- [isHd](generated_client.TrailersApiGetTrailersRequest.md#ishd) -- [isKids](generated_client.TrailersApiGetTrailersRequest.md#iskids) -- [isLocked](generated_client.TrailersApiGetTrailersRequest.md#islocked) -- [isMissing](generated_client.TrailersApiGetTrailersRequest.md#ismissing) -- [isMovie](generated_client.TrailersApiGetTrailersRequest.md#ismovie) -- [isNews](generated_client.TrailersApiGetTrailersRequest.md#isnews) -- [isPlaceHolder](generated_client.TrailersApiGetTrailersRequest.md#isplaceholder) -- [isPlayed](generated_client.TrailersApiGetTrailersRequest.md#isplayed) -- [isSeries](generated_client.TrailersApiGetTrailersRequest.md#isseries) -- [isSports](generated_client.TrailersApiGetTrailersRequest.md#issports) -- [isUnaired](generated_client.TrailersApiGetTrailersRequest.md#isunaired) -- [limit](generated_client.TrailersApiGetTrailersRequest.md#limit) -- [locationTypes](generated_client.TrailersApiGetTrailersRequest.md#locationtypes) -- [maxHeight](generated_client.TrailersApiGetTrailersRequest.md#maxheight) -- [maxOfficialRating](generated_client.TrailersApiGetTrailersRequest.md#maxofficialrating) -- [maxPremiereDate](generated_client.TrailersApiGetTrailersRequest.md#maxpremieredate) -- [maxWidth](generated_client.TrailersApiGetTrailersRequest.md#maxwidth) -- [mediaTypes](generated_client.TrailersApiGetTrailersRequest.md#mediatypes) -- [minCommunityRating](generated_client.TrailersApiGetTrailersRequest.md#mincommunityrating) -- [minCriticRating](generated_client.TrailersApiGetTrailersRequest.md#mincriticrating) -- [minDateLastSaved](generated_client.TrailersApiGetTrailersRequest.md#mindatelastsaved) -- [minDateLastSavedForUser](generated_client.TrailersApiGetTrailersRequest.md#mindatelastsavedforuser) -- [minHeight](generated_client.TrailersApiGetTrailersRequest.md#minheight) -- [minOfficialRating](generated_client.TrailersApiGetTrailersRequest.md#minofficialrating) -- [minPremiereDate](generated_client.TrailersApiGetTrailersRequest.md#minpremieredate) -- [minWidth](generated_client.TrailersApiGetTrailersRequest.md#minwidth) -- [nameLessThan](generated_client.TrailersApiGetTrailersRequest.md#namelessthan) -- [nameStartsWith](generated_client.TrailersApiGetTrailersRequest.md#namestartswith) -- [nameStartsWithOrGreater](generated_client.TrailersApiGetTrailersRequest.md#namestartswithorgreater) -- [officialRatings](generated_client.TrailersApiGetTrailersRequest.md#officialratings) -- [parentId](generated_client.TrailersApiGetTrailersRequest.md#parentid) -- [parentIndexNumber](generated_client.TrailersApiGetTrailersRequest.md#parentindexnumber) -- [person](generated_client.TrailersApiGetTrailersRequest.md#person) -- [personIds](generated_client.TrailersApiGetTrailersRequest.md#personids) -- [personTypes](generated_client.TrailersApiGetTrailersRequest.md#persontypes) -- [recursive](generated_client.TrailersApiGetTrailersRequest.md#recursive) -- [searchTerm](generated_client.TrailersApiGetTrailersRequest.md#searchterm) -- [seriesStatus](generated_client.TrailersApiGetTrailersRequest.md#seriesstatus) -- [sortBy](generated_client.TrailersApiGetTrailersRequest.md#sortby) -- [sortOrder](generated_client.TrailersApiGetTrailersRequest.md#sortorder) -- [startIndex](generated_client.TrailersApiGetTrailersRequest.md#startindex) -- [studioIds](generated_client.TrailersApiGetTrailersRequest.md#studioids) -- [studios](generated_client.TrailersApiGetTrailersRequest.md#studios) -- [tags](generated_client.TrailersApiGetTrailersRequest.md#tags) -- [userId](generated_client.TrailersApiGetTrailersRequest.md#userid) -- [videoTypes](generated_client.TrailersApiGetTrailersRequest.md#videotypes) -- [years](generated_client.TrailersApiGetTrailersRequest.md#years) - -## Properties - -### adjacentTo - -• `Optional` `Readonly` **adjacentTo**: `string` - -Optional. Return items that are siblings of a supplied item. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:778](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L778) - -___ - -### albumArtistIds - -• `Optional` `Readonly` **albumArtistIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified album artist id. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1149](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1149) - -___ - -### albumIds - -• `Optional` `Readonly` **albumIds**: `string`[] - -Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1170](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1170) - -___ - -### albums - -• `Optional` `Readonly` **albums**: `string`[] - -Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1163](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1163) - -___ - -### artistIds - -• `Optional` `Readonly` **artistIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified artist id. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1142](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1142) - -___ - -### artists - -• `Optional` `Readonly` **artists**: `string`[] - -Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1128](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1128) - -___ - -### collapseBoxSetItems - -• `Optional` `Readonly` **collapseBoxSetItems**: `boolean` - -Whether or not to hide items behind their boxsets. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1219](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1219) - -___ - -### contributingArtistIds - -• `Optional` `Readonly` **contributingArtistIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1156](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1156) - -___ - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1093](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1093) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional, include image information in output. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1310](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1310) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Optional. Enable the total record count. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1303](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1303) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional, include user data. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1079](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1079) - -___ - -### excludeArtistIds - -• `Optional` `Readonly` **excludeArtistIds**: `string`[] - -Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1135](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1135) - -___ - -### excludeItemIds - -• `Optional` `Readonly` **excludeItemIds**: `string`[] - -Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:946](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L946) - -___ - -### excludeItemTypes - -• `Optional` `Readonly` **excludeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1002](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1002) - -___ - -### excludeLocationTypes - -• `Optional` `Readonly` **excludeLocationTypes**: [`LocationType`](../enums/generated_client.LocationType.md)[] - -Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:820](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L820) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:995](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L995) - -___ - -### filters - -• `Optional` `Readonly` **filters**: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[] - -Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1009](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1009) - -___ - -### genreIds - -• `Optional` `Readonly` **genreIds**: `string`[] - -Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1296](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1296) - -___ - -### genres - -• `Optional` `Readonly` **genres**: `string`[] - -Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1051](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1051) - -___ - -### hasImdbId - -• `Optional` `Readonly` **hasImdbId**: `boolean` - -Optional filter by items that have an imdb id or not. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:890](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L890) - -___ - -### hasOfficialRating - -• `Optional` `Readonly` **hasOfficialRating**: `boolean` - -Optional filter by items that have official ratings. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1212](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1212) - -___ - -### hasOverview - -• `Optional` `Readonly` **hasOverview**: `boolean` - -Optional filter by items that have an overview or not. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:883](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L883) - -___ - -### hasParentalRating - -• `Optional` `Readonly` **hasParentalRating**: `boolean` - -Optional filter by items that have or do not have a parental rating. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:792](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L792) - -___ - -### hasSpecialFeature - -• `Optional` `Readonly` **hasSpecialFeature**: `boolean` - -Optional filter by items with special features. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:764](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L764) - -___ - -### hasSubtitles - -• `Optional` `Readonly` **hasSubtitles**: `boolean` - -Optional filter by items with subtitles. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:757](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L757) - -___ - -### hasThemeSong - -• `Optional` `Readonly` **hasThemeSong**: `boolean` - -Optional filter by items with theme songs. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:743](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L743) - -___ - -### hasThemeVideo - -• `Optional` `Readonly` **hasThemeVideo**: `boolean` - -Optional filter by items with theme videos. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:750](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L750) - -___ - -### hasTmdbId - -• `Optional` `Readonly` **hasTmdbId**: `boolean` - -Optional filter by items that have a tmdb id or not. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:897](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L897) - -___ - -### hasTrailer - -• `Optional` `Readonly` **hasTrailer**: `boolean` - -Optional filter by items with trailers. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:771](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L771) - -___ - -### hasTvdbId - -• `Optional` `Readonly` **hasTvdbId**: `boolean` - -Optional filter by items that have a tvdb id or not. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:904](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L904) - -___ - -### ids - -• `Optional` `Readonly` **ids**: `string`[] - -Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1177](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1177) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional, the max number of images to return, per image type. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1086](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1086) - -___ - -### imageTypes - -• `Optional` `Readonly` **imageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1030](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1030) - -___ - -### is3D - -• `Optional` `Readonly` **is3D**: `boolean` - -Optional filter by items that are 3D, or not. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1254](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1254) - -___ - -### is4K - -• `Optional` `Readonly` **is4K**: `boolean` - -Optional filter by items that are 4K or not. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:806](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L806) - -___ - -### isFavorite - -• `Optional` `Readonly` **isFavorite**: `boolean` - -Optional filter by items that are marked as favorite, or not. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1016](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1016) - -___ - -### isHd - -• `Optional` `Readonly` **isHd**: `boolean` - -Optional filter by items that are HD or not. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:799](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L799) - -___ - -### isKids - -• `Optional` `Readonly` **isKids**: `boolean` - -Optional filter for live tv kids. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:932](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L932) - -___ - -### isLocked - -• `Optional` `Readonly` **isLocked**: `boolean` - -Optional filter by items that are locked. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1198](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1198) - -___ - -### isMissing - -• `Optional` `Readonly` **isMissing**: `boolean` - -Optional filter by items that are missing episodes or not. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:827](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L827) - -___ - -### isMovie - -• `Optional` `Readonly` **isMovie**: `boolean` - -Optional filter for live tv movies. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:911](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L911) - -___ - -### isNews - -• `Optional` `Readonly` **isNews**: `boolean` - -Optional filter for live tv news. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:925](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L925) - -___ - -### isPlaceHolder - -• `Optional` `Readonly` **isPlaceHolder**: `boolean` - -Optional filter by items that are placeholders. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1205](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1205) - -___ - -### isPlayed - -• `Optional` `Readonly` **isPlayed**: `boolean` - -Optional filter by items that are played, or not. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1044](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1044) - -___ - -### isSeries - -• `Optional` `Readonly` **isSeries**: `boolean` - -Optional filter for live tv series. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:918](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L918) - -___ - -### isSports - -• `Optional` `Readonly` **isSports**: `boolean` - -Optional filter for live tv sports. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:939](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L939) - -___ - -### isUnaired - -• `Optional` `Readonly` **isUnaired**: `boolean` - -Optional filter by items that are unaired episodes or not. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:834](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L834) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:960](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L960) - -___ - -### locationTypes - -• `Optional` `Readonly` **locationTypes**: [`LocationType`](../enums/generated_client.LocationType.md)[] - -Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:813](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L813) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -Optional. Filter by the maximum height of the item. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1247](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1247) - -___ - -### maxOfficialRating - -• `Optional` `Readonly` **maxOfficialRating**: `string` - -Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:736](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L736) - -___ - -### maxPremiereDate - -• `Optional` `Readonly` **maxPremiereDate**: `string` - -Optional. The maximum premiere date. Format = ISO. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:876](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L876) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -Optional. Filter by the maximum width of the item. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1240](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1240) - -___ - -### mediaTypes - -• `Optional` `Readonly` **mediaTypes**: `string`[] - -Optional filter by MediaType. Allows multiple, comma delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1023](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1023) - -___ - -### minCommunityRating - -• `Optional` `Readonly` **minCommunityRating**: `number` - -Optional filter by minimum community rating. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:841](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L841) - -___ - -### minCriticRating - -• `Optional` `Readonly` **minCriticRating**: `number` - -Optional filter by minimum critic rating. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:848](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L848) - -___ - -### minDateLastSaved - -• `Optional` `Readonly` **minDateLastSaved**: `string` - -Optional. The minimum last saved date. Format = ISO. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:862](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L862) - -___ - -### minDateLastSavedForUser - -• `Optional` `Readonly` **minDateLastSavedForUser**: `string` - -Optional. The minimum last saved date for the current user. Format = ISO. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:869](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L869) - -___ - -### minHeight - -• `Optional` `Readonly` **minHeight**: `number` - -Optional. Filter by the minimum height of the item. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1233](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1233) - -___ - -### minOfficialRating - -• `Optional` `Readonly` **minOfficialRating**: `string` - -Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1191](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1191) - -___ - -### minPremiereDate - -• `Optional` `Readonly` **minPremiereDate**: `string` - -Optional. The minimum premiere date. Format = ISO. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:855](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L855) - -___ - -### minWidth - -• `Optional` `Readonly` **minWidth**: `number` - -Optional. Filter by the minimum width of the item. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1226](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1226) - -___ - -### nameLessThan - -• `Optional` `Readonly` **nameLessThan**: `string` - -Optional filter by items whose name is equally or lesser than a given input string. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1282](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1282) - -___ - -### nameStartsWith - -• `Optional` `Readonly` **nameStartsWith**: `string` - -Optional filter by items whose name is sorted equally than a given input string. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1275](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1275) - -___ - -### nameStartsWithOrGreater - -• `Optional` `Readonly` **nameStartsWithOrGreater**: `string` - -Optional filter by items whose name is sorted equally or greater than a given input string. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1268](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1268) - -___ - -### officialRatings - -• `Optional` `Readonly` **officialRatings**: `string`[] - -Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1058](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1058) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:988](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L988) - -___ - -### parentIndexNumber - -• `Optional` `Readonly` **parentIndexNumber**: `number` - -Optional filter by parent index number. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:785](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L785) - -___ - -### person - -• `Optional` `Readonly` **person**: `string` - -Optional. If specified, results will be filtered to include only those containing the specified person. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1100](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1100) - -___ - -### personIds - -• `Optional` `Readonly` **personIds**: `string`[] - -Optional. If specified, results will be filtered to include only those containing the specified person id. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1107](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1107) - -___ - -### personTypes - -• `Optional` `Readonly` **personTypes**: `string`[] - -Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1114](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1114) - -___ - -### recursive - -• `Optional` `Readonly` **recursive**: `boolean` - -When searching within folders, this determines whether or not the search will be recursive. true/false. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:967](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L967) - -___ - -### searchTerm - -• `Optional` `Readonly` **searchTerm**: `string` - -Optional. Filter based on a search term. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:974](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L974) - -___ - -### seriesStatus - -• `Optional` `Readonly` **seriesStatus**: [`SeriesStatus`](../enums/generated_client.SeriesStatus.md)[] - -Optional filter by Series Status. Allows multiple, comma delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1261](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1261) - -___ - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string`[] - -Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1037](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1037) - -___ - -### sortOrder - -• `Optional` `Readonly` **sortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md)[] - -Sort Order - Ascending,Descending. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:981](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L981) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:953](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L953) - -___ - -### studioIds - -• `Optional` `Readonly` **studioIds**: `string`[] - -Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1289](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1289) - -___ - -### studios - -• `Optional` `Readonly` **studios**: `string`[] - -Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1121](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1121) - -___ - -### tags - -• `Optional` `Readonly` **tags**: `string`[] - -Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1065](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1065) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -The user id. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:729](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L729) - -___ - -### videoTypes - -• `Optional` `Readonly` **videoTypes**: [`VideoType`](../enums/generated_client.VideoType.md)[] - -Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1184](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1184) - -___ - -### years - -• `Optional` `Readonly` **years**: `number`[] - -Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. - -**`memberof`** TrailersApiGetTrailers - -#### Defined in - -[generated-client/api/trailers-api.ts:1072](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1072) diff --git a/docs/interfaces/generated_client.TranscodingInfo.md b/docs/interfaces/generated_client.TranscodingInfo.md deleted file mode 100644 index a4df18cb5..000000000 --- a/docs/interfaces/generated_client.TranscodingInfo.md +++ /dev/null @@ -1,183 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TranscodingInfo - -# Interface: TranscodingInfo - -[generated-client](../modules/generated_client.md).TranscodingInfo - -**`export`** - -**`interface`** TranscodingInfo - -## Table of contents - -### Properties - -- [AudioChannels](generated_client.TranscodingInfo.md#audiochannels) -- [AudioCodec](generated_client.TranscodingInfo.md#audiocodec) -- [Bitrate](generated_client.TranscodingInfo.md#bitrate) -- [CompletionPercentage](generated_client.TranscodingInfo.md#completionpercentage) -- [Container](generated_client.TranscodingInfo.md#container) -- [Framerate](generated_client.TranscodingInfo.md#framerate) -- [HardwareAccelerationType](generated_client.TranscodingInfo.md#hardwareaccelerationtype) -- [Height](generated_client.TranscodingInfo.md#height) -- [IsAudioDirect](generated_client.TranscodingInfo.md#isaudiodirect) -- [IsVideoDirect](generated_client.TranscodingInfo.md#isvideodirect) -- [TranscodeReasons](generated_client.TranscodingInfo.md#transcodereasons) -- [VideoCodec](generated_client.TranscodingInfo.md#videocodec) -- [Width](generated_client.TranscodingInfo.md#width) - -## Properties - -### AudioChannels - -• `Optional` **AudioChannels**: ``null`` \| `number` - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:89](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L89) - -___ - -### AudioCodec - -• `Optional` **AudioCodec**: ``null`` \| `string` - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L29) - -___ - -### Bitrate - -• `Optional` **Bitrate**: ``null`` \| `number` - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L59) - -___ - -### CompletionPercentage - -• `Optional` **CompletionPercentage**: ``null`` \| `number` - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L71) - -___ - -### Container - -• `Optional` **Container**: ``null`` \| `string` - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L41) - -___ - -### Framerate - -• `Optional` **Framerate**: ``null`` \| `number` - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L65) - -___ - -### HardwareAccelerationType - -• `Optional` **HardwareAccelerationType**: [`HardwareEncodingType`](../enums/generated_client.HardwareEncodingType.md) - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:95](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L95) - -___ - -### Height - -• `Optional` **Height**: ``null`` \| `number` - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:83](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L83) - -___ - -### IsAudioDirect - -• `Optional` **IsAudioDirect**: `boolean` - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L53) - -___ - -### IsVideoDirect - -• `Optional` **IsVideoDirect**: `boolean` - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L47) - -___ - -### TranscodeReasons - -• `Optional` **TranscodeReasons**: [`TranscodingInfoTranscodeReasonsEnum`](../enums/generated_client.TranscodingInfoTranscodeReasonsEnum.md) - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:101](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L101) - -___ - -### VideoCodec - -• `Optional` **VideoCodec**: ``null`` \| `string` - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L35) - -___ - -### Width - -• `Optional` **Width**: ``null`` \| `number` - -**`memberof`** TranscodingInfo - -#### Defined in - -[generated-client/models/transcoding-info.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-info.ts#L77) diff --git a/docs/interfaces/generated_client.TranscodingProfile.md b/docs/interfaces/generated_client.TranscodingProfile.md deleted file mode 100644 index 9e9f4817b..000000000 --- a/docs/interfaces/generated_client.TranscodingProfile.md +++ /dev/null @@ -1,222 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TranscodingProfile - -# Interface: TranscodingProfile - -[generated-client](../modules/generated_client.md).TranscodingProfile - -**`export`** - -**`interface`** TranscodingProfile - -## Table of contents - -### Properties - -- [AudioCodec](generated_client.TranscodingProfile.md#audiocodec) -- [BreakOnNonKeyFrames](generated_client.TranscodingProfile.md#breakonnonkeyframes) -- [Conditions](generated_client.TranscodingProfile.md#conditions) -- [Container](generated_client.TranscodingProfile.md#container) -- [Context](generated_client.TranscodingProfile.md#context) -- [CopyTimestamps](generated_client.TranscodingProfile.md#copytimestamps) -- [EnableMpegtsM2TsMode](generated_client.TranscodingProfile.md#enablempegtsm2tsmode) -- [EnableSubtitlesInManifest](generated_client.TranscodingProfile.md#enablesubtitlesinmanifest) -- [EstimateContentLength](generated_client.TranscodingProfile.md#estimatecontentlength) -- [MaxAudioChannels](generated_client.TranscodingProfile.md#maxaudiochannels) -- [MinSegments](generated_client.TranscodingProfile.md#minsegments) -- [Protocol](generated_client.TranscodingProfile.md#protocol) -- [SegmentLength](generated_client.TranscodingProfile.md#segmentlength) -- [TranscodeSeekInfo](generated_client.TranscodingProfile.md#transcodeseekinfo) -- [Type](generated_client.TranscodingProfile.md#type) -- [VideoCodec](generated_client.TranscodingProfile.md#videocodec) - -## Properties - -### AudioCodec - -• `Optional` **AudioCodec**: `string` - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L50) - -___ - -### BreakOnNonKeyFrames - -• `Optional` **BreakOnNonKeyFrames**: `boolean` - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:116](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L116) - -___ - -### Conditions - -• `Optional` **Conditions**: [`ProfileCondition`](generated_client.ProfileCondition.md)[] - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:122](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L122) - -___ - -### Container - -• `Optional` **Container**: `string` - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L32) - -___ - -### Context - -• `Optional` **Context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:86](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L86) - -___ - -### CopyTimestamps - -• `Optional` **CopyTimestamps**: `boolean` - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:80](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L80) - -___ - -### EnableMpegtsM2TsMode - -• `Optional` **EnableMpegtsM2TsMode**: `boolean` - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:68](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L68) - -___ - -### EnableSubtitlesInManifest - -• `Optional` **EnableSubtitlesInManifest**: `boolean` - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:92](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L92) - -___ - -### EstimateContentLength - -• `Optional` **EstimateContentLength**: `boolean` - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:62](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L62) - -___ - -### MaxAudioChannels - -• `Optional` **MaxAudioChannels**: ``null`` \| `string` - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:98](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L98) - -___ - -### MinSegments - -• `Optional` **MinSegments**: `number` - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:104](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L104) - -___ - -### Protocol - -• `Optional` **Protocol**: `string` - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:56](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L56) - -___ - -### SegmentLength - -• `Optional` **SegmentLength**: `number` - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:110](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L110) - -___ - -### TranscodeSeekInfo - -• `Optional` **TranscodeSeekInfo**: [`TranscodeSeekInfo`](../enums/generated_client.TranscodeSeekInfo.md) - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:74](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L74) - -___ - -### Type - -• `Optional` **Type**: [`DlnaProfileType`](../enums/generated_client.DlnaProfileType.md) - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:38](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L38) - -___ - -### VideoCodec - -• `Optional` **VideoCodec**: `string` - -**`memberof`** TranscodingProfile - -#### Defined in - -[generated-client/models/transcoding-profile.ts:44](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/transcoding-profile.ts#L44) diff --git a/docs/interfaces/generated_client.TunerChannelMapping.md b/docs/interfaces/generated_client.TunerChannelMapping.md deleted file mode 100644 index 38fc33f37..000000000 --- a/docs/interfaces/generated_client.TunerChannelMapping.md +++ /dev/null @@ -1,66 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TunerChannelMapping - -# Interface: TunerChannelMapping - -[generated-client](../modules/generated_client.md).TunerChannelMapping - -**`export`** - -**`interface`** TunerChannelMapping - -## Table of contents - -### Properties - -- [Id](generated_client.TunerChannelMapping.md#id) -- [Name](generated_client.TunerChannelMapping.md#name) -- [ProviderChannelId](generated_client.TunerChannelMapping.md#providerchannelid) -- [ProviderChannelName](generated_client.TunerChannelMapping.md#providerchannelname) - -## Properties - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -**`memberof`** TunerChannelMapping - -#### Defined in - -[generated-client/models/tuner-channel-mapping.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-channel-mapping.ts#L46) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -**`memberof`** TunerChannelMapping - -#### Defined in - -[generated-client/models/tuner-channel-mapping.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-channel-mapping.ts#L28) - -___ - -### ProviderChannelId - -• `Optional` **ProviderChannelId**: ``null`` \| `string` - -**`memberof`** TunerChannelMapping - -#### Defined in - -[generated-client/models/tuner-channel-mapping.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-channel-mapping.ts#L40) - -___ - -### ProviderChannelName - -• `Optional` **ProviderChannelName**: ``null`` \| `string` - -**`memberof`** TunerChannelMapping - -#### Defined in - -[generated-client/models/tuner-channel-mapping.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-channel-mapping.ts#L34) diff --git a/docs/interfaces/generated_client.TunerHostInfo.md b/docs/interfaces/generated_client.TunerHostInfo.md deleted file mode 100644 index 2902e29e5..000000000 --- a/docs/interfaces/generated_client.TunerHostInfo.md +++ /dev/null @@ -1,157 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TunerHostInfo - -# Interface: TunerHostInfo - -[generated-client](../modules/generated_client.md).TunerHostInfo - -**`export`** - -**`interface`** TunerHostInfo - -## Table of contents - -### Properties - -- [AllowHWTranscoding](generated_client.TunerHostInfo.md#allowhwtranscoding) -- [DeviceId](generated_client.TunerHostInfo.md#deviceid) -- [EnableStreamLooping](generated_client.TunerHostInfo.md#enablestreamlooping) -- [FriendlyName](generated_client.TunerHostInfo.md#friendlyname) -- [Id](generated_client.TunerHostInfo.md#id) -- [ImportFavoritesOnly](generated_client.TunerHostInfo.md#importfavoritesonly) -- [Source](generated_client.TunerHostInfo.md#source) -- [TunerCount](generated_client.TunerHostInfo.md#tunercount) -- [Type](generated_client.TunerHostInfo.md#type) -- [Url](generated_client.TunerHostInfo.md#url) -- [UserAgent](generated_client.TunerHostInfo.md#useragent) - -## Properties - -### AllowHWTranscoding - -• `Optional` **AllowHWTranscoding**: `boolean` - -**`memberof`** TunerHostInfo - -#### Defined in - -[generated-client/models/tuner-host-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-host-info.ts#L64) - -___ - -### DeviceId - -• `Optional` **DeviceId**: ``null`` \| `string` - -**`memberof`** TunerHostInfo - -#### Defined in - -[generated-client/models/tuner-host-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-host-info.ts#L46) - -___ - -### EnableStreamLooping - -• `Optional` **EnableStreamLooping**: `boolean` - -**`memberof`** TunerHostInfo - -#### Defined in - -[generated-client/models/tuner-host-info.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-host-info.ts#L70) - -___ - -### FriendlyName - -• `Optional` **FriendlyName**: ``null`` \| `string` - -**`memberof`** TunerHostInfo - -#### Defined in - -[generated-client/models/tuner-host-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-host-info.ts#L52) - -___ - -### Id - -• `Optional` **Id**: ``null`` \| `string` - -**`memberof`** TunerHostInfo - -#### Defined in - -[generated-client/models/tuner-host-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-host-info.ts#L28) - -___ - -### ImportFavoritesOnly - -• `Optional` **ImportFavoritesOnly**: `boolean` - -**`memberof`** TunerHostInfo - -#### Defined in - -[generated-client/models/tuner-host-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-host-info.ts#L58) - -___ - -### Source - -• `Optional` **Source**: ``null`` \| `string` - -**`memberof`** TunerHostInfo - -#### Defined in - -[generated-client/models/tuner-host-info.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-host-info.ts#L76) - -___ - -### TunerCount - -• `Optional` **TunerCount**: `number` - -**`memberof`** TunerHostInfo - -#### Defined in - -[generated-client/models/tuner-host-info.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-host-info.ts#L82) - -___ - -### Type - -• `Optional` **Type**: ``null`` \| `string` - -**`memberof`** TunerHostInfo - -#### Defined in - -[generated-client/models/tuner-host-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-host-info.ts#L40) - -___ - -### Url - -• `Optional` **Url**: ``null`` \| `string` - -**`memberof`** TunerHostInfo - -#### Defined in - -[generated-client/models/tuner-host-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-host-info.ts#L34) - -___ - -### UserAgent - -• `Optional` **UserAgent**: ``null`` \| `string` - -**`memberof`** TunerHostInfo - -#### Defined in - -[generated-client/models/tuner-host-info.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/tuner-host-info.ts#L88) diff --git a/docs/interfaces/generated_client.TvShowsApiGetEpisodesRequest.md b/docs/interfaces/generated_client.TvShowsApiGetEpisodesRequest.md deleted file mode 100644 index 6da5244e3..000000000 --- a/docs/interfaces/generated_client.TvShowsApiGetEpisodesRequest.md +++ /dev/null @@ -1,241 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TvShowsApiGetEpisodesRequest - -# Interface: TvShowsApiGetEpisodesRequest - -[generated-client](../modules/generated_client.md).TvShowsApiGetEpisodesRequest - -Request parameters for getEpisodes operation in TvShowsApi. - -**`export`** - -**`interface`** TvShowsApiGetEpisodesRequest - -## Table of contents - -### Properties - -- [adjacentTo](generated_client.TvShowsApiGetEpisodesRequest.md#adjacentto) -- [enableImageTypes](generated_client.TvShowsApiGetEpisodesRequest.md#enableimagetypes) -- [enableImages](generated_client.TvShowsApiGetEpisodesRequest.md#enableimages) -- [enableUserData](generated_client.TvShowsApiGetEpisodesRequest.md#enableuserdata) -- [fields](generated_client.TvShowsApiGetEpisodesRequest.md#fields) -- [imageTypeLimit](generated_client.TvShowsApiGetEpisodesRequest.md#imagetypelimit) -- [isMissing](generated_client.TvShowsApiGetEpisodesRequest.md#ismissing) -- [limit](generated_client.TvShowsApiGetEpisodesRequest.md#limit) -- [season](generated_client.TvShowsApiGetEpisodesRequest.md#season) -- [seasonId](generated_client.TvShowsApiGetEpisodesRequest.md#seasonid) -- [seriesId](generated_client.TvShowsApiGetEpisodesRequest.md#seriesid) -- [sortBy](generated_client.TvShowsApiGetEpisodesRequest.md#sortby) -- [startIndex](generated_client.TvShowsApiGetEpisodesRequest.md#startindex) -- [startItemId](generated_client.TvShowsApiGetEpisodesRequest.md#startitemid) -- [userId](generated_client.TvShowsApiGetEpisodesRequest.md#userid) - -## Properties - -### adjacentTo - -• `Optional` `Readonly` **adjacentTo**: `string` - -Optional. Return items that are siblings of a supplied item. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:657](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L657) - -___ - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:699](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L699) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional, include image information in output. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:685](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L685) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:706](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L706) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:629](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L629) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional, the max number of images to return, per image type. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:692](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L692) - -___ - -### isMissing - -• `Optional` `Readonly` **isMissing**: `boolean` - -Optional. Filter by items that are missing episodes or not. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:650](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L650) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:678](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L678) - -___ - -### season - -• `Optional` `Readonly` **season**: `number` - -Optional filter by season number. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:636](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L636) - -___ - -### seasonId - -• `Optional` `Readonly` **seasonId**: `string` - -Optional. Filter by season id. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:643](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L643) - -___ - -### seriesId - -• `Readonly` **seriesId**: `string` - -The series id. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:615](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L615) - -___ - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string` - -Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:713](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L713) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:671](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L671) - -___ - -### startItemId - -• `Optional` `Readonly` **startItemId**: `string` - -Optional. Skip through the list until a given item is found. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:664](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L664) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -The user id. - -**`memberof`** TvShowsApiGetEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:622](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L622) diff --git a/docs/interfaces/generated_client.TvShowsApiGetNextUpRequest.md b/docs/interfaces/generated_client.TvShowsApiGetNextUpRequest.md deleted file mode 100644 index 28f2781de..000000000 --- a/docs/interfaces/generated_client.TvShowsApiGetNextUpRequest.md +++ /dev/null @@ -1,226 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TvShowsApiGetNextUpRequest - -# Interface: TvShowsApiGetNextUpRequest - -[generated-client](../modules/generated_client.md).TvShowsApiGetNextUpRequest - -Request parameters for getNextUp operation in TvShowsApi. - -**`export`** - -**`interface`** TvShowsApiGetNextUpRequest - -## Table of contents - -### Properties - -- [disableFirstEpisode](generated_client.TvShowsApiGetNextUpRequest.md#disablefirstepisode) -- [enableImageTypes](generated_client.TvShowsApiGetNextUpRequest.md#enableimagetypes) -- [enableImages](generated_client.TvShowsApiGetNextUpRequest.md#enableimages) -- [enableRewatching](generated_client.TvShowsApiGetNextUpRequest.md#enablerewatching) -- [enableTotalRecordCount](generated_client.TvShowsApiGetNextUpRequest.md#enabletotalrecordcount) -- [enableUserData](generated_client.TvShowsApiGetNextUpRequest.md#enableuserdata) -- [fields](generated_client.TvShowsApiGetNextUpRequest.md#fields) -- [imageTypeLimit](generated_client.TvShowsApiGetNextUpRequest.md#imagetypelimit) -- [limit](generated_client.TvShowsApiGetNextUpRequest.md#limit) -- [nextUpDateCutoff](generated_client.TvShowsApiGetNextUpRequest.md#nextupdatecutoff) -- [parentId](generated_client.TvShowsApiGetNextUpRequest.md#parentid) -- [seriesId](generated_client.TvShowsApiGetNextUpRequest.md#seriesid) -- [startIndex](generated_client.TvShowsApiGetNextUpRequest.md#startindex) -- [userId](generated_client.TvShowsApiGetNextUpRequest.md#userid) - -## Properties - -### disableFirstEpisode - -• `Optional` `Readonly` **disableFirstEpisode**: `boolean` - -Whether to disable sending the first episode in a series as next up. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:811](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L811) - -___ - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:783](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L783) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:769](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L769) - -___ - -### enableRewatching - -• `Optional` `Readonly` **enableRewatching**: `boolean` - -Whether to include watched episode in next up results. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:818](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L818) - -___ - -### enableTotalRecordCount - -• `Optional` `Readonly` **enableTotalRecordCount**: `boolean` - -Whether to enable the total records count. Defaults to true. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:804](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L804) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:790](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L790) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:748](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L748) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:776](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L776) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:741](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L741) - -___ - -### nextUpDateCutoff - -• `Optional` `Readonly` **nextUpDateCutoff**: `string` - -Optional. Starting date of shows to show in Next Up section. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:797](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L797) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Optional. Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:762](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L762) - -___ - -### seriesId - -• `Optional` `Readonly` **seriesId**: `string` - -Optional. Filter by series id. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:755](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L755) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:734](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L734) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -The user id of the user to get the next up episodes for. - -**`memberof`** TvShowsApiGetNextUp - -#### Defined in - -[generated-client/api/tv-shows-api.ts:727](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L727) diff --git a/docs/interfaces/generated_client.TvShowsApiGetSeasonsRequest.md b/docs/interfaces/generated_client.TvShowsApiGetSeasonsRequest.md deleted file mode 100644 index 0dc9b24ea..000000000 --- a/docs/interfaces/generated_client.TvShowsApiGetSeasonsRequest.md +++ /dev/null @@ -1,166 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TvShowsApiGetSeasonsRequest - -# Interface: TvShowsApiGetSeasonsRequest - -[generated-client](../modules/generated_client.md).TvShowsApiGetSeasonsRequest - -Request parameters for getSeasons operation in TvShowsApi. - -**`export`** - -**`interface`** TvShowsApiGetSeasonsRequest - -## Table of contents - -### Properties - -- [adjacentTo](generated_client.TvShowsApiGetSeasonsRequest.md#adjacentto) -- [enableImageTypes](generated_client.TvShowsApiGetSeasonsRequest.md#enableimagetypes) -- [enableImages](generated_client.TvShowsApiGetSeasonsRequest.md#enableimages) -- [enableUserData](generated_client.TvShowsApiGetSeasonsRequest.md#enableuserdata) -- [fields](generated_client.TvShowsApiGetSeasonsRequest.md#fields) -- [imageTypeLimit](generated_client.TvShowsApiGetSeasonsRequest.md#imagetypelimit) -- [isMissing](generated_client.TvShowsApiGetSeasonsRequest.md#ismissing) -- [isSpecialSeason](generated_client.TvShowsApiGetSeasonsRequest.md#isspecialseason) -- [seriesId](generated_client.TvShowsApiGetSeasonsRequest.md#seriesid) -- [userId](generated_client.TvShowsApiGetSeasonsRequest.md#userid) - -## Properties - -### adjacentTo - -• `Optional` `Readonly` **adjacentTo**: `string` - -Optional. Return items that are siblings of a supplied item. - -**`memberof`** TvShowsApiGetSeasons - -#### Defined in - -[generated-client/api/tv-shows-api.ts:867](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L867) - -___ - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** TvShowsApiGetSeasons - -#### Defined in - -[generated-client/api/tv-shows-api.ts:888](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L888) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** TvShowsApiGetSeasons - -#### Defined in - -[generated-client/api/tv-shows-api.ts:874](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L874) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** TvShowsApiGetSeasons - -#### Defined in - -[generated-client/api/tv-shows-api.ts:895](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L895) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. - -**`memberof`** TvShowsApiGetSeasons - -#### Defined in - -[generated-client/api/tv-shows-api.ts:846](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L846) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** TvShowsApiGetSeasons - -#### Defined in - -[generated-client/api/tv-shows-api.ts:881](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L881) - -___ - -### isMissing - -• `Optional` `Readonly` **isMissing**: `boolean` - -Optional. Filter by items that are missing episodes or not. - -**`memberof`** TvShowsApiGetSeasons - -#### Defined in - -[generated-client/api/tv-shows-api.ts:860](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L860) - -___ - -### isSpecialSeason - -• `Optional` `Readonly` **isSpecialSeason**: `boolean` - -Optional. Filter by special season. - -**`memberof`** TvShowsApiGetSeasons - -#### Defined in - -[generated-client/api/tv-shows-api.ts:853](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L853) - -___ - -### seriesId - -• `Readonly` **seriesId**: `string` - -The series id. - -**`memberof`** TvShowsApiGetSeasons - -#### Defined in - -[generated-client/api/tv-shows-api.ts:832](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L832) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -The user id. - -**`memberof`** TvShowsApiGetSeasons - -#### Defined in - -[generated-client/api/tv-shows-api.ts:839](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L839) diff --git a/docs/interfaces/generated_client.TvShowsApiGetUpcomingEpisodesRequest.md b/docs/interfaces/generated_client.TvShowsApiGetUpcomingEpisodesRequest.md deleted file mode 100644 index 39cc5dc41..000000000 --- a/docs/interfaces/generated_client.TvShowsApiGetUpcomingEpisodesRequest.md +++ /dev/null @@ -1,151 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TvShowsApiGetUpcomingEpisodesRequest - -# Interface: TvShowsApiGetUpcomingEpisodesRequest - -[generated-client](../modules/generated_client.md).TvShowsApiGetUpcomingEpisodesRequest - -Request parameters for getUpcomingEpisodes operation in TvShowsApi. - -**`export`** - -**`interface`** TvShowsApiGetUpcomingEpisodesRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.TvShowsApiGetUpcomingEpisodesRequest.md#enableimagetypes) -- [enableImages](generated_client.TvShowsApiGetUpcomingEpisodesRequest.md#enableimages) -- [enableUserData](generated_client.TvShowsApiGetUpcomingEpisodesRequest.md#enableuserdata) -- [fields](generated_client.TvShowsApiGetUpcomingEpisodesRequest.md#fields) -- [imageTypeLimit](generated_client.TvShowsApiGetUpcomingEpisodesRequest.md#imagetypelimit) -- [limit](generated_client.TvShowsApiGetUpcomingEpisodesRequest.md#limit) -- [parentId](generated_client.TvShowsApiGetUpcomingEpisodesRequest.md#parentid) -- [startIndex](generated_client.TvShowsApiGetUpcomingEpisodesRequest.md#startindex) -- [userId](generated_client.TvShowsApiGetUpcomingEpisodesRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** TvShowsApiGetUpcomingEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:958](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L958) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** TvShowsApiGetUpcomingEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:944](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L944) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** TvShowsApiGetUpcomingEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:965](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L965) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** TvShowsApiGetUpcomingEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:930](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L930) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** TvShowsApiGetUpcomingEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:951](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L951) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** TvShowsApiGetUpcomingEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:923](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L923) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Optional. Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** TvShowsApiGetUpcomingEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:937](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L937) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Optional. The record index to start at. All items with a lower index will be dropped from the results. - -**`memberof`** TvShowsApiGetUpcomingEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:916](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L916) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -The user id of the user to get the upcoming episodes for. - -**`memberof`** TvShowsApiGetUpcomingEpisodes - -#### Defined in - -[generated-client/api/tv-shows-api.ts:909](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L909) diff --git a/docs/interfaces/generated_client.TypeOptions.md b/docs/interfaces/generated_client.TypeOptions.md deleted file mode 100644 index 778cf2d2c..000000000 --- a/docs/interfaces/generated_client.TypeOptions.md +++ /dev/null @@ -1,92 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TypeOptions - -# Interface: TypeOptions - -[generated-client](../modules/generated_client.md).TypeOptions - -**`export`** - -**`interface`** TypeOptions - -## Table of contents - -### Properties - -- [ImageFetcherOrder](generated_client.TypeOptions.md#imagefetcherorder) -- [ImageFetchers](generated_client.TypeOptions.md#imagefetchers) -- [ImageOptions](generated_client.TypeOptions.md#imageoptions) -- [MetadataFetcherOrder](generated_client.TypeOptions.md#metadatafetcherorder) -- [MetadataFetchers](generated_client.TypeOptions.md#metadatafetchers) -- [Type](generated_client.TypeOptions.md#type) - -## Properties - -### ImageFetcherOrder - -• `Optional` **ImageFetcherOrder**: ``null`` \| `string`[] - -**`memberof`** TypeOptions - -#### Defined in - -[generated-client/models/type-options.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/type-options.ts#L53) - -___ - -### ImageFetchers - -• `Optional` **ImageFetchers**: ``null`` \| `string`[] - -**`memberof`** TypeOptions - -#### Defined in - -[generated-client/models/type-options.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/type-options.ts#L47) - -___ - -### ImageOptions - -• `Optional` **ImageOptions**: ``null`` \| [`ImageOption`](generated_client.ImageOption.md)[] - -**`memberof`** TypeOptions - -#### Defined in - -[generated-client/models/type-options.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/type-options.ts#L59) - -___ - -### MetadataFetcherOrder - -• `Optional` **MetadataFetcherOrder**: ``null`` \| `string`[] - -**`memberof`** TypeOptions - -#### Defined in - -[generated-client/models/type-options.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/type-options.ts#L41) - -___ - -### MetadataFetchers - -• `Optional` **MetadataFetchers**: ``null`` \| `string`[] - -**`memberof`** TypeOptions - -#### Defined in - -[generated-client/models/type-options.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/type-options.ts#L35) - -___ - -### Type - -• `Optional` **Type**: ``null`` \| `string` - -**`memberof`** TypeOptions - -#### Defined in - -[generated-client/models/type-options.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/type-options.ts#L29) diff --git a/docs/interfaces/generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md b/docs/interfaces/generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md deleted file mode 100644 index 8f9a13775..000000000 --- a/docs/interfaces/generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md +++ /dev/null @@ -1,286 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UniversalAudioApiGetUniversalAudioStreamRequest - -# Interface: UniversalAudioApiGetUniversalAudioStreamRequest - -[generated-client](../modules/generated_client.md).UniversalAudioApiGetUniversalAudioStreamRequest - -Request parameters for getUniversalAudioStream operation in UniversalAudioApi. - -**`export`** - -**`interface`** UniversalAudioApiGetUniversalAudioStreamRequest - -## Table of contents - -### Properties - -- [audioBitRate](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#audiobitrate) -- [audioCodec](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#audiocodec) -- [breakOnNonKeyFrames](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#breakonnonkeyframes) -- [container](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#container) -- [deviceId](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#deviceid) -- [enableRedirection](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#enableredirection) -- [enableRemoteMedia](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#enableremotemedia) -- [itemId](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#itemid) -- [maxAudioBitDepth](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#maxaudiochannels) -- [maxAudioSampleRate](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#maxaudiosamplerate) -- [maxStreamingBitrate](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#maxstreamingbitrate) -- [mediaSourceId](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#mediasourceid) -- [startTimeTicks](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#starttimeticks) -- [transcodingAudioChannels](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#transcodingaudiochannels) -- [transcodingContainer](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#transcodingcontainer) -- [transcodingProtocol](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#transcodingprotocol) -- [userId](generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md#userid) - -## Properties - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:480](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L480) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. The audio codec to transcode to. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:452](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L452) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:529](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L529) - -___ - -### container - -• `Optional` `Readonly` **container**: `string`[] - -Optional. The audio container. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:424](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L424) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:438](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L438) - -___ - -### enableRedirection - -• `Optional` `Readonly` **enableRedirection**: `boolean` - -Whether to enable redirection. Defaults to true. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:536](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L536) - -___ - -### enableRemoteMedia - -• `Optional` `Readonly` **enableRemoteMedia**: `boolean` - -Optional. Whether to enable remote media. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:522](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L522) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:417](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L417) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:515](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L515) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. The maximum number of audio channels. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:459](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L459) - -___ - -### maxAudioSampleRate - -• `Optional` `Readonly` **maxAudioSampleRate**: `number` - -Optional. The maximum audio sample rate. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:508](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L508) - -___ - -### maxStreamingBitrate - -• `Optional` `Readonly` **maxStreamingBitrate**: `number` - -Optional. The maximum streaming bitrate. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:473](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L473) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:431](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L431) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:487](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L487) - -___ - -### transcodingAudioChannels - -• `Optional` `Readonly` **transcodingAudioChannels**: `number` - -Optional. The number of how many audio channels to transcode to. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:466](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L466) - -___ - -### transcodingContainer - -• `Optional` `Readonly` **transcodingContainer**: `string` - -Optional. The container to transcode to. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:494](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L494) - -___ - -### transcodingProtocol - -• `Optional` `Readonly` **transcodingProtocol**: `string` - -Optional. The transcoding protocol. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:501](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L501) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. The user id. - -**`memberof`** UniversalAudioApiGetUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:445](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L445) diff --git a/docs/interfaces/generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md b/docs/interfaces/generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md deleted file mode 100644 index 1e83dd515..000000000 --- a/docs/interfaces/generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md +++ /dev/null @@ -1,286 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UniversalAudioApiHeadUniversalAudioStreamRequest - -# Interface: UniversalAudioApiHeadUniversalAudioStreamRequest - -[generated-client](../modules/generated_client.md).UniversalAudioApiHeadUniversalAudioStreamRequest - -Request parameters for headUniversalAudioStream operation in UniversalAudioApi. - -**`export`** - -**`interface`** UniversalAudioApiHeadUniversalAudioStreamRequest - -## Table of contents - -### Properties - -- [audioBitRate](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#audiobitrate) -- [audioCodec](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#audiocodec) -- [breakOnNonKeyFrames](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#breakonnonkeyframes) -- [container](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#container) -- [deviceId](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#deviceid) -- [enableRedirection](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#enableredirection) -- [enableRemoteMedia](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#enableremotemedia) -- [itemId](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#itemid) -- [maxAudioBitDepth](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#maxaudiochannels) -- [maxAudioSampleRate](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#maxaudiosamplerate) -- [maxStreamingBitrate](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#maxstreamingbitrate) -- [mediaSourceId](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#mediasourceid) -- [startTimeTicks](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#starttimeticks) -- [transcodingAudioChannels](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#transcodingaudiochannels) -- [transcodingContainer](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#transcodingcontainer) -- [transcodingProtocol](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#transcodingprotocol) -- [userId](generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md#userid) - -## Properties - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:613](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L613) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. The audio codec to transcode to. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:585](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L585) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:662](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L662) - -___ - -### container - -• `Optional` `Readonly` **container**: `string`[] - -Optional. The audio container. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:557](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L557) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:571](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L571) - -___ - -### enableRedirection - -• `Optional` `Readonly` **enableRedirection**: `boolean` - -Whether to enable redirection. Defaults to true. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:669](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L669) - -___ - -### enableRemoteMedia - -• `Optional` `Readonly` **enableRemoteMedia**: `boolean` - -Optional. Whether to enable remote media. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:655](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L655) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:550](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L550) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:648](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L648) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. The maximum number of audio channels. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:592](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L592) - -___ - -### maxAudioSampleRate - -• `Optional` `Readonly` **maxAudioSampleRate**: `number` - -Optional. The maximum audio sample rate. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:641](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L641) - -___ - -### maxStreamingBitrate - -• `Optional` `Readonly` **maxStreamingBitrate**: `number` - -Optional. The maximum streaming bitrate. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:606](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L606) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:564](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L564) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:620](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L620) - -___ - -### transcodingAudioChannels - -• `Optional` `Readonly` **transcodingAudioChannels**: `number` - -Optional. The number of how many audio channels to transcode to. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:599](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L599) - -___ - -### transcodingContainer - -• `Optional` `Readonly` **transcodingContainer**: `string` - -Optional. The container to transcode to. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:627](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L627) - -___ - -### transcodingProtocol - -• `Optional` `Readonly` **transcodingProtocol**: `string` - -Optional. The transcoding protocol. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:634](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L634) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. The user id. - -**`memberof`** UniversalAudioApiHeadUniversalAudioStream - -#### Defined in - -[generated-client/api/universal-audio-api.ts:578](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L578) diff --git a/docs/interfaces/generated_client.UpdateLibraryOptionsDto.md b/docs/interfaces/generated_client.UpdateLibraryOptionsDto.md deleted file mode 100644 index 3e8811dc5..000000000 --- a/docs/interfaces/generated_client.UpdateLibraryOptionsDto.md +++ /dev/null @@ -1,44 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UpdateLibraryOptionsDto - -# Interface: UpdateLibraryOptionsDto - -[generated-client](../modules/generated_client.md).UpdateLibraryOptionsDto - -Update library options dto. - -**`export`** - -**`interface`** UpdateLibraryOptionsDto - -## Table of contents - -### Properties - -- [Id](generated_client.UpdateLibraryOptionsDto.md#id) -- [LibraryOptions](generated_client.UpdateLibraryOptionsDto.md#libraryoptions) - -## Properties - -### Id - -• `Optional` **Id**: `string` - -Gets or sets the library item id. - -**`memberof`** UpdateLibraryOptionsDto - -#### Defined in - -[generated-client/models/update-library-options-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/update-library-options-dto.ts#L29) - -___ - -### LibraryOptions - -• `Optional` **LibraryOptions**: [`LibraryOptions`](generated_client.LibraryOptions.md) - -**`memberof`** UpdateLibraryOptionsDto - -#### Defined in - -[generated-client/models/update-library-options-dto.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/update-library-options-dto.ts#L35) diff --git a/docs/interfaces/generated_client.UpdateMediaPathRequestDto.md b/docs/interfaces/generated_client.UpdateMediaPathRequestDto.md deleted file mode 100644 index f067f7864..000000000 --- a/docs/interfaces/generated_client.UpdateMediaPathRequestDto.md +++ /dev/null @@ -1,44 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UpdateMediaPathRequestDto - -# Interface: UpdateMediaPathRequestDto - -[generated-client](../modules/generated_client.md).UpdateMediaPathRequestDto - -Update library options dto. - -**`export`** - -**`interface`** UpdateMediaPathRequestDto - -## Table of contents - -### Properties - -- [Name](generated_client.UpdateMediaPathRequestDto.md#name) -- [PathInfo](generated_client.UpdateMediaPathRequestDto.md#pathinfo) - -## Properties - -### Name - -• **Name**: `string` - -Gets or sets the library name. - -**`memberof`** UpdateMediaPathRequestDto - -#### Defined in - -[generated-client/models/update-media-path-request-dto.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/update-media-path-request-dto.ts#L29) - -___ - -### PathInfo - -• **PathInfo**: [`MediaPathInfo`](generated_client.MediaPathInfo.md) - -**`memberof`** UpdateMediaPathRequestDto - -#### Defined in - -[generated-client/models/update-media-path-request-dto.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/update-media-path-request-dto.ts#L35) diff --git a/docs/interfaces/generated_client.UpdateUserEasyPassword.md b/docs/interfaces/generated_client.UpdateUserEasyPassword.md deleted file mode 100644 index cc7441bc2..000000000 --- a/docs/interfaces/generated_client.UpdateUserEasyPassword.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UpdateUserEasyPassword - -# Interface: UpdateUserEasyPassword - -[generated-client](../modules/generated_client.md).UpdateUserEasyPassword - -The update user easy password request body. - -**`export`** - -**`interface`** UpdateUserEasyPassword - -## Table of contents - -### Properties - -- [NewPassword](generated_client.UpdateUserEasyPassword.md#newpassword) -- [NewPw](generated_client.UpdateUserEasyPassword.md#newpw) -- [ResetPassword](generated_client.UpdateUserEasyPassword.md#resetpassword) - -## Properties - -### NewPassword - -• `Optional` **NewPassword**: ``null`` \| `string` - -Gets or sets the new sha1-hashed password. - -**`memberof`** UpdateUserEasyPassword - -#### Defined in - -[generated-client/models/update-user-easy-password.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/update-user-easy-password.ts#L28) - -___ - -### NewPw - -• `Optional` **NewPw**: ``null`` \| `string` - -Gets or sets the new password. - -**`memberof`** UpdateUserEasyPassword - -#### Defined in - -[generated-client/models/update-user-easy-password.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/update-user-easy-password.ts#L34) - -___ - -### ResetPassword - -• `Optional` **ResetPassword**: `boolean` - -Gets or sets a value indicating whether to reset the password. - -**`memberof`** UpdateUserEasyPassword - -#### Defined in - -[generated-client/models/update-user-easy-password.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/update-user-easy-password.ts#L40) diff --git a/docs/interfaces/generated_client.UpdateUserPassword.md b/docs/interfaces/generated_client.UpdateUserPassword.md deleted file mode 100644 index 4078affd1..000000000 --- a/docs/interfaces/generated_client.UpdateUserPassword.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UpdateUserPassword - -# Interface: UpdateUserPassword - -[generated-client](../modules/generated_client.md).UpdateUserPassword - -The update user password request body. - -**`export`** - -**`interface`** UpdateUserPassword - -## Table of contents - -### Properties - -- [CurrentPassword](generated_client.UpdateUserPassword.md#currentpassword) -- [CurrentPw](generated_client.UpdateUserPassword.md#currentpw) -- [NewPw](generated_client.UpdateUserPassword.md#newpw) -- [ResetPassword](generated_client.UpdateUserPassword.md#resetpassword) - -## Properties - -### CurrentPassword - -• `Optional` **CurrentPassword**: ``null`` \| `string` - -Gets or sets the current sha1-hashed password. - -**`memberof`** UpdateUserPassword - -#### Defined in - -[generated-client/models/update-user-password.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/update-user-password.ts#L28) - -___ - -### CurrentPw - -• `Optional` **CurrentPw**: ``null`` \| `string` - -Gets or sets the current plain text password. - -**`memberof`** UpdateUserPassword - -#### Defined in - -[generated-client/models/update-user-password.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/update-user-password.ts#L34) - -___ - -### NewPw - -• `Optional` **NewPw**: ``null`` \| `string` - -Gets or sets the new plain text password. - -**`memberof`** UpdateUserPassword - -#### Defined in - -[generated-client/models/update-user-password.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/update-user-password.ts#L40) - -___ - -### ResetPassword - -• `Optional` **ResetPassword**: `boolean` - -Gets or sets a value indicating whether to reset the password. - -**`memberof`** UpdateUserPassword - -#### Defined in - -[generated-client/models/update-user-password.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/update-user-password.ts#L46) diff --git a/docs/interfaces/generated_client.UploadSubtitleDto.md b/docs/interfaces/generated_client.UploadSubtitleDto.md deleted file mode 100644 index 2b0cb6bb2..000000000 --- a/docs/interfaces/generated_client.UploadSubtitleDto.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UploadSubtitleDto - -# Interface: UploadSubtitleDto - -[generated-client](../modules/generated_client.md).UploadSubtitleDto - -Upload subtitles dto. - -**`export`** - -**`interface`** UploadSubtitleDto - -## Table of contents - -### Properties - -- [Data](generated_client.UploadSubtitleDto.md#data) -- [Format](generated_client.UploadSubtitleDto.md#format) -- [IsForced](generated_client.UploadSubtitleDto.md#isforced) -- [Language](generated_client.UploadSubtitleDto.md#language) - -## Properties - -### Data - -• **Data**: `string` - -Gets or sets the subtitle data. - -**`memberof`** UploadSubtitleDto - -#### Defined in - -[generated-client/models/upload-subtitle-dto.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/upload-subtitle-dto.ts#L46) - -___ - -### Format - -• **Format**: `string` - -Gets or sets the subtitle format. - -**`memberof`** UploadSubtitleDto - -#### Defined in - -[generated-client/models/upload-subtitle-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/upload-subtitle-dto.ts#L34) - -___ - -### IsForced - -• **IsForced**: `boolean` - -Gets or sets a value indicating whether the subtitle is forced. - -**`memberof`** UploadSubtitleDto - -#### Defined in - -[generated-client/models/upload-subtitle-dto.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/upload-subtitle-dto.ts#L40) - -___ - -### Language - -• **Language**: `string` - -Gets or sets the subtitle language. - -**`memberof`** UploadSubtitleDto - -#### Defined in - -[generated-client/models/upload-subtitle-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/upload-subtitle-dto.ts#L28) diff --git a/docs/interfaces/generated_client.UserApiAuthenticateUserByNameRequest.md b/docs/interfaces/generated_client.UserApiAuthenticateUserByNameRequest.md deleted file mode 100644 index e4c75cd56..000000000 --- a/docs/interfaces/generated_client.UserApiAuthenticateUserByNameRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiAuthenticateUserByNameRequest - -# Interface: UserApiAuthenticateUserByNameRequest - -[generated-client](../modules/generated_client.md).UserApiAuthenticateUserByNameRequest - -Request parameters for authenticateUserByName operation in UserApi. - -**`export`** - -**`interface`** UserApiAuthenticateUserByNameRequest - -## Table of contents - -### Properties - -- [authenticateUserByName](generated_client.UserApiAuthenticateUserByNameRequest.md#authenticateuserbyname) - -## Properties - -### authenticateUserByName - -• `Readonly` **authenticateUserByName**: [`AuthenticateUserByName`](generated_client.AuthenticateUserByName.md) - -The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request. - -**`memberof`** UserApiAuthenticateUserByName - -#### Defined in - -[generated-client/api/user-api.ts:1091](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1091) diff --git a/docs/interfaces/generated_client.UserApiAuthenticateUserRequest.md b/docs/interfaces/generated_client.UserApiAuthenticateUserRequest.md deleted file mode 100644 index b067c46bf..000000000 --- a/docs/interfaces/generated_client.UserApiAuthenticateUserRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiAuthenticateUserRequest - -# Interface: UserApiAuthenticateUserRequest - -[generated-client](../modules/generated_client.md).UserApiAuthenticateUserRequest - -Request parameters for authenticateUser operation in UserApi. - -**`export`** - -**`interface`** UserApiAuthenticateUserRequest - -## Table of contents - -### Properties - -- [password](generated_client.UserApiAuthenticateUserRequest.md#password) -- [pw](generated_client.UserApiAuthenticateUserRequest.md#pw) -- [userId](generated_client.UserApiAuthenticateUserRequest.md#userid) - -## Properties - -### password - -• `Optional` `Readonly` **password**: `string` - -The password sha1-hash. - -**`memberof`** UserApiAuthenticateUser - -#### Defined in - -[generated-client/api/user-api.ts:1077](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1077) - -___ - -### pw - -• `Readonly` **pw**: `string` - -The password as plain text. - -**`memberof`** UserApiAuthenticateUser - -#### Defined in - -[generated-client/api/user-api.ts:1070](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1070) - -___ - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** UserApiAuthenticateUser - -#### Defined in - -[generated-client/api/user-api.ts:1063](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1063) diff --git a/docs/interfaces/generated_client.UserApiAuthenticateWithQuickConnectRequest.md b/docs/interfaces/generated_client.UserApiAuthenticateWithQuickConnectRequest.md deleted file mode 100644 index a4bfb9426..000000000 --- a/docs/interfaces/generated_client.UserApiAuthenticateWithQuickConnectRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiAuthenticateWithQuickConnectRequest - -# Interface: UserApiAuthenticateWithQuickConnectRequest - -[generated-client](../modules/generated_client.md).UserApiAuthenticateWithQuickConnectRequest - -Request parameters for authenticateWithQuickConnect operation in UserApi. - -**`export`** - -**`interface`** UserApiAuthenticateWithQuickConnectRequest - -## Table of contents - -### Properties - -- [quickConnectDto](generated_client.UserApiAuthenticateWithQuickConnectRequest.md#quickconnectdto) - -## Properties - -### quickConnectDto - -• `Readonly` **quickConnectDto**: [`QuickConnectDto`](generated_client.QuickConnectDto.md) - -The Jellyfin.Api.Models.UserDtos.QuickConnectDto request. - -**`memberof`** UserApiAuthenticateWithQuickConnect - -#### Defined in - -[generated-client/api/user-api.ts:1105](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1105) diff --git a/docs/interfaces/generated_client.UserApiCreateUserByNameRequest.md b/docs/interfaces/generated_client.UserApiCreateUserByNameRequest.md deleted file mode 100644 index 147e6a903..000000000 --- a/docs/interfaces/generated_client.UserApiCreateUserByNameRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiCreateUserByNameRequest - -# Interface: UserApiCreateUserByNameRequest - -[generated-client](../modules/generated_client.md).UserApiCreateUserByNameRequest - -Request parameters for createUserByName operation in UserApi. - -**`export`** - -**`interface`** UserApiCreateUserByNameRequest - -## Table of contents - -### Properties - -- [createUserByName](generated_client.UserApiCreateUserByNameRequest.md#createuserbyname) - -## Properties - -### createUserByName - -• `Readonly` **createUserByName**: [`CreateUserByName`](generated_client.CreateUserByName.md) - -The create user by name request body. - -**`memberof`** UserApiCreateUserByName - -#### Defined in - -[generated-client/api/user-api.ts:1119](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1119) diff --git a/docs/interfaces/generated_client.UserApiDeleteUserRequest.md b/docs/interfaces/generated_client.UserApiDeleteUserRequest.md deleted file mode 100644 index 7c6c1d7bf..000000000 --- a/docs/interfaces/generated_client.UserApiDeleteUserRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiDeleteUserRequest - -# Interface: UserApiDeleteUserRequest - -[generated-client](../modules/generated_client.md).UserApiDeleteUserRequest - -Request parameters for deleteUser operation in UserApi. - -**`export`** - -**`interface`** UserApiDeleteUserRequest - -## Table of contents - -### Properties - -- [userId](generated_client.UserApiDeleteUserRequest.md#userid) - -## Properties - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** UserApiDeleteUser - -#### Defined in - -[generated-client/api/user-api.ts:1133](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1133) diff --git a/docs/interfaces/generated_client.UserApiForgotPasswordPinRequest.md b/docs/interfaces/generated_client.UserApiForgotPasswordPinRequest.md deleted file mode 100644 index 3d2aef4dd..000000000 --- a/docs/interfaces/generated_client.UserApiForgotPasswordPinRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiForgotPasswordPinRequest - -# Interface: UserApiForgotPasswordPinRequest - -[generated-client](../modules/generated_client.md).UserApiForgotPasswordPinRequest - -Request parameters for forgotPasswordPin operation in UserApi. - -**`export`** - -**`interface`** UserApiForgotPasswordPinRequest - -## Table of contents - -### Properties - -- [forgotPasswordPinDto](generated_client.UserApiForgotPasswordPinRequest.md#forgotpasswordpindto) - -## Properties - -### forgotPasswordPinDto - -• `Readonly` **forgotPasswordPinDto**: [`ForgotPasswordPinDto`](generated_client.ForgotPasswordPinDto.md) - -The forgot password pin request containing the entered pin. - -**`memberof`** UserApiForgotPasswordPin - -#### Defined in - -[generated-client/api/user-api.ts:1161](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1161) diff --git a/docs/interfaces/generated_client.UserApiForgotPasswordRequest.md b/docs/interfaces/generated_client.UserApiForgotPasswordRequest.md deleted file mode 100644 index 1b6f40354..000000000 --- a/docs/interfaces/generated_client.UserApiForgotPasswordRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiForgotPasswordRequest - -# Interface: UserApiForgotPasswordRequest - -[generated-client](../modules/generated_client.md).UserApiForgotPasswordRequest - -Request parameters for forgotPassword operation in UserApi. - -**`export`** - -**`interface`** UserApiForgotPasswordRequest - -## Table of contents - -### Properties - -- [forgotPasswordDto](generated_client.UserApiForgotPasswordRequest.md#forgotpassworddto) - -## Properties - -### forgotPasswordDto - -• `Readonly` **forgotPasswordDto**: [`ForgotPasswordDto`](generated_client.ForgotPasswordDto.md) - -The forgot password request containing the entered username. - -**`memberof`** UserApiForgotPassword - -#### Defined in - -[generated-client/api/user-api.ts:1147](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1147) diff --git a/docs/interfaces/generated_client.UserApiGetUserByIdRequest.md b/docs/interfaces/generated_client.UserApiGetUserByIdRequest.md deleted file mode 100644 index 4fe0d6f4e..000000000 --- a/docs/interfaces/generated_client.UserApiGetUserByIdRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiGetUserByIdRequest - -# Interface: UserApiGetUserByIdRequest - -[generated-client](../modules/generated_client.md).UserApiGetUserByIdRequest - -Request parameters for getUserById operation in UserApi. - -**`export`** - -**`interface`** UserApiGetUserByIdRequest - -## Table of contents - -### Properties - -- [userId](generated_client.UserApiGetUserByIdRequest.md#userid) - -## Properties - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** UserApiGetUserById - -#### Defined in - -[generated-client/api/user-api.ts:1175](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1175) diff --git a/docs/interfaces/generated_client.UserApiGetUsersRequest.md b/docs/interfaces/generated_client.UserApiGetUsersRequest.md deleted file mode 100644 index 2d5a4bf1c..000000000 --- a/docs/interfaces/generated_client.UserApiGetUsersRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiGetUsersRequest - -# Interface: UserApiGetUsersRequest - -[generated-client](../modules/generated_client.md).UserApiGetUsersRequest - -Request parameters for getUsers operation in UserApi. - -**`export`** - -**`interface`** UserApiGetUsersRequest - -## Table of contents - -### Properties - -- [isDisabled](generated_client.UserApiGetUsersRequest.md#isdisabled) -- [isHidden](generated_client.UserApiGetUsersRequest.md#ishidden) - -## Properties - -### isDisabled - -• `Optional` `Readonly` **isDisabled**: `boolean` - -Optional filter by IsDisabled=true or false. - -**`memberof`** UserApiGetUsers - -#### Defined in - -[generated-client/api/user-api.ts:1196](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1196) - -___ - -### isHidden - -• `Optional` `Readonly` **isHidden**: `boolean` - -Optional filter by IsHidden=true or false. - -**`memberof`** UserApiGetUsers - -#### Defined in - -[generated-client/api/user-api.ts:1189](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1189) diff --git a/docs/interfaces/generated_client.UserApiUpdateUserConfigurationRequest.md b/docs/interfaces/generated_client.UserApiUpdateUserConfigurationRequest.md deleted file mode 100644 index 3c0c04d46..000000000 --- a/docs/interfaces/generated_client.UserApiUpdateUserConfigurationRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiUpdateUserConfigurationRequest - -# Interface: UserApiUpdateUserConfigurationRequest - -[generated-client](../modules/generated_client.md).UserApiUpdateUserConfigurationRequest - -Request parameters for updateUserConfiguration operation in UserApi. - -**`export`** - -**`interface`** UserApiUpdateUserConfigurationRequest - -## Table of contents - -### Properties - -- [userConfiguration](generated_client.UserApiUpdateUserConfigurationRequest.md#userconfiguration) -- [userId](generated_client.UserApiUpdateUserConfigurationRequest.md#userid) - -## Properties - -### userConfiguration - -• `Readonly` **userConfiguration**: [`UserConfiguration`](generated_client.UserConfiguration.md) - -The new user configuration. - -**`memberof`** UserApiUpdateUserConfiguration - -#### Defined in - -[generated-client/api/user-api.ts:1238](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1238) - -___ - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** UserApiUpdateUserConfiguration - -#### Defined in - -[generated-client/api/user-api.ts:1231](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1231) diff --git a/docs/interfaces/generated_client.UserApiUpdateUserEasyPasswordRequest.md b/docs/interfaces/generated_client.UserApiUpdateUserEasyPasswordRequest.md deleted file mode 100644 index 2c1618ec1..000000000 --- a/docs/interfaces/generated_client.UserApiUpdateUserEasyPasswordRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiUpdateUserEasyPasswordRequest - -# Interface: UserApiUpdateUserEasyPasswordRequest - -[generated-client](../modules/generated_client.md).UserApiUpdateUserEasyPasswordRequest - -Request parameters for updateUserEasyPassword operation in UserApi. - -**`export`** - -**`interface`** UserApiUpdateUserEasyPasswordRequest - -## Table of contents - -### Properties - -- [updateUserEasyPassword](generated_client.UserApiUpdateUserEasyPasswordRequest.md#updateusereasypassword) -- [userId](generated_client.UserApiUpdateUserEasyPasswordRequest.md#userid) - -## Properties - -### updateUserEasyPassword - -• `Readonly` **updateUserEasyPassword**: [`UpdateUserEasyPassword`](generated_client.UpdateUserEasyPassword.md) - -The M:Jellyfin.Api.Controllers.UserController.UpdateUserEasyPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserEasyPassword) request. - -**`memberof`** UserApiUpdateUserEasyPassword - -#### Defined in - -[generated-client/api/user-api.ts:1259](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1259) - -___ - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** UserApiUpdateUserEasyPassword - -#### Defined in - -[generated-client/api/user-api.ts:1252](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1252) diff --git a/docs/interfaces/generated_client.UserApiUpdateUserPasswordRequest.md b/docs/interfaces/generated_client.UserApiUpdateUserPasswordRequest.md deleted file mode 100644 index 1b8596317..000000000 --- a/docs/interfaces/generated_client.UserApiUpdateUserPasswordRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiUpdateUserPasswordRequest - -# Interface: UserApiUpdateUserPasswordRequest - -[generated-client](../modules/generated_client.md).UserApiUpdateUserPasswordRequest - -Request parameters for updateUserPassword operation in UserApi. - -**`export`** - -**`interface`** UserApiUpdateUserPasswordRequest - -## Table of contents - -### Properties - -- [updateUserPassword](generated_client.UserApiUpdateUserPasswordRequest.md#updateuserpassword) -- [userId](generated_client.UserApiUpdateUserPasswordRequest.md#userid) - -## Properties - -### updateUserPassword - -• `Readonly` **updateUserPassword**: [`UpdateUserPassword`](generated_client.UpdateUserPassword.md) - -The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. - -**`memberof`** UserApiUpdateUserPassword - -#### Defined in - -[generated-client/api/user-api.ts:1280](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1280) - -___ - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** UserApiUpdateUserPassword - -#### Defined in - -[generated-client/api/user-api.ts:1273](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1273) diff --git a/docs/interfaces/generated_client.UserApiUpdateUserPolicyRequest.md b/docs/interfaces/generated_client.UserApiUpdateUserPolicyRequest.md deleted file mode 100644 index 2f3201674..000000000 --- a/docs/interfaces/generated_client.UserApiUpdateUserPolicyRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiUpdateUserPolicyRequest - -# Interface: UserApiUpdateUserPolicyRequest - -[generated-client](../modules/generated_client.md).UserApiUpdateUserPolicyRequest - -Request parameters for updateUserPolicy operation in UserApi. - -**`export`** - -**`interface`** UserApiUpdateUserPolicyRequest - -## Table of contents - -### Properties - -- [userId](generated_client.UserApiUpdateUserPolicyRequest.md#userid) -- [userPolicy](generated_client.UserApiUpdateUserPolicyRequest.md#userpolicy) - -## Properties - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** UserApiUpdateUserPolicy - -#### Defined in - -[generated-client/api/user-api.ts:1294](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1294) - -___ - -### userPolicy - -• `Readonly` **userPolicy**: [`UserPolicy`](generated_client.UserPolicy.md) - -The new user policy. - -**`memberof`** UserApiUpdateUserPolicy - -#### Defined in - -[generated-client/api/user-api.ts:1301](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1301) diff --git a/docs/interfaces/generated_client.UserApiUpdateUserRequest.md b/docs/interfaces/generated_client.UserApiUpdateUserRequest.md deleted file mode 100644 index aa7ebc8aa..000000000 --- a/docs/interfaces/generated_client.UserApiUpdateUserRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApiUpdateUserRequest - -# Interface: UserApiUpdateUserRequest - -[generated-client](../modules/generated_client.md).UserApiUpdateUserRequest - -Request parameters for updateUser operation in UserApi. - -**`export`** - -**`interface`** UserApiUpdateUserRequest - -## Table of contents - -### Properties - -- [userDto](generated_client.UserApiUpdateUserRequest.md#userdto) -- [userId](generated_client.UserApiUpdateUserRequest.md#userid) - -## Properties - -### userDto - -• `Readonly` **userDto**: [`UserDto`](generated_client.UserDto.md) - -The updated user model. - -**`memberof`** UserApiUpdateUser - -#### Defined in - -[generated-client/api/user-api.ts:1217](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1217) - -___ - -### userId - -• `Readonly` **userId**: `string` - -The user id. - -**`memberof`** UserApiUpdateUser - -#### Defined in - -[generated-client/api/user-api.ts:1210](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1210) diff --git a/docs/interfaces/generated_client.UserConfiguration.md b/docs/interfaces/generated_client.UserConfiguration.md deleted file mode 100644 index 2dcc7c8a5..000000000 --- a/docs/interfaces/generated_client.UserConfiguration.md +++ /dev/null @@ -1,217 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserConfiguration - -# Interface: UserConfiguration - -[generated-client](../modules/generated_client.md).UserConfiguration - -Class UserConfiguration. - -**`export`** - -**`interface`** UserConfiguration - -## Table of contents - -### Properties - -- [AudioLanguagePreference](generated_client.UserConfiguration.md#audiolanguagepreference) -- [DisplayCollectionsView](generated_client.UserConfiguration.md#displaycollectionsview) -- [DisplayMissingEpisodes](generated_client.UserConfiguration.md#displaymissingepisodes) -- [EnableLocalPassword](generated_client.UserConfiguration.md#enablelocalpassword) -- [EnableNextEpisodeAutoPlay](generated_client.UserConfiguration.md#enablenextepisodeautoplay) -- [GroupedFolders](generated_client.UserConfiguration.md#groupedfolders) -- [HidePlayedInLatest](generated_client.UserConfiguration.md#hideplayedinlatest) -- [LatestItemsExcludes](generated_client.UserConfiguration.md#latestitemsexcludes) -- [MyMediaExcludes](generated_client.UserConfiguration.md#mymediaexcludes) -- [OrderedViews](generated_client.UserConfiguration.md#orderedviews) -- [PlayDefaultAudioTrack](generated_client.UserConfiguration.md#playdefaultaudiotrack) -- [RememberAudioSelections](generated_client.UserConfiguration.md#rememberaudioselections) -- [RememberSubtitleSelections](generated_client.UserConfiguration.md#remembersubtitleselections) -- [SubtitleLanguagePreference](generated_client.UserConfiguration.md#subtitlelanguagepreference) -- [SubtitleMode](generated_client.UserConfiguration.md#subtitlemode) - -## Properties - -### AudioLanguagePreference - -• `Optional` **AudioLanguagePreference**: ``null`` \| `string` - -Gets or sets the audio language preference. - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L29) - -___ - -### DisplayCollectionsView - -• `Optional` **DisplayCollectionsView**: `boolean` - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L65) - -___ - -### DisplayMissingEpisodes - -• `Optional` **DisplayMissingEpisodes**: `boolean` - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L47) - -___ - -### EnableLocalPassword - -• `Optional` **EnableLocalPassword**: `boolean` - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L71) - -___ - -### EnableNextEpisodeAutoPlay - -• `Optional` **EnableNextEpisodeAutoPlay**: `boolean` - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:113](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L113) - -___ - -### GroupedFolders - -• `Optional` **GroupedFolders**: `string`[] - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L53) - -___ - -### HidePlayedInLatest - -• `Optional` **HidePlayedInLatest**: `boolean` - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:95](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L95) - -___ - -### LatestItemsExcludes - -• `Optional` **LatestItemsExcludes**: `string`[] - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:83](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L83) - -___ - -### MyMediaExcludes - -• `Optional` **MyMediaExcludes**: `string`[] - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:89](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L89) - -___ - -### OrderedViews - -• `Optional` **OrderedViews**: `string`[] - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L77) - -___ - -### PlayDefaultAudioTrack - -• `Optional` **PlayDefaultAudioTrack**: `boolean` - -Gets or sets a value indicating whether [play default audio track]. - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L35) - -___ - -### RememberAudioSelections - -• `Optional` **RememberAudioSelections**: `boolean` - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:101](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L101) - -___ - -### RememberSubtitleSelections - -• `Optional` **RememberSubtitleSelections**: `boolean` - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:107](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L107) - -___ - -### SubtitleLanguagePreference - -• `Optional` **SubtitleLanguagePreference**: ``null`` \| `string` - -Gets or sets the subtitle language preference. - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L41) - -___ - -### SubtitleMode - -• `Optional` **SubtitleMode**: [`SubtitlePlaybackMode`](../enums/generated_client.SubtitlePlaybackMode.md) - -**`memberof`** UserConfiguration - -#### Defined in - -[generated-client/models/user-configuration.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-configuration.ts#L59) diff --git a/docs/interfaces/generated_client.UserDto.md b/docs/interfaces/generated_client.UserDto.md deleted file mode 100644 index eee932c2c..000000000 --- a/docs/interfaces/generated_client.UserDto.md +++ /dev/null @@ -1,222 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserDto - -# Interface: UserDto - -[generated-client](../modules/generated_client.md).UserDto - -Class UserDto. - -**`export`** - -**`interface`** UserDto - -## Table of contents - -### Properties - -- [Configuration](generated_client.UserDto.md#configuration) -- [EnableAutoLogin](generated_client.UserDto.md#enableautologin) -- [HasConfiguredEasyPassword](generated_client.UserDto.md#hasconfiguredeasypassword) -- [HasConfiguredPassword](generated_client.UserDto.md#hasconfiguredpassword) -- [HasPassword](generated_client.UserDto.md#haspassword) -- [Id](generated_client.UserDto.md#id) -- [LastActivityDate](generated_client.UserDto.md#lastactivitydate) -- [LastLoginDate](generated_client.UserDto.md#lastlogindate) -- [Name](generated_client.UserDto.md#name) -- [Policy](generated_client.UserDto.md#policy) -- [PrimaryImageAspectRatio](generated_client.UserDto.md#primaryimageaspectratio) -- [PrimaryImageTag](generated_client.UserDto.md#primaryimagetag) -- [ServerId](generated_client.UserDto.md#serverid) -- [ServerName](generated_client.UserDto.md#servername) - -## Properties - -### Configuration - -• `Optional` **Configuration**: [`UserConfiguration`](generated_client.UserConfiguration.md) - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:96](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L96) - -___ - -### EnableAutoLogin - -• `Optional` **EnableAutoLogin**: ``null`` \| `boolean` - -Gets or sets whether async login is enabled or not. - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:78](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L78) - -___ - -### HasConfiguredEasyPassword - -• `Optional` **HasConfiguredEasyPassword**: `boolean` - -Gets or sets a value indicating whether this instance has configured easy password. - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L72) - -___ - -### HasConfiguredPassword - -• `Optional` **HasConfiguredPassword**: `boolean` - -Gets or sets a value indicating whether this instance has configured password. - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L66) - -___ - -### HasPassword - -• `Optional` **HasPassword**: `boolean` - -Gets or sets a value indicating whether this instance has password. - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L60) - -___ - -### Id - -• `Optional` **Id**: `string` - -Gets or sets the id. - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L48) - -___ - -### LastActivityDate - -• `Optional` **LastActivityDate**: ``null`` \| `string` - -Gets or sets the last activity date. - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:90](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L90) - -___ - -### LastLoginDate - -• `Optional` **LastLoginDate**: ``null`` \| `string` - -Gets or sets the last login date. - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:84](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L84) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L30) - -___ - -### Policy - -• `Optional` **Policy**: [`UserPolicy`](generated_client.UserPolicy.md) - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:102](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L102) - -___ - -### PrimaryImageAspectRatio - -• `Optional` **PrimaryImageAspectRatio**: ``null`` \| `number` - -Gets or sets the primary image aspect ratio. - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:108](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L108) - -___ - -### PrimaryImageTag - -• `Optional` **PrimaryImageTag**: ``null`` \| `string` - -Gets or sets the primary image tag. - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L54) - -___ - -### ServerId - -• `Optional` **ServerId**: ``null`` \| `string` - -Gets or sets the server identifier. - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L36) - -___ - -### ServerName - -• `Optional` **ServerName**: ``null`` \| `string` - -Gets or sets the name of the server. This is not used by the server and is for client-side usage only. - -**`memberof`** UserDto - -#### Defined in - -[generated-client/models/user-dto.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-dto.ts#L42) diff --git a/docs/interfaces/generated_client.UserItemDataDto.md b/docs/interfaces/generated_client.UserItemDataDto.md deleted file mode 100644 index 02711aa8d..000000000 --- a/docs/interfaces/generated_client.UserItemDataDto.md +++ /dev/null @@ -1,181 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserItemDataDto - -# Interface: UserItemDataDto - -[generated-client](../modules/generated_client.md).UserItemDataDto - -Class UserItemDataDto. - -**`export`** - -**`interface`** UserItemDataDto - -## Table of contents - -### Properties - -- [IsFavorite](generated_client.UserItemDataDto.md#isfavorite) -- [ItemId](generated_client.UserItemDataDto.md#itemid) -- [Key](generated_client.UserItemDataDto.md#key) -- [LastPlayedDate](generated_client.UserItemDataDto.md#lastplayeddate) -- [Likes](generated_client.UserItemDataDto.md#likes) -- [PlayCount](generated_client.UserItemDataDto.md#playcount) -- [PlaybackPositionTicks](generated_client.UserItemDataDto.md#playbackpositionticks) -- [Played](generated_client.UserItemDataDto.md#played) -- [PlayedPercentage](generated_client.UserItemDataDto.md#playedpercentage) -- [Rating](generated_client.UserItemDataDto.md#rating) -- [UnplayedItemCount](generated_client.UserItemDataDto.md#unplayeditemcount) - -## Properties - -### IsFavorite - -• `Optional` **IsFavorite**: `boolean` - -Gets or sets a value indicating whether this instance is favorite. - -**`memberof`** UserItemDataDto - -#### Defined in - -[generated-client/models/user-item-data-dto.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-item-data-dto.ts#L58) - -___ - -### ItemId - -• `Optional` **ItemId**: ``null`` \| `string` - -Gets or sets the item identifier. - -**`memberof`** UserItemDataDto - -#### Defined in - -[generated-client/models/user-item-data-dto.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-item-data-dto.ts#L88) - -___ - -### Key - -• `Optional` **Key**: ``null`` \| `string` - -Gets or sets the key. - -**`memberof`** UserItemDataDto - -#### Defined in - -[generated-client/models/user-item-data-dto.ts:82](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-item-data-dto.ts#L82) - -___ - -### LastPlayedDate - -• `Optional` **LastPlayedDate**: ``null`` \| `string` - -Gets or sets the last played date. - -**`memberof`** UserItemDataDto - -#### Defined in - -[generated-client/models/user-item-data-dto.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-item-data-dto.ts#L70) - -___ - -### Likes - -• `Optional` **Likes**: ``null`` \| `boolean` - -Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is likes. - -**`memberof`** UserItemDataDto - -#### Defined in - -[generated-client/models/user-item-data-dto.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-item-data-dto.ts#L64) - -___ - -### PlayCount - -• `Optional` **PlayCount**: `number` - -Gets or sets the play count. - -**`memberof`** UserItemDataDto - -#### Defined in - -[generated-client/models/user-item-data-dto.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-item-data-dto.ts#L52) - -___ - -### PlaybackPositionTicks - -• `Optional` **PlaybackPositionTicks**: `number` - -Gets or sets the playback position ticks. - -**`memberof`** UserItemDataDto - -#### Defined in - -[generated-client/models/user-item-data-dto.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-item-data-dto.ts#L46) - -___ - -### Played - -• `Optional` **Played**: `boolean` - -Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is played. - -**`memberof`** UserItemDataDto - -#### Defined in - -[generated-client/models/user-item-data-dto.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-item-data-dto.ts#L76) - -___ - -### PlayedPercentage - -• `Optional` **PlayedPercentage**: ``null`` \| `number` - -Gets or sets the played percentage. - -**`memberof`** UserItemDataDto - -#### Defined in - -[generated-client/models/user-item-data-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-item-data-dto.ts#L34) - -___ - -### Rating - -• `Optional` **Rating**: ``null`` \| `number` - -Gets or sets the rating. - -**`memberof`** UserItemDataDto - -#### Defined in - -[generated-client/models/user-item-data-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-item-data-dto.ts#L28) - -___ - -### UnplayedItemCount - -• `Optional` **UnplayedItemCount**: ``null`` \| `number` - -Gets or sets the unplayed item count. - -**`memberof`** UserItemDataDto - -#### Defined in - -[generated-client/models/user-item-data-dto.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-item-data-dto.ts#L40) diff --git a/docs/interfaces/generated_client.UserLibraryApiDeleteUserItemRatingRequest.md b/docs/interfaces/generated_client.UserLibraryApiDeleteUserItemRatingRequest.md deleted file mode 100644 index ade3dcc55..000000000 --- a/docs/interfaces/generated_client.UserLibraryApiDeleteUserItemRatingRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserLibraryApiDeleteUserItemRatingRequest - -# Interface: UserLibraryApiDeleteUserItemRatingRequest - -[generated-client](../modules/generated_client.md).UserLibraryApiDeleteUserItemRatingRequest - -Request parameters for deleteUserItemRating operation in UserLibraryApi. - -**`export`** - -**`interface`** UserLibraryApiDeleteUserItemRatingRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.UserLibraryApiDeleteUserItemRatingRequest.md#itemid) -- [userId](generated_client.UserLibraryApiDeleteUserItemRatingRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** UserLibraryApiDeleteUserItemRating - -#### Defined in - -[generated-client/api/user-library-api.ts:787](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L787) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** UserLibraryApiDeleteUserItemRating - -#### Defined in - -[generated-client/api/user-library-api.ts:780](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L780) diff --git a/docs/interfaces/generated_client.UserLibraryApiGetIntrosRequest.md b/docs/interfaces/generated_client.UserLibraryApiGetIntrosRequest.md deleted file mode 100644 index 13d7c0541..000000000 --- a/docs/interfaces/generated_client.UserLibraryApiGetIntrosRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserLibraryApiGetIntrosRequest - -# Interface: UserLibraryApiGetIntrosRequest - -[generated-client](../modules/generated_client.md).UserLibraryApiGetIntrosRequest - -Request parameters for getIntros operation in UserLibraryApi. - -**`export`** - -**`interface`** UserLibraryApiGetIntrosRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.UserLibraryApiGetIntrosRequest.md#itemid) -- [userId](generated_client.UserLibraryApiGetIntrosRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** UserLibraryApiGetIntros - -#### Defined in - -[generated-client/api/user-library-api.ts:808](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L808) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** UserLibraryApiGetIntros - -#### Defined in - -[generated-client/api/user-library-api.ts:801](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L801) diff --git a/docs/interfaces/generated_client.UserLibraryApiGetItemRequest.md b/docs/interfaces/generated_client.UserLibraryApiGetItemRequest.md deleted file mode 100644 index b28571023..000000000 --- a/docs/interfaces/generated_client.UserLibraryApiGetItemRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserLibraryApiGetItemRequest - -# Interface: UserLibraryApiGetItemRequest - -[generated-client](../modules/generated_client.md).UserLibraryApiGetItemRequest - -Request parameters for getItem operation in UserLibraryApi. - -**`export`** - -**`interface`** UserLibraryApiGetItemRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.UserLibraryApiGetItemRequest.md#itemid) -- [userId](generated_client.UserLibraryApiGetItemRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** UserLibraryApiGetItem - -#### Defined in - -[generated-client/api/user-library-api.ts:829](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L829) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** UserLibraryApiGetItem - -#### Defined in - -[generated-client/api/user-library-api.ts:822](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L822) diff --git a/docs/interfaces/generated_client.UserLibraryApiGetLatestMediaRequest.md b/docs/interfaces/generated_client.UserLibraryApiGetLatestMediaRequest.md deleted file mode 100644 index 43d0d910d..000000000 --- a/docs/interfaces/generated_client.UserLibraryApiGetLatestMediaRequest.md +++ /dev/null @@ -1,181 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserLibraryApiGetLatestMediaRequest - -# Interface: UserLibraryApiGetLatestMediaRequest - -[generated-client](../modules/generated_client.md).UserLibraryApiGetLatestMediaRequest - -Request parameters for getLatestMedia operation in UserLibraryApi. - -**`export`** - -**`interface`** UserLibraryApiGetLatestMediaRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.UserLibraryApiGetLatestMediaRequest.md#enableimagetypes) -- [enableImages](generated_client.UserLibraryApiGetLatestMediaRequest.md#enableimages) -- [enableUserData](generated_client.UserLibraryApiGetLatestMediaRequest.md#enableuserdata) -- [fields](generated_client.UserLibraryApiGetLatestMediaRequest.md#fields) -- [groupItems](generated_client.UserLibraryApiGetLatestMediaRequest.md#groupitems) -- [imageTypeLimit](generated_client.UserLibraryApiGetLatestMediaRequest.md#imagetypelimit) -- [includeItemTypes](generated_client.UserLibraryApiGetLatestMediaRequest.md#includeitemtypes) -- [isPlayed](generated_client.UserLibraryApiGetLatestMediaRequest.md#isplayed) -- [limit](generated_client.UserLibraryApiGetLatestMediaRequest.md#limit) -- [parentId](generated_client.UserLibraryApiGetLatestMediaRequest.md#parentid) -- [userId](generated_client.UserLibraryApiGetLatestMediaRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** UserLibraryApiGetLatestMedia - -#### Defined in - -[generated-client/api/user-library-api.ts:892](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L892) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. include image information in output. - -**`memberof`** UserLibraryApiGetLatestMedia - -#### Defined in - -[generated-client/api/user-library-api.ts:878](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L878) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. include user data. - -**`memberof`** UserLibraryApiGetLatestMedia - -#### Defined in - -[generated-client/api/user-library-api.ts:899](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L899) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** UserLibraryApiGetLatestMedia - -#### Defined in - -[generated-client/api/user-library-api.ts:857](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L857) - -___ - -### groupItems - -• `Optional` `Readonly` **groupItems**: `boolean` - -Whether or not to group items into a parent container. - -**`memberof`** UserLibraryApiGetLatestMedia - -#### Defined in - -[generated-client/api/user-library-api.ts:913](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L913) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. the max number of images to return, per image type. - -**`memberof`** UserLibraryApiGetLatestMedia - -#### Defined in - -[generated-client/api/user-library-api.ts:885](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L885) - -___ - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - -**`memberof`** UserLibraryApiGetLatestMedia - -#### Defined in - -[generated-client/api/user-library-api.ts:864](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L864) - -___ - -### isPlayed - -• `Optional` `Readonly` **isPlayed**: `boolean` - -Filter by items that are played, or not. - -**`memberof`** UserLibraryApiGetLatestMedia - -#### Defined in - -[generated-client/api/user-library-api.ts:871](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L871) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Return item limit. - -**`memberof`** UserLibraryApiGetLatestMedia - -#### Defined in - -[generated-client/api/user-library-api.ts:906](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L906) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** UserLibraryApiGetLatestMedia - -#### Defined in - -[generated-client/api/user-library-api.ts:850](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L850) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** UserLibraryApiGetLatestMedia - -#### Defined in - -[generated-client/api/user-library-api.ts:843](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L843) diff --git a/docs/interfaces/generated_client.UserLibraryApiGetLocalTrailersRequest.md b/docs/interfaces/generated_client.UserLibraryApiGetLocalTrailersRequest.md deleted file mode 100644 index d3ffdcb3c..000000000 --- a/docs/interfaces/generated_client.UserLibraryApiGetLocalTrailersRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserLibraryApiGetLocalTrailersRequest - -# Interface: UserLibraryApiGetLocalTrailersRequest - -[generated-client](../modules/generated_client.md).UserLibraryApiGetLocalTrailersRequest - -Request parameters for getLocalTrailers operation in UserLibraryApi. - -**`export`** - -**`interface`** UserLibraryApiGetLocalTrailersRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.UserLibraryApiGetLocalTrailersRequest.md#itemid) -- [userId](generated_client.UserLibraryApiGetLocalTrailersRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** UserLibraryApiGetLocalTrailers - -#### Defined in - -[generated-client/api/user-library-api.ts:934](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L934) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** UserLibraryApiGetLocalTrailers - -#### Defined in - -[generated-client/api/user-library-api.ts:927](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L927) diff --git a/docs/interfaces/generated_client.UserLibraryApiGetRootFolderRequest.md b/docs/interfaces/generated_client.UserLibraryApiGetRootFolderRequest.md deleted file mode 100644 index 7296a5a42..000000000 --- a/docs/interfaces/generated_client.UserLibraryApiGetRootFolderRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserLibraryApiGetRootFolderRequest - -# Interface: UserLibraryApiGetRootFolderRequest - -[generated-client](../modules/generated_client.md).UserLibraryApiGetRootFolderRequest - -Request parameters for getRootFolder operation in UserLibraryApi. - -**`export`** - -**`interface`** UserLibraryApiGetRootFolderRequest - -## Table of contents - -### Properties - -- [userId](generated_client.UserLibraryApiGetRootFolderRequest.md#userid) - -## Properties - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** UserLibraryApiGetRootFolder - -#### Defined in - -[generated-client/api/user-library-api.ts:948](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L948) diff --git a/docs/interfaces/generated_client.UserLibraryApiGetSpecialFeaturesRequest.md b/docs/interfaces/generated_client.UserLibraryApiGetSpecialFeaturesRequest.md deleted file mode 100644 index 66e8e3360..000000000 --- a/docs/interfaces/generated_client.UserLibraryApiGetSpecialFeaturesRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserLibraryApiGetSpecialFeaturesRequest - -# Interface: UserLibraryApiGetSpecialFeaturesRequest - -[generated-client](../modules/generated_client.md).UserLibraryApiGetSpecialFeaturesRequest - -Request parameters for getSpecialFeatures operation in UserLibraryApi. - -**`export`** - -**`interface`** UserLibraryApiGetSpecialFeaturesRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.UserLibraryApiGetSpecialFeaturesRequest.md#itemid) -- [userId](generated_client.UserLibraryApiGetSpecialFeaturesRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** UserLibraryApiGetSpecialFeatures - -#### Defined in - -[generated-client/api/user-library-api.ts:969](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L969) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** UserLibraryApiGetSpecialFeatures - -#### Defined in - -[generated-client/api/user-library-api.ts:962](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L962) diff --git a/docs/interfaces/generated_client.UserLibraryApiMarkFavoriteItemRequest.md b/docs/interfaces/generated_client.UserLibraryApiMarkFavoriteItemRequest.md deleted file mode 100644 index 64a47f87d..000000000 --- a/docs/interfaces/generated_client.UserLibraryApiMarkFavoriteItemRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserLibraryApiMarkFavoriteItemRequest - -# Interface: UserLibraryApiMarkFavoriteItemRequest - -[generated-client](../modules/generated_client.md).UserLibraryApiMarkFavoriteItemRequest - -Request parameters for markFavoriteItem operation in UserLibraryApi. - -**`export`** - -**`interface`** UserLibraryApiMarkFavoriteItemRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.UserLibraryApiMarkFavoriteItemRequest.md#itemid) -- [userId](generated_client.UserLibraryApiMarkFavoriteItemRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** UserLibraryApiMarkFavoriteItem - -#### Defined in - -[generated-client/api/user-library-api.ts:990](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L990) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** UserLibraryApiMarkFavoriteItem - -#### Defined in - -[generated-client/api/user-library-api.ts:983](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L983) diff --git a/docs/interfaces/generated_client.UserLibraryApiUnmarkFavoriteItemRequest.md b/docs/interfaces/generated_client.UserLibraryApiUnmarkFavoriteItemRequest.md deleted file mode 100644 index f3be421e6..000000000 --- a/docs/interfaces/generated_client.UserLibraryApiUnmarkFavoriteItemRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserLibraryApiUnmarkFavoriteItemRequest - -# Interface: UserLibraryApiUnmarkFavoriteItemRequest - -[generated-client](../modules/generated_client.md).UserLibraryApiUnmarkFavoriteItemRequest - -Request parameters for unmarkFavoriteItem operation in UserLibraryApi. - -**`export`** - -**`interface`** UserLibraryApiUnmarkFavoriteItemRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.UserLibraryApiUnmarkFavoriteItemRequest.md#itemid) -- [userId](generated_client.UserLibraryApiUnmarkFavoriteItemRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** UserLibraryApiUnmarkFavoriteItem - -#### Defined in - -[generated-client/api/user-library-api.ts:1011](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1011) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** UserLibraryApiUnmarkFavoriteItem - -#### Defined in - -[generated-client/api/user-library-api.ts:1004](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1004) diff --git a/docs/interfaces/generated_client.UserLibraryApiUpdateUserItemRatingRequest.md b/docs/interfaces/generated_client.UserLibraryApiUpdateUserItemRatingRequest.md deleted file mode 100644 index 91ec694b3..000000000 --- a/docs/interfaces/generated_client.UserLibraryApiUpdateUserItemRatingRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserLibraryApiUpdateUserItemRatingRequest - -# Interface: UserLibraryApiUpdateUserItemRatingRequest - -[generated-client](../modules/generated_client.md).UserLibraryApiUpdateUserItemRatingRequest - -Request parameters for updateUserItemRating operation in UserLibraryApi. - -**`export`** - -**`interface`** UserLibraryApiUpdateUserItemRatingRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.UserLibraryApiUpdateUserItemRatingRequest.md#itemid) -- [likes](generated_client.UserLibraryApiUpdateUserItemRatingRequest.md#likes) -- [userId](generated_client.UserLibraryApiUpdateUserItemRatingRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -Item id. - -**`memberof`** UserLibraryApiUpdateUserItemRating - -#### Defined in - -[generated-client/api/user-library-api.ts:1032](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1032) - -___ - -### likes - -• `Optional` `Readonly` **likes**: `boolean` - -Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Guid,System.Guid,System.Nullable{System.Boolean}) is likes. - -**`memberof`** UserLibraryApiUpdateUserItemRating - -#### Defined in - -[generated-client/api/user-library-api.ts:1039](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1039) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** UserLibraryApiUpdateUserItemRating - -#### Defined in - -[generated-client/api/user-library-api.ts:1025](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1025) diff --git a/docs/interfaces/generated_client.UserPolicy.md b/docs/interfaces/generated_client.UserPolicy.md deleted file mode 100644 index 5091858cc..000000000 --- a/docs/interfaces/generated_client.UserPolicy.md +++ /dev/null @@ -1,531 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserPolicy - -# Interface: UserPolicy - -[generated-client](../modules/generated_client.md).UserPolicy - -**`export`** - -**`interface`** UserPolicy - -## Table of contents - -### Properties - -- [AccessSchedules](generated_client.UserPolicy.md#accessschedules) -- [AuthenticationProviderId](generated_client.UserPolicy.md#authenticationproviderid) -- [BlockUnratedItems](generated_client.UserPolicy.md#blockunrateditems) -- [BlockedChannels](generated_client.UserPolicy.md#blockedchannels) -- [BlockedMediaFolders](generated_client.UserPolicy.md#blockedmediafolders) -- [BlockedTags](generated_client.UserPolicy.md#blockedtags) -- [EnableAllChannels](generated_client.UserPolicy.md#enableallchannels) -- [EnableAllDevices](generated_client.UserPolicy.md#enablealldevices) -- [EnableAllFolders](generated_client.UserPolicy.md#enableallfolders) -- [EnableAudioPlaybackTranscoding](generated_client.UserPolicy.md#enableaudioplaybacktranscoding) -- [EnableContentDeletion](generated_client.UserPolicy.md#enablecontentdeletion) -- [EnableContentDeletionFromFolders](generated_client.UserPolicy.md#enablecontentdeletionfromfolders) -- [EnableContentDownloading](generated_client.UserPolicy.md#enablecontentdownloading) -- [EnableLiveTvAccess](generated_client.UserPolicy.md#enablelivetvaccess) -- [EnableLiveTvManagement](generated_client.UserPolicy.md#enablelivetvmanagement) -- [EnableMediaConversion](generated_client.UserPolicy.md#enablemediaconversion) -- [EnableMediaPlayback](generated_client.UserPolicy.md#enablemediaplayback) -- [EnablePlaybackRemuxing](generated_client.UserPolicy.md#enableplaybackremuxing) -- [EnablePublicSharing](generated_client.UserPolicy.md#enablepublicsharing) -- [EnableRemoteAccess](generated_client.UserPolicy.md#enableremoteaccess) -- [EnableRemoteControlOfOtherUsers](generated_client.UserPolicy.md#enableremotecontrolofotherusers) -- [EnableSharedDeviceControl](generated_client.UserPolicy.md#enableshareddevicecontrol) -- [EnableSyncTranscoding](generated_client.UserPolicy.md#enablesynctranscoding) -- [EnableUserPreferenceAccess](generated_client.UserPolicy.md#enableuserpreferenceaccess) -- [EnableVideoPlaybackTranscoding](generated_client.UserPolicy.md#enablevideoplaybacktranscoding) -- [EnabledChannels](generated_client.UserPolicy.md#enabledchannels) -- [EnabledDevices](generated_client.UserPolicy.md#enableddevices) -- [EnabledFolders](generated_client.UserPolicy.md#enabledfolders) -- [ForceRemoteSourceTranscoding](generated_client.UserPolicy.md#forceremotesourcetranscoding) -- [InvalidLoginAttemptCount](generated_client.UserPolicy.md#invalidloginattemptcount) -- [IsAdministrator](generated_client.UserPolicy.md#isadministrator) -- [IsDisabled](generated_client.UserPolicy.md#isdisabled) -- [IsHidden](generated_client.UserPolicy.md#ishidden) -- [LoginAttemptsBeforeLockout](generated_client.UserPolicy.md#loginattemptsbeforelockout) -- [MaxActiveSessions](generated_client.UserPolicy.md#maxactivesessions) -- [MaxParentalRating](generated_client.UserPolicy.md#maxparentalrating) -- [PasswordResetProviderId](generated_client.UserPolicy.md#passwordresetproviderid) -- [RemoteClientBitrateLimit](generated_client.UserPolicy.md#remoteclientbitratelimit) -- [SyncPlayAccess](generated_client.UserPolicy.md#syncplayaccess) - -## Properties - -### AccessSchedules - -• `Optional` **AccessSchedules**: ``null`` \| [`AccessSchedule`](generated_client.AccessSchedule.md)[] - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:67](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L67) - -___ - -### AuthenticationProviderId - -• `Optional` **AuthenticationProviderId**: ``null`` \| `string` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:247](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L247) - -___ - -### BlockUnratedItems - -• `Optional` **BlockUnratedItems**: ``null`` \| [`UnratedItem`](../enums/generated_client.UnratedItem.md)[] - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:73](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L73) - -___ - -### BlockedChannels - -• `Optional` **BlockedChannels**: ``null`` \| `string`[] - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:235](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L235) - -___ - -### BlockedMediaFolders - -• `Optional` **BlockedMediaFolders**: ``null`` \| `string`[] - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:229](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L229) - -___ - -### BlockedTags - -• `Optional` **BlockedTags**: ``null`` \| `string`[] - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L55) - -___ - -### EnableAllChannels - -• `Optional` **EnableAllChannels**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:187](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L187) - -___ - -### EnableAllDevices - -• `Optional` **EnableAllDevices**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:175](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L175) - -___ - -### EnableAllFolders - -• `Optional` **EnableAllFolders**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:199](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L199) - -___ - -### EnableAudioPlaybackTranscoding - -• `Optional` **EnableAudioPlaybackTranscoding**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:115](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L115) - -___ - -### EnableContentDeletion - -• `Optional` **EnableContentDeletion**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:139](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L139) - -___ - -### EnableContentDeletionFromFolders - -• `Optional` **EnableContentDeletionFromFolders**: ``null`` \| `string`[] - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:145](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L145) - -___ - -### EnableContentDownloading - -• `Optional` **EnableContentDownloading**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:151](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L151) - -___ - -### EnableLiveTvAccess - -• `Optional` **EnableLiveTvAccess**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:103](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L103) - -___ - -### EnableLiveTvManagement - -• `Optional` **EnableLiveTvManagement**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:97](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L97) - -___ - -### EnableMediaConversion - -• `Optional` **EnableMediaConversion**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:163](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L163) - -___ - -### EnableMediaPlayback - -• `Optional` **EnableMediaPlayback**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:109](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L109) - -___ - -### EnablePlaybackRemuxing - -• `Optional` **EnablePlaybackRemuxing**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:127](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L127) - -___ - -### EnablePublicSharing - -• `Optional` **EnablePublicSharing**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:223](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L223) - -___ - -### EnableRemoteAccess - -• `Optional` **EnableRemoteAccess**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:91](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L91) - -___ - -### EnableRemoteControlOfOtherUsers - -• `Optional` **EnableRemoteControlOfOtherUsers**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:79](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L79) - -___ - -### EnableSharedDeviceControl - -• `Optional` **EnableSharedDeviceControl**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:85](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L85) - -___ - -### EnableSyncTranscoding - -• `Optional` **EnableSyncTranscoding**: `boolean` - -Gets or sets a value indicating whether [enable synchronize]. - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:157](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L157) - -___ - -### EnableUserPreferenceAccess - -• `Optional` **EnableUserPreferenceAccess**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:61](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L61) - -___ - -### EnableVideoPlaybackTranscoding - -• `Optional` **EnableVideoPlaybackTranscoding**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:121](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L121) - -___ - -### EnabledChannels - -• `Optional` **EnabledChannels**: ``null`` \| `string`[] - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L181) - -___ - -### EnabledDevices - -• `Optional` **EnabledDevices**: ``null`` \| `string`[] - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:169](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L169) - -___ - -### EnabledFolders - -• `Optional` **EnabledFolders**: ``null`` \| `string`[] - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:193](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L193) - -___ - -### ForceRemoteSourceTranscoding - -• `Optional` **ForceRemoteSourceTranscoding**: `boolean` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:133](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L133) - -___ - -### InvalidLoginAttemptCount - -• `Optional` **InvalidLoginAttemptCount**: `number` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:205](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L205) - -___ - -### IsAdministrator - -• `Optional` **IsAdministrator**: `boolean` - -Gets or sets a value indicating whether this instance is administrator. - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L31) - -___ - -### IsDisabled - -• `Optional` **IsDisabled**: `boolean` - -Gets or sets a value indicating whether this instance is disabled. - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L43) - -___ - -### IsHidden - -• `Optional` **IsHidden**: `boolean` - -Gets or sets a value indicating whether this instance is hidden. - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L37) - -___ - -### LoginAttemptsBeforeLockout - -• `Optional` **LoginAttemptsBeforeLockout**: `number` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:211](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L211) - -___ - -### MaxActiveSessions - -• `Optional` **MaxActiveSessions**: `number` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:217](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L217) - -___ - -### MaxParentalRating - -• `Optional` **MaxParentalRating**: ``null`` \| `number` - -Gets or sets the max parental rating. - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L49) - -___ - -### PasswordResetProviderId - -• `Optional` **PasswordResetProviderId**: ``null`` \| `string` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:253](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L253) - -___ - -### RemoteClientBitrateLimit - -• `Optional` **RemoteClientBitrateLimit**: `number` - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:241](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L241) - -___ - -### SyncPlayAccess - -• `Optional` **SyncPlayAccess**: [`SyncPlayUserAccessType`](../enums/generated_client.SyncPlayUserAccessType.md) - -**`memberof`** UserPolicy - -#### Defined in - -[generated-client/models/user-policy.ts:259](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/user-policy.ts#L259) diff --git a/docs/interfaces/generated_client.UserViewsApiGetGroupingOptionsRequest.md b/docs/interfaces/generated_client.UserViewsApiGetGroupingOptionsRequest.md deleted file mode 100644 index d2cd20838..000000000 --- a/docs/interfaces/generated_client.UserViewsApiGetGroupingOptionsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserViewsApiGetGroupingOptionsRequest - -# Interface: UserViewsApiGetGroupingOptionsRequest - -[generated-client](../modules/generated_client.md).UserViewsApiGetGroupingOptionsRequest - -Request parameters for getGroupingOptions operation in UserViewsApi. - -**`export`** - -**`interface`** UserViewsApiGetGroupingOptionsRequest - -## Table of contents - -### Properties - -- [userId](generated_client.UserViewsApiGetGroupingOptionsRequest.md#userid) - -## Properties - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** UserViewsApiGetGroupingOptions - -#### Defined in - -[generated-client/api/user-views-api.ts:206](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-views-api.ts#L206) diff --git a/docs/interfaces/generated_client.UserViewsApiGetUserViewsRequest.md b/docs/interfaces/generated_client.UserViewsApiGetUserViewsRequest.md deleted file mode 100644 index c6408d81f..000000000 --- a/docs/interfaces/generated_client.UserViewsApiGetUserViewsRequest.md +++ /dev/null @@ -1,76 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserViewsApiGetUserViewsRequest - -# Interface: UserViewsApiGetUserViewsRequest - -[generated-client](../modules/generated_client.md).UserViewsApiGetUserViewsRequest - -Request parameters for getUserViews operation in UserViewsApi. - -**`export`** - -**`interface`** UserViewsApiGetUserViewsRequest - -## Table of contents - -### Properties - -- [includeExternalContent](generated_client.UserViewsApiGetUserViewsRequest.md#includeexternalcontent) -- [includeHidden](generated_client.UserViewsApiGetUserViewsRequest.md#includehidden) -- [presetViews](generated_client.UserViewsApiGetUserViewsRequest.md#presetviews) -- [userId](generated_client.UserViewsApiGetUserViewsRequest.md#userid) - -## Properties - -### includeExternalContent - -• `Optional` `Readonly` **includeExternalContent**: `boolean` - -Whether or not to include external views such as channels or live tv. - -**`memberof`** UserViewsApiGetUserViews - -#### Defined in - -[generated-client/api/user-views-api.ts:227](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-views-api.ts#L227) - -___ - -### includeHidden - -• `Optional` `Readonly` **includeHidden**: `boolean` - -Whether or not to include hidden content. - -**`memberof`** UserViewsApiGetUserViews - -#### Defined in - -[generated-client/api/user-views-api.ts:241](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-views-api.ts#L241) - -___ - -### presetViews - -• `Optional` `Readonly` **presetViews**: `string`[] - -Preset views. - -**`memberof`** UserViewsApiGetUserViews - -#### Defined in - -[generated-client/api/user-views-api.ts:234](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-views-api.ts#L234) - -___ - -### userId - -• `Readonly` **userId**: `string` - -User id. - -**`memberof`** UserViewsApiGetUserViews - -#### Defined in - -[generated-client/api/user-views-api.ts:220](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-views-api.ts#L220) diff --git a/docs/interfaces/generated_client.UtcTimeResponse.md b/docs/interfaces/generated_client.UtcTimeResponse.md deleted file mode 100644 index 4d52f6c75..000000000 --- a/docs/interfaces/generated_client.UtcTimeResponse.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UtcTimeResponse - -# Interface: UtcTimeResponse - -[generated-client](../modules/generated_client.md).UtcTimeResponse - -Class UtcTimeResponse. - -**`export`** - -**`interface`** UtcTimeResponse - -## Table of contents - -### Properties - -- [RequestReceptionTime](generated_client.UtcTimeResponse.md#requestreceptiontime) -- [ResponseTransmissionTime](generated_client.UtcTimeResponse.md#responsetransmissiontime) - -## Properties - -### RequestReceptionTime - -• `Optional` **RequestReceptionTime**: `string` - -Gets the UTC time when request has been received. - -**`memberof`** UtcTimeResponse - -#### Defined in - -[generated-client/models/utc-time-response.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/utc-time-response.ts#L28) - -___ - -### ResponseTransmissionTime - -• `Optional` **ResponseTransmissionTime**: `string` - -Gets the UTC time when response has been sent. - -**`memberof`** UtcTimeResponse - -#### Defined in - -[generated-client/models/utc-time-response.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/utc-time-response.ts#L34) diff --git a/docs/interfaces/generated_client.ValidatePathDto.md b/docs/interfaces/generated_client.ValidatePathDto.md deleted file mode 100644 index 9413228bd..000000000 --- a/docs/interfaces/generated_client.ValidatePathDto.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ValidatePathDto - -# Interface: ValidatePathDto - -[generated-client](../modules/generated_client.md).ValidatePathDto - -Validate path object. - -**`export`** - -**`interface`** ValidatePathDto - -## Table of contents - -### Properties - -- [IsFile](generated_client.ValidatePathDto.md#isfile) -- [Path](generated_client.ValidatePathDto.md#path) -- [ValidateWritable](generated_client.ValidatePathDto.md#validatewritable) - -## Properties - -### IsFile - -• `Optional` **IsFile**: ``null`` \| `boolean` - -Gets or sets is path file. - -**`memberof`** ValidatePathDto - -#### Defined in - -[generated-client/models/validate-path-dto.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/validate-path-dto.ts#L40) - -___ - -### Path - -• `Optional` **Path**: ``null`` \| `string` - -Gets or sets the path. - -**`memberof`** ValidatePathDto - -#### Defined in - -[generated-client/models/validate-path-dto.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/validate-path-dto.ts#L34) - -___ - -### ValidateWritable - -• `Optional` **ValidateWritable**: `boolean` - -Gets or sets a value indicating whether validate if path is writable. - -**`memberof`** ValidatePathDto - -#### Defined in - -[generated-client/models/validate-path-dto.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/validate-path-dto.ts#L28) diff --git a/docs/interfaces/generated_client.VersionInfo.md b/docs/interfaces/generated_client.VersionInfo.md deleted file mode 100644 index 93830648e..000000000 --- a/docs/interfaces/generated_client.VersionInfo.md +++ /dev/null @@ -1,151 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VersionInfo - -# Interface: VersionInfo - -[generated-client](../modules/generated_client.md).VersionInfo - -Defines the MediaBrowser.Model.Updates.VersionInfo class. - -**`export`** - -**`interface`** VersionInfo - -## Table of contents - -### Properties - -- [VersionNumber](generated_client.VersionInfo.md#versionnumber) -- [changelog](generated_client.VersionInfo.md#changelog) -- [checksum](generated_client.VersionInfo.md#checksum) -- [repositoryName](generated_client.VersionInfo.md#repositoryname) -- [repositoryUrl](generated_client.VersionInfo.md#repositoryurl) -- [sourceUrl](generated_client.VersionInfo.md#sourceurl) -- [targetAbi](generated_client.VersionInfo.md#targetabi) -- [timestamp](generated_client.VersionInfo.md#timestamp) -- [version](generated_client.VersionInfo.md#version) - -## Properties - -### VersionNumber - -• `Optional` **VersionNumber**: `string` - -Gets the version as a System.Version. - -**`memberof`** VersionInfo - -#### Defined in - -[generated-client/models/version-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/version-info.ts#L34) - -___ - -### changelog - -• `Optional` **changelog**: ``null`` \| `string` - -Gets or sets the changelog for this version. - -**`memberof`** VersionInfo - -#### Defined in - -[generated-client/models/version-info.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/version-info.ts#L40) - -___ - -### checksum - -• `Optional` **checksum**: ``null`` \| `string` - -Gets or sets a checksum for the binary. - -**`memberof`** VersionInfo - -#### Defined in - -[generated-client/models/version-info.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/version-info.ts#L58) - -___ - -### repositoryName - -• `Optional` **repositoryName**: `string` - -Gets or sets the repository name. - -**`memberof`** VersionInfo - -#### Defined in - -[generated-client/models/version-info.ts:70](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/version-info.ts#L70) - -___ - -### repositoryUrl - -• `Optional` **repositoryUrl**: `string` - -Gets or sets the repository url. - -**`memberof`** VersionInfo - -#### Defined in - -[generated-client/models/version-info.ts:76](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/version-info.ts#L76) - -___ - -### sourceUrl - -• `Optional` **sourceUrl**: ``null`` \| `string` - -Gets or sets the source URL. - -**`memberof`** VersionInfo - -#### Defined in - -[generated-client/models/version-info.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/version-info.ts#L52) - -___ - -### targetAbi - -• `Optional` **targetAbi**: ``null`` \| `string` - -Gets or sets the ABI that this version was built against. - -**`memberof`** VersionInfo - -#### Defined in - -[generated-client/models/version-info.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/version-info.ts#L46) - -___ - -### timestamp - -• `Optional` **timestamp**: ``null`` \| `string` - -Gets or sets a timestamp of when the binary was built. - -**`memberof`** VersionInfo - -#### Defined in - -[generated-client/models/version-info.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/version-info.ts#L64) - -___ - -### version - -• `Optional` **version**: `string` - -Gets or sets the version. - -**`memberof`** VersionInfo - -#### Defined in - -[generated-client/models/version-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/version-info.ts#L28) diff --git a/docs/interfaces/generated_client.VideoAttachmentsApiGetAttachmentRequest.md b/docs/interfaces/generated_client.VideoAttachmentsApiGetAttachmentRequest.md deleted file mode 100644 index ef0eb0a09..000000000 --- a/docs/interfaces/generated_client.VideoAttachmentsApiGetAttachmentRequest.md +++ /dev/null @@ -1,61 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideoAttachmentsApiGetAttachmentRequest - -# Interface: VideoAttachmentsApiGetAttachmentRequest - -[generated-client](../modules/generated_client.md).VideoAttachmentsApiGetAttachmentRequest - -Request parameters for getAttachment operation in VideoAttachmentsApi. - -**`export`** - -**`interface`** VideoAttachmentsApiGetAttachmentRequest - -## Table of contents - -### Properties - -- [index](generated_client.VideoAttachmentsApiGetAttachmentRequest.md#index) -- [mediaSourceId](generated_client.VideoAttachmentsApiGetAttachmentRequest.md#mediasourceid) -- [videoId](generated_client.VideoAttachmentsApiGetAttachmentRequest.md#videoid) - -## Properties - -### index - -• `Readonly` **index**: `number` - -Attachment Index. - -**`memberof`** VideoAttachmentsApiGetAttachment - -#### Defined in - -[generated-client/api/video-attachments-api.ts:146](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/video-attachments-api.ts#L146) - -___ - -### mediaSourceId - -• `Readonly` **mediaSourceId**: `string` - -Media Source ID. - -**`memberof`** VideoAttachmentsApiGetAttachment - -#### Defined in - -[generated-client/api/video-attachments-api.ts:139](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/video-attachments-api.ts#L139) - -___ - -### videoId - -• `Readonly` **videoId**: `string` - -Video ID. - -**`memberof`** VideoAttachmentsApiGetAttachment - -#### Defined in - -[generated-client/api/video-attachments-api.ts:132](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/video-attachments-api.ts#L132) diff --git a/docs/interfaces/generated_client.VideosApiDeleteAlternateSourcesRequest.md b/docs/interfaces/generated_client.VideosApiDeleteAlternateSourcesRequest.md deleted file mode 100644 index da8bb1d26..000000000 --- a/docs/interfaces/generated_client.VideosApiDeleteAlternateSourcesRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideosApiDeleteAlternateSourcesRequest - -# Interface: VideosApiDeleteAlternateSourcesRequest - -[generated-client](../modules/generated_client.md).VideosApiDeleteAlternateSourcesRequest - -Request parameters for deleteAlternateSources operation in VideosApi. - -**`export`** - -**`interface`** VideosApiDeleteAlternateSourcesRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.VideosApiDeleteAlternateSourcesRequest.md#itemid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** VideosApiDeleteAlternateSources - -#### Defined in - -[generated-client/api/videos-api.ts:1873](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1873) diff --git a/docs/interfaces/generated_client.VideosApiGetAdditionalPartRequest.md b/docs/interfaces/generated_client.VideosApiGetAdditionalPartRequest.md deleted file mode 100644 index ed60c6b61..000000000 --- a/docs/interfaces/generated_client.VideosApiGetAdditionalPartRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideosApiGetAdditionalPartRequest - -# Interface: VideosApiGetAdditionalPartRequest - -[generated-client](../modules/generated_client.md).VideosApiGetAdditionalPartRequest - -Request parameters for getAdditionalPart operation in VideosApi. - -**`export`** - -**`interface`** VideosApiGetAdditionalPartRequest - -## Table of contents - -### Properties - -- [itemId](generated_client.VideosApiGetAdditionalPartRequest.md#itemid) -- [userId](generated_client.VideosApiGetAdditionalPartRequest.md#userid) - -## Properties - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** VideosApiGetAdditionalPart - -#### Defined in - -[generated-client/api/videos-api.ts:1887](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1887) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** VideosApiGetAdditionalPart - -#### Defined in - -[generated-client/api/videos-api.ts:1894](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1894) diff --git a/docs/interfaces/generated_client.VideosApiGetVideoStreamByContainerRequest.md b/docs/interfaces/generated_client.VideosApiGetVideoStreamByContainerRequest.md deleted file mode 100644 index caceabb4f..000000000 --- a/docs/interfaces/generated_client.VideosApiGetVideoStreamByContainerRequest.md +++ /dev/null @@ -1,785 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideosApiGetVideoStreamByContainerRequest - -# Interface: VideosApiGetVideoStreamByContainerRequest - -[generated-client](../modules/generated_client.md).VideosApiGetVideoStreamByContainerRequest - -Request parameters for getVideoStreamByContainer operation in VideosApi. - -**`export`** - -**`interface`** VideosApiGetVideoStreamByContainerRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.VideosApiGetVideoStreamByContainerRequest.md#_static) -- [allowAudioStreamCopy](generated_client.VideosApiGetVideoStreamByContainerRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.VideosApiGetVideoStreamByContainerRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.VideosApiGetVideoStreamByContainerRequest.md#audiobitrate) -- [audioChannels](generated_client.VideosApiGetVideoStreamByContainerRequest.md#audiochannels) -- [audioCodec](generated_client.VideosApiGetVideoStreamByContainerRequest.md#audiocodec) -- [audioSampleRate](generated_client.VideosApiGetVideoStreamByContainerRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.VideosApiGetVideoStreamByContainerRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.VideosApiGetVideoStreamByContainerRequest.md#breakonnonkeyframes) -- [container](generated_client.VideosApiGetVideoStreamByContainerRequest.md#container) -- [context](generated_client.VideosApiGetVideoStreamByContainerRequest.md#context) -- [copyTimestamps](generated_client.VideosApiGetVideoStreamByContainerRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.VideosApiGetVideoStreamByContainerRequest.md#cpucorelimit) -- [deInterlace](generated_client.VideosApiGetVideoStreamByContainerRequest.md#deinterlace) -- [deviceId](generated_client.VideosApiGetVideoStreamByContainerRequest.md#deviceid) -- [deviceProfileId](generated_client.VideosApiGetVideoStreamByContainerRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.VideosApiGetVideoStreamByContainerRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.VideosApiGetVideoStreamByContainerRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.VideosApiGetVideoStreamByContainerRequest.md#framerate) -- [height](generated_client.VideosApiGetVideoStreamByContainerRequest.md#height) -- [itemId](generated_client.VideosApiGetVideoStreamByContainerRequest.md#itemid) -- [level](generated_client.VideosApiGetVideoStreamByContainerRequest.md#level) -- [liveStreamId](generated_client.VideosApiGetVideoStreamByContainerRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.VideosApiGetVideoStreamByContainerRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.VideosApiGetVideoStreamByContainerRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.VideosApiGetVideoStreamByContainerRequest.md#maxframerate) -- [maxHeight](generated_client.VideosApiGetVideoStreamByContainerRequest.md#maxheight) -- [maxRefFrames](generated_client.VideosApiGetVideoStreamByContainerRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.VideosApiGetVideoStreamByContainerRequest.md#maxvideobitdepth) -- [maxWidth](generated_client.VideosApiGetVideoStreamByContainerRequest.md#maxwidth) -- [mediaSourceId](generated_client.VideosApiGetVideoStreamByContainerRequest.md#mediasourceid) -- [minSegments](generated_client.VideosApiGetVideoStreamByContainerRequest.md#minsegments) -- [params](generated_client.VideosApiGetVideoStreamByContainerRequest.md#params) -- [playSessionId](generated_client.VideosApiGetVideoStreamByContainerRequest.md#playsessionid) -- [profile](generated_client.VideosApiGetVideoStreamByContainerRequest.md#profile) -- [requireAvc](generated_client.VideosApiGetVideoStreamByContainerRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.VideosApiGetVideoStreamByContainerRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.VideosApiGetVideoStreamByContainerRequest.md#segmentcontainer) -- [segmentLength](generated_client.VideosApiGetVideoStreamByContainerRequest.md#segmentlength) -- [startTimeTicks](generated_client.VideosApiGetVideoStreamByContainerRequest.md#starttimeticks) -- [streamOptions](generated_client.VideosApiGetVideoStreamByContainerRequest.md#streamoptions) -- [subtitleCodec](generated_client.VideosApiGetVideoStreamByContainerRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.VideosApiGetVideoStreamByContainerRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.VideosApiGetVideoStreamByContainerRequest.md#subtitlestreamindex) -- [tag](generated_client.VideosApiGetVideoStreamByContainerRequest.md#tag) -- [transcodeReasons](generated_client.VideosApiGetVideoStreamByContainerRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.VideosApiGetVideoStreamByContainerRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.VideosApiGetVideoStreamByContainerRequest.md#videobitrate) -- [videoCodec](generated_client.VideosApiGetVideoStreamByContainerRequest.md#videocodec) -- [videoStreamIndex](generated_client.VideosApiGetVideoStreamByContainerRequest.md#videostreamindex) -- [width](generated_client.VideosApiGetVideoStreamByContainerRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2286](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2286) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2377](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2377) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2370](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2370) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2405](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2405) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2412](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2412) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2356](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2356) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2391](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2391) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2601](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2601) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2384](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2384) - -___ - -### container - -• `Readonly` **container**: `string` - -The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2279](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2279) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2615](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2615) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2454](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2454) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2559](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2559) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2538](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2538) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2349](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2349) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2307](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2307) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2363](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2363) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2573](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2573) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2440](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2440) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2475](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2475) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2272](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2272) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2433](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2433) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2566](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2566) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2398](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2398) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2419](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2419) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2447](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2447) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -Optional. The maximum vertical resolution of the encoded video. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2489](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2489) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2517](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2517) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2524](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2524) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -Optional. The maximum horizontal resolution of the encoded video. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2482](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2482) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2342](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2342) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2335](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2335) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2293](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2293) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2314](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2314) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2426](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2426) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2531](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2531) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2545](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2545) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2321](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2321) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2328](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2328) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2461](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2461) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/videos-api.ts:2622](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2622) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2587](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2587) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2510](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2510) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2503](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2503) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2300](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2300) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2594](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2594) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2552](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2552) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2496](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2496) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2580](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2580) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2608](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2608) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** VideosApiGetVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:2468](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2468) diff --git a/docs/interfaces/generated_client.VideosApiGetVideoStreamRequest.md b/docs/interfaces/generated_client.VideosApiGetVideoStreamRequest.md deleted file mode 100644 index b940f9f8f..000000000 --- a/docs/interfaces/generated_client.VideosApiGetVideoStreamRequest.md +++ /dev/null @@ -1,785 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideosApiGetVideoStreamRequest - -# Interface: VideosApiGetVideoStreamRequest - -[generated-client](../modules/generated_client.md).VideosApiGetVideoStreamRequest - -Request parameters for getVideoStream operation in VideosApi. - -**`export`** - -**`interface`** VideosApiGetVideoStreamRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.VideosApiGetVideoStreamRequest.md#_static) -- [allowAudioStreamCopy](generated_client.VideosApiGetVideoStreamRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.VideosApiGetVideoStreamRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.VideosApiGetVideoStreamRequest.md#audiobitrate) -- [audioChannels](generated_client.VideosApiGetVideoStreamRequest.md#audiochannels) -- [audioCodec](generated_client.VideosApiGetVideoStreamRequest.md#audiocodec) -- [audioSampleRate](generated_client.VideosApiGetVideoStreamRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.VideosApiGetVideoStreamRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.VideosApiGetVideoStreamRequest.md#breakonnonkeyframes) -- [container](generated_client.VideosApiGetVideoStreamRequest.md#container) -- [context](generated_client.VideosApiGetVideoStreamRequest.md#context) -- [copyTimestamps](generated_client.VideosApiGetVideoStreamRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.VideosApiGetVideoStreamRequest.md#cpucorelimit) -- [deInterlace](generated_client.VideosApiGetVideoStreamRequest.md#deinterlace) -- [deviceId](generated_client.VideosApiGetVideoStreamRequest.md#deviceid) -- [deviceProfileId](generated_client.VideosApiGetVideoStreamRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.VideosApiGetVideoStreamRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.VideosApiGetVideoStreamRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.VideosApiGetVideoStreamRequest.md#framerate) -- [height](generated_client.VideosApiGetVideoStreamRequest.md#height) -- [itemId](generated_client.VideosApiGetVideoStreamRequest.md#itemid) -- [level](generated_client.VideosApiGetVideoStreamRequest.md#level) -- [liveStreamId](generated_client.VideosApiGetVideoStreamRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.VideosApiGetVideoStreamRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.VideosApiGetVideoStreamRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.VideosApiGetVideoStreamRequest.md#maxframerate) -- [maxHeight](generated_client.VideosApiGetVideoStreamRequest.md#maxheight) -- [maxRefFrames](generated_client.VideosApiGetVideoStreamRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.VideosApiGetVideoStreamRequest.md#maxvideobitdepth) -- [maxWidth](generated_client.VideosApiGetVideoStreamRequest.md#maxwidth) -- [mediaSourceId](generated_client.VideosApiGetVideoStreamRequest.md#mediasourceid) -- [minSegments](generated_client.VideosApiGetVideoStreamRequest.md#minsegments) -- [params](generated_client.VideosApiGetVideoStreamRequest.md#params) -- [playSessionId](generated_client.VideosApiGetVideoStreamRequest.md#playsessionid) -- [profile](generated_client.VideosApiGetVideoStreamRequest.md#profile) -- [requireAvc](generated_client.VideosApiGetVideoStreamRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.VideosApiGetVideoStreamRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.VideosApiGetVideoStreamRequest.md#segmentcontainer) -- [segmentLength](generated_client.VideosApiGetVideoStreamRequest.md#segmentlength) -- [startTimeTicks](generated_client.VideosApiGetVideoStreamRequest.md#starttimeticks) -- [streamOptions](generated_client.VideosApiGetVideoStreamRequest.md#streamoptions) -- [subtitleCodec](generated_client.VideosApiGetVideoStreamRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.VideosApiGetVideoStreamRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.VideosApiGetVideoStreamRequest.md#subtitlestreamindex) -- [tag](generated_client.VideosApiGetVideoStreamRequest.md#tag) -- [transcodeReasons](generated_client.VideosApiGetVideoStreamRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.VideosApiGetVideoStreamRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.VideosApiGetVideoStreamRequest.md#videobitrate) -- [videoCodec](generated_client.VideosApiGetVideoStreamRequest.md#videocodec) -- [videoStreamIndex](generated_client.VideosApiGetVideoStreamRequest.md#videostreamindex) -- [width](generated_client.VideosApiGetVideoStreamRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1922](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1922) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2013](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2013) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2006](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2006) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2041](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2041) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2048](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2048) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1992](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1992) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2027](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2027) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2237](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2237) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2020](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2020) - -___ - -### container - -• `Optional` `Readonly` **container**: `string` - -The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1915](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1915) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2251](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2251) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2090](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2090) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2195](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2195) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2174](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2174) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1985](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1985) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1943](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1943) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1999](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1999) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2209](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2209) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2076](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2076) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2111](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2111) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1908](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1908) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2069](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2069) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2202](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2202) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2034](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2034) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2055](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2055) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2083](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2083) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -Optional. The maximum vertical resolution of the encoded video. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2125](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2125) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2153](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2153) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2160](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2160) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -Optional. The maximum horizontal resolution of the encoded video. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2118](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2118) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1978](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1978) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1971](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1971) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1929](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1929) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1950](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1950) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2062](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2062) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2167](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2167) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2181) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1957](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1957) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1964](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1964) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2097](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2097) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** VideosApiGetVideoStream - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/videos-api.ts:2258](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2258) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2223](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2223) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2146](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2146) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2139](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2139) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:1936](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1936) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2230](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2230) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2188](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2188) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2132](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2132) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2216](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2216) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2244](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2244) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** VideosApiGetVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2104](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2104) diff --git a/docs/interfaces/generated_client.VideosApiHeadVideoStreamByContainerRequest.md b/docs/interfaces/generated_client.VideosApiHeadVideoStreamByContainerRequest.md deleted file mode 100644 index d5e7ba29a..000000000 --- a/docs/interfaces/generated_client.VideosApiHeadVideoStreamByContainerRequest.md +++ /dev/null @@ -1,785 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideosApiHeadVideoStreamByContainerRequest - -# Interface: VideosApiHeadVideoStreamByContainerRequest - -[generated-client](../modules/generated_client.md).VideosApiHeadVideoStreamByContainerRequest - -Request parameters for headVideoStreamByContainer operation in VideosApi. - -**`export`** - -**`interface`** VideosApiHeadVideoStreamByContainerRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#_static) -- [allowAudioStreamCopy](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#audiobitrate) -- [audioChannels](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#audiochannels) -- [audioCodec](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#audiocodec) -- [audioSampleRate](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#breakonnonkeyframes) -- [container](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#container) -- [context](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#context) -- [copyTimestamps](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#cpucorelimit) -- [deInterlace](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#deinterlace) -- [deviceId](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#deviceid) -- [deviceProfileId](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#framerate) -- [height](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#height) -- [itemId](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#itemid) -- [level](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#level) -- [liveStreamId](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#maxframerate) -- [maxHeight](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#maxheight) -- [maxRefFrames](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#maxvideobitdepth) -- [maxWidth](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#maxwidth) -- [mediaSourceId](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#mediasourceid) -- [minSegments](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#minsegments) -- [params](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#params) -- [playSessionId](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#playsessionid) -- [profile](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#profile) -- [requireAvc](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#segmentcontainer) -- [segmentLength](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#segmentlength) -- [startTimeTicks](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#starttimeticks) -- [streamOptions](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#streamoptions) -- [subtitleCodec](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#subtitlestreamindex) -- [tag](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#tag) -- [transcodeReasons](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#videobitrate) -- [videoCodec](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#videocodec) -- [videoStreamIndex](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#videostreamindex) -- [width](generated_client.VideosApiHeadVideoStreamByContainerRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3014](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3014) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3105](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3105) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3098](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3098) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3133](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3133) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3140](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3140) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3084](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3084) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3119](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3119) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3329](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3329) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3112](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3112) - -___ - -### container - -• `Readonly` **container**: `string` - -The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3007](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3007) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3343](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3343) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3182](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3182) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3287](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3287) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3266](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3266) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3077](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3077) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3035](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3035) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3091](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3091) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3301](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3301) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3168](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3168) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3203](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3203) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3000](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3000) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3161](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3161) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3294](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3294) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3126](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3126) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3147](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3147) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3175](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3175) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -Optional. The maximum vertical resolution of the encoded video. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3217](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3217) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3245](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3245) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3252](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3252) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -Optional. The maximum horizontal resolution of the encoded video. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3210](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3210) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3070](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3070) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3063](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3063) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3021](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3021) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3042](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3042) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3154](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3154) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3259](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3259) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3273](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3273) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3049](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3049) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3056](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3056) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3189](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3189) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/videos-api.ts:3350](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3350) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3315](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3315) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3238](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3238) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3231](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3231) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3028](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3028) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3322](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3322) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3280](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3280) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3224](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3224) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3308](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3308) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3336](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3336) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** VideosApiHeadVideoStreamByContainer - -#### Defined in - -[generated-client/api/videos-api.ts:3196](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3196) diff --git a/docs/interfaces/generated_client.VideosApiHeadVideoStreamRequest.md b/docs/interfaces/generated_client.VideosApiHeadVideoStreamRequest.md deleted file mode 100644 index 8deac50cb..000000000 --- a/docs/interfaces/generated_client.VideosApiHeadVideoStreamRequest.md +++ /dev/null @@ -1,785 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideosApiHeadVideoStreamRequest - -# Interface: VideosApiHeadVideoStreamRequest - -[generated-client](../modules/generated_client.md).VideosApiHeadVideoStreamRequest - -Request parameters for headVideoStream operation in VideosApi. - -**`export`** - -**`interface`** VideosApiHeadVideoStreamRequest - -## Table of contents - -### Properties - -- [\_static](generated_client.VideosApiHeadVideoStreamRequest.md#_static) -- [allowAudioStreamCopy](generated_client.VideosApiHeadVideoStreamRequest.md#allowaudiostreamcopy) -- [allowVideoStreamCopy](generated_client.VideosApiHeadVideoStreamRequest.md#allowvideostreamcopy) -- [audioBitRate](generated_client.VideosApiHeadVideoStreamRequest.md#audiobitrate) -- [audioChannels](generated_client.VideosApiHeadVideoStreamRequest.md#audiochannels) -- [audioCodec](generated_client.VideosApiHeadVideoStreamRequest.md#audiocodec) -- [audioSampleRate](generated_client.VideosApiHeadVideoStreamRequest.md#audiosamplerate) -- [audioStreamIndex](generated_client.VideosApiHeadVideoStreamRequest.md#audiostreamindex) -- [breakOnNonKeyFrames](generated_client.VideosApiHeadVideoStreamRequest.md#breakonnonkeyframes) -- [container](generated_client.VideosApiHeadVideoStreamRequest.md#container) -- [context](generated_client.VideosApiHeadVideoStreamRequest.md#context) -- [copyTimestamps](generated_client.VideosApiHeadVideoStreamRequest.md#copytimestamps) -- [cpuCoreLimit](generated_client.VideosApiHeadVideoStreamRequest.md#cpucorelimit) -- [deInterlace](generated_client.VideosApiHeadVideoStreamRequest.md#deinterlace) -- [deviceId](generated_client.VideosApiHeadVideoStreamRequest.md#deviceid) -- [deviceProfileId](generated_client.VideosApiHeadVideoStreamRequest.md#deviceprofileid) -- [enableAutoStreamCopy](generated_client.VideosApiHeadVideoStreamRequest.md#enableautostreamcopy) -- [enableMpegtsM2TsMode](generated_client.VideosApiHeadVideoStreamRequest.md#enablempegtsm2tsmode) -- [framerate](generated_client.VideosApiHeadVideoStreamRequest.md#framerate) -- [height](generated_client.VideosApiHeadVideoStreamRequest.md#height) -- [itemId](generated_client.VideosApiHeadVideoStreamRequest.md#itemid) -- [level](generated_client.VideosApiHeadVideoStreamRequest.md#level) -- [liveStreamId](generated_client.VideosApiHeadVideoStreamRequest.md#livestreamid) -- [maxAudioBitDepth](generated_client.VideosApiHeadVideoStreamRequest.md#maxaudiobitdepth) -- [maxAudioChannels](generated_client.VideosApiHeadVideoStreamRequest.md#maxaudiochannels) -- [maxFramerate](generated_client.VideosApiHeadVideoStreamRequest.md#maxframerate) -- [maxHeight](generated_client.VideosApiHeadVideoStreamRequest.md#maxheight) -- [maxRefFrames](generated_client.VideosApiHeadVideoStreamRequest.md#maxrefframes) -- [maxVideoBitDepth](generated_client.VideosApiHeadVideoStreamRequest.md#maxvideobitdepth) -- [maxWidth](generated_client.VideosApiHeadVideoStreamRequest.md#maxwidth) -- [mediaSourceId](generated_client.VideosApiHeadVideoStreamRequest.md#mediasourceid) -- [minSegments](generated_client.VideosApiHeadVideoStreamRequest.md#minsegments) -- [params](generated_client.VideosApiHeadVideoStreamRequest.md#params) -- [playSessionId](generated_client.VideosApiHeadVideoStreamRequest.md#playsessionid) -- [profile](generated_client.VideosApiHeadVideoStreamRequest.md#profile) -- [requireAvc](generated_client.VideosApiHeadVideoStreamRequest.md#requireavc) -- [requireNonAnamorphic](generated_client.VideosApiHeadVideoStreamRequest.md#requirenonanamorphic) -- [segmentContainer](generated_client.VideosApiHeadVideoStreamRequest.md#segmentcontainer) -- [segmentLength](generated_client.VideosApiHeadVideoStreamRequest.md#segmentlength) -- [startTimeTicks](generated_client.VideosApiHeadVideoStreamRequest.md#starttimeticks) -- [streamOptions](generated_client.VideosApiHeadVideoStreamRequest.md#streamoptions) -- [subtitleCodec](generated_client.VideosApiHeadVideoStreamRequest.md#subtitlecodec) -- [subtitleMethod](generated_client.VideosApiHeadVideoStreamRequest.md#subtitlemethod) -- [subtitleStreamIndex](generated_client.VideosApiHeadVideoStreamRequest.md#subtitlestreamindex) -- [tag](generated_client.VideosApiHeadVideoStreamRequest.md#tag) -- [transcodeReasons](generated_client.VideosApiHeadVideoStreamRequest.md#transcodereasons) -- [transcodingMaxAudioChannels](generated_client.VideosApiHeadVideoStreamRequest.md#transcodingmaxaudiochannels) -- [videoBitRate](generated_client.VideosApiHeadVideoStreamRequest.md#videobitrate) -- [videoCodec](generated_client.VideosApiHeadVideoStreamRequest.md#videocodec) -- [videoStreamIndex](generated_client.VideosApiHeadVideoStreamRequest.md#videostreamindex) -- [width](generated_client.VideosApiHeadVideoStreamRequest.md#width) - -## Properties - -### \_static - -• `Optional` `Readonly` **\_static**: `boolean` - -Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2650](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2650) - -___ - -### allowAudioStreamCopy - -• `Optional` `Readonly` **allowAudioStreamCopy**: `boolean` - -Whether or not to allow copying of the audio stream url. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2741](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2741) - -___ - -### allowVideoStreamCopy - -• `Optional` `Readonly` **allowVideoStreamCopy**: `boolean` - -Whether or not to allow copying of the video stream url. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2734](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2734) - -___ - -### audioBitRate - -• `Optional` `Readonly` **audioBitRate**: `number` - -Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2769](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2769) - -___ - -### audioChannels - -• `Optional` `Readonly` **audioChannels**: `number` - -Optional. Specify a specific number of audio channels to encode to, e.g. 2. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2776](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2776) - -___ - -### audioCodec - -• `Optional` `Readonly` **audioCodec**: `string` - -Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. Options: aac, mp3, vorbis, wma. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2720](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2720) - -___ - -### audioSampleRate - -• `Optional` `Readonly` **audioSampleRate**: `number` - -Optional. Specify a specific audio sample rate, e.g. 44100. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2755](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2755) - -___ - -### audioStreamIndex - -• `Optional` `Readonly` **audioStreamIndex**: `number` - -Optional. The index of the audio stream to use. If omitted the first audio stream will be used. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2965](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2965) - -___ - -### breakOnNonKeyFrames - -• `Optional` `Readonly` **breakOnNonKeyFrames**: `boolean` - -Optional. Whether to break on non key frames. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2748](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2748) - -___ - -### container - -• `Optional` `Readonly` **container**: `string` - -The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2643](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2643) - -___ - -### context - -• `Optional` `Readonly` **context**: [`EncodingContext`](../enums/generated_client.EncodingContext.md) - -Optional. The MediaBrowser.Model.Dlna.EncodingContext. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2979](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2979) - -___ - -### copyTimestamps - -• `Optional` `Readonly` **copyTimestamps**: `boolean` - -Whether or not to copy timestamps when transcoding with an offset. Defaults to false. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2818](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2818) - -___ - -### cpuCoreLimit - -• `Optional` `Readonly` **cpuCoreLimit**: `number` - -Optional. The limit of how many cpu cores to use. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2923](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2923) - -___ - -### deInterlace - -• `Optional` `Readonly` **deInterlace**: `boolean` - -Optional. Whether to deinterlace the video. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2902](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2902) - -___ - -### deviceId - -• `Optional` `Readonly` **deviceId**: `string` - -The device id of the client requesting. Used to stop encoding processes when needed. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2713](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2713) - -___ - -### deviceProfileId - -• `Optional` `Readonly` **deviceProfileId**: `string` - -Optional. The dlna device profile id to utilize. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2671](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2671) - -___ - -### enableAutoStreamCopy - -• `Optional` `Readonly` **enableAutoStreamCopy**: `boolean` - -Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2727](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2727) - -___ - -### enableMpegtsM2TsMode - -• `Optional` `Readonly` **enableMpegtsM2TsMode**: `boolean` - -Optional. Whether to enable the MpegtsM2Ts mode. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2937](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2937) - -___ - -### framerate - -• `Optional` `Readonly` **framerate**: `number` - -Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2804](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2804) - -___ - -### height - -• `Optional` `Readonly` **height**: `number` - -Optional. The fixed vertical resolution of the encoded video. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2839](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2839) - -___ - -### itemId - -• `Readonly` **itemId**: `string` - -The item id. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2636](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2636) - -___ - -### level - -• `Optional` `Readonly` **level**: `string` - -Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2797](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2797) - -___ - -### liveStreamId - -• `Optional` `Readonly` **liveStreamId**: `string` - -The live stream id. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2930](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2930) - -___ - -### maxAudioBitDepth - -• `Optional` `Readonly` **maxAudioBitDepth**: `number` - -Optional. The maximum audio bit depth. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2762](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2762) - -___ - -### maxAudioChannels - -• `Optional` `Readonly` **maxAudioChannels**: `number` - -Optional. Specify a maximum number of audio channels to encode to, e.g. 2. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2783](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2783) - -___ - -### maxFramerate - -• `Optional` `Readonly` **maxFramerate**: `number` - -Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2811](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2811) - -___ - -### maxHeight - -• `Optional` `Readonly` **maxHeight**: `number` - -Optional. The maximum vertical resolution of the encoded video. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2853](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2853) - -___ - -### maxRefFrames - -• `Optional` `Readonly` **maxRefFrames**: `number` - -Optional. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2881](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2881) - -___ - -### maxVideoBitDepth - -• `Optional` `Readonly` **maxVideoBitDepth**: `number` - -Optional. The maximum video bit depth. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2888](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2888) - -___ - -### maxWidth - -• `Optional` `Readonly` **maxWidth**: `number` - -Optional. The maximum horizontal resolution of the encoded video. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2846](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2846) - -___ - -### mediaSourceId - -• `Optional` `Readonly` **mediaSourceId**: `string` - -The media version id, if playing an alternate version. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2706](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2706) - -___ - -### minSegments - -• `Optional` `Readonly` **minSegments**: `number` - -The minimum number of segments. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2699](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2699) - -___ - -### params - -• `Optional` `Readonly` **params**: `string` - -The streaming parameters. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2657](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2657) - -___ - -### playSessionId - -• `Optional` `Readonly` **playSessionId**: `string` - -The play session id. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2678](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2678) - -___ - -### profile - -• `Optional` `Readonly` **profile**: `string` - -Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2790](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2790) - -___ - -### requireAvc - -• `Optional` `Readonly` **requireAvc**: `boolean` - -Optional. Whether to require avc. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2895](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2895) - -___ - -### requireNonAnamorphic - -• `Optional` `Readonly` **requireNonAnamorphic**: `boolean` - -Optional. Whether to require a non anamorphic stream. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2909](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2909) - -___ - -### segmentContainer - -• `Optional` `Readonly` **segmentContainer**: `string` - -The segment container. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2685](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2685) - -___ - -### segmentLength - -• `Optional` `Readonly` **segmentLength**: `number` - -The segment length. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2692](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2692) - -___ - -### startTimeTicks - -• `Optional` `Readonly` **startTimeTicks**: `number` - -Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2825](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2825) - -___ - -### streamOptions - -• `Optional` `Readonly` **streamOptions**: `Object` - -Optional. The streaming options. - -**`memberof`** VideosApiHeadVideoStream - -#### Index signature - -▪ [key: `string`]: `string` - -#### Defined in - -[generated-client/api/videos-api.ts:2986](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2986) - -___ - -### subtitleCodec - -• `Optional` `Readonly` **subtitleCodec**: `string` - -Optional. Specify a subtitle codec to encode to. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2951](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2951) - -___ - -### subtitleMethod - -• `Optional` `Readonly` **subtitleMethod**: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md) - -Optional. Specify the subtitle delivery method. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2874](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2874) - -___ - -### subtitleStreamIndex - -• `Optional` `Readonly` **subtitleStreamIndex**: `number` - -Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2867](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2867) - -___ - -### tag - -• `Optional` `Readonly` **tag**: `string` - -The tag. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2664](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2664) - -___ - -### transcodeReasons - -• `Optional` `Readonly` **transcodeReasons**: `string` - -Optional. The transcoding reason. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2958](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2958) - -___ - -### transcodingMaxAudioChannels - -• `Optional` `Readonly` **transcodingMaxAudioChannels**: `number` - -Optional. The maximum number of audio channels to transcode. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2916](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2916) - -___ - -### videoBitRate - -• `Optional` `Readonly` **videoBitRate**: `number` - -Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2860](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2860) - -___ - -### videoCodec - -• `Optional` `Readonly` **videoCodec**: `string` - -Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. Options: h265, h264, mpeg4, theora, vp8, vp9, vpx (deprecated), wmv. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2944](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2944) - -___ - -### videoStreamIndex - -• `Optional` `Readonly` **videoStreamIndex**: `number` - -Optional. The index of the video stream to use. If omitted the first video stream will be used. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2972](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2972) - -___ - -### width - -• `Optional` `Readonly` **width**: `number` - -Optional. The fixed horizontal resolution of the encoded video. - -**`memberof`** VideosApiHeadVideoStream - -#### Defined in - -[generated-client/api/videos-api.ts:2832](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L2832) diff --git a/docs/interfaces/generated_client.VideosApiMergeVersionsRequest.md b/docs/interfaces/generated_client.VideosApiMergeVersionsRequest.md deleted file mode 100644 index 6d5474705..000000000 --- a/docs/interfaces/generated_client.VideosApiMergeVersionsRequest.md +++ /dev/null @@ -1,31 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideosApiMergeVersionsRequest - -# Interface: VideosApiMergeVersionsRequest - -[generated-client](../modules/generated_client.md).VideosApiMergeVersionsRequest - -Request parameters for mergeVersions operation in VideosApi. - -**`export`** - -**`interface`** VideosApiMergeVersionsRequest - -## Table of contents - -### Properties - -- [ids](generated_client.VideosApiMergeVersionsRequest.md#ids) - -## Properties - -### ids - -• `Readonly` **ids**: `string`[] - -Item id list. This allows multiple, comma delimited. - -**`memberof`** VideosApiMergeVersions - -#### Defined in - -[generated-client/api/videos-api.ts:3364](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3364) diff --git a/docs/interfaces/generated_client.VirtualFolderInfo.md b/docs/interfaces/generated_client.VirtualFolderInfo.md deleted file mode 100644 index f97349378..000000000 --- a/docs/interfaces/generated_client.VirtualFolderInfo.md +++ /dev/null @@ -1,128 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VirtualFolderInfo - -# Interface: VirtualFolderInfo - -[generated-client](../modules/generated_client.md).VirtualFolderInfo - -Used to hold information about a user\'s list of configured virtual folders. - -**`export`** - -**`interface`** VirtualFolderInfo - -## Table of contents - -### Properties - -- [CollectionType](generated_client.VirtualFolderInfo.md#collectiontype) -- [ItemId](generated_client.VirtualFolderInfo.md#itemid) -- [LibraryOptions](generated_client.VirtualFolderInfo.md#libraryoptions) -- [Locations](generated_client.VirtualFolderInfo.md#locations) -- [Name](generated_client.VirtualFolderInfo.md#name) -- [PrimaryImageItemId](generated_client.VirtualFolderInfo.md#primaryimageitemid) -- [RefreshProgress](generated_client.VirtualFolderInfo.md#refreshprogress) -- [RefreshStatus](generated_client.VirtualFolderInfo.md#refreshstatus) - -## Properties - -### CollectionType - -• `Optional` **CollectionType**: [`CollectionTypeOptions`](../enums/generated_client.CollectionTypeOptions.md) - -**`memberof`** VirtualFolderInfo - -#### Defined in - -[generated-client/models/virtual-folder-info.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/virtual-folder-info.ts#L42) - -___ - -### ItemId - -• `Optional` **ItemId**: ``null`` \| `string` - -Gets or sets the item identifier. - -**`memberof`** VirtualFolderInfo - -#### Defined in - -[generated-client/models/virtual-folder-info.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/virtual-folder-info.ts#L54) - -___ - -### LibraryOptions - -• `Optional` **LibraryOptions**: [`LibraryOptions`](generated_client.LibraryOptions.md) - -**`memberof`** VirtualFolderInfo - -#### Defined in - -[generated-client/models/virtual-folder-info.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/virtual-folder-info.ts#L48) - -___ - -### Locations - -• `Optional` **Locations**: ``null`` \| `string`[] - -Gets or sets the locations. - -**`memberof`** VirtualFolderInfo - -#### Defined in - -[generated-client/models/virtual-folder-info.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/virtual-folder-info.ts#L36) - -___ - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name. - -**`memberof`** VirtualFolderInfo - -#### Defined in - -[generated-client/models/virtual-folder-info.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/virtual-folder-info.ts#L30) - -___ - -### PrimaryImageItemId - -• `Optional` **PrimaryImageItemId**: ``null`` \| `string` - -Gets or sets the primary image item identifier. - -**`memberof`** VirtualFolderInfo - -#### Defined in - -[generated-client/models/virtual-folder-info.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/virtual-folder-info.ts#L60) - -___ - -### RefreshProgress - -• `Optional` **RefreshProgress**: ``null`` \| `number` - -**`memberof`** VirtualFolderInfo - -#### Defined in - -[generated-client/models/virtual-folder-info.ts:66](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/virtual-folder-info.ts#L66) - -___ - -### RefreshStatus - -• `Optional` **RefreshStatus**: ``null`` \| `string` - -**`memberof`** VirtualFolderInfo - -#### Defined in - -[generated-client/models/virtual-folder-info.ts:72](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/virtual-folder-info.ts#L72) diff --git a/docs/interfaces/generated_client.WakeOnLanInfo.md b/docs/interfaces/generated_client.WakeOnLanInfo.md deleted file mode 100644 index 052d5415a..000000000 --- a/docs/interfaces/generated_client.WakeOnLanInfo.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / WakeOnLanInfo - -# Interface: WakeOnLanInfo - -[generated-client](../modules/generated_client.md).WakeOnLanInfo - -Provides the MAC address and port for wake-on-LAN functionality. - -**`export`** - -**`interface`** WakeOnLanInfo - -## Table of contents - -### Properties - -- [MacAddress](generated_client.WakeOnLanInfo.md#macaddress) -- [Port](generated_client.WakeOnLanInfo.md#port) - -## Properties - -### MacAddress - -• `Optional` **MacAddress**: ``null`` \| `string` - -Gets the MAC address of the device. - -**`memberof`** WakeOnLanInfo - -#### Defined in - -[generated-client/models/wake-on-lan-info.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/wake-on-lan-info.ts#L28) - -___ - -### Port - -• `Optional` **Port**: `number` - -Gets or sets the wake-on-LAN port. - -**`memberof`** WakeOnLanInfo - -#### Defined in - -[generated-client/models/wake-on-lan-info.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/wake-on-lan-info.ts#L34) diff --git a/docs/interfaces/generated_client.XbmcMetadataOptions.md b/docs/interfaces/generated_client.XbmcMetadataOptions.md deleted file mode 100644 index 560f4ede9..000000000 --- a/docs/interfaces/generated_client.XbmcMetadataOptions.md +++ /dev/null @@ -1,79 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / XbmcMetadataOptions - -# Interface: XbmcMetadataOptions - -[generated-client](../modules/generated_client.md).XbmcMetadataOptions - -**`export`** - -**`interface`** XbmcMetadataOptions - -## Table of contents - -### Properties - -- [EnableExtraThumbsDuplication](generated_client.XbmcMetadataOptions.md#enableextrathumbsduplication) -- [EnablePathSubstitution](generated_client.XbmcMetadataOptions.md#enablepathsubstitution) -- [ReleaseDateFormat](generated_client.XbmcMetadataOptions.md#releasedateformat) -- [SaveImagePathsInNfo](generated_client.XbmcMetadataOptions.md#saveimagepathsinnfo) -- [UserId](generated_client.XbmcMetadataOptions.md#userid) - -## Properties - -### EnableExtraThumbsDuplication - -• `Optional` **EnableExtraThumbsDuplication**: `boolean` - -**`memberof`** XbmcMetadataOptions - -#### Defined in - -[generated-client/models/xbmc-metadata-options.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/xbmc-metadata-options.ts#L52) - -___ - -### EnablePathSubstitution - -• `Optional` **EnablePathSubstitution**: `boolean` - -**`memberof`** XbmcMetadataOptions - -#### Defined in - -[generated-client/models/xbmc-metadata-options.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/xbmc-metadata-options.ts#L46) - -___ - -### ReleaseDateFormat - -• `Optional` **ReleaseDateFormat**: `string` - -**`memberof`** XbmcMetadataOptions - -#### Defined in - -[generated-client/models/xbmc-metadata-options.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/xbmc-metadata-options.ts#L34) - -___ - -### SaveImagePathsInNfo - -• `Optional` **SaveImagePathsInNfo**: `boolean` - -**`memberof`** XbmcMetadataOptions - -#### Defined in - -[generated-client/models/xbmc-metadata-options.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/xbmc-metadata-options.ts#L40) - -___ - -### UserId - -• `Optional` **UserId**: ``null`` \| `string` - -**`memberof`** XbmcMetadataOptions - -#### Defined in - -[generated-client/models/xbmc-metadata-options.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/xbmc-metadata-options.ts#L28) diff --git a/docs/interfaces/generated_client.XmlAttribute.md b/docs/interfaces/generated_client.XmlAttribute.md deleted file mode 100644 index 562634d1b..000000000 --- a/docs/interfaces/generated_client.XmlAttribute.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / XmlAttribute - -# Interface: XmlAttribute - -[generated-client](../modules/generated_client.md).XmlAttribute - -Defines the MediaBrowser.Model.Dlna.XmlAttribute. - -**`export`** - -**`interface`** XmlAttribute - -## Table of contents - -### Properties - -- [Name](generated_client.XmlAttribute.md#name) -- [Value](generated_client.XmlAttribute.md#value) - -## Properties - -### Name - -• `Optional` **Name**: ``null`` \| `string` - -Gets or sets the name of the attribute. - -**`memberof`** XmlAttribute - -#### Defined in - -[generated-client/models/xml-attribute.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/xml-attribute.ts#L28) - -___ - -### Value - -• `Optional` **Value**: ``null`` \| `string` - -Gets or sets the value of the attribute. - -**`memberof`** XmlAttribute - -#### Defined in - -[generated-client/models/xml-attribute.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/xml-attribute.ts#L34) diff --git a/docs/interfaces/generated_client.YearsApiGetYearRequest.md b/docs/interfaces/generated_client.YearsApiGetYearRequest.md deleted file mode 100644 index 53961a93d..000000000 --- a/docs/interfaces/generated_client.YearsApiGetYearRequest.md +++ /dev/null @@ -1,46 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / YearsApiGetYearRequest - -# Interface: YearsApiGetYearRequest - -[generated-client](../modules/generated_client.md).YearsApiGetYearRequest - -Request parameters for getYear operation in YearsApi. - -**`export`** - -**`interface`** YearsApiGetYearRequest - -## Table of contents - -### Properties - -- [userId](generated_client.YearsApiGetYearRequest.md#userid) -- [year](generated_client.YearsApiGetYearRequest.md#year) - -## Properties - -### userId - -• `Optional` `Readonly` **userId**: `string` - -Optional. Filter by user id, and attach user data. - -**`memberof`** YearsApiGetYear - -#### Defined in - -[generated-client/api/years-api.ts:306](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L306) - -___ - -### year - -• `Readonly` **year**: `number` - -The year. - -**`memberof`** YearsApiGetYear - -#### Defined in - -[generated-client/api/years-api.ts:299](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L299) diff --git a/docs/interfaces/generated_client.YearsApiGetYearsRequest.md b/docs/interfaces/generated_client.YearsApiGetYearsRequest.md deleted file mode 100644 index 4199cebff..000000000 --- a/docs/interfaces/generated_client.YearsApiGetYearsRequest.md +++ /dev/null @@ -1,241 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / YearsApiGetYearsRequest - -# Interface: YearsApiGetYearsRequest - -[generated-client](../modules/generated_client.md).YearsApiGetYearsRequest - -Request parameters for getYears operation in YearsApi. - -**`export`** - -**`interface`** YearsApiGetYearsRequest - -## Table of contents - -### Properties - -- [enableImageTypes](generated_client.YearsApiGetYearsRequest.md#enableimagetypes) -- [enableImages](generated_client.YearsApiGetYearsRequest.md#enableimages) -- [enableUserData](generated_client.YearsApiGetYearsRequest.md#enableuserdata) -- [excludeItemTypes](generated_client.YearsApiGetYearsRequest.md#excludeitemtypes) -- [fields](generated_client.YearsApiGetYearsRequest.md#fields) -- [imageTypeLimit](generated_client.YearsApiGetYearsRequest.md#imagetypelimit) -- [includeItemTypes](generated_client.YearsApiGetYearsRequest.md#includeitemtypes) -- [limit](generated_client.YearsApiGetYearsRequest.md#limit) -- [mediaTypes](generated_client.YearsApiGetYearsRequest.md#mediatypes) -- [parentId](generated_client.YearsApiGetYearsRequest.md#parentid) -- [recursive](generated_client.YearsApiGetYearsRequest.md#recursive) -- [sortBy](generated_client.YearsApiGetYearsRequest.md#sortby) -- [sortOrder](generated_client.YearsApiGetYearsRequest.md#sortorder) -- [startIndex](generated_client.YearsApiGetYearsRequest.md#startindex) -- [userId](generated_client.YearsApiGetYearsRequest.md#userid) - -## Properties - -### enableImageTypes - -• `Optional` `Readonly` **enableImageTypes**: [`ImageType`](../enums/generated_client.ImageType.md)[] - -Optional. The image types to include in the output. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:397](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L397) - -___ - -### enableImages - -• `Optional` `Readonly` **enableImages**: `boolean` - -Optional. Include image information in output. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:418](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L418) - -___ - -### enableUserData - -• `Optional` `Readonly` **enableUserData**: `boolean` - -Optional. Include user data. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:383](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L383) - -___ - -### excludeItemTypes - -• `Optional` `Readonly` **excludeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:355](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L355) - -___ - -### fields - -• `Optional` `Readonly` **fields**: [`ItemFields`](../enums/generated_client.ItemFields.md)[] - -Optional. Specify additional fields of information to return in the output. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:348](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L348) - -___ - -### imageTypeLimit - -• `Optional` `Readonly` **imageTypeLimit**: `number` - -Optional. The max number of images to return, per image type. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:390](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L390) - -___ - -### includeItemTypes - -• `Optional` `Readonly` **includeItemTypes**: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[] - -Optional. If specified, results will be included based on item type. This allows multiple, comma delimited. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:362](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L362) - -___ - -### limit - -• `Optional` `Readonly` **limit**: `number` - -Optional. The maximum number of records to return. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:327](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L327) - -___ - -### mediaTypes - -• `Optional` `Readonly` **mediaTypes**: `string`[] - -Optional. Filter by MediaType. Allows multiple, comma delimited. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:369](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L369) - -___ - -### parentId - -• `Optional` `Readonly` **parentId**: `string` - -Specify this to localize the search to a specific item or folder. Omit to use the root. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:341](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L341) - -___ - -### recursive - -• `Optional` `Readonly` **recursive**: `boolean` - -Search recursively. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:411](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L411) - -___ - -### sortBy - -• `Optional` `Readonly` **sortBy**: `string`[] - -Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:376](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L376) - -___ - -### sortOrder - -• `Optional` `Readonly` **sortOrder**: [`SortOrder`](../enums/generated_client.SortOrder.md)[] - -Sort Order - Ascending,Descending. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:334](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L334) - -___ - -### startIndex - -• `Optional` `Readonly` **startIndex**: `number` - -Skips over a given number of items within the results. Use for paging. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:320](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L320) - -___ - -### userId - -• `Optional` `Readonly` **userId**: `string` - -User Id. - -**`memberof`** YearsApiGetYears - -#### Defined in - -[generated-client/api/years-api.ts:404](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L404) diff --git a/docs/interfaces/index.ClientInfo.md b/docs/interfaces/index.ClientInfo.md deleted file mode 100644 index 1a5a40cd8..000000000 --- a/docs/interfaces/index.ClientInfo.md +++ /dev/null @@ -1,34 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / ClientInfo - -# Interface: ClientInfo - -[index](../modules/index.md).ClientInfo - -An interface representing a client application. - -## Table of contents - -### Properties - -- [name](index.ClientInfo.md#name) -- [version](index.ClientInfo.md#version) - -## Properties - -### name - -• **name**: `string` - -#### Defined in - -[models/client-info.ts:11](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/client-info.ts#L11) - -___ - -### version - -• **version**: `string` - -#### Defined in - -[models/client-info.ts:12](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/client-info.ts#L12) diff --git a/docs/interfaces/index.DeviceInfo.md b/docs/interfaces/index.DeviceInfo.md deleted file mode 100644 index 40553f581..000000000 --- a/docs/interfaces/index.DeviceInfo.md +++ /dev/null @@ -1,34 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / DeviceInfo - -# Interface: DeviceInfo - -[index](../modules/index.md).DeviceInfo - -An interface representing a client device. - -## Table of contents - -### Properties - -- [id](index.DeviceInfo.md#id) -- [name](index.DeviceInfo.md#name) - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[models/device-info.ts:11](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/device-info.ts#L11) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[models/device-info.ts:12](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/device-info.ts#L12) diff --git a/docs/interfaces/index.JellyfinParameters.md b/docs/interfaces/index.JellyfinParameters.md deleted file mode 100644 index 418ef9f12..000000000 --- a/docs/interfaces/index.JellyfinParameters.md +++ /dev/null @@ -1,34 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / JellyfinParameters - -# Interface: JellyfinParameters - -[index](../modules/index.md).JellyfinParameters - -Parameters to create a Jellyfin SDK instance. - -## Table of contents - -### Properties - -- [clientInfo](index.JellyfinParameters.md#clientinfo) -- [deviceInfo](index.JellyfinParameters.md#deviceinfo) - -## Properties - -### clientInfo - -• **clientInfo**: [`ClientInfo`](index.ClientInfo.md) - -#### Defined in - -[jellyfin.ts:15](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L15) - -___ - -### deviceInfo - -• **deviceInfo**: [`DeviceInfo`](index.DeviceInfo.md) - -#### Defined in - -[jellyfin.ts:16](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L16) diff --git a/docs/interfaces/index.RecommendedServerInfo.md b/docs/interfaces/index.RecommendedServerInfo.md deleted file mode 100644 index 3410d0ef1..000000000 --- a/docs/interfaces/index.RecommendedServerInfo.md +++ /dev/null @@ -1,67 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / RecommendedServerInfo - -# Interface: RecommendedServerInfo - -[index](../modules/index.md).RecommendedServerInfo - -Information about a recommended server. - -## Table of contents - -### Properties - -- [address](index.RecommendedServerInfo.md#address) -- [issues](index.RecommendedServerInfo.md#issues) -- [responseTime](index.RecommendedServerInfo.md#responsetime) -- [score](index.RecommendedServerInfo.md#score) -- [systemInfo](index.RecommendedServerInfo.md#systeminfo) - -## Properties - -### address - -• **address**: `string` - -#### Defined in - -[models/recommended-server-info.ts:21](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-info.ts#L21) - -___ - -### issues - -• **issues**: [`RecommendedServerIssue`](../classes/index.RecommendedServerIssue.md)[] - -#### Defined in - -[models/recommended-server-info.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-info.ts#L24) - -___ - -### responseTime - -• **responseTime**: `number` - -#### Defined in - -[models/recommended-server-info.ts:22](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-info.ts#L22) - -___ - -### score - -• **score**: [`RecommendedServerInfoScore`](../enums/index.RecommendedServerInfoScore.md) - -#### Defined in - -[models/recommended-server-info.ts:23](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-info.ts#L23) - -___ - -### systemInfo - -• `Optional` **systemInfo**: [`PublicSystemInfo`](generated_client.PublicSystemInfo.md) - -#### Defined in - -[models/recommended-server-info.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-info.ts#L25) diff --git a/docs/interfaces/index.utils.DeviceProfileGeneratorOptions.md b/docs/interfaces/index.utils.DeviceProfileGeneratorOptions.md deleted file mode 100644 index 02156363d..000000000 --- a/docs/interfaces/index.utils.DeviceProfileGeneratorOptions.md +++ /dev/null @@ -1,29 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / [utils](../modules/index.utils.md) / DeviceProfileGeneratorOptions - -# Interface: DeviceProfileGeneratorOptions - -[index](../modules/index.md).[utils](../modules/index.utils.md).DeviceProfileGeneratorOptions - -Options parameters to build profiles - -**`export`** - -**`interface`** DeviceProfileGeneratorOptions - -## Table of contents - -### Properties - -- [ssaExternal](index.utils.DeviceProfileGeneratorOptions.md#ssaexternal) - -## Properties - -### ssaExternal - -• `Optional` **ssaExternal**: `boolean` - -Deliver SSA subtitles externally instead of requiring a burn in - -#### Defined in - -[utils/browser-profiles.ts:20](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/browser-profiles.ts#L20) diff --git a/docs/modules.md b/docs/modules.md deleted file mode 100644 index e967107d4..000000000 --- a/docs/modules.md +++ /dev/null @@ -1,10 +0,0 @@ -[@thornbill/jellyfin-sdk](README.md) / Modules - -# @thornbill/jellyfin-sdk - -## Table of contents - -### Modules - -- [generated-client](modules/generated_client.md) -- [index](modules/index.md) diff --git a/docs/modules/generated_client.md b/docs/modules/generated_client.md deleted file mode 100644 index 2ee2681d2..000000000 --- a/docs/modules/generated_client.md +++ /dev/null @@ -1,7182 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / generated-client - -# Module: generated-client - -## Table of contents - -### Enumerations - -- [Architecture](../enums/generated_client.Architecture.md) -- [BaseItemKind](../enums/generated_client.BaseItemKind.md) -- [ChannelItemSortField](../enums/generated_client.ChannelItemSortField.md) -- [ChannelMediaContentType](../enums/generated_client.ChannelMediaContentType.md) -- [ChannelMediaType](../enums/generated_client.ChannelMediaType.md) -- [ChannelType](../enums/generated_client.ChannelType.md) -- [CodecType](../enums/generated_client.CodecType.md) -- [CollectionTypeOptions](../enums/generated_client.CollectionTypeOptions.md) -- [DayOfWeek](../enums/generated_client.DayOfWeek.md) -- [DayPattern](../enums/generated_client.DayPattern.md) -- [DeviceProfileType](../enums/generated_client.DeviceProfileType.md) -- [DlnaProfileType](../enums/generated_client.DlnaProfileType.md) -- [DynamicDayOfWeek](../enums/generated_client.DynamicDayOfWeek.md) -- [EmbeddedSubtitleOptions](../enums/generated_client.EmbeddedSubtitleOptions.md) -- [EncodingContext](../enums/generated_client.EncodingContext.md) -- [ExternalIdMediaType](../enums/generated_client.ExternalIdMediaType.md) -- [FFmpegLocation](../enums/generated_client.FFmpegLocation.md) -- [FileSystemEntryType](../enums/generated_client.FileSystemEntryType.md) -- [ForgotPasswordAction](../enums/generated_client.ForgotPasswordAction.md) -- [GeneralCommandType](../enums/generated_client.GeneralCommandType.md) -- [GroupQueueMode](../enums/generated_client.GroupQueueMode.md) -- [GroupRepeatMode](../enums/generated_client.GroupRepeatMode.md) -- [GroupShuffleMode](../enums/generated_client.GroupShuffleMode.md) -- [GroupStateType](../enums/generated_client.GroupStateType.md) -- [GroupUpdateType](../enums/generated_client.GroupUpdateType.md) -- [HardwareEncodingType](../enums/generated_client.HardwareEncodingType.md) -- [HeaderMatchType](../enums/generated_client.HeaderMatchType.md) -- [ImageFormat](../enums/generated_client.ImageFormat.md) -- [ImageOrientation](../enums/generated_client.ImageOrientation.md) -- [ImageSavingConvention](../enums/generated_client.ImageSavingConvention.md) -- [ImageType](../enums/generated_client.ImageType.md) -- [IsoType](../enums/generated_client.IsoType.md) -- [ItemFields](../enums/generated_client.ItemFields.md) -- [ItemFilter](../enums/generated_client.ItemFilter.md) -- [KeepUntil](../enums/generated_client.KeepUntil.md) -- [LiveTvServiceStatus](../enums/generated_client.LiveTvServiceStatus.md) -- [LocationType](../enums/generated_client.LocationType.md) -- [LogLevel](../enums/generated_client.LogLevel.md) -- [MediaProtocol](../enums/generated_client.MediaProtocol.md) -- [MediaSourceType](../enums/generated_client.MediaSourceType.md) -- [MediaStreamType](../enums/generated_client.MediaStreamType.md) -- [MetadataField](../enums/generated_client.MetadataField.md) -- [MetadataRefreshMode](../enums/generated_client.MetadataRefreshMode.md) -- [NotificationLevel](../enums/generated_client.NotificationLevel.md) -- [PlayAccess](../enums/generated_client.PlayAccess.md) -- [PlayCommand](../enums/generated_client.PlayCommand.md) -- [PlayMethod](../enums/generated_client.PlayMethod.md) -- [PlaybackErrorCode](../enums/generated_client.PlaybackErrorCode.md) -- [PlaystateCommand](../enums/generated_client.PlaystateCommand.md) -- [PluginStatus](../enums/generated_client.PluginStatus.md) -- [ProfileConditionType](../enums/generated_client.ProfileConditionType.md) -- [ProfileConditionValue](../enums/generated_client.ProfileConditionValue.md) -- [ProgramAudio](../enums/generated_client.ProgramAudio.md) -- [RatingType](../enums/generated_client.RatingType.md) -- [RecommendationType](../enums/generated_client.RecommendationType.md) -- [RecordingStatus](../enums/generated_client.RecordingStatus.md) -- [RepeatMode](../enums/generated_client.RepeatMode.md) -- [ScrollDirection](../enums/generated_client.ScrollDirection.md) -- [SendCommandType](../enums/generated_client.SendCommandType.md) -- [SendToUserType](../enums/generated_client.SendToUserType.md) -- [SeriesStatus](../enums/generated_client.SeriesStatus.md) -- [SessionMessageType](../enums/generated_client.SessionMessageType.md) -- [SortOrder](../enums/generated_client.SortOrder.md) -- [SubtitleDeliveryMethod](../enums/generated_client.SubtitleDeliveryMethod.md) -- [SubtitlePlaybackMode](../enums/generated_client.SubtitlePlaybackMode.md) -- [SyncPlayUserAccessType](../enums/generated_client.SyncPlayUserAccessType.md) -- [TaskCompletionStatus](../enums/generated_client.TaskCompletionStatus.md) -- [TaskState](../enums/generated_client.TaskState.md) -- [TranscodeSeekInfo](../enums/generated_client.TranscodeSeekInfo.md) -- [TranscodingInfoTranscodeReasonsEnum](../enums/generated_client.TranscodingInfoTranscodeReasonsEnum.md) -- [TransportStreamTimestamp](../enums/generated_client.TransportStreamTimestamp.md) -- [UnratedItem](../enums/generated_client.UnratedItem.md) -- [Video3DFormat](../enums/generated_client.Video3DFormat.md) -- [VideoType](../enums/generated_client.VideoType.md) - -### Classes - -- [ActivityLogApi](../classes/generated_client.ActivityLogApi.md) -- [ApiKeyApi](../classes/generated_client.ApiKeyApi.md) -- [ArtistsApi](../classes/generated_client.ArtistsApi.md) -- [AudioApi](../classes/generated_client.AudioApi.md) -- [BrandingApi](../classes/generated_client.BrandingApi.md) -- [ChannelsApi](../classes/generated_client.ChannelsApi.md) -- [ClientLogApi](../classes/generated_client.ClientLogApi.md) -- [CollectionApi](../classes/generated_client.CollectionApi.md) -- [Configuration](../classes/generated_client.Configuration.md) -- [ConfigurationApi](../classes/generated_client.ConfigurationApi.md) -- [DashboardApi](../classes/generated_client.DashboardApi.md) -- [DevicesApi](../classes/generated_client.DevicesApi.md) -- [DisplayPreferencesApi](../classes/generated_client.DisplayPreferencesApi.md) -- [DlnaApi](../classes/generated_client.DlnaApi.md) -- [DlnaServerApi](../classes/generated_client.DlnaServerApi.md) -- [DynamicHlsApi](../classes/generated_client.DynamicHlsApi.md) -- [EnvironmentApi](../classes/generated_client.EnvironmentApi.md) -- [FilterApi](../classes/generated_client.FilterApi.md) -- [GenresApi](../classes/generated_client.GenresApi.md) -- [HlsSegmentApi](../classes/generated_client.HlsSegmentApi.md) -- [ImageApi](../classes/generated_client.ImageApi.md) -- [ImageByNameApi](../classes/generated_client.ImageByNameApi.md) -- [InstantMixApi](../classes/generated_client.InstantMixApi.md) -- [ItemLookupApi](../classes/generated_client.ItemLookupApi.md) -- [ItemRefreshApi](../classes/generated_client.ItemRefreshApi.md) -- [ItemUpdateApi](../classes/generated_client.ItemUpdateApi.md) -- [ItemsApi](../classes/generated_client.ItemsApi.md) -- [LibraryApi](../classes/generated_client.LibraryApi.md) -- [LibraryStructureApi](../classes/generated_client.LibraryStructureApi.md) -- [LiveTvApi](../classes/generated_client.LiveTvApi.md) -- [LocalizationApi](../classes/generated_client.LocalizationApi.md) -- [MediaInfoApi](../classes/generated_client.MediaInfoApi.md) -- [MoviesApi](../classes/generated_client.MoviesApi.md) -- [MusicGenresApi](../classes/generated_client.MusicGenresApi.md) -- [NotificationsApi](../classes/generated_client.NotificationsApi.md) -- [PackageApi](../classes/generated_client.PackageApi.md) -- [PersonsApi](../classes/generated_client.PersonsApi.md) -- [PlaylistsApi](../classes/generated_client.PlaylistsApi.md) -- [PlaystateApi](../classes/generated_client.PlaystateApi.md) -- [PluginsApi](../classes/generated_client.PluginsApi.md) -- [QuickConnectApi](../classes/generated_client.QuickConnectApi.md) -- [RemoteImageApi](../classes/generated_client.RemoteImageApi.md) -- [ScheduledTasksApi](../classes/generated_client.ScheduledTasksApi.md) -- [SearchApi](../classes/generated_client.SearchApi.md) -- [SessionApi](../classes/generated_client.SessionApi.md) -- [StartupApi](../classes/generated_client.StartupApi.md) -- [StudiosApi](../classes/generated_client.StudiosApi.md) -- [SubtitleApi](../classes/generated_client.SubtitleApi.md) -- [SuggestionsApi](../classes/generated_client.SuggestionsApi.md) -- [SyncPlayApi](../classes/generated_client.SyncPlayApi.md) -- [SystemApi](../classes/generated_client.SystemApi.md) -- [TimeSyncApi](../classes/generated_client.TimeSyncApi.md) -- [TmdbApi](../classes/generated_client.TmdbApi.md) -- [TrailersApi](../classes/generated_client.TrailersApi.md) -- [TvShowsApi](../classes/generated_client.TvShowsApi.md) -- [UniversalAudioApi](../classes/generated_client.UniversalAudioApi.md) -- [UserApi](../classes/generated_client.UserApi.md) -- [UserLibraryApi](../classes/generated_client.UserLibraryApi.md) -- [UserViewsApi](../classes/generated_client.UserViewsApi.md) -- [VideoAttachmentsApi](../classes/generated_client.VideoAttachmentsApi.md) -- [VideosApi](../classes/generated_client.VideosApi.md) -- [YearsApi](../classes/generated_client.YearsApi.md) - -### Interfaces - -- [AccessSchedule](../interfaces/generated_client.AccessSchedule.md) -- [ActivityLogApiGetLogEntriesRequest](../interfaces/generated_client.ActivityLogApiGetLogEntriesRequest.md) -- [ActivityLogEntry](../interfaces/generated_client.ActivityLogEntry.md) -- [ActivityLogEntryQueryResult](../interfaces/generated_client.ActivityLogEntryQueryResult.md) -- [AddVirtualFolderDto](../interfaces/generated_client.AddVirtualFolderDto.md) -- [AdminNotificationDto](../interfaces/generated_client.AdminNotificationDto.md) -- [AlbumInfo](../interfaces/generated_client.AlbumInfo.md) -- [AlbumInfoRemoteSearchQuery](../interfaces/generated_client.AlbumInfoRemoteSearchQuery.md) -- [AllThemeMediaResult](../interfaces/generated_client.AllThemeMediaResult.md) -- [ApiKeyApiCreateKeyRequest](../interfaces/generated_client.ApiKeyApiCreateKeyRequest.md) -- [ApiKeyApiRevokeKeyRequest](../interfaces/generated_client.ApiKeyApiRevokeKeyRequest.md) -- [ArtistInfo](../interfaces/generated_client.ArtistInfo.md) -- [ArtistInfoRemoteSearchQuery](../interfaces/generated_client.ArtistInfoRemoteSearchQuery.md) -- [ArtistsApiGetAlbumArtistsRequest](../interfaces/generated_client.ArtistsApiGetAlbumArtistsRequest.md) -- [ArtistsApiGetArtistByNameRequest](../interfaces/generated_client.ArtistsApiGetArtistByNameRequest.md) -- [ArtistsApiGetArtistsRequest](../interfaces/generated_client.ArtistsApiGetArtistsRequest.md) -- [AudioApiGetAudioStreamByContainerRequest](../interfaces/generated_client.AudioApiGetAudioStreamByContainerRequest.md) -- [AudioApiGetAudioStreamRequest](../interfaces/generated_client.AudioApiGetAudioStreamRequest.md) -- [AudioApiHeadAudioStreamByContainerRequest](../interfaces/generated_client.AudioApiHeadAudioStreamByContainerRequest.md) -- [AudioApiHeadAudioStreamRequest](../interfaces/generated_client.AudioApiHeadAudioStreamRequest.md) -- [AuthenticateUserByName](../interfaces/generated_client.AuthenticateUserByName.md) -- [AuthenticationInfo](../interfaces/generated_client.AuthenticationInfo.md) -- [AuthenticationInfoQueryResult](../interfaces/generated_client.AuthenticationInfoQueryResult.md) -- [AuthenticationResult](../interfaces/generated_client.AuthenticationResult.md) -- [BaseItem](../interfaces/generated_client.BaseItem.md) -- [BaseItemDto](../interfaces/generated_client.BaseItemDto.md) -- [BaseItemDtoImageBlurHashes](../interfaces/generated_client.BaseItemDtoImageBlurHashes.md) -- [BaseItemDtoQueryResult](../interfaces/generated_client.BaseItemDtoQueryResult.md) -- [BaseItemPerson](../interfaces/generated_client.BaseItemPerson.md) -- [BaseItemPersonImageBlurHashes](../interfaces/generated_client.BaseItemPersonImageBlurHashes.md) -- [BookInfo](../interfaces/generated_client.BookInfo.md) -- [BookInfoRemoteSearchQuery](../interfaces/generated_client.BookInfoRemoteSearchQuery.md) -- [BoxSetInfo](../interfaces/generated_client.BoxSetInfo.md) -- [BoxSetInfoRemoteSearchQuery](../interfaces/generated_client.BoxSetInfoRemoteSearchQuery.md) -- [BrandingOptions](../interfaces/generated_client.BrandingOptions.md) -- [BufferRequestDto](../interfaces/generated_client.BufferRequestDto.md) -- [ChannelFeatures](../interfaces/generated_client.ChannelFeatures.md) -- [ChannelMappingOptionsDto](../interfaces/generated_client.ChannelMappingOptionsDto.md) -- [ChannelsApiGetChannelFeaturesRequest](../interfaces/generated_client.ChannelsApiGetChannelFeaturesRequest.md) -- [ChannelsApiGetChannelItemsRequest](../interfaces/generated_client.ChannelsApiGetChannelItemsRequest.md) -- [ChannelsApiGetChannelsRequest](../interfaces/generated_client.ChannelsApiGetChannelsRequest.md) -- [ChannelsApiGetLatestChannelItemsRequest](../interfaces/generated_client.ChannelsApiGetLatestChannelItemsRequest.md) -- [ChapterInfo](../interfaces/generated_client.ChapterInfo.md) -- [ClientCapabilities](../interfaces/generated_client.ClientCapabilities.md) -- [ClientCapabilitiesDto](../interfaces/generated_client.ClientCapabilitiesDto.md) -- [ClientLogApiLogFileRequest](../interfaces/generated_client.ClientLogApiLogFileRequest.md) -- [ClientLogDocumentResponseDto](../interfaces/generated_client.ClientLogDocumentResponseDto.md) -- [CodecProfile](../interfaces/generated_client.CodecProfile.md) -- [CollectionApiAddToCollectionRequest](../interfaces/generated_client.CollectionApiAddToCollectionRequest.md) -- [CollectionApiCreateCollectionRequest](../interfaces/generated_client.CollectionApiCreateCollectionRequest.md) -- [CollectionApiRemoveFromCollectionRequest](../interfaces/generated_client.CollectionApiRemoveFromCollectionRequest.md) -- [CollectionCreationResult](../interfaces/generated_client.CollectionCreationResult.md) -- [ConfigImageTypes](../interfaces/generated_client.ConfigImageTypes.md) -- [ConfigurationApiGetNamedConfigurationRequest](../interfaces/generated_client.ConfigurationApiGetNamedConfigurationRequest.md) -- [ConfigurationApiUpdateConfigurationRequest](../interfaces/generated_client.ConfigurationApiUpdateConfigurationRequest.md) -- [ConfigurationApiUpdateMediaEncoderPathRequest](../interfaces/generated_client.ConfigurationApiUpdateMediaEncoderPathRequest.md) -- [ConfigurationApiUpdateNamedConfigurationRequest](../interfaces/generated_client.ConfigurationApiUpdateNamedConfigurationRequest.md) -- [ConfigurationPageInfo](../interfaces/generated_client.ConfigurationPageInfo.md) -- [ConfigurationParameters](../interfaces/generated_client.ConfigurationParameters.md) -- [ContainerProfile](../interfaces/generated_client.ContainerProfile.md) -- [ControlResponse](../interfaces/generated_client.ControlResponse.md) -- [CountryInfo](../interfaces/generated_client.CountryInfo.md) -- [CreatePlaylistDto](../interfaces/generated_client.CreatePlaylistDto.md) -- [CreateUserByName](../interfaces/generated_client.CreateUserByName.md) -- [CultureDto](../interfaces/generated_client.CultureDto.md) -- [DashboardApiGetConfigurationPagesRequest](../interfaces/generated_client.DashboardApiGetConfigurationPagesRequest.md) -- [DashboardApiGetDashboardConfigurationPageRequest](../interfaces/generated_client.DashboardApiGetDashboardConfigurationPageRequest.md) -- [DefaultDirectoryBrowserInfoDto](../interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md) -- [DeviceIdentification](../interfaces/generated_client.DeviceIdentification.md) -- [DeviceInfo](../interfaces/generated_client.DeviceInfo.md) -- [DeviceInfoQueryResult](../interfaces/generated_client.DeviceInfoQueryResult.md) -- [DeviceOptions](../interfaces/generated_client.DeviceOptions.md) -- [DeviceOptionsDto](../interfaces/generated_client.DeviceOptionsDto.md) -- [DeviceProfile](../interfaces/generated_client.DeviceProfile.md) -- [DeviceProfileInfo](../interfaces/generated_client.DeviceProfileInfo.md) -- [DevicesApiDeleteDeviceRequest](../interfaces/generated_client.DevicesApiDeleteDeviceRequest.md) -- [DevicesApiGetDeviceInfoRequest](../interfaces/generated_client.DevicesApiGetDeviceInfoRequest.md) -- [DevicesApiGetDeviceOptionsRequest](../interfaces/generated_client.DevicesApiGetDeviceOptionsRequest.md) -- [DevicesApiGetDevicesRequest](../interfaces/generated_client.DevicesApiGetDevicesRequest.md) -- [DevicesApiUpdateDeviceOptionsRequest](../interfaces/generated_client.DevicesApiUpdateDeviceOptionsRequest.md) -- [DirectPlayProfile](../interfaces/generated_client.DirectPlayProfile.md) -- [DisplayPreferencesApiGetDisplayPreferencesRequest](../interfaces/generated_client.DisplayPreferencesApiGetDisplayPreferencesRequest.md) -- [DisplayPreferencesApiUpdateDisplayPreferencesRequest](../interfaces/generated_client.DisplayPreferencesApiUpdateDisplayPreferencesRequest.md) -- [DisplayPreferencesDto](../interfaces/generated_client.DisplayPreferencesDto.md) -- [DlnaApiCreateProfileRequest](../interfaces/generated_client.DlnaApiCreateProfileRequest.md) -- [DlnaApiDeleteProfileRequest](../interfaces/generated_client.DlnaApiDeleteProfileRequest.md) -- [DlnaApiGetProfileRequest](../interfaces/generated_client.DlnaApiGetProfileRequest.md) -- [DlnaApiUpdateProfileRequest](../interfaces/generated_client.DlnaApiUpdateProfileRequest.md) -- [DlnaOptions](../interfaces/generated_client.DlnaOptions.md) -- [DlnaServerApiGetConnectionManager2Request](../interfaces/generated_client.DlnaServerApiGetConnectionManager2Request.md) -- [DlnaServerApiGetConnectionManager3Request](../interfaces/generated_client.DlnaServerApiGetConnectionManager3Request.md) -- [DlnaServerApiGetConnectionManagerRequest](../interfaces/generated_client.DlnaServerApiGetConnectionManagerRequest.md) -- [DlnaServerApiGetContentDirectory2Request](../interfaces/generated_client.DlnaServerApiGetContentDirectory2Request.md) -- [DlnaServerApiGetContentDirectory3Request](../interfaces/generated_client.DlnaServerApiGetContentDirectory3Request.md) -- [DlnaServerApiGetContentDirectoryRequest](../interfaces/generated_client.DlnaServerApiGetContentDirectoryRequest.md) -- [DlnaServerApiGetDescriptionXml2Request](../interfaces/generated_client.DlnaServerApiGetDescriptionXml2Request.md) -- [DlnaServerApiGetDescriptionXmlRequest](../interfaces/generated_client.DlnaServerApiGetDescriptionXmlRequest.md) -- [DlnaServerApiGetIconIdRequest](../interfaces/generated_client.DlnaServerApiGetIconIdRequest.md) -- [DlnaServerApiGetIconRequest](../interfaces/generated_client.DlnaServerApiGetIconRequest.md) -- [DlnaServerApiGetMediaReceiverRegistrar2Request](../interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar2Request.md) -- [DlnaServerApiGetMediaReceiverRegistrar3Request](../interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar3Request.md) -- [DlnaServerApiGetMediaReceiverRegistrarRequest](../interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrarRequest.md) -- [DlnaServerApiProcessConnectionManagerControlRequestRequest](../interfaces/generated_client.DlnaServerApiProcessConnectionManagerControlRequestRequest.md) -- [DlnaServerApiProcessContentDirectoryControlRequestRequest](../interfaces/generated_client.DlnaServerApiProcessContentDirectoryControlRequestRequest.md) -- [DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest](../interfaces/generated_client.DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest.md) -- [DynamicHlsApiGetHlsAudioSegmentRequest](../interfaces/generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md) -- [DynamicHlsApiGetHlsVideoSegmentRequest](../interfaces/generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md) -- [DynamicHlsApiGetLiveHlsStreamRequest](../interfaces/generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md) -- [DynamicHlsApiGetMasterHlsAudioPlaylistRequest](../interfaces/generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md) -- [DynamicHlsApiGetMasterHlsVideoPlaylistRequest](../interfaces/generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md) -- [DynamicHlsApiGetVariantHlsAudioPlaylistRequest](../interfaces/generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md) -- [DynamicHlsApiGetVariantHlsVideoPlaylistRequest](../interfaces/generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md) -- [DynamicHlsApiHeadMasterHlsAudioPlaylistRequest](../interfaces/generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md) -- [DynamicHlsApiHeadMasterHlsVideoPlaylistRequest](../interfaces/generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md) -- [EncodingOptions](../interfaces/generated_client.EncodingOptions.md) -- [EndPointInfo](../interfaces/generated_client.EndPointInfo.md) -- [EnvironmentApiGetDirectoryContentsRequest](../interfaces/generated_client.EnvironmentApiGetDirectoryContentsRequest.md) -- [EnvironmentApiGetParentPathRequest](../interfaces/generated_client.EnvironmentApiGetParentPathRequest.md) -- [EnvironmentApiValidatePathRequest](../interfaces/generated_client.EnvironmentApiValidatePathRequest.md) -- [ExternalIdInfo](../interfaces/generated_client.ExternalIdInfo.md) -- [ExternalUrl](../interfaces/generated_client.ExternalUrl.md) -- [FileSystemEntryInfo](../interfaces/generated_client.FileSystemEntryInfo.md) -- [FilterApiGetQueryFiltersLegacyRequest](../interfaces/generated_client.FilterApiGetQueryFiltersLegacyRequest.md) -- [FilterApiGetQueryFiltersRequest](../interfaces/generated_client.FilterApiGetQueryFiltersRequest.md) -- [FontFile](../interfaces/generated_client.FontFile.md) -- [ForgotPasswordDto](../interfaces/generated_client.ForgotPasswordDto.md) -- [ForgotPasswordPinDto](../interfaces/generated_client.ForgotPasswordPinDto.md) -- [ForgotPasswordResult](../interfaces/generated_client.ForgotPasswordResult.md) -- [GeneralCommand](../interfaces/generated_client.GeneralCommand.md) -- [GenresApiGetGenreRequest](../interfaces/generated_client.GenresApiGetGenreRequest.md) -- [GenresApiGetGenresRequest](../interfaces/generated_client.GenresApiGetGenresRequest.md) -- [GetProgramsDto](../interfaces/generated_client.GetProgramsDto.md) -- [GroupInfoDto](../interfaces/generated_client.GroupInfoDto.md) -- [GuideInfo](../interfaces/generated_client.GuideInfo.md) -- [HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest](../interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest.md) -- [HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request](../interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request.md) -- [HlsSegmentApiGetHlsPlaylistLegacyRequest](../interfaces/generated_client.HlsSegmentApiGetHlsPlaylistLegacyRequest.md) -- [HlsSegmentApiGetHlsVideoSegmentLegacyRequest](../interfaces/generated_client.HlsSegmentApiGetHlsVideoSegmentLegacyRequest.md) -- [HlsSegmentApiStopEncodingProcessRequest](../interfaces/generated_client.HlsSegmentApiStopEncodingProcessRequest.md) -- [HttpHeaderInfo](../interfaces/generated_client.HttpHeaderInfo.md) -- [IPlugin](../interfaces/generated_client.IPlugin.md) -- [IgnoreWaitRequestDto](../interfaces/generated_client.IgnoreWaitRequestDto.md) -- [ImageApiDeleteItemImageByIndexRequest](../interfaces/generated_client.ImageApiDeleteItemImageByIndexRequest.md) -- [ImageApiDeleteItemImageRequest](../interfaces/generated_client.ImageApiDeleteItemImageRequest.md) -- [ImageApiDeleteUserImageByIndexRequest](../interfaces/generated_client.ImageApiDeleteUserImageByIndexRequest.md) -- [ImageApiDeleteUserImageRequest](../interfaces/generated_client.ImageApiDeleteUserImageRequest.md) -- [ImageApiGetArtistImageRequest](../interfaces/generated_client.ImageApiGetArtistImageRequest.md) -- [ImageApiGetGenreImageByIndexRequest](../interfaces/generated_client.ImageApiGetGenreImageByIndexRequest.md) -- [ImageApiGetGenreImageRequest](../interfaces/generated_client.ImageApiGetGenreImageRequest.md) -- [ImageApiGetItemImage2Request](../interfaces/generated_client.ImageApiGetItemImage2Request.md) -- [ImageApiGetItemImageByIndexRequest](../interfaces/generated_client.ImageApiGetItemImageByIndexRequest.md) -- [ImageApiGetItemImageInfosRequest](../interfaces/generated_client.ImageApiGetItemImageInfosRequest.md) -- [ImageApiGetItemImageRequest](../interfaces/generated_client.ImageApiGetItemImageRequest.md) -- [ImageApiGetMusicGenreImageByIndexRequest](../interfaces/generated_client.ImageApiGetMusicGenreImageByIndexRequest.md) -- [ImageApiGetMusicGenreImageRequest](../interfaces/generated_client.ImageApiGetMusicGenreImageRequest.md) -- [ImageApiGetPersonImageByIndexRequest](../interfaces/generated_client.ImageApiGetPersonImageByIndexRequest.md) -- [ImageApiGetPersonImageRequest](../interfaces/generated_client.ImageApiGetPersonImageRequest.md) -- [ImageApiGetSplashscreenRequest](../interfaces/generated_client.ImageApiGetSplashscreenRequest.md) -- [ImageApiGetStudioImageByIndexRequest](../interfaces/generated_client.ImageApiGetStudioImageByIndexRequest.md) -- [ImageApiGetStudioImageRequest](../interfaces/generated_client.ImageApiGetStudioImageRequest.md) -- [ImageApiGetUserImageByIndexRequest](../interfaces/generated_client.ImageApiGetUserImageByIndexRequest.md) -- [ImageApiGetUserImageRequest](../interfaces/generated_client.ImageApiGetUserImageRequest.md) -- [ImageApiHeadArtistImageRequest](../interfaces/generated_client.ImageApiHeadArtistImageRequest.md) -- [ImageApiHeadGenreImageByIndexRequest](../interfaces/generated_client.ImageApiHeadGenreImageByIndexRequest.md) -- [ImageApiHeadGenreImageRequest](../interfaces/generated_client.ImageApiHeadGenreImageRequest.md) -- [ImageApiHeadItemImage2Request](../interfaces/generated_client.ImageApiHeadItemImage2Request.md) -- [ImageApiHeadItemImageByIndexRequest](../interfaces/generated_client.ImageApiHeadItemImageByIndexRequest.md) -- [ImageApiHeadItemImageRequest](../interfaces/generated_client.ImageApiHeadItemImageRequest.md) -- [ImageApiHeadMusicGenreImageByIndexRequest](../interfaces/generated_client.ImageApiHeadMusicGenreImageByIndexRequest.md) -- [ImageApiHeadMusicGenreImageRequest](../interfaces/generated_client.ImageApiHeadMusicGenreImageRequest.md) -- [ImageApiHeadPersonImageByIndexRequest](../interfaces/generated_client.ImageApiHeadPersonImageByIndexRequest.md) -- [ImageApiHeadPersonImageRequest](../interfaces/generated_client.ImageApiHeadPersonImageRequest.md) -- [ImageApiHeadStudioImageByIndexRequest](../interfaces/generated_client.ImageApiHeadStudioImageByIndexRequest.md) -- [ImageApiHeadStudioImageRequest](../interfaces/generated_client.ImageApiHeadStudioImageRequest.md) -- [ImageApiHeadUserImageByIndexRequest](../interfaces/generated_client.ImageApiHeadUserImageByIndexRequest.md) -- [ImageApiHeadUserImageRequest](../interfaces/generated_client.ImageApiHeadUserImageRequest.md) -- [ImageApiPostUserImageByIndexRequest](../interfaces/generated_client.ImageApiPostUserImageByIndexRequest.md) -- [ImageApiPostUserImageRequest](../interfaces/generated_client.ImageApiPostUserImageRequest.md) -- [ImageApiSetItemImageByIndexRequest](../interfaces/generated_client.ImageApiSetItemImageByIndexRequest.md) -- [ImageApiSetItemImageRequest](../interfaces/generated_client.ImageApiSetItemImageRequest.md) -- [ImageApiUpdateItemImageIndexRequest](../interfaces/generated_client.ImageApiUpdateItemImageIndexRequest.md) -- [ImageApiUploadCustomSplashscreenRequest](../interfaces/generated_client.ImageApiUploadCustomSplashscreenRequest.md) -- [ImageByNameApiGetGeneralImageRequest](../interfaces/generated_client.ImageByNameApiGetGeneralImageRequest.md) -- [ImageByNameApiGetMediaInfoImageRequest](../interfaces/generated_client.ImageByNameApiGetMediaInfoImageRequest.md) -- [ImageByNameApiGetRatingImageRequest](../interfaces/generated_client.ImageByNameApiGetRatingImageRequest.md) -- [ImageByNameInfo](../interfaces/generated_client.ImageByNameInfo.md) -- [ImageInfo](../interfaces/generated_client.ImageInfo.md) -- [ImageOption](../interfaces/generated_client.ImageOption.md) -- [ImageProviderInfo](../interfaces/generated_client.ImageProviderInfo.md) -- [InstallationInfo](../interfaces/generated_client.InstallationInfo.md) -- [InstantMixApiGetInstantMixFromAlbumRequest](../interfaces/generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md) -- [InstantMixApiGetInstantMixFromArtists2Request](../interfaces/generated_client.InstantMixApiGetInstantMixFromArtists2Request.md) -- [InstantMixApiGetInstantMixFromArtistsRequest](../interfaces/generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md) -- [InstantMixApiGetInstantMixFromItemRequest](../interfaces/generated_client.InstantMixApiGetInstantMixFromItemRequest.md) -- [InstantMixApiGetInstantMixFromMusicGenreByIdRequest](../interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md) -- [InstantMixApiGetInstantMixFromMusicGenreByNameRequest](../interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md) -- [InstantMixApiGetInstantMixFromPlaylistRequest](../interfaces/generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md) -- [InstantMixApiGetInstantMixFromSongRequest](../interfaces/generated_client.InstantMixApiGetInstantMixFromSongRequest.md) -- [ItemCounts](../interfaces/generated_client.ItemCounts.md) -- [ItemLookupApiApplySearchCriteriaRequest](../interfaces/generated_client.ItemLookupApiApplySearchCriteriaRequest.md) -- [ItemLookupApiGetBookRemoteSearchResultsRequest](../interfaces/generated_client.ItemLookupApiGetBookRemoteSearchResultsRequest.md) -- [ItemLookupApiGetBoxSetRemoteSearchResultsRequest](../interfaces/generated_client.ItemLookupApiGetBoxSetRemoteSearchResultsRequest.md) -- [ItemLookupApiGetExternalIdInfosRequest](../interfaces/generated_client.ItemLookupApiGetExternalIdInfosRequest.md) -- [ItemLookupApiGetMovieRemoteSearchResultsRequest](../interfaces/generated_client.ItemLookupApiGetMovieRemoteSearchResultsRequest.md) -- [ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest](../interfaces/generated_client.ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest.md) -- [ItemLookupApiGetMusicArtistRemoteSearchResultsRequest](../interfaces/generated_client.ItemLookupApiGetMusicArtistRemoteSearchResultsRequest.md) -- [ItemLookupApiGetMusicVideoRemoteSearchResultsRequest](../interfaces/generated_client.ItemLookupApiGetMusicVideoRemoteSearchResultsRequest.md) -- [ItemLookupApiGetPersonRemoteSearchResultsRequest](../interfaces/generated_client.ItemLookupApiGetPersonRemoteSearchResultsRequest.md) -- [ItemLookupApiGetSeriesRemoteSearchResultsRequest](../interfaces/generated_client.ItemLookupApiGetSeriesRemoteSearchResultsRequest.md) -- [ItemLookupApiGetTrailerRemoteSearchResultsRequest](../interfaces/generated_client.ItemLookupApiGetTrailerRemoteSearchResultsRequest.md) -- [ItemRefreshApiRefreshItemRequest](../interfaces/generated_client.ItemRefreshApiRefreshItemRequest.md) -- [ItemUpdateApiGetMetadataEditorInfoRequest](../interfaces/generated_client.ItemUpdateApiGetMetadataEditorInfoRequest.md) -- [ItemUpdateApiUpdateItemContentTypeRequest](../interfaces/generated_client.ItemUpdateApiUpdateItemContentTypeRequest.md) -- [ItemUpdateApiUpdateItemRequest](../interfaces/generated_client.ItemUpdateApiUpdateItemRequest.md) -- [ItemsApiGetItemsByUserIdRequest](../interfaces/generated_client.ItemsApiGetItemsByUserIdRequest.md) -- [ItemsApiGetItemsRequest](../interfaces/generated_client.ItemsApiGetItemsRequest.md) -- [ItemsApiGetResumeItemsRequest](../interfaces/generated_client.ItemsApiGetResumeItemsRequest.md) -- [JoinGroupRequestDto](../interfaces/generated_client.JoinGroupRequestDto.md) -- [LibraryApiDeleteItemRequest](../interfaces/generated_client.LibraryApiDeleteItemRequest.md) -- [LibraryApiDeleteItemsRequest](../interfaces/generated_client.LibraryApiDeleteItemsRequest.md) -- [LibraryApiGetAncestorsRequest](../interfaces/generated_client.LibraryApiGetAncestorsRequest.md) -- [LibraryApiGetCriticReviewsRequest](../interfaces/generated_client.LibraryApiGetCriticReviewsRequest.md) -- [LibraryApiGetDownloadRequest](../interfaces/generated_client.LibraryApiGetDownloadRequest.md) -- [LibraryApiGetFileRequest](../interfaces/generated_client.LibraryApiGetFileRequest.md) -- [LibraryApiGetItemCountsRequest](../interfaces/generated_client.LibraryApiGetItemCountsRequest.md) -- [LibraryApiGetLibraryOptionsInfoRequest](../interfaces/generated_client.LibraryApiGetLibraryOptionsInfoRequest.md) -- [LibraryApiGetMediaFoldersRequest](../interfaces/generated_client.LibraryApiGetMediaFoldersRequest.md) -- [LibraryApiGetSimilarAlbumsRequest](../interfaces/generated_client.LibraryApiGetSimilarAlbumsRequest.md) -- [LibraryApiGetSimilarArtistsRequest](../interfaces/generated_client.LibraryApiGetSimilarArtistsRequest.md) -- [LibraryApiGetSimilarItemsRequest](../interfaces/generated_client.LibraryApiGetSimilarItemsRequest.md) -- [LibraryApiGetSimilarMoviesRequest](../interfaces/generated_client.LibraryApiGetSimilarMoviesRequest.md) -- [LibraryApiGetSimilarShowsRequest](../interfaces/generated_client.LibraryApiGetSimilarShowsRequest.md) -- [LibraryApiGetSimilarTrailersRequest](../interfaces/generated_client.LibraryApiGetSimilarTrailersRequest.md) -- [LibraryApiGetThemeMediaRequest](../interfaces/generated_client.LibraryApiGetThemeMediaRequest.md) -- [LibraryApiGetThemeSongsRequest](../interfaces/generated_client.LibraryApiGetThemeSongsRequest.md) -- [LibraryApiGetThemeVideosRequest](../interfaces/generated_client.LibraryApiGetThemeVideosRequest.md) -- [LibraryApiPostAddedMoviesRequest](../interfaces/generated_client.LibraryApiPostAddedMoviesRequest.md) -- [LibraryApiPostAddedSeriesRequest](../interfaces/generated_client.LibraryApiPostAddedSeriesRequest.md) -- [LibraryApiPostUpdatedMediaRequest](../interfaces/generated_client.LibraryApiPostUpdatedMediaRequest.md) -- [LibraryApiPostUpdatedMoviesRequest](../interfaces/generated_client.LibraryApiPostUpdatedMoviesRequest.md) -- [LibraryApiPostUpdatedSeriesRequest](../interfaces/generated_client.LibraryApiPostUpdatedSeriesRequest.md) -- [LibraryOptionInfoDto](../interfaces/generated_client.LibraryOptionInfoDto.md) -- [LibraryOptions](../interfaces/generated_client.LibraryOptions.md) -- [LibraryOptionsResultDto](../interfaces/generated_client.LibraryOptionsResultDto.md) -- [LibraryStructureApiAddMediaPathRequest](../interfaces/generated_client.LibraryStructureApiAddMediaPathRequest.md) -- [LibraryStructureApiAddVirtualFolderRequest](../interfaces/generated_client.LibraryStructureApiAddVirtualFolderRequest.md) -- [LibraryStructureApiRemoveMediaPathRequest](../interfaces/generated_client.LibraryStructureApiRemoveMediaPathRequest.md) -- [LibraryStructureApiRemoveVirtualFolderRequest](../interfaces/generated_client.LibraryStructureApiRemoveVirtualFolderRequest.md) -- [LibraryStructureApiRenameVirtualFolderRequest](../interfaces/generated_client.LibraryStructureApiRenameVirtualFolderRequest.md) -- [LibraryStructureApiUpdateLibraryOptionsRequest](../interfaces/generated_client.LibraryStructureApiUpdateLibraryOptionsRequest.md) -- [LibraryStructureApiUpdateMediaPathRequest](../interfaces/generated_client.LibraryStructureApiUpdateMediaPathRequest.md) -- [LibraryTypeOptionsDto](../interfaces/generated_client.LibraryTypeOptionsDto.md) -- [LibraryUpdateInfo](../interfaces/generated_client.LibraryUpdateInfo.md) -- [ListingsProviderInfo](../interfaces/generated_client.ListingsProviderInfo.md) -- [LiveStreamResponse](../interfaces/generated_client.LiveStreamResponse.md) -- [LiveTvApiAddListingProviderRequest](../interfaces/generated_client.LiveTvApiAddListingProviderRequest.md) -- [LiveTvApiAddTunerHostRequest](../interfaces/generated_client.LiveTvApiAddTunerHostRequest.md) -- [LiveTvApiCancelSeriesTimerRequest](../interfaces/generated_client.LiveTvApiCancelSeriesTimerRequest.md) -- [LiveTvApiCancelTimerRequest](../interfaces/generated_client.LiveTvApiCancelTimerRequest.md) -- [LiveTvApiCreateSeriesTimerRequest](../interfaces/generated_client.LiveTvApiCreateSeriesTimerRequest.md) -- [LiveTvApiCreateTimerRequest](../interfaces/generated_client.LiveTvApiCreateTimerRequest.md) -- [LiveTvApiDeleteListingProviderRequest](../interfaces/generated_client.LiveTvApiDeleteListingProviderRequest.md) -- [LiveTvApiDeleteRecordingRequest](../interfaces/generated_client.LiveTvApiDeleteRecordingRequest.md) -- [LiveTvApiDeleteTunerHostRequest](../interfaces/generated_client.LiveTvApiDeleteTunerHostRequest.md) -- [LiveTvApiDiscoverTunersRequest](../interfaces/generated_client.LiveTvApiDiscoverTunersRequest.md) -- [LiveTvApiDiscvoverTunersRequest](../interfaces/generated_client.LiveTvApiDiscvoverTunersRequest.md) -- [LiveTvApiGetChannelMappingOptionsRequest](../interfaces/generated_client.LiveTvApiGetChannelMappingOptionsRequest.md) -- [LiveTvApiGetChannelRequest](../interfaces/generated_client.LiveTvApiGetChannelRequest.md) -- [LiveTvApiGetDefaultTimerRequest](../interfaces/generated_client.LiveTvApiGetDefaultTimerRequest.md) -- [LiveTvApiGetLineupsRequest](../interfaces/generated_client.LiveTvApiGetLineupsRequest.md) -- [LiveTvApiGetLiveRecordingFileRequest](../interfaces/generated_client.LiveTvApiGetLiveRecordingFileRequest.md) -- [LiveTvApiGetLiveStreamFileRequest](../interfaces/generated_client.LiveTvApiGetLiveStreamFileRequest.md) -- [LiveTvApiGetLiveTvChannelsRequest](../interfaces/generated_client.LiveTvApiGetLiveTvChannelsRequest.md) -- [LiveTvApiGetLiveTvProgramsRequest](../interfaces/generated_client.LiveTvApiGetLiveTvProgramsRequest.md) -- [LiveTvApiGetProgramRequest](../interfaces/generated_client.LiveTvApiGetProgramRequest.md) -- [LiveTvApiGetProgramsRequest](../interfaces/generated_client.LiveTvApiGetProgramsRequest.md) -- [LiveTvApiGetRecommendedProgramsRequest](../interfaces/generated_client.LiveTvApiGetRecommendedProgramsRequest.md) -- [LiveTvApiGetRecordingFoldersRequest](../interfaces/generated_client.LiveTvApiGetRecordingFoldersRequest.md) -- [LiveTvApiGetRecordingGroupRequest](../interfaces/generated_client.LiveTvApiGetRecordingGroupRequest.md) -- [LiveTvApiGetRecordingGroupsRequest](../interfaces/generated_client.LiveTvApiGetRecordingGroupsRequest.md) -- [LiveTvApiGetRecordingRequest](../interfaces/generated_client.LiveTvApiGetRecordingRequest.md) -- [LiveTvApiGetRecordingsRequest](../interfaces/generated_client.LiveTvApiGetRecordingsRequest.md) -- [LiveTvApiGetRecordingsSeriesRequest](../interfaces/generated_client.LiveTvApiGetRecordingsSeriesRequest.md) -- [LiveTvApiGetSeriesTimerRequest](../interfaces/generated_client.LiveTvApiGetSeriesTimerRequest.md) -- [LiveTvApiGetSeriesTimersRequest](../interfaces/generated_client.LiveTvApiGetSeriesTimersRequest.md) -- [LiveTvApiGetTimerRequest](../interfaces/generated_client.LiveTvApiGetTimerRequest.md) -- [LiveTvApiGetTimersRequest](../interfaces/generated_client.LiveTvApiGetTimersRequest.md) -- [LiveTvApiResetTunerRequest](../interfaces/generated_client.LiveTvApiResetTunerRequest.md) -- [LiveTvApiSetChannelMappingRequest](../interfaces/generated_client.LiveTvApiSetChannelMappingRequest.md) -- [LiveTvApiUpdateSeriesTimerRequest](../interfaces/generated_client.LiveTvApiUpdateSeriesTimerRequest.md) -- [LiveTvApiUpdateTimerRequest](../interfaces/generated_client.LiveTvApiUpdateTimerRequest.md) -- [LiveTvInfo](../interfaces/generated_client.LiveTvInfo.md) -- [LiveTvOptions](../interfaces/generated_client.LiveTvOptions.md) -- [LiveTvServiceInfo](../interfaces/generated_client.LiveTvServiceInfo.md) -- [LocalizationOption](../interfaces/generated_client.LocalizationOption.md) -- [LogFile](../interfaces/generated_client.LogFile.md) -- [MediaAttachment](../interfaces/generated_client.MediaAttachment.md) -- [MediaEncoderPathDto](../interfaces/generated_client.MediaEncoderPathDto.md) -- [MediaInfoApiCloseLiveStreamRequest](../interfaces/generated_client.MediaInfoApiCloseLiveStreamRequest.md) -- [MediaInfoApiGetBitrateTestBytesRequest](../interfaces/generated_client.MediaInfoApiGetBitrateTestBytesRequest.md) -- [MediaInfoApiGetPlaybackInfoRequest](../interfaces/generated_client.MediaInfoApiGetPlaybackInfoRequest.md) -- [MediaInfoApiGetPostedPlaybackInfoRequest](../interfaces/generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md) -- [MediaInfoApiOpenLiveStreamRequest](../interfaces/generated_client.MediaInfoApiOpenLiveStreamRequest.md) -- [MediaPathDto](../interfaces/generated_client.MediaPathDto.md) -- [MediaPathInfo](../interfaces/generated_client.MediaPathInfo.md) -- [MediaSourceInfo](../interfaces/generated_client.MediaSourceInfo.md) -- [MediaStream](../interfaces/generated_client.MediaStream.md) -- [MediaUpdateInfoDto](../interfaces/generated_client.MediaUpdateInfoDto.md) -- [MediaUpdateInfoPathDto](../interfaces/generated_client.MediaUpdateInfoPathDto.md) -- [MediaUrl](../interfaces/generated_client.MediaUrl.md) -- [MessageCommand](../interfaces/generated_client.MessageCommand.md) -- [MetadataConfiguration](../interfaces/generated_client.MetadataConfiguration.md) -- [MetadataEditorInfo](../interfaces/generated_client.MetadataEditorInfo.md) -- [MetadataOptions](../interfaces/generated_client.MetadataOptions.md) -- [MovePlaylistItemRequestDto](../interfaces/generated_client.MovePlaylistItemRequestDto.md) -- [MovieInfo](../interfaces/generated_client.MovieInfo.md) -- [MovieInfoRemoteSearchQuery](../interfaces/generated_client.MovieInfoRemoteSearchQuery.md) -- [MoviesApiGetMovieRecommendationsRequest](../interfaces/generated_client.MoviesApiGetMovieRecommendationsRequest.md) -- [MusicGenresApiGetMusicGenreRequest](../interfaces/generated_client.MusicGenresApiGetMusicGenreRequest.md) -- [MusicGenresApiGetMusicGenresRequest](../interfaces/generated_client.MusicGenresApiGetMusicGenresRequest.md) -- [MusicVideoInfo](../interfaces/generated_client.MusicVideoInfo.md) -- [MusicVideoInfoRemoteSearchQuery](../interfaces/generated_client.MusicVideoInfoRemoteSearchQuery.md) -- [NameGuidPair](../interfaces/generated_client.NameGuidPair.md) -- [NameIdPair](../interfaces/generated_client.NameIdPair.md) -- [NameValuePair](../interfaces/generated_client.NameValuePair.md) -- [NetworkConfiguration](../interfaces/generated_client.NetworkConfiguration.md) -- [NewGroupRequestDto](../interfaces/generated_client.NewGroupRequestDto.md) -- [NextItemRequestDto](../interfaces/generated_client.NextItemRequestDto.md) -- [NotificationDto](../interfaces/generated_client.NotificationDto.md) -- [NotificationOption](../interfaces/generated_client.NotificationOption.md) -- [NotificationOptions](../interfaces/generated_client.NotificationOptions.md) -- [NotificationResultDto](../interfaces/generated_client.NotificationResultDto.md) -- [NotificationTypeInfo](../interfaces/generated_client.NotificationTypeInfo.md) -- [NotificationsApiCreateAdminNotificationRequest](../interfaces/generated_client.NotificationsApiCreateAdminNotificationRequest.md) -- [NotificationsApiGetNotificationsRequest](../interfaces/generated_client.NotificationsApiGetNotificationsRequest.md) -- [NotificationsApiGetNotificationsSummaryRequest](../interfaces/generated_client.NotificationsApiGetNotificationsSummaryRequest.md) -- [NotificationsApiSetReadRequest](../interfaces/generated_client.NotificationsApiSetReadRequest.md) -- [NotificationsApiSetUnreadRequest](../interfaces/generated_client.NotificationsApiSetUnreadRequest.md) -- [NotificationsSummaryDto](../interfaces/generated_client.NotificationsSummaryDto.md) -- [ObjectGroupUpdate](../interfaces/generated_client.ObjectGroupUpdate.md) -- [OpenLiveStreamDto](../interfaces/generated_client.OpenLiveStreamDto.md) -- [PackageApiCancelPackageInstallationRequest](../interfaces/generated_client.PackageApiCancelPackageInstallationRequest.md) -- [PackageApiGetPackageInfoRequest](../interfaces/generated_client.PackageApiGetPackageInfoRequest.md) -- [PackageApiInstallPackageRequest](../interfaces/generated_client.PackageApiInstallPackageRequest.md) -- [PackageApiSetRepositoriesRequest](../interfaces/generated_client.PackageApiSetRepositoriesRequest.md) -- [PackageInfo](../interfaces/generated_client.PackageInfo.md) -- [ParentalRating](../interfaces/generated_client.ParentalRating.md) -- [PathSubstitution](../interfaces/generated_client.PathSubstitution.md) -- [PersonLookupInfo](../interfaces/generated_client.PersonLookupInfo.md) -- [PersonLookupInfoRemoteSearchQuery](../interfaces/generated_client.PersonLookupInfoRemoteSearchQuery.md) -- [PersonsApiGetPersonRequest](../interfaces/generated_client.PersonsApiGetPersonRequest.md) -- [PersonsApiGetPersonsRequest](../interfaces/generated_client.PersonsApiGetPersonsRequest.md) -- [PinRedeemResult](../interfaces/generated_client.PinRedeemResult.md) -- [PingRequestDto](../interfaces/generated_client.PingRequestDto.md) -- [PlayRequest](../interfaces/generated_client.PlayRequest.md) -- [PlayRequestDto](../interfaces/generated_client.PlayRequestDto.md) -- [PlaybackInfoDto](../interfaces/generated_client.PlaybackInfoDto.md) -- [PlaybackInfoResponse](../interfaces/generated_client.PlaybackInfoResponse.md) -- [PlaybackProgressInfo](../interfaces/generated_client.PlaybackProgressInfo.md) -- [PlaybackStartInfo](../interfaces/generated_client.PlaybackStartInfo.md) -- [PlaybackStopInfo](../interfaces/generated_client.PlaybackStopInfo.md) -- [PlayerStateInfo](../interfaces/generated_client.PlayerStateInfo.md) -- [PlaylistCreationResult](../interfaces/generated_client.PlaylistCreationResult.md) -- [PlaylistsApiAddToPlaylistRequest](../interfaces/generated_client.PlaylistsApiAddToPlaylistRequest.md) -- [PlaylistsApiCreatePlaylistRequest](../interfaces/generated_client.PlaylistsApiCreatePlaylistRequest.md) -- [PlaylistsApiGetPlaylistItemsRequest](../interfaces/generated_client.PlaylistsApiGetPlaylistItemsRequest.md) -- [PlaylistsApiMoveItemRequest](../interfaces/generated_client.PlaylistsApiMoveItemRequest.md) -- [PlaylistsApiRemoveFromPlaylistRequest](../interfaces/generated_client.PlaylistsApiRemoveFromPlaylistRequest.md) -- [PlaystateApiMarkPlayedItemRequest](../interfaces/generated_client.PlaystateApiMarkPlayedItemRequest.md) -- [PlaystateApiMarkUnplayedItemRequest](../interfaces/generated_client.PlaystateApiMarkUnplayedItemRequest.md) -- [PlaystateApiOnPlaybackProgressRequest](../interfaces/generated_client.PlaystateApiOnPlaybackProgressRequest.md) -- [PlaystateApiOnPlaybackStartRequest](../interfaces/generated_client.PlaystateApiOnPlaybackStartRequest.md) -- [PlaystateApiOnPlaybackStoppedRequest](../interfaces/generated_client.PlaystateApiOnPlaybackStoppedRequest.md) -- [PlaystateApiPingPlaybackSessionRequest](../interfaces/generated_client.PlaystateApiPingPlaybackSessionRequest.md) -- [PlaystateApiReportPlaybackProgressRequest](../interfaces/generated_client.PlaystateApiReportPlaybackProgressRequest.md) -- [PlaystateApiReportPlaybackStartRequest](../interfaces/generated_client.PlaystateApiReportPlaybackStartRequest.md) -- [PlaystateApiReportPlaybackStoppedRequest](../interfaces/generated_client.PlaystateApiReportPlaybackStoppedRequest.md) -- [PlaystateRequest](../interfaces/generated_client.PlaystateRequest.md) -- [PluginInfo](../interfaces/generated_client.PluginInfo.md) -- [PluginsApiDisablePluginRequest](../interfaces/generated_client.PluginsApiDisablePluginRequest.md) -- [PluginsApiEnablePluginRequest](../interfaces/generated_client.PluginsApiEnablePluginRequest.md) -- [PluginsApiGetPluginConfigurationRequest](../interfaces/generated_client.PluginsApiGetPluginConfigurationRequest.md) -- [PluginsApiGetPluginImageRequest](../interfaces/generated_client.PluginsApiGetPluginImageRequest.md) -- [PluginsApiGetPluginManifestRequest](../interfaces/generated_client.PluginsApiGetPluginManifestRequest.md) -- [PluginsApiUninstallPluginByVersionRequest](../interfaces/generated_client.PluginsApiUninstallPluginByVersionRequest.md) -- [PluginsApiUninstallPluginRequest](../interfaces/generated_client.PluginsApiUninstallPluginRequest.md) -- [PluginsApiUpdatePluginConfigurationRequest](../interfaces/generated_client.PluginsApiUpdatePluginConfigurationRequest.md) -- [PreviousItemRequestDto](../interfaces/generated_client.PreviousItemRequestDto.md) -- [ProblemDetails](../interfaces/generated_client.ProblemDetails.md) -- [ProfileCondition](../interfaces/generated_client.ProfileCondition.md) -- [PublicSystemInfo](../interfaces/generated_client.PublicSystemInfo.md) -- [QueryFilters](../interfaces/generated_client.QueryFilters.md) -- [QueryFiltersLegacy](../interfaces/generated_client.QueryFiltersLegacy.md) -- [QueueItem](../interfaces/generated_client.QueueItem.md) -- [QueueRequestDto](../interfaces/generated_client.QueueRequestDto.md) -- [QuickConnectApiAuthorizeRequest](../interfaces/generated_client.QuickConnectApiAuthorizeRequest.md) -- [QuickConnectApiConnectRequest](../interfaces/generated_client.QuickConnectApiConnectRequest.md) -- [QuickConnectDto](../interfaces/generated_client.QuickConnectDto.md) -- [QuickConnectResult](../interfaces/generated_client.QuickConnectResult.md) -- [ReadyRequestDto](../interfaces/generated_client.ReadyRequestDto.md) -- [RecommendationDto](../interfaces/generated_client.RecommendationDto.md) -- [RemoteImageApiDownloadRemoteImageRequest](../interfaces/generated_client.RemoteImageApiDownloadRemoteImageRequest.md) -- [RemoteImageApiGetRemoteImageProvidersRequest](../interfaces/generated_client.RemoteImageApiGetRemoteImageProvidersRequest.md) -- [RemoteImageApiGetRemoteImagesRequest](../interfaces/generated_client.RemoteImageApiGetRemoteImagesRequest.md) -- [RemoteImageInfo](../interfaces/generated_client.RemoteImageInfo.md) -- [RemoteImageResult](../interfaces/generated_client.RemoteImageResult.md) -- [RemoteSearchResult](../interfaces/generated_client.RemoteSearchResult.md) -- [RemoteSubtitleInfo](../interfaces/generated_client.RemoteSubtitleInfo.md) -- [RemoveFromPlaylistRequestDto](../interfaces/generated_client.RemoveFromPlaylistRequestDto.md) -- [RepositoryInfo](../interfaces/generated_client.RepositoryInfo.md) -- [ResponseProfile](../interfaces/generated_client.ResponseProfile.md) -- [ScheduledTasksApiGetTaskRequest](../interfaces/generated_client.ScheduledTasksApiGetTaskRequest.md) -- [ScheduledTasksApiGetTasksRequest](../interfaces/generated_client.ScheduledTasksApiGetTasksRequest.md) -- [ScheduledTasksApiStartTaskRequest](../interfaces/generated_client.ScheduledTasksApiStartTaskRequest.md) -- [ScheduledTasksApiStopTaskRequest](../interfaces/generated_client.ScheduledTasksApiStopTaskRequest.md) -- [ScheduledTasksApiUpdateTaskRequest](../interfaces/generated_client.ScheduledTasksApiUpdateTaskRequest.md) -- [SearchApiGetRequest](../interfaces/generated_client.SearchApiGetRequest.md) -- [SearchHint](../interfaces/generated_client.SearchHint.md) -- [SearchHintResult](../interfaces/generated_client.SearchHintResult.md) -- [SeekRequestDto](../interfaces/generated_client.SeekRequestDto.md) -- [SendCommand](../interfaces/generated_client.SendCommand.md) -- [SeriesInfo](../interfaces/generated_client.SeriesInfo.md) -- [SeriesInfoRemoteSearchQuery](../interfaces/generated_client.SeriesInfoRemoteSearchQuery.md) -- [SeriesTimerInfoDto](../interfaces/generated_client.SeriesTimerInfoDto.md) -- [SeriesTimerInfoDtoQueryResult](../interfaces/generated_client.SeriesTimerInfoDtoQueryResult.md) -- [ServerConfiguration](../interfaces/generated_client.ServerConfiguration.md) -- [ServerDiscoveryInfo](../interfaces/generated_client.ServerDiscoveryInfo.md) -- [SessionApiAddUserToSessionRequest](../interfaces/generated_client.SessionApiAddUserToSessionRequest.md) -- [SessionApiDisplayContentRequest](../interfaces/generated_client.SessionApiDisplayContentRequest.md) -- [SessionApiGetSessionsRequest](../interfaces/generated_client.SessionApiGetSessionsRequest.md) -- [SessionApiPlayRequest](../interfaces/generated_client.SessionApiPlayRequest.md) -- [SessionApiPostCapabilitiesRequest](../interfaces/generated_client.SessionApiPostCapabilitiesRequest.md) -- [SessionApiPostFullCapabilitiesRequest](../interfaces/generated_client.SessionApiPostFullCapabilitiesRequest.md) -- [SessionApiRemoveUserFromSessionRequest](../interfaces/generated_client.SessionApiRemoveUserFromSessionRequest.md) -- [SessionApiReportViewingRequest](../interfaces/generated_client.SessionApiReportViewingRequest.md) -- [SessionApiSendFullGeneralCommandRequest](../interfaces/generated_client.SessionApiSendFullGeneralCommandRequest.md) -- [SessionApiSendGeneralCommandRequest](../interfaces/generated_client.SessionApiSendGeneralCommandRequest.md) -- [SessionApiSendMessageCommandRequest](../interfaces/generated_client.SessionApiSendMessageCommandRequest.md) -- [SessionApiSendPlaystateCommandRequest](../interfaces/generated_client.SessionApiSendPlaystateCommandRequest.md) -- [SessionApiSendSystemCommandRequest](../interfaces/generated_client.SessionApiSendSystemCommandRequest.md) -- [SessionInfo](../interfaces/generated_client.SessionInfo.md) -- [SessionUserInfo](../interfaces/generated_client.SessionUserInfo.md) -- [SetChannelMappingDto](../interfaces/generated_client.SetChannelMappingDto.md) -- [SetPlaylistItemRequestDto](../interfaces/generated_client.SetPlaylistItemRequestDto.md) -- [SetRepeatModeRequestDto](../interfaces/generated_client.SetRepeatModeRequestDto.md) -- [SetShuffleModeRequestDto](../interfaces/generated_client.SetShuffleModeRequestDto.md) -- [SongInfo](../interfaces/generated_client.SongInfo.md) -- [SpecialViewOptionDto](../interfaces/generated_client.SpecialViewOptionDto.md) -- [StartupApiSetRemoteAccessRequest](../interfaces/generated_client.StartupApiSetRemoteAccessRequest.md) -- [StartupApiUpdateInitialConfigurationRequest](../interfaces/generated_client.StartupApiUpdateInitialConfigurationRequest.md) -- [StartupApiUpdateStartupUserRequest](../interfaces/generated_client.StartupApiUpdateStartupUserRequest.md) -- [StartupConfigurationDto](../interfaces/generated_client.StartupConfigurationDto.md) -- [StartupRemoteAccessDto](../interfaces/generated_client.StartupRemoteAccessDto.md) -- [StartupUserDto](../interfaces/generated_client.StartupUserDto.md) -- [StudiosApiGetStudioRequest](../interfaces/generated_client.StudiosApiGetStudioRequest.md) -- [StudiosApiGetStudiosRequest](../interfaces/generated_client.StudiosApiGetStudiosRequest.md) -- [SubtitleApiDeleteSubtitleRequest](../interfaces/generated_client.SubtitleApiDeleteSubtitleRequest.md) -- [SubtitleApiDownloadRemoteSubtitlesRequest](../interfaces/generated_client.SubtitleApiDownloadRemoteSubtitlesRequest.md) -- [SubtitleApiGetFallbackFontRequest](../interfaces/generated_client.SubtitleApiGetFallbackFontRequest.md) -- [SubtitleApiGetRemoteSubtitlesRequest](../interfaces/generated_client.SubtitleApiGetRemoteSubtitlesRequest.md) -- [SubtitleApiGetSubtitlePlaylistRequest](../interfaces/generated_client.SubtitleApiGetSubtitlePlaylistRequest.md) -- [SubtitleApiGetSubtitleRequest](../interfaces/generated_client.SubtitleApiGetSubtitleRequest.md) -- [SubtitleApiGetSubtitleWithTicksRequest](../interfaces/generated_client.SubtitleApiGetSubtitleWithTicksRequest.md) -- [SubtitleApiSearchRemoteSubtitlesRequest](../interfaces/generated_client.SubtitleApiSearchRemoteSubtitlesRequest.md) -- [SubtitleApiUploadSubtitleRequest](../interfaces/generated_client.SubtitleApiUploadSubtitleRequest.md) -- [SubtitleOptions](../interfaces/generated_client.SubtitleOptions.md) -- [SubtitleProfile](../interfaces/generated_client.SubtitleProfile.md) -- [SuggestionsApiGetSuggestionsRequest](../interfaces/generated_client.SuggestionsApiGetSuggestionsRequest.md) -- [SyncPlayApiSyncPlayBufferingRequest](../interfaces/generated_client.SyncPlayApiSyncPlayBufferingRequest.md) -- [SyncPlayApiSyncPlayCreateGroupRequest](../interfaces/generated_client.SyncPlayApiSyncPlayCreateGroupRequest.md) -- [SyncPlayApiSyncPlayJoinGroupRequest](../interfaces/generated_client.SyncPlayApiSyncPlayJoinGroupRequest.md) -- [SyncPlayApiSyncPlayMovePlaylistItemRequest](../interfaces/generated_client.SyncPlayApiSyncPlayMovePlaylistItemRequest.md) -- [SyncPlayApiSyncPlayNextItemRequest](../interfaces/generated_client.SyncPlayApiSyncPlayNextItemRequest.md) -- [SyncPlayApiSyncPlayPingRequest](../interfaces/generated_client.SyncPlayApiSyncPlayPingRequest.md) -- [SyncPlayApiSyncPlayPreviousItemRequest](../interfaces/generated_client.SyncPlayApiSyncPlayPreviousItemRequest.md) -- [SyncPlayApiSyncPlayQueueRequest](../interfaces/generated_client.SyncPlayApiSyncPlayQueueRequest.md) -- [SyncPlayApiSyncPlayReadyRequest](../interfaces/generated_client.SyncPlayApiSyncPlayReadyRequest.md) -- [SyncPlayApiSyncPlayRemoveFromPlaylistRequest](../interfaces/generated_client.SyncPlayApiSyncPlayRemoveFromPlaylistRequest.md) -- [SyncPlayApiSyncPlaySeekRequest](../interfaces/generated_client.SyncPlayApiSyncPlaySeekRequest.md) -- [SyncPlayApiSyncPlaySetIgnoreWaitRequest](../interfaces/generated_client.SyncPlayApiSyncPlaySetIgnoreWaitRequest.md) -- [SyncPlayApiSyncPlaySetNewQueueRequest](../interfaces/generated_client.SyncPlayApiSyncPlaySetNewQueueRequest.md) -- [SyncPlayApiSyncPlaySetPlaylistItemRequest](../interfaces/generated_client.SyncPlayApiSyncPlaySetPlaylistItemRequest.md) -- [SyncPlayApiSyncPlaySetRepeatModeRequest](../interfaces/generated_client.SyncPlayApiSyncPlaySetRepeatModeRequest.md) -- [SyncPlayApiSyncPlaySetShuffleModeRequest](../interfaces/generated_client.SyncPlayApiSyncPlaySetShuffleModeRequest.md) -- [SystemApiGetLogFileRequest](../interfaces/generated_client.SystemApiGetLogFileRequest.md) -- [SystemInfo](../interfaces/generated_client.SystemInfo.md) -- [TaskInfo](../interfaces/generated_client.TaskInfo.md) -- [TaskResult](../interfaces/generated_client.TaskResult.md) -- [TaskTriggerInfo](../interfaces/generated_client.TaskTriggerInfo.md) -- [ThemeMediaResult](../interfaces/generated_client.ThemeMediaResult.md) -- [TimerEventInfo](../interfaces/generated_client.TimerEventInfo.md) -- [TimerInfoDto](../interfaces/generated_client.TimerInfoDto.md) -- [TimerInfoDtoQueryResult](../interfaces/generated_client.TimerInfoDtoQueryResult.md) -- [TrailerInfo](../interfaces/generated_client.TrailerInfo.md) -- [TrailerInfoRemoteSearchQuery](../interfaces/generated_client.TrailerInfoRemoteSearchQuery.md) -- [TrailersApiGetTrailersRequest](../interfaces/generated_client.TrailersApiGetTrailersRequest.md) -- [TranscodingInfo](../interfaces/generated_client.TranscodingInfo.md) -- [TranscodingProfile](../interfaces/generated_client.TranscodingProfile.md) -- [TunerChannelMapping](../interfaces/generated_client.TunerChannelMapping.md) -- [TunerHostInfo](../interfaces/generated_client.TunerHostInfo.md) -- [TvShowsApiGetEpisodesRequest](../interfaces/generated_client.TvShowsApiGetEpisodesRequest.md) -- [TvShowsApiGetNextUpRequest](../interfaces/generated_client.TvShowsApiGetNextUpRequest.md) -- [TvShowsApiGetSeasonsRequest](../interfaces/generated_client.TvShowsApiGetSeasonsRequest.md) -- [TvShowsApiGetUpcomingEpisodesRequest](../interfaces/generated_client.TvShowsApiGetUpcomingEpisodesRequest.md) -- [TypeOptions](../interfaces/generated_client.TypeOptions.md) -- [UniversalAudioApiGetUniversalAudioStreamRequest](../interfaces/generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md) -- [UniversalAudioApiHeadUniversalAudioStreamRequest](../interfaces/generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md) -- [UpdateLibraryOptionsDto](../interfaces/generated_client.UpdateLibraryOptionsDto.md) -- [UpdateMediaPathRequestDto](../interfaces/generated_client.UpdateMediaPathRequestDto.md) -- [UpdateUserEasyPassword](../interfaces/generated_client.UpdateUserEasyPassword.md) -- [UpdateUserPassword](../interfaces/generated_client.UpdateUserPassword.md) -- [UploadSubtitleDto](../interfaces/generated_client.UploadSubtitleDto.md) -- [UserApiAuthenticateUserByNameRequest](../interfaces/generated_client.UserApiAuthenticateUserByNameRequest.md) -- [UserApiAuthenticateUserRequest](../interfaces/generated_client.UserApiAuthenticateUserRequest.md) -- [UserApiAuthenticateWithQuickConnectRequest](../interfaces/generated_client.UserApiAuthenticateWithQuickConnectRequest.md) -- [UserApiCreateUserByNameRequest](../interfaces/generated_client.UserApiCreateUserByNameRequest.md) -- [UserApiDeleteUserRequest](../interfaces/generated_client.UserApiDeleteUserRequest.md) -- [UserApiForgotPasswordPinRequest](../interfaces/generated_client.UserApiForgotPasswordPinRequest.md) -- [UserApiForgotPasswordRequest](../interfaces/generated_client.UserApiForgotPasswordRequest.md) -- [UserApiGetUserByIdRequest](../interfaces/generated_client.UserApiGetUserByIdRequest.md) -- [UserApiGetUsersRequest](../interfaces/generated_client.UserApiGetUsersRequest.md) -- [UserApiUpdateUserConfigurationRequest](../interfaces/generated_client.UserApiUpdateUserConfigurationRequest.md) -- [UserApiUpdateUserEasyPasswordRequest](../interfaces/generated_client.UserApiUpdateUserEasyPasswordRequest.md) -- [UserApiUpdateUserPasswordRequest](../interfaces/generated_client.UserApiUpdateUserPasswordRequest.md) -- [UserApiUpdateUserPolicyRequest](../interfaces/generated_client.UserApiUpdateUserPolicyRequest.md) -- [UserApiUpdateUserRequest](../interfaces/generated_client.UserApiUpdateUserRequest.md) -- [UserConfiguration](../interfaces/generated_client.UserConfiguration.md) -- [UserDto](../interfaces/generated_client.UserDto.md) -- [UserItemDataDto](../interfaces/generated_client.UserItemDataDto.md) -- [UserLibraryApiDeleteUserItemRatingRequest](../interfaces/generated_client.UserLibraryApiDeleteUserItemRatingRequest.md) -- [UserLibraryApiGetIntrosRequest](../interfaces/generated_client.UserLibraryApiGetIntrosRequest.md) -- [UserLibraryApiGetItemRequest](../interfaces/generated_client.UserLibraryApiGetItemRequest.md) -- [UserLibraryApiGetLatestMediaRequest](../interfaces/generated_client.UserLibraryApiGetLatestMediaRequest.md) -- [UserLibraryApiGetLocalTrailersRequest](../interfaces/generated_client.UserLibraryApiGetLocalTrailersRequest.md) -- [UserLibraryApiGetRootFolderRequest](../interfaces/generated_client.UserLibraryApiGetRootFolderRequest.md) -- [UserLibraryApiGetSpecialFeaturesRequest](../interfaces/generated_client.UserLibraryApiGetSpecialFeaturesRequest.md) -- [UserLibraryApiMarkFavoriteItemRequest](../interfaces/generated_client.UserLibraryApiMarkFavoriteItemRequest.md) -- [UserLibraryApiUnmarkFavoriteItemRequest](../interfaces/generated_client.UserLibraryApiUnmarkFavoriteItemRequest.md) -- [UserLibraryApiUpdateUserItemRatingRequest](../interfaces/generated_client.UserLibraryApiUpdateUserItemRatingRequest.md) -- [UserPolicy](../interfaces/generated_client.UserPolicy.md) -- [UserViewsApiGetGroupingOptionsRequest](../interfaces/generated_client.UserViewsApiGetGroupingOptionsRequest.md) -- [UserViewsApiGetUserViewsRequest](../interfaces/generated_client.UserViewsApiGetUserViewsRequest.md) -- [UtcTimeResponse](../interfaces/generated_client.UtcTimeResponse.md) -- [ValidatePathDto](../interfaces/generated_client.ValidatePathDto.md) -- [VersionInfo](../interfaces/generated_client.VersionInfo.md) -- [VideoAttachmentsApiGetAttachmentRequest](../interfaces/generated_client.VideoAttachmentsApiGetAttachmentRequest.md) -- [VideosApiDeleteAlternateSourcesRequest](../interfaces/generated_client.VideosApiDeleteAlternateSourcesRequest.md) -- [VideosApiGetAdditionalPartRequest](../interfaces/generated_client.VideosApiGetAdditionalPartRequest.md) -- [VideosApiGetVideoStreamByContainerRequest](../interfaces/generated_client.VideosApiGetVideoStreamByContainerRequest.md) -- [VideosApiGetVideoStreamRequest](../interfaces/generated_client.VideosApiGetVideoStreamRequest.md) -- [VideosApiHeadVideoStreamByContainerRequest](../interfaces/generated_client.VideosApiHeadVideoStreamByContainerRequest.md) -- [VideosApiHeadVideoStreamRequest](../interfaces/generated_client.VideosApiHeadVideoStreamRequest.md) -- [VideosApiMergeVersionsRequest](../interfaces/generated_client.VideosApiMergeVersionsRequest.md) -- [VirtualFolderInfo](../interfaces/generated_client.VirtualFolderInfo.md) -- [WakeOnLanInfo](../interfaces/generated_client.WakeOnLanInfo.md) -- [XbmcMetadataOptions](../interfaces/generated_client.XbmcMetadataOptions.md) -- [XmlAttribute](../interfaces/generated_client.XmlAttribute.md) -- [YearsApiGetYearRequest](../interfaces/generated_client.YearsApiGetYearRequest.md) -- [YearsApiGetYearsRequest](../interfaces/generated_client.YearsApiGetYearsRequest.md) - -### Functions - -- [ActivityLogApiAxiosParamCreator](generated_client.md#activitylogapiaxiosparamcreator) -- [ActivityLogApiFactory](generated_client.md#activitylogapifactory) -- [ActivityLogApiFp](generated_client.md#activitylogapifp) -- [ApiKeyApiAxiosParamCreator](generated_client.md#apikeyapiaxiosparamcreator) -- [ApiKeyApiFactory](generated_client.md#apikeyapifactory) -- [ApiKeyApiFp](generated_client.md#apikeyapifp) -- [ArtistsApiAxiosParamCreator](generated_client.md#artistsapiaxiosparamcreator) -- [ArtistsApiFactory](generated_client.md#artistsapifactory) -- [ArtistsApiFp](generated_client.md#artistsapifp) -- [AudioApiAxiosParamCreator](generated_client.md#audioapiaxiosparamcreator) -- [AudioApiFactory](generated_client.md#audioapifactory) -- [AudioApiFp](generated_client.md#audioapifp) -- [BrandingApiAxiosParamCreator](generated_client.md#brandingapiaxiosparamcreator) -- [BrandingApiFactory](generated_client.md#brandingapifactory) -- [BrandingApiFp](generated_client.md#brandingapifp) -- [ChannelsApiAxiosParamCreator](generated_client.md#channelsapiaxiosparamcreator) -- [ChannelsApiFactory](generated_client.md#channelsapifactory) -- [ChannelsApiFp](generated_client.md#channelsapifp) -- [ClientLogApiAxiosParamCreator](generated_client.md#clientlogapiaxiosparamcreator) -- [ClientLogApiFactory](generated_client.md#clientlogapifactory) -- [ClientLogApiFp](generated_client.md#clientlogapifp) -- [CollectionApiAxiosParamCreator](generated_client.md#collectionapiaxiosparamcreator) -- [CollectionApiFactory](generated_client.md#collectionapifactory) -- [CollectionApiFp](generated_client.md#collectionapifp) -- [ConfigurationApiAxiosParamCreator](generated_client.md#configurationapiaxiosparamcreator) -- [ConfigurationApiFactory](generated_client.md#configurationapifactory) -- [ConfigurationApiFp](generated_client.md#configurationapifp) -- [DashboardApiAxiosParamCreator](generated_client.md#dashboardapiaxiosparamcreator) -- [DashboardApiFactory](generated_client.md#dashboardapifactory) -- [DashboardApiFp](generated_client.md#dashboardapifp) -- [DevicesApiAxiosParamCreator](generated_client.md#devicesapiaxiosparamcreator) -- [DevicesApiFactory](generated_client.md#devicesapifactory) -- [DevicesApiFp](generated_client.md#devicesapifp) -- [DisplayPreferencesApiAxiosParamCreator](generated_client.md#displaypreferencesapiaxiosparamcreator) -- [DisplayPreferencesApiFactory](generated_client.md#displaypreferencesapifactory) -- [DisplayPreferencesApiFp](generated_client.md#displaypreferencesapifp) -- [DlnaApiAxiosParamCreator](generated_client.md#dlnaapiaxiosparamcreator) -- [DlnaApiFactory](generated_client.md#dlnaapifactory) -- [DlnaApiFp](generated_client.md#dlnaapifp) -- [DlnaServerApiAxiosParamCreator](generated_client.md#dlnaserverapiaxiosparamcreator) -- [DlnaServerApiFactory](generated_client.md#dlnaserverapifactory) -- [DlnaServerApiFp](generated_client.md#dlnaserverapifp) -- [DynamicHlsApiAxiosParamCreator](generated_client.md#dynamichlsapiaxiosparamcreator) -- [DynamicHlsApiFactory](generated_client.md#dynamichlsapifactory) -- [DynamicHlsApiFp](generated_client.md#dynamichlsapifp) -- [EnvironmentApiAxiosParamCreator](generated_client.md#environmentapiaxiosparamcreator) -- [EnvironmentApiFactory](generated_client.md#environmentapifactory) -- [EnvironmentApiFp](generated_client.md#environmentapifp) -- [FilterApiAxiosParamCreator](generated_client.md#filterapiaxiosparamcreator) -- [FilterApiFactory](generated_client.md#filterapifactory) -- [FilterApiFp](generated_client.md#filterapifp) -- [GenresApiAxiosParamCreator](generated_client.md#genresapiaxiosparamcreator) -- [GenresApiFactory](generated_client.md#genresapifactory) -- [GenresApiFp](generated_client.md#genresapifp) -- [HlsSegmentApiAxiosParamCreator](generated_client.md#hlssegmentapiaxiosparamcreator) -- [HlsSegmentApiFactory](generated_client.md#hlssegmentapifactory) -- [HlsSegmentApiFp](generated_client.md#hlssegmentapifp) -- [ImageApiAxiosParamCreator](generated_client.md#imageapiaxiosparamcreator) -- [ImageApiFactory](generated_client.md#imageapifactory) -- [ImageApiFp](generated_client.md#imageapifp) -- [ImageByNameApiAxiosParamCreator](generated_client.md#imagebynameapiaxiosparamcreator) -- [ImageByNameApiFactory](generated_client.md#imagebynameapifactory) -- [ImageByNameApiFp](generated_client.md#imagebynameapifp) -- [InstantMixApiAxiosParamCreator](generated_client.md#instantmixapiaxiosparamcreator) -- [InstantMixApiFactory](generated_client.md#instantmixapifactory) -- [InstantMixApiFp](generated_client.md#instantmixapifp) -- [ItemLookupApiAxiosParamCreator](generated_client.md#itemlookupapiaxiosparamcreator) -- [ItemLookupApiFactory](generated_client.md#itemlookupapifactory) -- [ItemLookupApiFp](generated_client.md#itemlookupapifp) -- [ItemRefreshApiAxiosParamCreator](generated_client.md#itemrefreshapiaxiosparamcreator) -- [ItemRefreshApiFactory](generated_client.md#itemrefreshapifactory) -- [ItemRefreshApiFp](generated_client.md#itemrefreshapifp) -- [ItemUpdateApiAxiosParamCreator](generated_client.md#itemupdateapiaxiosparamcreator) -- [ItemUpdateApiFactory](generated_client.md#itemupdateapifactory) -- [ItemUpdateApiFp](generated_client.md#itemupdateapifp) -- [ItemsApiAxiosParamCreator](generated_client.md#itemsapiaxiosparamcreator) -- [ItemsApiFactory](generated_client.md#itemsapifactory) -- [ItemsApiFp](generated_client.md#itemsapifp) -- [LibraryApiAxiosParamCreator](generated_client.md#libraryapiaxiosparamcreator) -- [LibraryApiFactory](generated_client.md#libraryapifactory) -- [LibraryApiFp](generated_client.md#libraryapifp) -- [LibraryStructureApiAxiosParamCreator](generated_client.md#librarystructureapiaxiosparamcreator) -- [LibraryStructureApiFactory](generated_client.md#librarystructureapifactory) -- [LibraryStructureApiFp](generated_client.md#librarystructureapifp) -- [LiveTvApiAxiosParamCreator](generated_client.md#livetvapiaxiosparamcreator) -- [LiveTvApiFactory](generated_client.md#livetvapifactory) -- [LiveTvApiFp](generated_client.md#livetvapifp) -- [LocalizationApiAxiosParamCreator](generated_client.md#localizationapiaxiosparamcreator) -- [LocalizationApiFactory](generated_client.md#localizationapifactory) -- [LocalizationApiFp](generated_client.md#localizationapifp) -- [MediaInfoApiAxiosParamCreator](generated_client.md#mediainfoapiaxiosparamcreator) -- [MediaInfoApiFactory](generated_client.md#mediainfoapifactory) -- [MediaInfoApiFp](generated_client.md#mediainfoapifp) -- [MoviesApiAxiosParamCreator](generated_client.md#moviesapiaxiosparamcreator) -- [MoviesApiFactory](generated_client.md#moviesapifactory) -- [MoviesApiFp](generated_client.md#moviesapifp) -- [MusicGenresApiAxiosParamCreator](generated_client.md#musicgenresapiaxiosparamcreator) -- [MusicGenresApiFactory](generated_client.md#musicgenresapifactory) -- [MusicGenresApiFp](generated_client.md#musicgenresapifp) -- [NotificationsApiAxiosParamCreator](generated_client.md#notificationsapiaxiosparamcreator) -- [NotificationsApiFactory](generated_client.md#notificationsapifactory) -- [NotificationsApiFp](generated_client.md#notificationsapifp) -- [PackageApiAxiosParamCreator](generated_client.md#packageapiaxiosparamcreator) -- [PackageApiFactory](generated_client.md#packageapifactory) -- [PackageApiFp](generated_client.md#packageapifp) -- [PersonsApiAxiosParamCreator](generated_client.md#personsapiaxiosparamcreator) -- [PersonsApiFactory](generated_client.md#personsapifactory) -- [PersonsApiFp](generated_client.md#personsapifp) -- [PlaylistsApiAxiosParamCreator](generated_client.md#playlistsapiaxiosparamcreator) -- [PlaylistsApiFactory](generated_client.md#playlistsapifactory) -- [PlaylistsApiFp](generated_client.md#playlistsapifp) -- [PlaystateApiAxiosParamCreator](generated_client.md#playstateapiaxiosparamcreator) -- [PlaystateApiFactory](generated_client.md#playstateapifactory) -- [PlaystateApiFp](generated_client.md#playstateapifp) -- [PluginsApiAxiosParamCreator](generated_client.md#pluginsapiaxiosparamcreator) -- [PluginsApiFactory](generated_client.md#pluginsapifactory) -- [PluginsApiFp](generated_client.md#pluginsapifp) -- [QuickConnectApiAxiosParamCreator](generated_client.md#quickconnectapiaxiosparamcreator) -- [QuickConnectApiFactory](generated_client.md#quickconnectapifactory) -- [QuickConnectApiFp](generated_client.md#quickconnectapifp) -- [RemoteImageApiAxiosParamCreator](generated_client.md#remoteimageapiaxiosparamcreator) -- [RemoteImageApiFactory](generated_client.md#remoteimageapifactory) -- [RemoteImageApiFp](generated_client.md#remoteimageapifp) -- [ScheduledTasksApiAxiosParamCreator](generated_client.md#scheduledtasksapiaxiosparamcreator) -- [ScheduledTasksApiFactory](generated_client.md#scheduledtasksapifactory) -- [ScheduledTasksApiFp](generated_client.md#scheduledtasksapifp) -- [SearchApiAxiosParamCreator](generated_client.md#searchapiaxiosparamcreator) -- [SearchApiFactory](generated_client.md#searchapifactory) -- [SearchApiFp](generated_client.md#searchapifp) -- [SessionApiAxiosParamCreator](generated_client.md#sessionapiaxiosparamcreator) -- [SessionApiFactory](generated_client.md#sessionapifactory) -- [SessionApiFp](generated_client.md#sessionapifp) -- [StartupApiAxiosParamCreator](generated_client.md#startupapiaxiosparamcreator) -- [StartupApiFactory](generated_client.md#startupapifactory) -- [StartupApiFp](generated_client.md#startupapifp) -- [StudiosApiAxiosParamCreator](generated_client.md#studiosapiaxiosparamcreator) -- [StudiosApiFactory](generated_client.md#studiosapifactory) -- [StudiosApiFp](generated_client.md#studiosapifp) -- [SubtitleApiAxiosParamCreator](generated_client.md#subtitleapiaxiosparamcreator) -- [SubtitleApiFactory](generated_client.md#subtitleapifactory) -- [SubtitleApiFp](generated_client.md#subtitleapifp) -- [SuggestionsApiAxiosParamCreator](generated_client.md#suggestionsapiaxiosparamcreator) -- [SuggestionsApiFactory](generated_client.md#suggestionsapifactory) -- [SuggestionsApiFp](generated_client.md#suggestionsapifp) -- [SyncPlayApiAxiosParamCreator](generated_client.md#syncplayapiaxiosparamcreator) -- [SyncPlayApiFactory](generated_client.md#syncplayapifactory) -- [SyncPlayApiFp](generated_client.md#syncplayapifp) -- [SystemApiAxiosParamCreator](generated_client.md#systemapiaxiosparamcreator) -- [SystemApiFactory](generated_client.md#systemapifactory) -- [SystemApiFp](generated_client.md#systemapifp) -- [TimeSyncApiAxiosParamCreator](generated_client.md#timesyncapiaxiosparamcreator) -- [TimeSyncApiFactory](generated_client.md#timesyncapifactory) -- [TimeSyncApiFp](generated_client.md#timesyncapifp) -- [TmdbApiAxiosParamCreator](generated_client.md#tmdbapiaxiosparamcreator) -- [TmdbApiFactory](generated_client.md#tmdbapifactory) -- [TmdbApiFp](generated_client.md#tmdbapifp) -- [TrailersApiAxiosParamCreator](generated_client.md#trailersapiaxiosparamcreator) -- [TrailersApiFactory](generated_client.md#trailersapifactory) -- [TrailersApiFp](generated_client.md#trailersapifp) -- [TvShowsApiAxiosParamCreator](generated_client.md#tvshowsapiaxiosparamcreator) -- [TvShowsApiFactory](generated_client.md#tvshowsapifactory) -- [TvShowsApiFp](generated_client.md#tvshowsapifp) -- [UniversalAudioApiAxiosParamCreator](generated_client.md#universalaudioapiaxiosparamcreator) -- [UniversalAudioApiFactory](generated_client.md#universalaudioapifactory) -- [UniversalAudioApiFp](generated_client.md#universalaudioapifp) -- [UserApiAxiosParamCreator](generated_client.md#userapiaxiosparamcreator) -- [UserApiFactory](generated_client.md#userapifactory) -- [UserApiFp](generated_client.md#userapifp) -- [UserLibraryApiAxiosParamCreator](generated_client.md#userlibraryapiaxiosparamcreator) -- [UserLibraryApiFactory](generated_client.md#userlibraryapifactory) -- [UserLibraryApiFp](generated_client.md#userlibraryapifp) -- [UserViewsApiAxiosParamCreator](generated_client.md#userviewsapiaxiosparamcreator) -- [UserViewsApiFactory](generated_client.md#userviewsapifactory) -- [UserViewsApiFp](generated_client.md#userviewsapifp) -- [VideoAttachmentsApiAxiosParamCreator](generated_client.md#videoattachmentsapiaxiosparamcreator) -- [VideoAttachmentsApiFactory](generated_client.md#videoattachmentsapifactory) -- [VideoAttachmentsApiFp](generated_client.md#videoattachmentsapifp) -- [VideosApiAxiosParamCreator](generated_client.md#videosapiaxiosparamcreator) -- [VideosApiFactory](generated_client.md#videosapifactory) -- [VideosApiFp](generated_client.md#videosapifp) -- [YearsApiAxiosParamCreator](generated_client.md#yearsapiaxiosparamcreator) -- [YearsApiFactory](generated_client.md#yearsapifactory) -- [YearsApiFp](generated_client.md#yearsapifp) - -## Functions - -### ActivityLogApiAxiosParamCreator - -▸ **ActivityLogApiAxiosParamCreator**(`configuration?`): `Object` - -ActivityLogApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getLogEntries` | (`startIndex?`: `number`, `limit?`: `number`, `minDate?`: `string`, `hasUserId?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/activity-log-api.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/activity-log-api.ts#L29) - -___ - -### ActivityLogApiFactory - -▸ **ActivityLogApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ActivityLogApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getLogEntries` | (`startIndex?`: `number`, `limit?`: `number`, `minDate?`: `string`, `hasUserId?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`ActivityLogEntryQueryResult`](../interfaces/generated_client.ActivityLogEntryQueryResult.md)\> | - -#### Defined in - -[generated-client/api/activity-log-api.ts:117](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/activity-log-api.ts#L117) - -___ - -### ActivityLogApiFp - -▸ **ActivityLogApiFp**(`configuration?`): `Object` - -ActivityLogApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getLogEntries` | (`startIndex?`: `number`, `limit?`: `number`, `minDate?`: `string`, `hasUserId?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ActivityLogEntryQueryResult`](../interfaces/generated_client.ActivityLogEntryQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/activity-log-api.ts:93](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/activity-log-api.ts#L93) - -___ - -### ApiKeyApiAxiosParamCreator - -▸ **ApiKeyApiAxiosParamCreator**(`configuration?`): `Object` - -ApiKeyApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `createKey` | (`app`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getKeys` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `revokeKey` | (`key`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/api-key-api.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L29) - -___ - -### ApiKeyApiFactory - -▸ **ApiKeyApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ApiKeyApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `createKey` | (`app`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getKeys` | (`options?`: `any`) => `AxiosPromise`<[`AuthenticationInfoQueryResult`](../interfaces/generated_client.AuthenticationInfoQueryResult.md)\> | -| `revokeKey` | (`key`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/api-key-api.ts:190](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L190) - -___ - -### ApiKeyApiFp - -▸ **ApiKeyApiFp**(`configuration?`): `Object` - -ApiKeyApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `createKey` | (`app`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getKeys` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`AuthenticationInfoQueryResult`](../interfaces/generated_client.AuthenticationInfoQueryResult.md)\>\> | -| `revokeKey` | (`key`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/api-key-api.ts:148](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L148) - -___ - -### ArtistsApiAxiosParamCreator - -▸ **ArtistsApiAxiosParamCreator**(`configuration?`): `Object` - -ArtistsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getAlbumArtists` | (`minCommunityRating?`: `number`, `startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `genres?`: `string`[], `genreIds?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `studioIds?`: `string`[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getArtistByName` | (`name`: `string`, `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getArtists` | (`minCommunityRating?`: `number`, `startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `genres?`: `string`[], `genreIds?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `studioIds?`: `string`[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/artists-api.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L41) - -___ - -### ArtistsApiFactory - -▸ **ArtistsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ArtistsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getAlbumArtists` | (`minCommunityRating?`: `number`, `startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `genres?`: `string`[], `genreIds?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `studioIds?`: `string`[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getArtistByName` | (`name`: `string`, `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\> | -| `getArtists` | (`minCommunityRating?`: `number`, `startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `genres?`: `string`[], `genreIds?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `studioIds?`: `string`[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/artists-api.ts:584](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L584) - -___ - -### ArtistsApiFp - -▸ **ArtistsApiFp**(`configuration?`): `Object` - -ArtistsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getAlbumArtists` | (`minCommunityRating?`: `number`, `startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `genres?`: `string`[], `genreIds?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `studioIds?`: `string`[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getArtistByName` | (`name`: `string`, `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\> | -| `getArtists` | (`minCommunityRating?`: `number`, `startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `genres?`: `string`[], `genreIds?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `studioIds?`: `string`[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/artists-api.ts:478](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L478) - -___ - -### AudioApiAxiosParamCreator - -▸ **AudioApiAxiosParamCreator**(`configuration?`): `Object` - -AudioApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getAudioStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getAudioStreamByContainer` | (`itemId`: `string`, `container`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headAudioStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headAudioStreamByContainer` | (`itemId`: `string`, `container`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/audio-api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L31) - -___ - -### AudioApiFactory - -▸ **AudioApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -AudioApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getAudioStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getAudioStreamByContainer` | (`itemId`: `string`, `container`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headAudioStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headAudioStreamByContainer` | (`itemId`: `string`, `container`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `AxiosPromise`<`any`\> | - -#### Defined in - -[generated-client/api/audio-api.ts:1380](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1380) - -___ - -### AudioApiFp - -▸ **AudioApiFp**(`configuration?`): `Object` - -AudioApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getAudioStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getAudioStreamByContainer` | (`itemId`: `string`, `container`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headAudioStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headAudioStreamByContainer` | (`itemId`: `string`, `container`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | - -#### Defined in - -[generated-client/api/audio-api.ts:1134](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L1134) - -___ - -### BrandingApiAxiosParamCreator - -▸ **BrandingApiAxiosParamCreator**(`configuration?`): `Object` - -BrandingApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getBrandingCss` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getBrandingCss2` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getBrandingOptions` | (`options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/branding-api.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/branding-api.ts#L29) - -___ - -### BrandingApiFactory - -▸ **BrandingApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -BrandingApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getBrandingCss` | (`options?`: `any`) => `AxiosPromise`<`string`\> | -| `getBrandingCss2` | (`options?`: `any`) => `AxiosPromise`<`string`\> | -| `getBrandingOptions` | (`options?`: `any`) => `AxiosPromise`<[`BrandingOptions`](../interfaces/generated_client.BrandingOptions.md)\> | - -#### Defined in - -[generated-client/api/branding-api.ts:168](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/branding-api.ts#L168) - -___ - -### BrandingApiFp - -▸ **BrandingApiFp**(`configuration?`): `Object` - -BrandingApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getBrandingCss` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`\>\> | -| `getBrandingCss2` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`\>\> | -| `getBrandingOptions` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BrandingOptions`](../interfaces/generated_client.BrandingOptions.md)\>\> | - -#### Defined in - -[generated-client/api/branding-api.ts:128](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/branding-api.ts#L128) - -___ - -### ChannelsApiAxiosParamCreator - -▸ **ChannelsApiAxiosParamCreator**(`configuration?`): `Object` - -ChannelsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getAllChannelFeatures` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getChannelFeatures` | (`channelId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getChannelItems` | (`channelId`: `string`, `folderId?`: `string`, `userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `sortBy?`: `string`[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getChannels` | (`userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `supportsLatestItems?`: `boolean`, `supportsMediaDeletion?`: `boolean`, `isFavorite?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLatestChannelItems` | (`userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `channelIds?`: `string`[], `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/channels-api.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L37) - -___ - -### ChannelsApiFactory - -▸ **ChannelsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ChannelsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getAllChannelFeatures` | (`options?`: `any`) => `AxiosPromise`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md)[]\> | -| `getChannelFeatures` | (`channelId`: `string`, `options?`: `any`) => `AxiosPromise`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md)\> | -| `getChannelItems` | (`channelId`: `string`, `folderId?`: `string`, `userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `sortBy?`: `string`[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getChannels` | (`userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `supportsLatestItems?`: `boolean`, `supportsMediaDeletion?`: `boolean`, `isFavorite?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getLatestChannelItems` | (`userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `channelIds?`: `string`[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/channels-api.ts:401](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L401) - -___ - -### ChannelsApiFp - -▸ **ChannelsApiFp**(`configuration?`): `Object` - -ChannelsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getAllChannelFeatures` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md)[]\>\> | -| `getChannelFeatures` | (`channelId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md)\>\> | -| `getChannelItems` | (`channelId`: `string`, `folderId?`: `string`, `userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `sortBy?`: `string`[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getChannels` | (`userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `supportsLatestItems?`: `boolean`, `supportsMediaDeletion?`: `boolean`, `isFavorite?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getLatestChannelItems` | (`userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `channelIds?`: `string`[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/channels-api.ts:319](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L319) - -___ - -### ClientLogApiAxiosParamCreator - -▸ **ClientLogApiAxiosParamCreator**(`configuration?`): `Object` - -ClientLogApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `logFile` | (`body?`: `any`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/client-log-api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/client-log-api.ts#L31) - -___ - -### ClientLogApiFactory - -▸ **ClientLogApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ClientLogApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `logFile` | (`body?`: `any`, `options?`: `any`) => `AxiosPromise`<[`ClientLogDocumentResponseDto`](../interfaces/generated_client.ClientLogDocumentResponseDto.md)\> | - -#### Defined in - -[generated-client/api/client-log-api.ts:98](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/client-log-api.ts#L98) - -___ - -### ClientLogApiFp - -▸ **ClientLogApiFp**(`configuration?`): `Object` - -ClientLogApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `logFile` | (`body?`: `any`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ClientLogDocumentResponseDto`](../interfaces/generated_client.ClientLogDocumentResponseDto.md)\>\> | - -#### Defined in - -[generated-client/api/client-log-api.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/client-log-api.ts#L77) - -___ - -### CollectionApiAxiosParamCreator - -▸ **CollectionApiAxiosParamCreator**(`configuration?`): `Object` - -CollectionApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addToCollection` | (`collectionId`: `string`, `ids`: `string`[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `createCollection` | (`name?`: `string`, `ids?`: `string`[], `parentId?`: `string`, `isLocked?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `removeFromCollection` | (`collectionId`: `string`, `ids`: `string`[], `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/collection-api.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L29) - -___ - -### CollectionApiFactory - -▸ **CollectionApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -CollectionApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addToCollection` | (`collectionId`: `string`, `ids`: `string`[], `options?`: `any`) => `AxiosPromise`<`void`\> | -| `createCollection` | (`name?`: `string`, `ids?`: `string`[], `parentId?`: `string`, `isLocked?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`CollectionCreationResult`](../interfaces/generated_client.CollectionCreationResult.md)\> | -| `removeFromCollection` | (`collectionId`: `string`, `ids`: `string`[], `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/collection-api.ts:227](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L227) - -___ - -### CollectionApiFp - -▸ **CollectionApiFp**(`configuration?`): `Object` - -CollectionApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addToCollection` | (`collectionId`: `string`, `ids`: `string`[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `createCollection` | (`name?`: `string`, `ids?`: `string`[], `parentId?`: `string`, `isLocked?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`CollectionCreationResult`](../interfaces/generated_client.CollectionCreationResult.md)\>\> | -| `removeFromCollection` | (`collectionId`: `string`, `ids`: `string`[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/collection-api.ts:179](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L179) - -___ - -### ConfigurationApiAxiosParamCreator - -▸ **ConfigurationApiAxiosParamCreator**(`configuration?`): `Object` - -ConfigurationApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getConfiguration` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDefaultMetadataOptions` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getNamedConfiguration` | (`key`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateConfiguration` | (`serverConfiguration`: [`ServerConfiguration`](../interfaces/generated_client.ServerConfiguration.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateMediaEncoderPath` | (`mediaEncoderPathDto`: [`MediaEncoderPathDto`](../interfaces/generated_client.MediaEncoderPathDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateNamedConfiguration` | (`key`: `string`, `body`: `any`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/configuration-api.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L33) - -___ - -### ConfigurationApiFactory - -▸ **ConfigurationApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ConfigurationApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getConfiguration` | (`options?`: `any`) => `AxiosPromise`<[`ServerConfiguration`](../interfaces/generated_client.ServerConfiguration.md)\> | -| `getDefaultMetadataOptions` | (`options?`: `any`) => `AxiosPromise`<[`MetadataOptions`](../interfaces/generated_client.MetadataOptions.md)\> | -| `getNamedConfiguration` | (`key`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `updateConfiguration` | (`serverConfiguration`: [`ServerConfiguration`](../interfaces/generated_client.ServerConfiguration.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateMediaEncoderPath` | (`mediaEncoderPathDto`: [`MediaEncoderPathDto`](../interfaces/generated_client.MediaEncoderPathDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateNamedConfiguration` | (`key`: `string`, `body`: `any`, `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/configuration-api.ts:341](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L341) - -___ - -### ConfigurationApiFp - -▸ **ConfigurationApiFp**(`configuration?`): `Object` - -ConfigurationApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getConfiguration` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ServerConfiguration`](../interfaces/generated_client.ServerConfiguration.md)\>\> | -| `getDefaultMetadataOptions` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`MetadataOptions`](../interfaces/generated_client.MetadataOptions.md)\>\> | -| `getNamedConfiguration` | (`key`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `updateConfiguration` | (`serverConfiguration`: [`ServerConfiguration`](../interfaces/generated_client.ServerConfiguration.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateMediaEncoderPath` | (`mediaEncoderPathDto`: [`MediaEncoderPathDto`](../interfaces/generated_client.MediaEncoderPathDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateNamedConfiguration` | (`key`: `string`, `body`: `any`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/configuration-api.ts:266](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L266) - -___ - -### DashboardApiAxiosParamCreator - -▸ **DashboardApiAxiosParamCreator**(`configuration?`): `Object` - -DashboardApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getConfigurationPages` | (`enableInMainMenu?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDashboardConfigurationPage` | (`name?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/dashboard-api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dashboard-api.ts#L31) - -___ - -### DashboardApiFactory - -▸ **DashboardApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -DashboardApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getConfigurationPages` | (`enableInMainMenu?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`ConfigurationPageInfo`](../interfaces/generated_client.ConfigurationPageInfo.md)[]\> | -| `getDashboardConfigurationPage` | (`name?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | - -#### Defined in - -[generated-client/api/dashboard-api.ts:145](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dashboard-api.ts#L145) - -___ - -### DashboardApiFp - -▸ **DashboardApiFp**(`configuration?`): `Object` - -DashboardApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getConfigurationPages` | (`enableInMainMenu?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ConfigurationPageInfo`](../interfaces/generated_client.ConfigurationPageInfo.md)[]\>\> | -| `getDashboardConfigurationPage` | (`name?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | - -#### Defined in - -[generated-client/api/dashboard-api.ts:113](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dashboard-api.ts#L113) - -___ - -### DevicesApiAxiosParamCreator - -▸ **DevicesApiAxiosParamCreator**(`configuration?`): `Object` - -DevicesApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteDevice` | (`id`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDeviceInfo` | (`id`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDeviceOptions` | (`id`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDevices` | (`supportsSync?`: `boolean`, `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateDeviceOptions` | (`id`: `string`, `deviceOptionsDto`: [`DeviceOptionsDto`](../interfaces/generated_client.DeviceOptionsDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/devices-api.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L37) - -___ - -### DevicesApiFactory - -▸ **DevicesApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -DevicesApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteDevice` | (`id`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getDeviceInfo` | (`id`: `string`, `options?`: `any`) => `AxiosPromise`<[`DeviceInfo`](../interfaces/generated_client.DeviceInfo.md)\> | -| `getDeviceOptions` | (`id`: `string`, `options?`: `any`) => `AxiosPromise`<[`DeviceOptions`](../interfaces/generated_client.DeviceOptions.md)\> | -| `getDevices` | (`supportsSync?`: `boolean`, `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`DeviceInfoQueryResult`](../interfaces/generated_client.DeviceInfoQueryResult.md)\> | -| `updateDeviceOptions` | (`id`: `string`, `deviceOptionsDto`: [`DeviceOptionsDto`](../interfaces/generated_client.DeviceOptionsDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/devices-api.ts:322](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L322) - -___ - -### DevicesApiFp - -▸ **DevicesApiFp**(`configuration?`): `Object` - -DevicesApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteDevice` | (`id`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getDeviceInfo` | (`id`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`DeviceInfo`](../interfaces/generated_client.DeviceInfo.md)\>\> | -| `getDeviceOptions` | (`id`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`DeviceOptions`](../interfaces/generated_client.DeviceOptions.md)\>\> | -| `getDevices` | (`supportsSync?`: `boolean`, `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`DeviceInfoQueryResult`](../interfaces/generated_client.DeviceInfoQueryResult.md)\>\> | -| `updateDeviceOptions` | (`id`: `string`, `deviceOptionsDto`: [`DeviceOptionsDto`](../interfaces/generated_client.DeviceOptionsDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/devices-api.ts:255](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L255) - -___ - -### DisplayPreferencesApiAxiosParamCreator - -▸ **DisplayPreferencesApiAxiosParamCreator**(`configuration?`): `Object` - -DisplayPreferencesApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getDisplayPreferences` | (`displayPreferencesId`: `string`, `userId`: `string`, `client`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateDisplayPreferences` | (`displayPreferencesId`: `string`, `userId`: `string`, `client`: `string`, `displayPreferencesDto`: [`DisplayPreferencesDto`](../interfaces/generated_client.DisplayPreferencesDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/display-preferences-api.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L29) - -___ - -### DisplayPreferencesApiFactory - -▸ **DisplayPreferencesApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -DisplayPreferencesApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getDisplayPreferences` | (`displayPreferencesId`: `string`, `userId`: `string`, `client`: `string`, `options?`: `any`) => `AxiosPromise`<[`DisplayPreferencesDto`](../interfaces/generated_client.DisplayPreferencesDto.md)\> | -| `updateDisplayPreferences` | (`displayPreferencesId`: `string`, `userId`: `string`, `client`: `string`, `displayPreferencesDto`: [`DisplayPreferencesDto`](../interfaces/generated_client.DisplayPreferencesDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/display-preferences-api.ts:183](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L183) - -___ - -### DisplayPreferencesApiFp - -▸ **DisplayPreferencesApiFp**(`configuration?`): `Object` - -DisplayPreferencesApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getDisplayPreferences` | (`displayPreferencesId`: `string`, `userId`: `string`, `client`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`DisplayPreferencesDto`](../interfaces/generated_client.DisplayPreferencesDto.md)\>\> | -| `updateDisplayPreferences` | (`displayPreferencesId`: `string`, `userId`: `string`, `client`: `string`, `displayPreferencesDto`: [`DisplayPreferencesDto`](../interfaces/generated_client.DisplayPreferencesDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/display-preferences-api.ts:146](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L146) - -___ - -### DlnaApiAxiosParamCreator - -▸ **DlnaApiAxiosParamCreator**(`configuration?`): `Object` - -DlnaApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `createProfile` | (`deviceProfile?`: [`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `deleteProfile` | (`profileId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDefaultProfile` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getProfile` | (`profileId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getProfileInfos` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateProfile` | (`profileId`: `string`, `deviceProfile?`: [`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/dlna-api.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L33) - -___ - -### DlnaApiFactory - -▸ **DlnaApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -DlnaApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `createProfile` | (`deviceProfile?`: [`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `deleteProfile` | (`profileId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getDefaultProfile` | (`options?`: `any`) => `AxiosPromise`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md)\> | -| `getProfile` | (`profileId`: `string`, `options?`: `any`) => `AxiosPromise`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md)\> | -| `getProfileInfos` | (`options?`: `any`) => `AxiosPromise`<[`DeviceProfileInfo`](../interfaces/generated_client.DeviceProfileInfo.md)[]\> | -| `updateProfile` | (`profileId`: `string`, `deviceProfile?`: [`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/dlna-api.ts:335](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L335) - -___ - -### DlnaApiFp - -▸ **DlnaApiFp**(`configuration?`): `Object` - -DlnaApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `createProfile` | (`deviceProfile?`: [`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `deleteProfile` | (`profileId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getDefaultProfile` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md)\>\> | -| `getProfile` | (`profileId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md)\>\> | -| `getProfileInfos` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`DeviceProfileInfo`](../interfaces/generated_client.DeviceProfileInfo.md)[]\>\> | -| `updateProfile` | (`profileId`: `string`, `deviceProfile?`: [`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/dlna-api.ts:260](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L260) - -___ - -### DlnaServerApiAxiosParamCreator - -▸ **DlnaServerApiAxiosParamCreator**(`configuration?`): `Object` - -DlnaServerApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getConnectionManager` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getConnectionManager2` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getConnectionManager3` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getContentDirectory` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getContentDirectory2` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getContentDirectory3` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDescriptionXml` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDescriptionXml2` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getIcon` | (`fileName`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getIconId` | (`serverId`: `string`, `fileName`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMediaReceiverRegistrar` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMediaReceiverRegistrar2` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMediaReceiverRegistrar3` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `processConnectionManagerControlRequest` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `processContentDirectoryControlRequest` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `processMediaReceiverRegistrarControlRequest` | (`serverId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/dlna-server-api.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L29) - -___ - -### DlnaServerApiFactory - -▸ **DlnaServerApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -DlnaServerApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getConnectionManager` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getConnectionManager2` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getConnectionManager3` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getContentDirectory` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getContentDirectory2` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getContentDirectory3` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getDescriptionXml` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getDescriptionXml2` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getIcon` | (`fileName`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getIconId` | (`serverId`: `string`, `fileName`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getMediaReceiverRegistrar` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getMediaReceiverRegistrar2` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getMediaReceiverRegistrar3` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `processConnectionManagerControlRequest` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `processContentDirectoryControlRequest` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `processMediaReceiverRegistrarControlRequest` | (`serverId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | - -#### Defined in - -[generated-client/api/dlna-server-api.ts:821](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L821) - -___ - -### DlnaServerApiFp - -▸ **DlnaServerApiFp**(`configuration?`): `Object` - -DlnaServerApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getConnectionManager` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getConnectionManager2` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getConnectionManager3` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getContentDirectory` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getContentDirectory2` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getContentDirectory3` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getDescriptionXml` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getDescriptionXml2` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getIcon` | (`fileName`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getIconId` | (`serverId`: `string`, `fileName`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getMediaReceiverRegistrar` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getMediaReceiverRegistrar2` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getMediaReceiverRegistrar3` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `processConnectionManagerControlRequest` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `processContentDirectoryControlRequest` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `processMediaReceiverRegistrarControlRequest` | (`serverId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | - -#### Defined in - -[generated-client/api/dlna-server-api.ts:634](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L634) - -___ - -### DynamicHlsApiAxiosParamCreator - -▸ **DynamicHlsApiAxiosParamCreator**(`configuration?`): `Object` - -DynamicHlsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getHlsAudioSegment` | (`itemId`: `string`, `playlistId`: `string`, `segmentId`: `number`, `container`: `string`, `runtimeTicks`: `number`, `actualSegmentLengthTicks`: `number`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getHlsVideoSegment` | (`itemId`: `string`, `playlistId`: `string`, `segmentId`: `number`, `container`: `string`, `runtimeTicks`: `number`, `actualSegmentLengthTicks`: `number`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLiveHlsStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `maxWidth?`: `number`, `maxHeight?`: `number`, `enableSubtitlesInManifest?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMasterHlsAudioPlaylist` | (`itemId`: `string`, `mediaSourceId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `enableAdaptiveBitrateStreaming?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMasterHlsVideoPlaylist` | (`itemId`: `string`, `mediaSourceId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `enableAdaptiveBitrateStreaming?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getVariantHlsAudioPlaylist` | (`itemId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getVariantHlsVideoPlaylist` | (`itemId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headMasterHlsAudioPlaylist` | (`itemId`: `string`, `mediaSourceId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `enableAdaptiveBitrateStreaming?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headMasterHlsVideoPlaylist` | (`itemId`: `string`, `mediaSourceId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `enableAdaptiveBitrateStreaming?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L31) - -___ - -### DynamicHlsApiFactory - -▸ **DynamicHlsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -DynamicHlsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getHlsAudioSegment` | (`itemId`: `string`, `playlistId`: `string`, `segmentId`: `number`, `container`: `string`, `runtimeTicks`: `number`, `actualSegmentLengthTicks`: `number`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getHlsVideoSegment` | (`itemId`: `string`, `playlistId`: `string`, `segmentId`: `number`, `container`: `string`, `runtimeTicks`: `number`, `actualSegmentLengthTicks`: `number`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getLiveHlsStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `maxWidth?`: `number`, `maxHeight?`: `number`, `enableSubtitlesInManifest?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getMasterHlsAudioPlaylist` | (`itemId`: `string`, `mediaSourceId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `enableAdaptiveBitrateStreaming?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getMasterHlsVideoPlaylist` | (`itemId`: `string`, `mediaSourceId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `enableAdaptiveBitrateStreaming?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getVariantHlsAudioPlaylist` | (`itemId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getVariantHlsVideoPlaylist` | (`itemId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headMasterHlsAudioPlaylist` | (`itemId`: `string`, `mediaSourceId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `enableAdaptiveBitrateStreaming?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headMasterHlsVideoPlaylist` | (`itemId`: `string`, `mediaSourceId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `enableAdaptiveBitrateStreaming?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`any`\> | - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:3210](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L3210) - -___ - -### DynamicHlsApiFp - -▸ **DynamicHlsApiFp**(`configuration?`): `Object` - -DynamicHlsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getHlsAudioSegment` | (`itemId`: `string`, `playlistId`: `string`, `segmentId`: `number`, `container`: `string`, `runtimeTicks`: `number`, `actualSegmentLengthTicks`: `number`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getHlsVideoSegment` | (`itemId`: `string`, `playlistId`: `string`, `segmentId`: `number`, `container`: `string`, `runtimeTicks`: `number`, `actualSegmentLengthTicks`: `number`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getLiveHlsStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `maxWidth?`: `number`, `maxHeight?`: `number`, `enableSubtitlesInManifest?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getMasterHlsAudioPlaylist` | (`itemId`: `string`, `mediaSourceId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `enableAdaptiveBitrateStreaming?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getMasterHlsVideoPlaylist` | (`itemId`: `string`, `mediaSourceId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `enableAdaptiveBitrateStreaming?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getVariantHlsAudioPlaylist` | (`itemId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getVariantHlsVideoPlaylist` | (`itemId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headMasterHlsAudioPlaylist` | (`itemId`: `string`, `mediaSourceId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `enableAdaptiveBitrateStreaming?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headMasterHlsVideoPlaylist` | (`itemId`: `string`, `mediaSourceId`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `enableAdaptiveBitrateStreaming?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | - -#### Defined in - -[generated-client/api/dynamic-hls-api.ts:2648](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L2648) - -___ - -### EnvironmentApiAxiosParamCreator - -▸ **EnvironmentApiAxiosParamCreator**(`configuration?`): `Object` - -EnvironmentApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getDefaultDirectoryBrowser` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDirectoryContents` | (`path`: `string`, `includeFiles?`: `boolean`, `includeDirectories?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDrives` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getNetworkShares` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getParentPath` | (`path`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `validatePath` | (`validatePathDto`: [`ValidatePathDto`](../interfaces/generated_client.ValidatePathDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/environment-api.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L35) - -___ - -### EnvironmentApiFactory - -▸ **EnvironmentApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -EnvironmentApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getDefaultDirectoryBrowser` | (`options?`: `any`) => `AxiosPromise`<[`DefaultDirectoryBrowserInfoDto`](../interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md)\> | -| `getDirectoryContents` | (`path`: `string`, `includeFiles?`: `boolean`, `includeDirectories?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[]\> | -| `getDrives` | (`options?`: `any`) => `AxiosPromise`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[]\> | -| `getNetworkShares` | (`options?`: `any`) => `AxiosPromise`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[]\> | -| `getParentPath` | (`path`: `string`, `options?`: `any`) => `AxiosPromise`<`string`\> | -| `validatePath` | (`validatePathDto`: [`ValidatePathDto`](../interfaces/generated_client.ValidatePathDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/environment-api.ts:349](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L349) - -___ - -### EnvironmentApiFp - -▸ **EnvironmentApiFp**(`configuration?`): `Object` - -EnvironmentApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getDefaultDirectoryBrowser` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`DefaultDirectoryBrowserInfoDto`](../interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md)\>\> | -| `getDirectoryContents` | (`path`: `string`, `includeFiles?`: `boolean`, `includeDirectories?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[]\>\> | -| `getDrives` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[]\>\> | -| `getNetworkShares` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[]\>\> | -| `getParentPath` | (`path`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`\>\> | -| `validatePath` | (`validatePathDto`: [`ValidatePathDto`](../interfaces/generated_client.ValidatePathDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/environment-api.ts:273](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L273) - -___ - -### FilterApiAxiosParamCreator - -▸ **FilterApiAxiosParamCreator**(`configuration?`): `Object` - -FilterApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getQueryFilters` | (`userId?`: `string`, `parentId?`: `string`, `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isAiring?`: `boolean`, `isMovie?`: `boolean`, `isSports?`: `boolean`, `isKids?`: `boolean`, `isNews?`: `boolean`, `isSeries?`: `boolean`, `recursive?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getQueryFiltersLegacy` | (`userId?`: `string`, `parentId?`: `string`, `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `mediaTypes?`: `string`[], `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/filter-api.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L33) - -___ - -### FilterApiFactory - -▸ **FilterApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -FilterApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getQueryFilters` | (`userId?`: `string`, `parentId?`: `string`, `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isAiring?`: `boolean`, `isMovie?`: `boolean`, `isSports?`: `boolean`, `isKids?`: `boolean`, `isNews?`: `boolean`, `isSeries?`: `boolean`, `recursive?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`QueryFilters`](../interfaces/generated_client.QueryFilters.md)\> | -| `getQueryFiltersLegacy` | (`userId?`: `string`, `parentId?`: `string`, `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `mediaTypes?`: `string`[], `options?`: `any`) => `AxiosPromise`<[`QueryFiltersLegacy`](../interfaces/generated_client.QueryFiltersLegacy.md)\> | - -#### Defined in - -[generated-client/api/filter-api.ts:222](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L222) - -___ - -### FilterApiFp - -▸ **FilterApiFp**(`configuration?`): `Object` - -FilterApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getQueryFilters` | (`userId?`: `string`, `parentId?`: `string`, `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isAiring?`: `boolean`, `isMovie?`: `boolean`, `isSports?`: `boolean`, `isKids?`: `boolean`, `isNews?`: `boolean`, `isSeries?`: `boolean`, `recursive?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`QueryFilters`](../interfaces/generated_client.QueryFilters.md)\>\> | -| `getQueryFiltersLegacy` | (`userId?`: `string`, `parentId?`: `string`, `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `mediaTypes?`: `string`[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`QueryFiltersLegacy`](../interfaces/generated_client.QueryFiltersLegacy.md)\>\> | - -#### Defined in - -[generated-client/api/filter-api.ts:178](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L178) - -___ - -### GenresApiAxiosParamCreator - -▸ **GenresApiAxiosParamCreator**(`configuration?`): `Object` - -GenresApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getGenre` | (`genreName`: `string`, `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getGenres` | (`startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isFavorite?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/genres-api.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L39) - -___ - -### GenresApiFactory - -▸ **GenresApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -GenresApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getGenre` | (`genreName`: `string`, `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\> | -| `getGenres` | (`startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isFavorite?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/genres-api.ts:263](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L263) - -___ - -### GenresApiFp - -▸ **GenresApiFp**(`configuration?`): `Object` - -GenresApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getGenre` | (`genreName`: `string`, `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\> | -| `getGenres` | (`startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isFavorite?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/genres-api.ts:213](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L213) - -___ - -### HlsSegmentApiAxiosParamCreator - -▸ **HlsSegmentApiAxiosParamCreator**(`configuration?`): `Object` - -HlsSegmentApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getHlsAudioSegmentLegacyAac` | (`itemId`: `string`, `segmentId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getHlsAudioSegmentLegacyMp3` | (`itemId`: `string`, `segmentId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getHlsPlaylistLegacy` | (`itemId`: `string`, `playlistId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getHlsVideoSegmentLegacy` | (`itemId`: `string`, `playlistId`: `string`, `segmentId`: `string`, `segmentContainer`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `stopEncodingProcess` | (`deviceId`: `string`, `playSessionId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/hls-segment-api.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L29) - -___ - -### HlsSegmentApiFactory - -▸ **HlsSegmentApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -HlsSegmentApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getHlsAudioSegmentLegacyAac` | (`itemId`: `string`, `segmentId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getHlsAudioSegmentLegacyMp3` | (`itemId`: `string`, `segmentId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getHlsPlaylistLegacy` | (`itemId`: `string`, `playlistId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getHlsVideoSegmentLegacy` | (`itemId`: `string`, `playlistId`: `string`, `segmentId`: `string`, `segmentContainer`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `stopEncodingProcess` | (`deviceId`: `string`, `playSessionId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/hls-segment-api.ts:320](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L320) - -___ - -### HlsSegmentApiFp - -▸ **HlsSegmentApiFp**(`configuration?`): `Object` - -HlsSegmentApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getHlsAudioSegmentLegacyAac` | (`itemId`: `string`, `segmentId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getHlsAudioSegmentLegacyMp3` | (`itemId`: `string`, `segmentId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getHlsPlaylistLegacy` | (`itemId`: `string`, `playlistId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getHlsVideoSegmentLegacy` | (`itemId`: `string`, `playlistId`: `string`, `segmentId`: `string`, `segmentContainer`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `stopEncodingProcess` | (`deviceId`: `string`, `playSessionId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/hls-segment-api.ts:248](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L248) - -___ - -### ImageApiAxiosParamCreator - -▸ **ImageApiAxiosParamCreator**(`configuration?`): `Object` - -ImageApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteCustomSplashscreen` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `deleteItemImage` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `deleteItemImageByIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `deleteUserImage` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `index?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `deleteUserImageByIndex` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `index`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getArtistImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getGenreImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getGenreImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getItemImage` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `tag?`: `string`, `cropWhitespace?`: `boolean`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `addPlayedIndicator?`: `boolean`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getItemImage2` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `maxWidth`: `number`, `maxHeight`: `number`, `tag`: `string`, `format`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `percentPlayed`: `number`, `unplayedCount`: `number`, `imageIndex`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getItemImageByIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `tag?`: `string`, `cropWhitespace?`: `boolean`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `addPlayedIndicator?`: `boolean`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getItemImageInfos` | (`itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMusicGenreImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMusicGenreImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPersonImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPersonImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSplashscreen` | (`tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `quality?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getStudioImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getStudioImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getUserImage` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getUserImageByIndex` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headArtistImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headGenreImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headGenreImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headItemImage` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `tag?`: `string`, `cropWhitespace?`: `boolean`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `addPlayedIndicator?`: `boolean`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headItemImage2` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `maxWidth`: `number`, `maxHeight`: `number`, `tag`: `string`, `format`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `percentPlayed`: `number`, `unplayedCount`: `number`, `imageIndex`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headItemImageByIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `tag?`: `string`, `cropWhitespace?`: `boolean`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `addPlayedIndicator?`: `boolean`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headMusicGenreImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headMusicGenreImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headPersonImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headPersonImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headStudioImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headStudioImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headUserImage` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headUserImageByIndex` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `postUserImage` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `index?`: `number`, `body?`: `any`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `postUserImageByIndex` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `index`: `number`, `body?`: `any`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `setItemImage` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `body?`: `any`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `setItemImageByIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `body?`: `any`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateItemImageIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `newIndex`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `uploadCustomSplashscreen` | (`body?`: `any`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/image-api.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L35) - -___ - -### ImageApiFactory - -▸ **ImageApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ImageApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteCustomSplashscreen` | (`options?`: `any`) => `AxiosPromise`<`void`\> | -| `deleteItemImage` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `deleteItemImageByIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `deleteUserImage` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `index?`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `deleteUserImageByIndex` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `index`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getArtistImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getGenreImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getGenreImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getItemImage` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `tag?`: `string`, `cropWhitespace?`: `boolean`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `addPlayedIndicator?`: `boolean`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getItemImage2` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `maxWidth`: `number`, `maxHeight`: `number`, `tag`: `string`, `format`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `percentPlayed`: `number`, `unplayedCount`: `number`, `imageIndex`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getItemImageByIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `tag?`: `string`, `cropWhitespace?`: `boolean`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `addPlayedIndicator?`: `boolean`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getItemImageInfos` | (`itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`ImageInfo`](../interfaces/generated_client.ImageInfo.md)[]\> | -| `getMusicGenreImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getMusicGenreImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getPersonImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getPersonImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getSplashscreen` | (`tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `quality?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getStudioImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getStudioImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getUserImage` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getUserImageByIndex` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headArtistImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headGenreImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headGenreImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headItemImage` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `tag?`: `string`, `cropWhitespace?`: `boolean`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `addPlayedIndicator?`: `boolean`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headItemImage2` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `maxWidth`: `number`, `maxHeight`: `number`, `tag`: `string`, `format`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `percentPlayed`: `number`, `unplayedCount`: `number`, `imageIndex`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headItemImageByIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `tag?`: `string`, `cropWhitespace?`: `boolean`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `addPlayedIndicator?`: `boolean`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headMusicGenreImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headMusicGenreImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headPersonImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headPersonImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headStudioImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headStudioImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headUserImage` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headUserImageByIndex` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `postUserImage` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `index?`: `number`, `body?`: `any`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `postUserImageByIndex` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `index`: `number`, `body?`: `any`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `setItemImage` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `body?`: `any`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `setItemImageByIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `body?`: `any`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateItemImageIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `newIndex`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `uploadCustomSplashscreen` | (`body?`: `any`, `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/image-api.ts:5081](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L5081) - -___ - -### ImageApiFp - -▸ **ImageApiFp**(`configuration?`): `Object` - -ImageApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteCustomSplashscreen` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `deleteItemImage` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `deleteItemImageByIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `deleteUserImage` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `index?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `deleteUserImageByIndex` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `index`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getArtistImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getGenreImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getGenreImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getItemImage` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `tag?`: `string`, `cropWhitespace?`: `boolean`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `addPlayedIndicator?`: `boolean`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getItemImage2` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `maxWidth`: `number`, `maxHeight`: `number`, `tag`: `string`, `format`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `percentPlayed`: `number`, `unplayedCount`: `number`, `imageIndex`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getItemImageByIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `tag?`: `string`, `cropWhitespace?`: `boolean`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `addPlayedIndicator?`: `boolean`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getItemImageInfos` | (`itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ImageInfo`](../interfaces/generated_client.ImageInfo.md)[]\>\> | -| `getMusicGenreImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getMusicGenreImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getPersonImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getPersonImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getSplashscreen` | (`tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `quality?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getStudioImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getStudioImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getUserImage` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getUserImageByIndex` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headArtistImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headGenreImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headGenreImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headItemImage` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `tag?`: `string`, `cropWhitespace?`: `boolean`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `addPlayedIndicator?`: `boolean`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headItemImage2` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `maxWidth`: `number`, `maxHeight`: `number`, `tag`: `string`, `format`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `percentPlayed`: `number`, `unplayedCount`: `number`, `imageIndex`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headItemImageByIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `tag?`: `string`, `cropWhitespace?`: `boolean`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `addPlayedIndicator?`: `boolean`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headMusicGenreImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headMusicGenreImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headPersonImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headPersonImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headStudioImage` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headStudioImageByIndex` | (`name`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headUserImage` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `imageIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headUserImageByIndex` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `tag?`: `string`, `format?`: [`ImageFormat`](../enums/generated_client.ImageFormat.md), `maxWidth?`: `number`, `maxHeight?`: `number`, `percentPlayed?`: `number`, `unplayedCount?`: `number`, `width?`: `number`, `height?`: `number`, `quality?`: `number`, `fillWidth?`: `number`, `fillHeight?`: `number`, `cropWhitespace?`: `boolean`, `addPlayedIndicator?`: `boolean`, `blur?`: `number`, `backgroundColor?`: `string`, `foregroundLayer?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `postUserImage` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `index?`: `number`, `body?`: `any`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `postUserImageByIndex` | (`userId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `index`: `number`, `body?`: `any`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `setItemImage` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `body?`: `any`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `setItemImageByIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `body?`: `any`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateItemImageIndex` | (`itemId`: `string`, `imageType`: [`ImageType`](../enums/generated_client.ImageType.md), `imageIndex`: `number`, `newIndex`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `uploadCustomSplashscreen` | (`body?`: `any`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/image-api.ts:4084](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-api.ts#L4084) - -___ - -### ImageByNameApiAxiosParamCreator - -▸ **ImageByNameApiAxiosParamCreator**(`configuration?`): `Object` - -ImageByNameApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getGeneralImage` | (`name`: `string`, `type`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getGeneralImages` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMediaInfoImage` | (`theme`: `string`, `name`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMediaInfoImages` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRatingImage` | (`theme`: `string`, `name`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRatingImages` | (`options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/image-by-name-api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L31) - -___ - -### ImageByNameApiFactory - -▸ **ImageByNameApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ImageByNameApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getGeneralImage` | (`name`: `string`, `type`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getGeneralImages` | (`options?`: `any`) => `AxiosPromise`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[]\> | -| `getMediaInfoImage` | (`theme`: `string`, `name`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getMediaInfoImages` | (`options?`: `any`) => `AxiosPromise`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[]\> | -| `getRatingImage` | (`theme`: `string`, `name`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getRatingImages` | (`options?`: `any`) => `AxiosPromise`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[]\> | - -#### Defined in - -[generated-client/api/image-by-name-api.ts:329](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L329) - -___ - -### ImageByNameApiFp - -▸ **ImageByNameApiFp**(`configuration?`): `Object` - -ImageByNameApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getGeneralImage` | (`name`: `string`, `type`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getGeneralImages` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[]\>\> | -| `getMediaInfoImage` | (`theme`: `string`, `name`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getMediaInfoImages` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[]\>\> | -| `getRatingImage` | (`theme`: `string`, `name`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getRatingImages` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[]\>\> | - -#### Defined in - -[generated-client/api/image-by-name-api.ts:253](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L253) - -___ - -### InstantMixApiAxiosParamCreator - -▸ **InstantMixApiAxiosParamCreator**(`configuration?`): `Object` - -InstantMixApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getInstantMixFromAlbum` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getInstantMixFromArtists` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getInstantMixFromArtists2` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getInstantMixFromItem` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getInstantMixFromMusicGenreById` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getInstantMixFromMusicGenreByName` | (`name`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getInstantMixFromPlaylist` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getInstantMixFromSong` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/instant-mix-api.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L33) - -___ - -### InstantMixApiFactory - -▸ **InstantMixApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -InstantMixApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getInstantMixFromAlbum` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getInstantMixFromArtists` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getInstantMixFromArtists2` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getInstantMixFromItem` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getInstantMixFromMusicGenreById` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getInstantMixFromMusicGenreByName` | (`name`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getInstantMixFromPlaylist` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getInstantMixFromSong` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/instant-mix-api.ts:780](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L780) - -___ - -### InstantMixApiFp - -▸ **InstantMixApiFp**(`configuration?`): `Object` - -InstantMixApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getInstantMixFromAlbum` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getInstantMixFromArtists` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getInstantMixFromArtists2` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getInstantMixFromItem` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getInstantMixFromMusicGenreById` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getInstantMixFromMusicGenreByName` | (`name`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getInstantMixFromPlaylist` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getInstantMixFromSong` | (`id`: `string`, `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/instant-mix-api.ts:625](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L625) - -___ - -### ItemLookupApiAxiosParamCreator - -▸ **ItemLookupApiAxiosParamCreator**(`configuration?`): `Object` - -ItemLookupApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `applySearchCriteria` | (`itemId`: `string`, `remoteSearchResult`: [`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md), `replaceAllImages?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getBookRemoteSearchResults` | (`bookInfoRemoteSearchQuery`: [`BookInfoRemoteSearchQuery`](../interfaces/generated_client.BookInfoRemoteSearchQuery.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getBoxSetRemoteSearchResults` | (`boxSetInfoRemoteSearchQuery`: [`BoxSetInfoRemoteSearchQuery`](../interfaces/generated_client.BoxSetInfoRemoteSearchQuery.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getExternalIdInfos` | (`itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMovieRemoteSearchResults` | (`movieInfoRemoteSearchQuery`: [`MovieInfoRemoteSearchQuery`](../interfaces/generated_client.MovieInfoRemoteSearchQuery.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMusicAlbumRemoteSearchResults` | (`albumInfoRemoteSearchQuery`: [`AlbumInfoRemoteSearchQuery`](../interfaces/generated_client.AlbumInfoRemoteSearchQuery.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMusicArtistRemoteSearchResults` | (`artistInfoRemoteSearchQuery`: [`ArtistInfoRemoteSearchQuery`](../interfaces/generated_client.ArtistInfoRemoteSearchQuery.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMusicVideoRemoteSearchResults` | (`musicVideoInfoRemoteSearchQuery`: [`MusicVideoInfoRemoteSearchQuery`](../interfaces/generated_client.MusicVideoInfoRemoteSearchQuery.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPersonRemoteSearchResults` | (`personLookupInfoRemoteSearchQuery`: [`PersonLookupInfoRemoteSearchQuery`](../interfaces/generated_client.PersonLookupInfoRemoteSearchQuery.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSeriesRemoteSearchResults` | (`seriesInfoRemoteSearchQuery`: [`SeriesInfoRemoteSearchQuery`](../interfaces/generated_client.SeriesInfoRemoteSearchQuery.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getTrailerRemoteSearchResults` | (`trailerInfoRemoteSearchQuery`: [`TrailerInfoRemoteSearchQuery`](../interfaces/generated_client.TrailerInfoRemoteSearchQuery.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/item-lookup-api.ts:51](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L51) - -___ - -### ItemLookupApiFactory - -▸ **ItemLookupApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ItemLookupApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `applySearchCriteria` | (`itemId`: `string`, `remoteSearchResult`: [`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md), `replaceAllImages?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getBookRemoteSearchResults` | (`bookInfoRemoteSearchQuery`: [`BookInfoRemoteSearchQuery`](../interfaces/generated_client.BookInfoRemoteSearchQuery.md), `options?`: `any`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\> | -| `getBoxSetRemoteSearchResults` | (`boxSetInfoRemoteSearchQuery`: [`BoxSetInfoRemoteSearchQuery`](../interfaces/generated_client.BoxSetInfoRemoteSearchQuery.md), `options?`: `any`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\> | -| `getExternalIdInfos` | (`itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`ExternalIdInfo`](../interfaces/generated_client.ExternalIdInfo.md)[]\> | -| `getMovieRemoteSearchResults` | (`movieInfoRemoteSearchQuery`: [`MovieInfoRemoteSearchQuery`](../interfaces/generated_client.MovieInfoRemoteSearchQuery.md), `options?`: `any`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\> | -| `getMusicAlbumRemoteSearchResults` | (`albumInfoRemoteSearchQuery`: [`AlbumInfoRemoteSearchQuery`](../interfaces/generated_client.AlbumInfoRemoteSearchQuery.md), `options?`: `any`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\> | -| `getMusicArtistRemoteSearchResults` | (`artistInfoRemoteSearchQuery`: [`ArtistInfoRemoteSearchQuery`](../interfaces/generated_client.ArtistInfoRemoteSearchQuery.md), `options?`: `any`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\> | -| `getMusicVideoRemoteSearchResults` | (`musicVideoInfoRemoteSearchQuery`: [`MusicVideoInfoRemoteSearchQuery`](../interfaces/generated_client.MusicVideoInfoRemoteSearchQuery.md), `options?`: `any`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\> | -| `getPersonRemoteSearchResults` | (`personLookupInfoRemoteSearchQuery`: [`PersonLookupInfoRemoteSearchQuery`](../interfaces/generated_client.PersonLookupInfoRemoteSearchQuery.md), `options?`: `any`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\> | -| `getSeriesRemoteSearchResults` | (`seriesInfoRemoteSearchQuery`: [`SeriesInfoRemoteSearchQuery`](../interfaces/generated_client.SeriesInfoRemoteSearchQuery.md), `options?`: `any`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\> | -| `getTrailerRemoteSearchResults` | (`trailerInfoRemoteSearchQuery`: [`TrailerInfoRemoteSearchQuery`](../interfaces/generated_client.TrailerInfoRemoteSearchQuery.md), `options?`: `any`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\> | - -#### Defined in - -[generated-client/api/item-lookup-api.ts:629](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L629) - -___ - -### ItemLookupApiFp - -▸ **ItemLookupApiFp**(`configuration?`): `Object` - -ItemLookupApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `applySearchCriteria` | (`itemId`: `string`, `remoteSearchResult`: [`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md), `replaceAllImages?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getBookRemoteSearchResults` | (`bookInfoRemoteSearchQuery`: [`BookInfoRemoteSearchQuery`](../interfaces/generated_client.BookInfoRemoteSearchQuery.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\> | -| `getBoxSetRemoteSearchResults` | (`boxSetInfoRemoteSearchQuery`: [`BoxSetInfoRemoteSearchQuery`](../interfaces/generated_client.BoxSetInfoRemoteSearchQuery.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\> | -| `getExternalIdInfos` | (`itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ExternalIdInfo`](../interfaces/generated_client.ExternalIdInfo.md)[]\>\> | -| `getMovieRemoteSearchResults` | (`movieInfoRemoteSearchQuery`: [`MovieInfoRemoteSearchQuery`](../interfaces/generated_client.MovieInfoRemoteSearchQuery.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\> | -| `getMusicAlbumRemoteSearchResults` | (`albumInfoRemoteSearchQuery`: [`AlbumInfoRemoteSearchQuery`](../interfaces/generated_client.AlbumInfoRemoteSearchQuery.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\> | -| `getMusicArtistRemoteSearchResults` | (`artistInfoRemoteSearchQuery`: [`ArtistInfoRemoteSearchQuery`](../interfaces/generated_client.ArtistInfoRemoteSearchQuery.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\> | -| `getMusicVideoRemoteSearchResults` | (`musicVideoInfoRemoteSearchQuery`: [`MusicVideoInfoRemoteSearchQuery`](../interfaces/generated_client.MusicVideoInfoRemoteSearchQuery.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\> | -| `getPersonRemoteSearchResults` | (`personLookupInfoRemoteSearchQuery`: [`PersonLookupInfoRemoteSearchQuery`](../interfaces/generated_client.PersonLookupInfoRemoteSearchQuery.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\> | -| `getSeriesRemoteSearchResults` | (`seriesInfoRemoteSearchQuery`: [`SeriesInfoRemoteSearchQuery`](../interfaces/generated_client.SeriesInfoRemoteSearchQuery.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\> | -| `getTrailerRemoteSearchResults` | (`trailerInfoRemoteSearchQuery`: [`TrailerInfoRemoteSearchQuery`](../interfaces/generated_client.TrailerInfoRemoteSearchQuery.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\> | - -#### Defined in - -[generated-client/api/item-lookup-api.ts:496](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L496) - -___ - -### ItemRefreshApiAxiosParamCreator - -▸ **ItemRefreshApiAxiosParamCreator**(`configuration?`): `Object` - -ItemRefreshApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `refreshItem` | (`itemId`: `string`, `metadataRefreshMode?`: [`MetadataRefreshMode`](../enums/generated_client.MetadataRefreshMode.md), `imageRefreshMode?`: [`MetadataRefreshMode`](../enums/generated_client.MetadataRefreshMode.md), `replaceAllMetadata?`: `boolean`, `replaceAllImages?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/item-refresh-api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-refresh-api.ts#L31) - -___ - -### ItemRefreshApiFactory - -▸ **ItemRefreshApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ItemRefreshApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `refreshItem` | (`itemId`: `string`, `metadataRefreshMode?`: [`MetadataRefreshMode`](../enums/generated_client.MetadataRefreshMode.md), `imageRefreshMode?`: [`MetadataRefreshMode`](../enums/generated_client.MetadataRefreshMode.md), `replaceAllMetadata?`: `boolean`, `replaceAllImages?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/item-refresh-api.ts:122](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-refresh-api.ts#L122) - -___ - -### ItemRefreshApiFp - -▸ **ItemRefreshApiFp**(`configuration?`): `Object` - -ItemRefreshApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `refreshItem` | (`itemId`: `string`, `metadataRefreshMode?`: [`MetadataRefreshMode`](../enums/generated_client.MetadataRefreshMode.md), `imageRefreshMode?`: [`MetadataRefreshMode`](../enums/generated_client.MetadataRefreshMode.md), `replaceAllMetadata?`: `boolean`, `replaceAllImages?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/item-refresh-api.ts:97](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-refresh-api.ts#L97) - -___ - -### ItemUpdateApiAxiosParamCreator - -▸ **ItemUpdateApiAxiosParamCreator**(`configuration?`): `Object` - -ItemUpdateApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getMetadataEditorInfo` | (`itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateItem` | (`itemId`: `string`, `baseItemDto`: [`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateItemContentType` | (`itemId`: `string`, `contentType?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/item-update-api.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L33) - -___ - -### ItemUpdateApiFactory - -▸ **ItemUpdateApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ItemUpdateApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getMetadataEditorInfo` | (`itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`MetadataEditorInfo`](../interfaces/generated_client.MetadataEditorInfo.md)\> | -| `updateItem` | (`itemId`: `string`, `baseItemDto`: [`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateItemContentType` | (`itemId`: `string`, `contentType?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/item-update-api.ts:209](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L209) - -___ - -### ItemUpdateApiFp - -▸ **ItemUpdateApiFp**(`configuration?`): `Object` - -ItemUpdateApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getMetadataEditorInfo` | (`itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`MetadataEditorInfo`](../interfaces/generated_client.MetadataEditorInfo.md)\>\> | -| `updateItem` | (`itemId`: `string`, `baseItemDto`: [`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateItemContentType` | (`itemId`: `string`, `contentType?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/item-update-api.ts:164](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L164) - -___ - -### ItemsApiAxiosParamCreator - -▸ **ItemsApiAxiosParamCreator**(`configuration?`): `Object` - -ItemsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getItems` | (`userId?`: `string`, `maxOfficialRating?`: `string`, `hasThemeSong?`: `boolean`, `hasThemeVideo?`: `boolean`, `hasSubtitles?`: `boolean`, `hasSpecialFeature?`: `boolean`, `hasTrailer?`: `boolean`, `adjacentTo?`: `string`, `parentIndexNumber?`: `number`, `hasParentalRating?`: `boolean`, `isHd?`: `boolean`, `is4K?`: `boolean`, `locationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `excludeLocationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `isMissing?`: `boolean`, `isUnaired?`: `boolean`, `minCommunityRating?`: `number`, `minCriticRating?`: `number`, `minPremiereDate?`: `string`, `minDateLastSaved?`: `string`, `minDateLastSavedForUser?`: `string`, `maxPremiereDate?`: `string`, `hasOverview?`: `boolean`, `hasImdbId?`: `boolean`, `hasTmdbId?`: `boolean`, `hasTvdbId?`: `boolean`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `excludeItemIds?`: `string`[], `startIndex?`: `number`, `limit?`: `number`, `recursive?`: `boolean`, `searchTerm?`: `string`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `imageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `sortBy?`: `string`[], `isPlayed?`: `boolean`, `genres?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `artists?`: `string`[], `excludeArtistIds?`: `string`[], `artistIds?`: `string`[], `albumArtistIds?`: `string`[], `contributingArtistIds?`: `string`[], `albums?`: `string`[], `albumIds?`: `string`[], `ids?`: `string`[], `videoTypes?`: [`VideoType`](../enums/generated_client.VideoType.md)[], `minOfficialRating?`: `string`, `isLocked?`: `boolean`, `isPlaceHolder?`: `boolean`, `hasOfficialRating?`: `boolean`, `collapseBoxSetItems?`: `boolean`, `minWidth?`: `number`, `minHeight?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `is3D?`: `boolean`, `seriesStatus?`: [`SeriesStatus`](../enums/generated_client.SeriesStatus.md)[], `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `studioIds?`: `string`[], `genreIds?`: `string`[], `enableTotalRecordCount?`: `boolean`, `enableImages?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getItemsByUserId` | (`userId`: `string`, `maxOfficialRating?`: `string`, `hasThemeSong?`: `boolean`, `hasThemeVideo?`: `boolean`, `hasSubtitles?`: `boolean`, `hasSpecialFeature?`: `boolean`, `hasTrailer?`: `boolean`, `adjacentTo?`: `string`, `parentIndexNumber?`: `number`, `hasParentalRating?`: `boolean`, `isHd?`: `boolean`, `is4K?`: `boolean`, `locationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `excludeLocationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `isMissing?`: `boolean`, `isUnaired?`: `boolean`, `minCommunityRating?`: `number`, `minCriticRating?`: `number`, `minPremiereDate?`: `string`, `minDateLastSaved?`: `string`, `minDateLastSavedForUser?`: `string`, `maxPremiereDate?`: `string`, `hasOverview?`: `boolean`, `hasImdbId?`: `boolean`, `hasTmdbId?`: `boolean`, `hasTvdbId?`: `boolean`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `excludeItemIds?`: `string`[], `startIndex?`: `number`, `limit?`: `number`, `recursive?`: `boolean`, `searchTerm?`: `string`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `imageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `sortBy?`: `string`[], `isPlayed?`: `boolean`, `genres?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `artists?`: `string`[], `excludeArtistIds?`: `string`[], `artistIds?`: `string`[], `albumArtistIds?`: `string`[], `contributingArtistIds?`: `string`[], `albums?`: `string`[], `albumIds?`: `string`[], `ids?`: `string`[], `videoTypes?`: [`VideoType`](../enums/generated_client.VideoType.md)[], `minOfficialRating?`: `string`, `isLocked?`: `boolean`, `isPlaceHolder?`: `boolean`, `hasOfficialRating?`: `boolean`, `collapseBoxSetItems?`: `boolean`, `minWidth?`: `number`, `minHeight?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `is3D?`: `boolean`, `seriesStatus?`: [`SeriesStatus`](../enums/generated_client.SeriesStatus.md)[], `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `studioIds?`: `string`[], `genreIds?`: `string`[], `enableTotalRecordCount?`: `boolean`, `enableImages?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getResumeItems` | (`userId`: `string`, `startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `mediaTypes?`: `string`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `enableTotalRecordCount?`: `boolean`, `enableImages?`: `boolean`, `excludeActiveSessions?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/items-api.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L45) - -___ - -### ItemsApiFactory - -▸ **ItemsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ItemsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getItems` | (`userId?`: `string`, `maxOfficialRating?`: `string`, `hasThemeSong?`: `boolean`, `hasThemeVideo?`: `boolean`, `hasSubtitles?`: `boolean`, `hasSpecialFeature?`: `boolean`, `hasTrailer?`: `boolean`, `adjacentTo?`: `string`, `parentIndexNumber?`: `number`, `hasParentalRating?`: `boolean`, `isHd?`: `boolean`, `is4K?`: `boolean`, `locationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `excludeLocationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `isMissing?`: `boolean`, `isUnaired?`: `boolean`, `minCommunityRating?`: `number`, `minCriticRating?`: `number`, `minPremiereDate?`: `string`, `minDateLastSaved?`: `string`, `minDateLastSavedForUser?`: `string`, `maxPremiereDate?`: `string`, `hasOverview?`: `boolean`, `hasImdbId?`: `boolean`, `hasTmdbId?`: `boolean`, `hasTvdbId?`: `boolean`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `excludeItemIds?`: `string`[], `startIndex?`: `number`, `limit?`: `number`, `recursive?`: `boolean`, `searchTerm?`: `string`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `imageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `sortBy?`: `string`[], `isPlayed?`: `boolean`, `genres?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `artists?`: `string`[], `excludeArtistIds?`: `string`[], `artistIds?`: `string`[], `albumArtistIds?`: `string`[], `contributingArtistIds?`: `string`[], `albums?`: `string`[], `albumIds?`: `string`[], `ids?`: `string`[], `videoTypes?`: [`VideoType`](../enums/generated_client.VideoType.md)[], `minOfficialRating?`: `string`, `isLocked?`: `boolean`, `isPlaceHolder?`: `boolean`, `hasOfficialRating?`: `boolean`, `collapseBoxSetItems?`: `boolean`, `minWidth?`: `number`, `minHeight?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `is3D?`: `boolean`, `seriesStatus?`: [`SeriesStatus`](../enums/generated_client.SeriesStatus.md)[], `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `studioIds?`: `string`[], `genreIds?`: `string`[], `enableTotalRecordCount?`: `boolean`, `enableImages?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getItemsByUserId` | (`userId`: `string`, `maxOfficialRating?`: `string`, `hasThemeSong?`: `boolean`, `hasThemeVideo?`: `boolean`, `hasSubtitles?`: `boolean`, `hasSpecialFeature?`: `boolean`, `hasTrailer?`: `boolean`, `adjacentTo?`: `string`, `parentIndexNumber?`: `number`, `hasParentalRating?`: `boolean`, `isHd?`: `boolean`, `is4K?`: `boolean`, `locationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `excludeLocationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `isMissing?`: `boolean`, `isUnaired?`: `boolean`, `minCommunityRating?`: `number`, `minCriticRating?`: `number`, `minPremiereDate?`: `string`, `minDateLastSaved?`: `string`, `minDateLastSavedForUser?`: `string`, `maxPremiereDate?`: `string`, `hasOverview?`: `boolean`, `hasImdbId?`: `boolean`, `hasTmdbId?`: `boolean`, `hasTvdbId?`: `boolean`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `excludeItemIds?`: `string`[], `startIndex?`: `number`, `limit?`: `number`, `recursive?`: `boolean`, `searchTerm?`: `string`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `imageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `sortBy?`: `string`[], `isPlayed?`: `boolean`, `genres?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `artists?`: `string`[], `excludeArtistIds?`: `string`[], `artistIds?`: `string`[], `albumArtistIds?`: `string`[], `contributingArtistIds?`: `string`[], `albums?`: `string`[], `albumIds?`: `string`[], `ids?`: `string`[], `videoTypes?`: [`VideoType`](../enums/generated_client.VideoType.md)[], `minOfficialRating?`: `string`, `isLocked?`: `boolean`, `isPlaceHolder?`: `boolean`, `hasOfficialRating?`: `boolean`, `collapseBoxSetItems?`: `boolean`, `minWidth?`: `number`, `minHeight?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `is3D?`: `boolean`, `seriesStatus?`: [`SeriesStatus`](../enums/generated_client.SeriesStatus.md)[], `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `studioIds?`: `string`[], `genreIds?`: `string`[], `enableTotalRecordCount?`: `boolean`, `enableImages?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getResumeItems` | (`userId`: `string`, `startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `mediaTypes?`: `string`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `enableTotalRecordCount?`: `boolean`, `enableImages?`: `boolean`, `excludeActiveSessions?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/items-api.ts:1317](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1317) - -___ - -### ItemsApiFp - -▸ **ItemsApiFp**(`configuration?`): `Object` - -ItemsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getItems` | (`userId?`: `string`, `maxOfficialRating?`: `string`, `hasThemeSong?`: `boolean`, `hasThemeVideo?`: `boolean`, `hasSubtitles?`: `boolean`, `hasSpecialFeature?`: `boolean`, `hasTrailer?`: `boolean`, `adjacentTo?`: `string`, `parentIndexNumber?`: `number`, `hasParentalRating?`: `boolean`, `isHd?`: `boolean`, `is4K?`: `boolean`, `locationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `excludeLocationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `isMissing?`: `boolean`, `isUnaired?`: `boolean`, `minCommunityRating?`: `number`, `minCriticRating?`: `number`, `minPremiereDate?`: `string`, `minDateLastSaved?`: `string`, `minDateLastSavedForUser?`: `string`, `maxPremiereDate?`: `string`, `hasOverview?`: `boolean`, `hasImdbId?`: `boolean`, `hasTmdbId?`: `boolean`, `hasTvdbId?`: `boolean`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `excludeItemIds?`: `string`[], `startIndex?`: `number`, `limit?`: `number`, `recursive?`: `boolean`, `searchTerm?`: `string`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `imageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `sortBy?`: `string`[], `isPlayed?`: `boolean`, `genres?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `artists?`: `string`[], `excludeArtistIds?`: `string`[], `artistIds?`: `string`[], `albumArtistIds?`: `string`[], `contributingArtistIds?`: `string`[], `albums?`: `string`[], `albumIds?`: `string`[], `ids?`: `string`[], `videoTypes?`: [`VideoType`](../enums/generated_client.VideoType.md)[], `minOfficialRating?`: `string`, `isLocked?`: `boolean`, `isPlaceHolder?`: `boolean`, `hasOfficialRating?`: `boolean`, `collapseBoxSetItems?`: `boolean`, `minWidth?`: `number`, `minHeight?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `is3D?`: `boolean`, `seriesStatus?`: [`SeriesStatus`](../enums/generated_client.SeriesStatus.md)[], `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `studioIds?`: `string`[], `genreIds?`: `string`[], `enableTotalRecordCount?`: `boolean`, `enableImages?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getItemsByUserId` | (`userId`: `string`, `maxOfficialRating?`: `string`, `hasThemeSong?`: `boolean`, `hasThemeVideo?`: `boolean`, `hasSubtitles?`: `boolean`, `hasSpecialFeature?`: `boolean`, `hasTrailer?`: `boolean`, `adjacentTo?`: `string`, `parentIndexNumber?`: `number`, `hasParentalRating?`: `boolean`, `isHd?`: `boolean`, `is4K?`: `boolean`, `locationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `excludeLocationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `isMissing?`: `boolean`, `isUnaired?`: `boolean`, `minCommunityRating?`: `number`, `minCriticRating?`: `number`, `minPremiereDate?`: `string`, `minDateLastSaved?`: `string`, `minDateLastSavedForUser?`: `string`, `maxPremiereDate?`: `string`, `hasOverview?`: `boolean`, `hasImdbId?`: `boolean`, `hasTmdbId?`: `boolean`, `hasTvdbId?`: `boolean`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `excludeItemIds?`: `string`[], `startIndex?`: `number`, `limit?`: `number`, `recursive?`: `boolean`, `searchTerm?`: `string`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `imageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `sortBy?`: `string`[], `isPlayed?`: `boolean`, `genres?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `artists?`: `string`[], `excludeArtistIds?`: `string`[], `artistIds?`: `string`[], `albumArtistIds?`: `string`[], `contributingArtistIds?`: `string`[], `albums?`: `string`[], `albumIds?`: `string`[], `ids?`: `string`[], `videoTypes?`: [`VideoType`](../enums/generated_client.VideoType.md)[], `minOfficialRating?`: `string`, `isLocked?`: `boolean`, `isPlaceHolder?`: `boolean`, `hasOfficialRating?`: `boolean`, `collapseBoxSetItems?`: `boolean`, `minWidth?`: `number`, `minHeight?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `is3D?`: `boolean`, `seriesStatus?`: [`SeriesStatus`](../enums/generated_client.SeriesStatus.md)[], `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `studioIds?`: `string`[], `genreIds?`: `string`[], `enableTotalRecordCount?`: `boolean`, `enableImages?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getResumeItems` | (`userId`: `string`, `startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `mediaTypes?`: `string`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `enableTotalRecordCount?`: `boolean`, `enableImages?`: `boolean`, `excludeActiveSessions?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/items-api.ts:1092](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L1092) - -___ - -### LibraryApiAxiosParamCreator - -▸ **LibraryApiAxiosParamCreator**(`configuration?`): `Object` - -LibraryApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteItem` | (`itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `deleteItems` | (`ids?`: `string`[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getAncestors` | (`itemId`: `string`, `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getCriticReviews` | (`itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDownload` | (`itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getFile` | (`itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getItemCounts` | (`userId?`: `string`, `isFavorite?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLibraryOptionsInfo` | (`libraryContentType?`: `string`, `isNewLibrary?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMediaFolders` | (`isHidden?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPhysicalPaths` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSimilarAlbums` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSimilarArtists` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSimilarItems` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSimilarMovies` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSimilarShows` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSimilarTrailers` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getThemeMedia` | (`itemId`: `string`, `userId?`: `string`, `inheritFromParent?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getThemeSongs` | (`itemId`: `string`, `userId?`: `string`, `inheritFromParent?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getThemeVideos` | (`itemId`: `string`, `userId?`: `string`, `inheritFromParent?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `postAddedMovies` | (`tmdbId?`: `string`, `imdbId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `postAddedSeries` | (`tvdbId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `postUpdatedMedia` | (`mediaUpdateInfoDto`: [`MediaUpdateInfoDto`](../interfaces/generated_client.MediaUpdateInfoDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `postUpdatedMovies` | (`tmdbId?`: `string`, `imdbId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `postUpdatedSeries` | (`tvdbId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `refreshLibrary` | (`options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/library-api.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L45) - -___ - -### LibraryApiFactory - -▸ **LibraryApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -LibraryApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteItem` | (`itemId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `deleteItems` | (`ids?`: `string`[], `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getAncestors` | (`itemId`: `string`, `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[]\> | -| `getCriticReviews` | (`itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getDownload` | (`itemId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getFile` | (`itemId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getItemCounts` | (`userId?`: `string`, `isFavorite?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`ItemCounts`](../interfaces/generated_client.ItemCounts.md)\> | -| `getLibraryOptionsInfo` | (`libraryContentType?`: `string`, `isNewLibrary?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`LibraryOptionsResultDto`](../interfaces/generated_client.LibraryOptionsResultDto.md)\> | -| `getMediaFolders` | (`isHidden?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getPhysicalPaths` | (`options?`: `any`) => `AxiosPromise`<`string`[]\> | -| `getSimilarAlbums` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getSimilarArtists` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getSimilarItems` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getSimilarMovies` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getSimilarShows` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getSimilarTrailers` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getThemeMedia` | (`itemId`: `string`, `userId?`: `string`, `inheritFromParent?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`AllThemeMediaResult`](../interfaces/generated_client.AllThemeMediaResult.md)\> | -| `getThemeSongs` | (`itemId`: `string`, `userId?`: `string`, `inheritFromParent?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md)\> | -| `getThemeVideos` | (`itemId`: `string`, `userId?`: `string`, `inheritFromParent?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md)\> | -| `postAddedMovies` | (`tmdbId?`: `string`, `imdbId?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `postAddedSeries` | (`tvdbId?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `postUpdatedMedia` | (`mediaUpdateInfoDto`: [`MediaUpdateInfoDto`](../interfaces/generated_client.MediaUpdateInfoDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `postUpdatedMovies` | (`tmdbId?`: `string`, `imdbId?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `postUpdatedSeries` | (`tvdbId?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `refreshLibrary` | (`options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/library-api.ts:1476](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1476) - -___ - -### LibraryApiFp - -▸ **LibraryApiFp**(`configuration?`): `Object` - -LibraryApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteItem` | (`itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `deleteItems` | (`ids?`: `string`[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getAncestors` | (`itemId`: `string`, `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[]\>\> | -| `getCriticReviews` | (`itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getDownload` | (`itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getFile` | (`itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getItemCounts` | (`userId?`: `string`, `isFavorite?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ItemCounts`](../interfaces/generated_client.ItemCounts.md)\>\> | -| `getLibraryOptionsInfo` | (`libraryContentType?`: `string`, `isNewLibrary?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`LibraryOptionsResultDto`](../interfaces/generated_client.LibraryOptionsResultDto.md)\>\> | -| `getMediaFolders` | (`isHidden?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getPhysicalPaths` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`[]\>\> | -| `getSimilarAlbums` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getSimilarArtists` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getSimilarItems` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getSimilarMovies` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getSimilarShows` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getSimilarTrailers` | (`itemId`: `string`, `excludeArtistIds?`: `string`[], `userId?`: `string`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getThemeMedia` | (`itemId`: `string`, `userId?`: `string`, `inheritFromParent?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`AllThemeMediaResult`](../interfaces/generated_client.AllThemeMediaResult.md)\>\> | -| `getThemeSongs` | (`itemId`: `string`, `userId?`: `string`, `inheritFromParent?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md)\>\> | -| `getThemeVideos` | (`itemId`: `string`, `userId?`: `string`, `inheritFromParent?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md)\>\> | -| `postAddedMovies` | (`tmdbId?`: `string`, `imdbId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `postAddedSeries` | (`tvdbId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `postUpdatedMedia` | (`mediaUpdateInfoDto`: [`MediaUpdateInfoDto`](../interfaces/generated_client.MediaUpdateInfoDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `postUpdatedMovies` | (`tmdbId?`: `string`, `imdbId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `postUpdatedSeries` | (`tvdbId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `refreshLibrary` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/library-api.ts:1157](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L1157) - -___ - -### LibraryStructureApiAxiosParamCreator - -▸ **LibraryStructureApiAxiosParamCreator**(`configuration?`): `Object` - -LibraryStructureApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addMediaPath` | (`mediaPathDto`: [`MediaPathDto`](../interfaces/generated_client.MediaPathDto.md), `refreshLibrary?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `addVirtualFolder` | (`name?`: `string`, `collectionType?`: [`CollectionTypeOptions`](../enums/generated_client.CollectionTypeOptions.md), `paths?`: `string`[], `refreshLibrary?`: `boolean`, `addVirtualFolderDto?`: [`AddVirtualFolderDto`](../interfaces/generated_client.AddVirtualFolderDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getVirtualFolders` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `removeMediaPath` | (`name?`: `string`, `path?`: `string`, `refreshLibrary?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `removeVirtualFolder` | (`name?`: `string`, `refreshLibrary?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `renameVirtualFolder` | (`name?`: `string`, `newName?`: `string`, `refreshLibrary?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateLibraryOptions` | (`updateLibraryOptionsDto?`: [`UpdateLibraryOptionsDto`](../interfaces/generated_client.UpdateLibraryOptionsDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateMediaPath` | (`updateMediaPathRequestDto`: [`UpdateMediaPathRequestDto`](../interfaces/generated_client.UpdateMediaPathRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/library-structure-api.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L41) - -___ - -### LibraryStructureApiFactory - -▸ **LibraryStructureApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -LibraryStructureApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addMediaPath` | (`mediaPathDto`: [`MediaPathDto`](../interfaces/generated_client.MediaPathDto.md), `refreshLibrary?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `addVirtualFolder` | (`name?`: `string`, `collectionType?`: [`CollectionTypeOptions`](../enums/generated_client.CollectionTypeOptions.md), `paths?`: `string`[], `refreshLibrary?`: `boolean`, `addVirtualFolderDto?`: [`AddVirtualFolderDto`](../interfaces/generated_client.AddVirtualFolderDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getVirtualFolders` | (`options?`: `any`) => `AxiosPromise`<[`VirtualFolderInfo`](../interfaces/generated_client.VirtualFolderInfo.md)[]\> | -| `removeMediaPath` | (`name?`: `string`, `path?`: `string`, `refreshLibrary?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `removeVirtualFolder` | (`name?`: `string`, `refreshLibrary?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `renameVirtualFolder` | (`name?`: `string`, `newName?`: `string`, `refreshLibrary?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateLibraryOptions` | (`updateLibraryOptionsDto?`: [`UpdateLibraryOptionsDto`](../interfaces/generated_client.UpdateLibraryOptionsDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateMediaPath` | (`updateMediaPathRequestDto`: [`UpdateMediaPathRequestDto`](../interfaces/generated_client.UpdateMediaPathRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/library-structure-api.ts:506](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L506) - -___ - -### LibraryStructureApiFp - -▸ **LibraryStructureApiFp**(`configuration?`): `Object` - -LibraryStructureApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addMediaPath` | (`mediaPathDto`: [`MediaPathDto`](../interfaces/generated_client.MediaPathDto.md), `refreshLibrary?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `addVirtualFolder` | (`name?`: `string`, `collectionType?`: [`CollectionTypeOptions`](../enums/generated_client.CollectionTypeOptions.md), `paths?`: `string`[], `refreshLibrary?`: `boolean`, `addVirtualFolderDto?`: [`AddVirtualFolderDto`](../interfaces/generated_client.AddVirtualFolderDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getVirtualFolders` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`VirtualFolderInfo`](../interfaces/generated_client.VirtualFolderInfo.md)[]\>\> | -| `removeMediaPath` | (`name?`: `string`, `path?`: `string`, `refreshLibrary?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `removeVirtualFolder` | (`name?`: `string`, `refreshLibrary?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `renameVirtualFolder` | (`name?`: `string`, `newName?`: `string`, `refreshLibrary?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateLibraryOptions` | (`updateLibraryOptionsDto?`: [`UpdateLibraryOptionsDto`](../interfaces/generated_client.UpdateLibraryOptionsDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateMediaPath` | (`updateMediaPathRequestDto`: [`UpdateMediaPathRequestDto`](../interfaces/generated_client.UpdateMediaPathRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/library-structure-api.ts:399](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L399) - -___ - -### LiveTvApiAxiosParamCreator - -▸ **LiveTvApiAxiosParamCreator**(`configuration?`): `Object` - -LiveTvApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addListingProvider` | (`pw?`: `string`, `validateListings?`: `boolean`, `validateLogin?`: `boolean`, `listingsProviderInfo?`: [`ListingsProviderInfo`](../interfaces/generated_client.ListingsProviderInfo.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `addTunerHost` | (`tunerHostInfo?`: [`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `cancelSeriesTimer` | (`timerId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `cancelTimer` | (`timerId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `createSeriesTimer` | (`seriesTimerInfoDto?`: [`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `createTimer` | (`timerInfoDto?`: [`TimerInfoDto`](../interfaces/generated_client.TimerInfoDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `deleteListingProvider` | (`id?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `deleteRecording` | (`recordingId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `deleteTunerHost` | (`id?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `discoverTuners` | (`newDevicesOnly?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `discvoverTuners` | (`newDevicesOnly?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getChannel` | (`channelId`: `string`, `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getChannelMappingOptions` | (`providerId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDefaultListingProvider` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getDefaultTimer` | (`programId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getGuideInfo` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLineups` | (`id?`: `string`, `type?`: `string`, `location?`: `string`, `country?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLiveRecordingFile` | (`recordingId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLiveStreamFile` | (`streamId`: `string`, `container`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLiveTvChannels` | (`type?`: [`ChannelType`](../enums/generated_client.ChannelType.md), `userId?`: `string`, `startIndex?`: `number`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `limit?`: `number`, `isFavorite?`: `boolean`, `isLiked?`: `boolean`, `isDisliked?`: `boolean`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableUserData?`: `boolean`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md), `enableFavoriteSorting?`: `boolean`, `addCurrentProgram?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLiveTvInfo` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLiveTvPrograms` | (`channelIds?`: `string`[], `userId?`: `string`, `minStartDate?`: `string`, `hasAired?`: `boolean`, `isAiring?`: `boolean`, `maxStartDate?`: `string`, `minEndDate?`: `string`, `maxEndDate?`: `string`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `startIndex?`: `number`, `limit?`: `number`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `genres?`: `string`[], `genreIds?`: `string`[], `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `seriesTimerId?`: `string`, `librarySeriesId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableTotalRecordCount?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getProgram` | (`programId`: `string`, `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPrograms` | (`getProgramsDto?`: [`GetProgramsDto`](../interfaces/generated_client.GetProgramsDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRecommendedPrograms` | (`userId?`: `string`, `limit?`: `number`, `isAiring?`: `boolean`, `hasAired?`: `boolean`, `isSeries?`: `boolean`, `isMovie?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `genreIds?`: `string`[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableUserData?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRecording` | (`recordingId`: `string`, `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRecordingFolders` | (`userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRecordingGroup` | (`groupId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRecordingGroups` | (`userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRecordings` | (`channelId?`: `string`, `userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `status?`: [`RecordingStatus`](../enums/generated_client.RecordingStatus.md), `isInProgress?`: `boolean`, `seriesTimerId?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableUserData?`: `boolean`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `isNews?`: `boolean`, `isLibraryItem?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRecordingsSeries` | (`channelId?`: `string`, `userId?`: `string`, `groupId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `status?`: [`RecordingStatus`](../enums/generated_client.RecordingStatus.md), `isInProgress?`: `boolean`, `seriesTimerId?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableUserData?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSchedulesDirectCountries` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSeriesTimer` | (`timerId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSeriesTimers` | (`sortBy?`: `string`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getTimer` | (`timerId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getTimers` | (`channelId?`: `string`, `seriesTimerId?`: `string`, `isActive?`: `boolean`, `isScheduled?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getTunerHostTypes` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `resetTuner` | (`tunerId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `setChannelMapping` | (`setChannelMappingDto`: [`SetChannelMappingDto`](../interfaces/generated_client.SetChannelMappingDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateSeriesTimer` | (`timerId`: `string`, `seriesTimerInfoDto?`: [`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateTimer` | (`timerId`: `string`, `timerInfoDto?`: [`TimerInfoDto`](../interfaces/generated_client.TimerInfoDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/live-tv-api.ts:69](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L69) - -___ - -### LiveTvApiFactory - -▸ **LiveTvApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -LiveTvApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addListingProvider` | (`pw?`: `string`, `validateListings?`: `boolean`, `validateLogin?`: `boolean`, `listingsProviderInfo?`: [`ListingsProviderInfo`](../interfaces/generated_client.ListingsProviderInfo.md), `options?`: `any`) => `AxiosPromise`<[`ListingsProviderInfo`](../interfaces/generated_client.ListingsProviderInfo.md)\> | -| `addTunerHost` | (`tunerHostInfo?`: [`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md), `options?`: `any`) => `AxiosPromise`<[`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md)\> | -| `cancelSeriesTimer` | (`timerId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `cancelTimer` | (`timerId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `createSeriesTimer` | (`seriesTimerInfoDto?`: [`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `createTimer` | (`timerInfoDto?`: [`TimerInfoDto`](../interfaces/generated_client.TimerInfoDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `deleteListingProvider` | (`id?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `deleteRecording` | (`recordingId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `deleteTunerHost` | (`id?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `discoverTuners` | (`newDevicesOnly?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md)[]\> | -| `discvoverTuners` | (`newDevicesOnly?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md)[]\> | -| `getChannel` | (`channelId`: `string`, `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\> | -| `getChannelMappingOptions` | (`providerId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`ChannelMappingOptionsDto`](../interfaces/generated_client.ChannelMappingOptionsDto.md)\> | -| `getDefaultListingProvider` | (`options?`: `any`) => `AxiosPromise`<[`ListingsProviderInfo`](../interfaces/generated_client.ListingsProviderInfo.md)\> | -| `getDefaultTimer` | (`programId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md)\> | -| `getGuideInfo` | (`options?`: `any`) => `AxiosPromise`<[`GuideInfo`](../interfaces/generated_client.GuideInfo.md)\> | -| `getLineups` | (`id?`: `string`, `type?`: `string`, `location?`: `string`, `country?`: `string`, `options?`: `any`) => `AxiosPromise`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\> | -| `getLiveRecordingFile` | (`recordingId`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getLiveStreamFile` | (`streamId`: `string`, `container`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getLiveTvChannels` | (`type?`: [`ChannelType`](../enums/generated_client.ChannelType.md), `userId?`: `string`, `startIndex?`: `number`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `limit?`: `number`, `isFavorite?`: `boolean`, `isLiked?`: `boolean`, `isDisliked?`: `boolean`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableUserData?`: `boolean`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md), `enableFavoriteSorting?`: `boolean`, `addCurrentProgram?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getLiveTvInfo` | (`options?`: `any`) => `AxiosPromise`<[`LiveTvInfo`](../interfaces/generated_client.LiveTvInfo.md)\> | -| `getLiveTvPrograms` | (`channelIds?`: `string`[], `userId?`: `string`, `minStartDate?`: `string`, `hasAired?`: `boolean`, `isAiring?`: `boolean`, `maxStartDate?`: `string`, `minEndDate?`: `string`, `maxEndDate?`: `string`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `startIndex?`: `number`, `limit?`: `number`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `genres?`: `string`[], `genreIds?`: `string`[], `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `seriesTimerId?`: `string`, `librarySeriesId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getProgram` | (`programId`: `string`, `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\> | -| `getPrograms` | (`getProgramsDto?`: [`GetProgramsDto`](../interfaces/generated_client.GetProgramsDto.md), `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getRecommendedPrograms` | (`userId?`: `string`, `limit?`: `number`, `isAiring?`: `boolean`, `hasAired?`: `boolean`, `isSeries?`: `boolean`, `isMovie?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `genreIds?`: `string`[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableUserData?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getRecording` | (`recordingId`: `string`, `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\> | -| `getRecordingFolders` | (`userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getRecordingGroup` | (`groupId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getRecordingGroups` | (`userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getRecordings` | (`channelId?`: `string`, `userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `status?`: [`RecordingStatus`](../enums/generated_client.RecordingStatus.md), `isInProgress?`: `boolean`, `seriesTimerId?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableUserData?`: `boolean`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `isNews?`: `boolean`, `isLibraryItem?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getRecordingsSeries` | (`channelId?`: `string`, `userId?`: `string`, `groupId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `status?`: [`RecordingStatus`](../enums/generated_client.RecordingStatus.md), `isInProgress?`: `boolean`, `seriesTimerId?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableUserData?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getSchedulesDirectCountries` | (`options?`: `any`) => `AxiosPromise`<`any`\> | -| `getSeriesTimer` | (`timerId`: `string`, `options?`: `any`) => `AxiosPromise`<[`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md)\> | -| `getSeriesTimers` | (`sortBy?`: `string`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md), `options?`: `any`) => `AxiosPromise`<[`SeriesTimerInfoDtoQueryResult`](../interfaces/generated_client.SeriesTimerInfoDtoQueryResult.md)\> | -| `getTimer` | (`timerId`: `string`, `options?`: `any`) => `AxiosPromise`<[`TimerInfoDto`](../interfaces/generated_client.TimerInfoDto.md)\> | -| `getTimers` | (`channelId?`: `string`, `seriesTimerId?`: `string`, `isActive?`: `boolean`, `isScheduled?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`TimerInfoDtoQueryResult`](../interfaces/generated_client.TimerInfoDtoQueryResult.md)\> | -| `getTunerHostTypes` | (`options?`: `any`) => `AxiosPromise`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\> | -| `resetTuner` | (`tunerId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `setChannelMapping` | (`setChannelMappingDto`: [`SetChannelMappingDto`](../interfaces/generated_client.SetChannelMappingDto.md), `options?`: `any`) => `AxiosPromise`<[`TunerChannelMapping`](../interfaces/generated_client.TunerChannelMapping.md)\> | -| `updateSeriesTimer` | (`timerId`: `string`, `seriesTimerInfoDto?`: [`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateTimer` | (`timerId`: `string`, `timerInfoDto?`: [`TimerInfoDto`](../interfaces/generated_client.TimerInfoDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/live-tv-api.ts:2702](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L2702) - -___ - -### LiveTvApiFp - -▸ **LiveTvApiFp**(`configuration?`): `Object` - -LiveTvApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addListingProvider` | (`pw?`: `string`, `validateListings?`: `boolean`, `validateLogin?`: `boolean`, `listingsProviderInfo?`: [`ListingsProviderInfo`](../interfaces/generated_client.ListingsProviderInfo.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ListingsProviderInfo`](../interfaces/generated_client.ListingsProviderInfo.md)\>\> | -| `addTunerHost` | (`tunerHostInfo?`: [`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md)\>\> | -| `cancelSeriesTimer` | (`timerId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `cancelTimer` | (`timerId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `createSeriesTimer` | (`seriesTimerInfoDto?`: [`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `createTimer` | (`timerInfoDto?`: [`TimerInfoDto`](../interfaces/generated_client.TimerInfoDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `deleteListingProvider` | (`id?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `deleteRecording` | (`recordingId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `deleteTunerHost` | (`id?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `discoverTuners` | (`newDevicesOnly?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md)[]\>\> | -| `discvoverTuners` | (`newDevicesOnly?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TunerHostInfo`](../interfaces/generated_client.TunerHostInfo.md)[]\>\> | -| `getChannel` | (`channelId`: `string`, `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\> | -| `getChannelMappingOptions` | (`providerId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ChannelMappingOptionsDto`](../interfaces/generated_client.ChannelMappingOptionsDto.md)\>\> | -| `getDefaultListingProvider` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ListingsProviderInfo`](../interfaces/generated_client.ListingsProviderInfo.md)\>\> | -| `getDefaultTimer` | (`programId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md)\>\> | -| `getGuideInfo` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GuideInfo`](../interfaces/generated_client.GuideInfo.md)\>\> | -| `getLineups` | (`id?`: `string`, `type?`: `string`, `location?`: `string`, `country?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\>\> | -| `getLiveRecordingFile` | (`recordingId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getLiveStreamFile` | (`streamId`: `string`, `container`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getLiveTvChannels` | (`type?`: [`ChannelType`](../enums/generated_client.ChannelType.md), `userId?`: `string`, `startIndex?`: `number`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `limit?`: `number`, `isFavorite?`: `boolean`, `isLiked?`: `boolean`, `isDisliked?`: `boolean`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableUserData?`: `boolean`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md), `enableFavoriteSorting?`: `boolean`, `addCurrentProgram?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getLiveTvInfo` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`LiveTvInfo`](../interfaces/generated_client.LiveTvInfo.md)\>\> | -| `getLiveTvPrograms` | (`channelIds?`: `string`[], `userId?`: `string`, `minStartDate?`: `string`, `hasAired?`: `boolean`, `isAiring?`: `boolean`, `maxStartDate?`: `string`, `minEndDate?`: `string`, `maxEndDate?`: `string`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `startIndex?`: `number`, `limit?`: `number`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `genres?`: `string`[], `genreIds?`: `string`[], `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `seriesTimerId?`: `string`, `librarySeriesId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getProgram` | (`programId`: `string`, `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\> | -| `getPrograms` | (`getProgramsDto?`: [`GetProgramsDto`](../interfaces/generated_client.GetProgramsDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getRecommendedPrograms` | (`userId?`: `string`, `limit?`: `number`, `isAiring?`: `boolean`, `hasAired?`: `boolean`, `isSeries?`: `boolean`, `isMovie?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `genreIds?`: `string`[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableUserData?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getRecording` | (`recordingId`: `string`, `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\> | -| `getRecordingFolders` | (`userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getRecordingGroup` | (`groupId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getRecordingGroups` | (`userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getRecordings` | (`channelId?`: `string`, `userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `status?`: [`RecordingStatus`](../enums/generated_client.RecordingStatus.md), `isInProgress?`: `boolean`, `seriesTimerId?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableUserData?`: `boolean`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `isNews?`: `boolean`, `isLibraryItem?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getRecordingsSeries` | (`channelId?`: `string`, `userId?`: `string`, `groupId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `status?`: [`RecordingStatus`](../enums/generated_client.RecordingStatus.md), `isInProgress?`: `boolean`, `seriesTimerId?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableUserData?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getSchedulesDirectCountries` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getSeriesTimer` | (`timerId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md)\>\> | -| `getSeriesTimers` | (`sortBy?`: `string`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`SeriesTimerInfoDtoQueryResult`](../interfaces/generated_client.SeriesTimerInfoDtoQueryResult.md)\>\> | -| `getTimer` | (`timerId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TimerInfoDto`](../interfaces/generated_client.TimerInfoDto.md)\>\> | -| `getTimers` | (`channelId?`: `string`, `seriesTimerId?`: `string`, `isActive?`: `boolean`, `isScheduled?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TimerInfoDtoQueryResult`](../interfaces/generated_client.TimerInfoDtoQueryResult.md)\>\> | -| `getTunerHostTypes` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\>\> | -| `resetTuner` | (`tunerId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `setChannelMapping` | (`setChannelMappingDto`: [`SetChannelMappingDto`](../interfaces/generated_client.SetChannelMappingDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TunerChannelMapping`](../interfaces/generated_client.TunerChannelMapping.md)\>\> | -| `updateSeriesTimer` | (`timerId`: `string`, `seriesTimerInfoDto?`: [`SeriesTimerInfoDto`](../interfaces/generated_client.SeriesTimerInfoDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateTimer` | (`timerId`: `string`, `timerInfoDto?`: [`TimerInfoDto`](../interfaces/generated_client.TimerInfoDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/live-tv-api.ts:2135](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/live-tv-api.ts#L2135) - -___ - -### LocalizationApiAxiosParamCreator - -▸ **LocalizationApiAxiosParamCreator**(`configuration?`): `Object` - -LocalizationApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getCountries` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getCultures` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLocalizationOptions` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getParentalRatings` | (`options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/localization-api.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/localization-api.ts#L35) - -___ - -### LocalizationApiFactory - -▸ **LocalizationApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -LocalizationApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getCountries` | (`options?`: `any`) => `AxiosPromise`<[`CountryInfo`](../interfaces/generated_client.CountryInfo.md)[]\> | -| `getCultures` | (`options?`: `any`) => `AxiosPromise`<[`CultureDto`](../interfaces/generated_client.CultureDto.md)[]\> | -| `getLocalizationOptions` | (`options?`: `any`) => `AxiosPromise`<[`LocalizationOption`](../interfaces/generated_client.LocalizationOption.md)[]\> | -| `getParentalRatings` | (`options?`: `any`) => `AxiosPromise`<[`ParentalRating`](../interfaces/generated_client.ParentalRating.md)[]\> | - -#### Defined in - -[generated-client/api/localization-api.ts:226](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/localization-api.ts#L226) - -___ - -### LocalizationApiFp - -▸ **LocalizationApiFp**(`configuration?`): `Object` - -LocalizationApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getCountries` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`CountryInfo`](../interfaces/generated_client.CountryInfo.md)[]\>\> | -| `getCultures` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`CultureDto`](../interfaces/generated_client.CultureDto.md)[]\>\> | -| `getLocalizationOptions` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`LocalizationOption`](../interfaces/generated_client.LocalizationOption.md)[]\>\> | -| `getParentalRatings` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ParentalRating`](../interfaces/generated_client.ParentalRating.md)[]\>\> | - -#### Defined in - -[generated-client/api/localization-api.ts:176](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/localization-api.ts#L176) - -___ - -### MediaInfoApiAxiosParamCreator - -▸ **MediaInfoApiAxiosParamCreator**(`configuration?`): `Object` - -MediaInfoApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `closeLiveStream` | (`liveStreamId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getBitrateTestBytes` | (`size?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPlaybackInfo` | (`itemId`: `string`, `userId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPostedPlaybackInfo` | (`itemId`: `string`, `userId?`: `string`, `maxStreamingBitrate?`: `number`, `startTimeTicks?`: `number`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `maxAudioChannels?`: `number`, `mediaSourceId?`: `string`, `liveStreamId?`: `string`, `autoOpenLiveStream?`: `boolean`, `enableDirectPlay?`: `boolean`, `enableDirectStream?`: `boolean`, `enableTranscoding?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `playbackInfoDto?`: [`PlaybackInfoDto`](../interfaces/generated_client.PlaybackInfoDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `openLiveStream` | (`openToken?`: `string`, `userId?`: `string`, `playSessionId?`: `string`, `maxStreamingBitrate?`: `number`, `startTimeTicks?`: `number`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `maxAudioChannels?`: `number`, `itemId?`: `string`, `enableDirectPlay?`: `boolean`, `enableDirectStream?`: `boolean`, `openLiveStreamDto?`: [`OpenLiveStreamDto`](../interfaces/generated_client.OpenLiveStreamDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/media-info-api.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L35) - -___ - -### MediaInfoApiFactory - -▸ **MediaInfoApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -MediaInfoApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `closeLiveStream` | (`liveStreamId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getBitrateTestBytes` | (`size?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getPlaybackInfo` | (`itemId`: `string`, `userId`: `string`, `options?`: `any`) => `AxiosPromise`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md)\> | -| `getPostedPlaybackInfo` | (`itemId`: `string`, `userId?`: `string`, `maxStreamingBitrate?`: `number`, `startTimeTicks?`: `number`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `maxAudioChannels?`: `number`, `mediaSourceId?`: `string`, `liveStreamId?`: `string`, `autoOpenLiveStream?`: `boolean`, `enableDirectPlay?`: `boolean`, `enableDirectStream?`: `boolean`, `enableTranscoding?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `playbackInfoDto?`: [`PlaybackInfoDto`](../interfaces/generated_client.PlaybackInfoDto.md), `options?`: `any`) => `AxiosPromise`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md)\> | -| `openLiveStream` | (`openToken?`: `string`, `userId?`: `string`, `playSessionId?`: `string`, `maxStreamingBitrate?`: `number`, `startTimeTicks?`: `number`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `maxAudioChannels?`: `number`, `itemId?`: `string`, `enableDirectPlay?`: `boolean`, `enableDirectStream?`: `boolean`, `openLiveStreamDto?`: [`OpenLiveStreamDto`](../interfaces/generated_client.OpenLiveStreamDto.md), `options?`: `any`) => `AxiosPromise`<[`LiveStreamResponse`](../interfaces/generated_client.LiveStreamResponse.md)\> | - -#### Defined in - -[generated-client/api/media-info-api.ts:461](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L461) - -___ - -### MediaInfoApiFp - -▸ **MediaInfoApiFp**(`configuration?`): `Object` - -MediaInfoApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `closeLiveStream` | (`liveStreamId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getBitrateTestBytes` | (`size?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getPlaybackInfo` | (`itemId`: `string`, `userId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md)\>\> | -| `getPostedPlaybackInfo` | (`itemId`: `string`, `userId?`: `string`, `maxStreamingBitrate?`: `number`, `startTimeTicks?`: `number`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `maxAudioChannels?`: `number`, `mediaSourceId?`: `string`, `liveStreamId?`: `string`, `autoOpenLiveStream?`: `boolean`, `enableDirectPlay?`: `boolean`, `enableDirectStream?`: `boolean`, `enableTranscoding?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `playbackInfoDto?`: [`PlaybackInfoDto`](../interfaces/generated_client.PlaybackInfoDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md)\>\> | -| `openLiveStream` | (`openToken?`: `string`, `userId?`: `string`, `playSessionId?`: `string`, `maxStreamingBitrate?`: `number`, `startTimeTicks?`: `number`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `maxAudioChannels?`: `number`, `itemId?`: `string`, `enableDirectPlay?`: `boolean`, `enableDirectStream?`: `boolean`, `openLiveStreamDto?`: [`OpenLiveStreamDto`](../interfaces/generated_client.OpenLiveStreamDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`LiveStreamResponse`](../interfaces/generated_client.LiveStreamResponse.md)\>\> | - -#### Defined in - -[generated-client/api/media-info-api.ts:369](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L369) - -___ - -### MoviesApiAxiosParamCreator - -▸ **MoviesApiAxiosParamCreator**(`configuration?`): `Object` - -MoviesApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getMovieRecommendations` | (`userId?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `categoryLimit?`: `number`, `itemLimit?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/movies-api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/movies-api.ts#L31) - -___ - -### MoviesApiFactory - -▸ **MoviesApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -MoviesApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getMovieRecommendations` | (`userId?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `categoryLimit?`: `number`, `itemLimit?`: `number`, `options?`: `any`) => `AxiosPromise`<[`RecommendationDto`](../interfaces/generated_client.RecommendationDto.md)[]\> | - -#### Defined in - -[generated-client/api/movies-api.ts:123](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/movies-api.ts#L123) - -___ - -### MoviesApiFp - -▸ **MoviesApiFp**(`configuration?`): `Object` - -MoviesApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getMovieRecommendations` | (`userId?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `categoryLimit?`: `number`, `itemLimit?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RecommendationDto`](../interfaces/generated_client.RecommendationDto.md)[]\>\> | - -#### Defined in - -[generated-client/api/movies-api.ts:98](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/movies-api.ts#L98) - -___ - -### MusicGenresApiAxiosParamCreator - -▸ **MusicGenresApiAxiosParamCreator**(`configuration?`): `Object` - -MusicGenresApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getMusicGenre` | (`genreName`: `string`, `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getMusicGenres` | (`startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isFavorite?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/music-genres-api.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L39) - -___ - -### MusicGenresApiFactory - -▸ **MusicGenresApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -MusicGenresApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getMusicGenre` | (`genreName`: `string`, `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\> | -| `getMusicGenres` | (`startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isFavorite?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/music-genres-api.ts:265](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L265) - -___ - -### MusicGenresApiFp - -▸ **MusicGenresApiFp**(`configuration?`): `Object` - -MusicGenresApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getMusicGenre` | (`genreName`: `string`, `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\> | -| `getMusicGenres` | (`startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isFavorite?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `sortBy?`: `string`[], `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/music-genres-api.ts:214](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L214) - -___ - -### NotificationsApiAxiosParamCreator - -▸ **NotificationsApiAxiosParamCreator**(`configuration?`): `Object` - -NotificationsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `createAdminNotification` | (`adminNotificationDto`: [`AdminNotificationDto`](../interfaces/generated_client.AdminNotificationDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getNotificationServices` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getNotificationTypes` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getNotifications` | (`userId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getNotificationsSummary` | (`userId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `setRead` | (`userId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `setUnread` | (`userId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/notifications-api.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L37) - -___ - -### NotificationsApiFactory - -▸ **NotificationsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -NotificationsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `createAdminNotification` | (`adminNotificationDto`: [`AdminNotificationDto`](../interfaces/generated_client.AdminNotificationDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getNotificationServices` | (`options?`: `any`) => `AxiosPromise`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\> | -| `getNotificationTypes` | (`options?`: `any`) => `AxiosPromise`<[`NotificationTypeInfo`](../interfaces/generated_client.NotificationTypeInfo.md)[]\> | -| `getNotifications` | (`userId`: `string`, `options?`: `any`) => `AxiosPromise`<[`NotificationResultDto`](../interfaces/generated_client.NotificationResultDto.md)\> | -| `getNotificationsSummary` | (`userId`: `string`, `options?`: `any`) => `AxiosPromise`<[`NotificationsSummaryDto`](../interfaces/generated_client.NotificationsSummaryDto.md)\> | -| `setRead` | (`userId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `setUnread` | (`userId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/notifications-api.ts:384](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L384) - -___ - -### NotificationsApiFp - -▸ **NotificationsApiFp**(`configuration?`): `Object` - -NotificationsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `createAdminNotification` | (`adminNotificationDto`: [`AdminNotificationDto`](../interfaces/generated_client.AdminNotificationDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getNotificationServices` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\>\> | -| `getNotificationTypes` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NotificationTypeInfo`](../interfaces/generated_client.NotificationTypeInfo.md)[]\>\> | -| `getNotifications` | (`userId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NotificationResultDto`](../interfaces/generated_client.NotificationResultDto.md)\>\> | -| `getNotificationsSummary` | (`userId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NotificationsSummaryDto`](../interfaces/generated_client.NotificationsSummaryDto.md)\>\> | -| `setRead` | (`userId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `setUnread` | (`userId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/notifications-api.ts:299](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L299) - -___ - -### PackageApiAxiosParamCreator - -▸ **PackageApiAxiosParamCreator**(`configuration?`): `Object` - -PackageApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `cancelPackageInstallation` | (`packageId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPackageInfo` | (`name`: `string`, `assemblyGuid?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPackages` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRepositories` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `installPackage` | (`name`: `string`, `assemblyGuid?`: `string`, `version?`: `string`, `repositoryUrl?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `setRepositories` | (`repositoryInfo`: [`RepositoryInfo`](../interfaces/generated_client.RepositoryInfo.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/package-api.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L33) - -___ - -### PackageApiFactory - -▸ **PackageApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -PackageApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `cancelPackageInstallation` | (`packageId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getPackageInfo` | (`name`: `string`, `assemblyGuid?`: `string`, `options?`: `any`) => `AxiosPromise`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md)\> | -| `getPackages` | (`options?`: `any`) => `AxiosPromise`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md)[]\> | -| `getRepositories` | (`options?`: `any`) => `AxiosPromise`<[`RepositoryInfo`](../interfaces/generated_client.RepositoryInfo.md)[]\> | -| `installPackage` | (`name`: `string`, `assemblyGuid?`: `string`, `version?`: `string`, `repositoryUrl?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `setRepositories` | (`repositoryInfo`: [`RepositoryInfo`](../interfaces/generated_client.RepositoryInfo.md)[], `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/package-api.ts:356](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L356) - -___ - -### PackageApiFp - -▸ **PackageApiFp**(`configuration?`): `Object` - -PackageApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `cancelPackageInstallation` | (`packageId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getPackageInfo` | (`name`: `string`, `assemblyGuid?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md)\>\> | -| `getPackages` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md)[]\>\> | -| `getRepositories` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RepositoryInfo`](../interfaces/generated_client.RepositoryInfo.md)[]\>\> | -| `installPackage` | (`name`: `string`, `assemblyGuid?`: `string`, `version?`: `string`, `repositoryUrl?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `setRepositories` | (`repositoryInfo`: [`RepositoryInfo`](../interfaces/generated_client.RepositoryInfo.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/package-api.ts:278](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L278) - -___ - -### PersonsApiAxiosParamCreator - -▸ **PersonsApiAxiosParamCreator**(`configuration?`): `Object` - -PersonsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getPerson` | (`name`: `string`, `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPersons` | (`limit?`: `number`, `searchTerm?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `excludePersonTypes?`: `string`[], `personTypes?`: `string`[], `appearsInItemId?`: `string`, `userId?`: `string`, `enableImages?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/persons-api.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L39) - -___ - -### PersonsApiFactory - -▸ **PersonsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -PersonsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getPerson` | (`name`: `string`, `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\> | -| `getPersons` | (`limit?`: `number`, `searchTerm?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `excludePersonTypes?`: `string`[], `personTypes?`: `string`[], `appearsInItemId?`: `string`, `userId?`: `string`, `enableImages?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/persons-api.ts:233](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L233) - -___ - -### PersonsApiFp - -▸ **PersonsApiFp**(`configuration?`): `Object` - -PersonsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getPerson` | (`name`: `string`, `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\> | -| `getPersons` | (`limit?`: `number`, `searchTerm?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `excludePersonTypes?`: `string`[], `personTypes?`: `string`[], `appearsInItemId?`: `string`, `userId?`: `string`, `enableImages?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/persons-api.ts:188](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L188) - -___ - -### PlaylistsApiAxiosParamCreator - -▸ **PlaylistsApiAxiosParamCreator**(`configuration?`): `Object` - -PlaylistsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addToPlaylist` | (`playlistId`: `string`, `ids?`: `string`[], `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `createPlaylist` | (`name?`: `string`, `ids?`: `string`[], `userId?`: `string`, `mediaType?`: `string`, `createPlaylistDto?`: [`CreatePlaylistDto`](../interfaces/generated_client.CreatePlaylistDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPlaylistItems` | (`playlistId`: `string`, `userId`: `string`, `startIndex?`: `number`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | -| `moveItem` | (`playlistId`: `string`, `itemId`: `string`, `newIndex`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `removeFromPlaylist` | (`playlistId`: `string`, `entryIds?`: `string`[], `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/playlists-api.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L37) - -___ - -### PlaylistsApiFactory - -▸ **PlaylistsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -PlaylistsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addToPlaylist` | (`playlistId`: `string`, `ids?`: `string`[], `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `createPlaylist` | (`name?`: `string`, `ids?`: `string`[], `userId?`: `string`, `mediaType?`: `string`, `createPlaylistDto?`: [`CreatePlaylistDto`](../interfaces/generated_client.CreatePlaylistDto.md), `options?`: `any`) => `AxiosPromise`<[`PlaylistCreationResult`](../interfaces/generated_client.PlaylistCreationResult.md)\> | -| `getPlaylistItems` | (`playlistId`: `string`, `userId`: `string`, `startIndex?`: `number`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `moveItem` | (`playlistId`: `string`, `itemId`: `string`, `newIndex`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `removeFromPlaylist` | (`playlistId`: `string`, `entryIds?`: `string`[], `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/playlists-api.ts:398](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L398) - -___ - -### PlaylistsApiFp - -▸ **PlaylistsApiFp**(`configuration?`): `Object` - -PlaylistsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addToPlaylist` | (`playlistId`: `string`, `ids?`: `string`[], `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `createPlaylist` | (`name?`: `string`, `ids?`: `string`[], `userId?`: `string`, `mediaType?`: `string`, `createPlaylistDto?`: [`CreatePlaylistDto`](../interfaces/generated_client.CreatePlaylistDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PlaylistCreationResult`](../interfaces/generated_client.PlaylistCreationResult.md)\>\> | -| `getPlaylistItems` | (`playlistId`: `string`, `userId`: `string`, `startIndex?`: `number`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `enableImages?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `moveItem` | (`playlistId`: `string`, `itemId`: `string`, `newIndex`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `removeFromPlaylist` | (`playlistId`: `string`, `entryIds?`: `string`[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/playlists-api.ts:316](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L316) - -___ - -### PlaystateApiAxiosParamCreator - -▸ **PlaystateApiAxiosParamCreator**(`configuration?`): `Object` - -PlaystateApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `markPlayedItem` | (`userId`: `string`, `itemId`: `string`, `datePlayed?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `markUnplayedItem` | (`userId`: `string`, `itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `onPlaybackProgress` | (`userId`: `string`, `itemId`: `string`, `mediaSourceId?`: `string`, `positionTicks?`: `number`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `volumeLevel?`: `number`, `playMethod?`: [`PlayMethod`](../enums/generated_client.PlayMethod.md), `liveStreamId?`: `string`, `playSessionId?`: `string`, `repeatMode?`: [`RepeatMode`](../enums/generated_client.RepeatMode.md), `isPaused?`: `boolean`, `isMuted?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `onPlaybackStart` | (`userId`: `string`, `itemId`: `string`, `mediaSourceId?`: `string`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `playMethod?`: [`PlayMethod`](../enums/generated_client.PlayMethod.md), `liveStreamId?`: `string`, `playSessionId?`: `string`, `canSeek?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `onPlaybackStopped` | (`userId`: `string`, `itemId`: `string`, `mediaSourceId?`: `string`, `nextMediaType?`: `string`, `positionTicks?`: `number`, `liveStreamId?`: `string`, `playSessionId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `pingPlaybackSession` | (`playSessionId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `reportPlaybackProgress` | (`playbackProgressInfo?`: [`PlaybackProgressInfo`](../interfaces/generated_client.PlaybackProgressInfo.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `reportPlaybackStart` | (`playbackStartInfo?`: [`PlaybackStartInfo`](../interfaces/generated_client.PlaybackStartInfo.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `reportPlaybackStopped` | (`playbackStopInfo?`: [`PlaybackStopInfo`](../interfaces/generated_client.PlaybackStopInfo.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/playstate-api.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L39) - -___ - -### PlaystateApiFactory - -▸ **PlaystateApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -PlaystateApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `markPlayedItem` | (`userId`: `string`, `itemId`: `string`, `datePlayed?`: `string`, `options?`: `any`) => `AxiosPromise`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\> | -| `markUnplayedItem` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\> | -| `onPlaybackProgress` | (`userId`: `string`, `itemId`: `string`, `mediaSourceId?`: `string`, `positionTicks?`: `number`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `volumeLevel?`: `number`, `playMethod?`: [`PlayMethod`](../enums/generated_client.PlayMethod.md), `liveStreamId?`: `string`, `playSessionId?`: `string`, `repeatMode?`: [`RepeatMode`](../enums/generated_client.RepeatMode.md), `isPaused?`: `boolean`, `isMuted?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `onPlaybackStart` | (`userId`: `string`, `itemId`: `string`, `mediaSourceId?`: `string`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `playMethod?`: [`PlayMethod`](../enums/generated_client.PlayMethod.md), `liveStreamId?`: `string`, `playSessionId?`: `string`, `canSeek?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `onPlaybackStopped` | (`userId`: `string`, `itemId`: `string`, `mediaSourceId?`: `string`, `nextMediaType?`: `string`, `positionTicks?`: `number`, `liveStreamId?`: `string`, `playSessionId?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `pingPlaybackSession` | (`playSessionId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `reportPlaybackProgress` | (`playbackProgressInfo?`: [`PlaybackProgressInfo`](../interfaces/generated_client.PlaybackProgressInfo.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `reportPlaybackStart` | (`playbackStartInfo?`: [`PlaybackStartInfo`](../interfaces/generated_client.PlaybackStartInfo.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `reportPlaybackStopped` | (`playbackStopInfo?`: [`PlaybackStopInfo`](../interfaces/generated_client.PlaybackStopInfo.md), `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/playstate-api.ts:664](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L664) - -___ - -### PlaystateApiFp - -▸ **PlaystateApiFp**(`configuration?`): `Object` - -PlaystateApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `markPlayedItem` | (`userId`: `string`, `itemId`: `string`, `datePlayed?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\>\> | -| `markUnplayedItem` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\>\> | -| `onPlaybackProgress` | (`userId`: `string`, `itemId`: `string`, `mediaSourceId?`: `string`, `positionTicks?`: `number`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `volumeLevel?`: `number`, `playMethod?`: [`PlayMethod`](../enums/generated_client.PlayMethod.md), `liveStreamId?`: `string`, `playSessionId?`: `string`, `repeatMode?`: [`RepeatMode`](../enums/generated_client.RepeatMode.md), `isPaused?`: `boolean`, `isMuted?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `onPlaybackStart` | (`userId`: `string`, `itemId`: `string`, `mediaSourceId?`: `string`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `playMethod?`: [`PlayMethod`](../enums/generated_client.PlayMethod.md), `liveStreamId?`: `string`, `playSessionId?`: `string`, `canSeek?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `onPlaybackStopped` | (`userId`: `string`, `itemId`: `string`, `mediaSourceId?`: `string`, `nextMediaType?`: `string`, `positionTicks?`: `number`, `liveStreamId?`: `string`, `playSessionId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `pingPlaybackSession` | (`playSessionId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `reportPlaybackProgress` | (`playbackProgressInfo?`: [`PlaybackProgressInfo`](../interfaces/generated_client.PlaybackProgressInfo.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `reportPlaybackStart` | (`playbackStartInfo?`: [`PlaybackStartInfo`](../interfaces/generated_client.PlaybackStartInfo.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `reportPlaybackStopped` | (`playbackStopInfo?`: [`PlaybackStopInfo`](../interfaces/generated_client.PlaybackStopInfo.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/playstate-api.ts:526](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L526) - -___ - -### PluginsApiAxiosParamCreator - -▸ **PluginsApiAxiosParamCreator**(`configuration?`): `Object` - -PluginsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `disablePlugin` | (`pluginId`: `string`, `version`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `enablePlugin` | (`pluginId`: `string`, `version`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPluginConfiguration` | (`pluginId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPluginImage` | (`pluginId`: `string`, `version`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPluginManifest` | (`pluginId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPlugins` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `uninstallPlugin` | (`pluginId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `uninstallPluginByVersion` | (`pluginId`: `string`, `version`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updatePluginConfiguration` | (`pluginId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/plugins-api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L31) - -___ - -### PluginsApiFactory - -▸ **PluginsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -PluginsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `disablePlugin` | (`pluginId`: `string`, `version`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `enablePlugin` | (`pluginId`: `string`, `version`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getPluginConfiguration` | (`pluginId`: `string`, `options?`: `any`) => `AxiosPromise`<`object`\> | -| `getPluginImage` | (`pluginId`: `string`, `version`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getPluginManifest` | (`pluginId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getPlugins` | (`options?`: `any`) => `AxiosPromise`<[`PluginInfo`](../interfaces/generated_client.PluginInfo.md)[]\> | -| `uninstallPlugin` | (`pluginId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `uninstallPluginByVersion` | (`pluginId`: `string`, `version`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updatePluginConfiguration` | (`pluginId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/plugins-api.ts:499](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L499) - -___ - -### PluginsApiFp - -▸ **PluginsApiFp**(`configuration?`): `Object` - -PluginsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `disablePlugin` | (`pluginId`: `string`, `version`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `enablePlugin` | (`pluginId`: `string`, `version`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getPluginConfiguration` | (`pluginId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`object`\>\> | -| `getPluginImage` | (`pluginId`: `string`, `version`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getPluginManifest` | (`pluginId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getPlugins` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PluginInfo`](../interfaces/generated_client.PluginInfo.md)[]\>\> | -| `uninstallPlugin` | (`pluginId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `uninstallPluginByVersion` | (`pluginId`: `string`, `version`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updatePluginConfiguration` | (`pluginId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/plugins-api.ts:386](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L386) - -___ - -### QuickConnectApiAxiosParamCreator - -▸ **QuickConnectApiAxiosParamCreator**(`configuration?`): `Object` - -QuickConnectApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `authorize` | (`code`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `connect` | (`secret`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getEnabled` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `initiate` | (`options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/quick-connect-api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L31) - -___ - -### QuickConnectApiFactory - -▸ **QuickConnectApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -QuickConnectApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `authorize` | (`code`: `string`, `options?`: `any`) => `AxiosPromise`<`boolean`\> | -| `connect` | (`secret`: `string`, `options?`: `any`) => `AxiosPromise`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md)\> | -| `getEnabled` | (`options?`: `any`) => `AxiosPromise`<`boolean`\> | -| `initiate` | (`options?`: `any`) => `AxiosPromise`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md)\> | - -#### Defined in - -[generated-client/api/quick-connect-api.ts:229](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L229) - -___ - -### QuickConnectApiFp - -▸ **QuickConnectApiFp**(`configuration?`): `Object` - -QuickConnectApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `authorize` | (`code`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`boolean`\>\> | -| `connect` | (`secret`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md)\>\> | -| `getEnabled` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`boolean`\>\> | -| `initiate` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md)\>\> | - -#### Defined in - -[generated-client/api/quick-connect-api.ts:177](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L177) - -___ - -### RemoteImageApiAxiosParamCreator - -▸ **RemoteImageApiAxiosParamCreator**(`configuration?`): `Object` - -RemoteImageApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `downloadRemoteImage` | (`itemId`: `string`, `type`: [`ImageType`](../enums/generated_client.ImageType.md), `imageUrl?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRemoteImageProviders` | (`itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRemoteImages` | (`itemId`: `string`, `type?`: [`ImageType`](../enums/generated_client.ImageType.md), `startIndex?`: `number`, `limit?`: `number`, `providerName?`: `string`, `includeAllLanguages?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/remote-image-api.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L35) - -___ - -### RemoteImageApiFactory - -▸ **RemoteImageApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -RemoteImageApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `downloadRemoteImage` | (`itemId`: `string`, `type`: [`ImageType`](../enums/generated_client.ImageType.md), `imageUrl?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getRemoteImageProviders` | (`itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`ImageProviderInfo`](../interfaces/generated_client.ImageProviderInfo.md)[]\> | -| `getRemoteImages` | (`itemId`: `string`, `type?`: [`ImageType`](../enums/generated_client.ImageType.md), `startIndex?`: `number`, `limit?`: `number`, `providerName?`: `string`, `includeAllLanguages?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`RemoteImageResult`](../interfaces/generated_client.RemoteImageResult.md)\> | - -#### Defined in - -[generated-client/api/remote-image-api.ts:242](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L242) - -___ - -### RemoteImageApiFp - -▸ **RemoteImageApiFp**(`configuration?`): `Object` - -RemoteImageApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `downloadRemoteImage` | (`itemId`: `string`, `type`: [`ImageType`](../enums/generated_client.ImageType.md), `imageUrl?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getRemoteImageProviders` | (`itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ImageProviderInfo`](../interfaces/generated_client.ImageProviderInfo.md)[]\>\> | -| `getRemoteImages` | (`itemId`: `string`, `type?`: [`ImageType`](../enums/generated_client.ImageType.md), `startIndex?`: `number`, `limit?`: `number`, `providerName?`: `string`, `includeAllLanguages?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RemoteImageResult`](../interfaces/generated_client.RemoteImageResult.md)\>\> | - -#### Defined in - -[generated-client/api/remote-image-api.ts:192](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L192) - -___ - -### ScheduledTasksApiAxiosParamCreator - -▸ **ScheduledTasksApiAxiosParamCreator**(`configuration?`): `Object` - -ScheduledTasksApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getTask` | (`taskId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getTasks` | (`isHidden?`: `boolean`, `isEnabled?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `startTask` | (`taskId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `stopTask` | (`taskId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateTask` | (`taskId`: `string`, `taskTriggerInfo`: [`TaskTriggerInfo`](../interfaces/generated_client.TaskTriggerInfo.md)[], `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L33) - -___ - -### ScheduledTasksApiFactory - -▸ **ScheduledTasksApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ScheduledTasksApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getTask` | (`taskId`: `string`, `options?`: `any`) => `AxiosPromise`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md)\> | -| `getTasks` | (`isHidden?`: `boolean`, `isEnabled?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md)[]\> | -| `startTask` | (`taskId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `stopTask` | (`taskId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateTask` | (`taskId`: `string`, `taskTriggerInfo`: [`TaskTriggerInfo`](../interfaces/generated_client.TaskTriggerInfo.md)[], `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:306](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L306) - -___ - -### ScheduledTasksApiFp - -▸ **ScheduledTasksApiFp**(`configuration?`): `Object` - -ScheduledTasksApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getTask` | (`taskId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md)\>\> | -| `getTasks` | (`isHidden?`: `boolean`, `isEnabled?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md)[]\>\> | -| `startTask` | (`taskId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `stopTask` | (`taskId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateTask` | (`taskId`: `string`, `taskTriggerInfo`: [`TaskTriggerInfo`](../interfaces/generated_client.TaskTriggerInfo.md)[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/scheduled-tasks-api.ts:239](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L239) - -___ - -### SearchApiAxiosParamCreator - -▸ **SearchApiAxiosParamCreator**(`configuration?`): `Object` - -SearchApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `get` | (`searchTerm`: `string`, `startIndex?`: `number`, `limit?`: `number`, `userId?`: `string`, `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `mediaTypes?`: `string`[], `parentId?`: `string`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `includePeople?`: `boolean`, `includeMedia?`: `boolean`, `includeGenres?`: `boolean`, `includeStudios?`: `boolean`, `includeArtists?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/search-api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L31) - -___ - -### SearchApiFactory - -▸ **SearchApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -SearchApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `get` | (`searchTerm`: `string`, `startIndex?`: `number`, `limit?`: `number`, `userId?`: `string`, `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `mediaTypes?`: `string`[], `parentId?`: `string`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `includePeople?`: `boolean`, `includeMedia?`: `boolean`, `includeGenres?`: `boolean`, `includeStudios?`: `boolean`, `includeArtists?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`SearchHintResult`](../interfaces/generated_client.SearchHintResult.md)\> | - -#### Defined in - -[generated-client/api/search-api.ts:203](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L203) - -___ - -### SearchApiFp - -▸ **SearchApiFp**(`configuration?`): `Object` - -SearchApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `get` | (`searchTerm`: `string`, `startIndex?`: `number`, `limit?`: `number`, `userId?`: `string`, `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `mediaTypes?`: `string`[], `parentId?`: `string`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `includePeople?`: `boolean`, `includeMedia?`: `boolean`, `includeGenres?`: `boolean`, `includeStudios?`: `boolean`, `includeArtists?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`SearchHintResult`](../interfaces/generated_client.SearchHintResult.md)\>\> | - -#### Defined in - -[generated-client/api/search-api.ts:165](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L165) - -___ - -### SessionApiAxiosParamCreator - -▸ **SessionApiAxiosParamCreator**(`configuration?`): `Object` - -SessionApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addUserToSession` | (`sessionId`: `string`, `userId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `displayContent` | (`sessionId`: `string`, `itemType`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md), `itemId`: `string`, `itemName`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getAuthProviders` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPasswordResetProviders` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSessions` | (`controllableByUserId?`: `string`, `deviceId?`: `string`, `activeWithinSeconds?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `play` | (`sessionId`: `string`, `playCommand`: [`PlayCommand`](../enums/generated_client.PlayCommand.md), `itemIds`: `string`[], `startPositionTicks?`: `number`, `mediaSourceId?`: `string`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `startIndex?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `postCapabilities` | (`id?`: `string`, `playableMediaTypes?`: `string`[], `supportedCommands?`: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md)[], `supportsMediaControl?`: `boolean`, `supportsSync?`: `boolean`, `supportsPersistentIdentifier?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `postFullCapabilities` | (`clientCapabilitiesDto`: [`ClientCapabilitiesDto`](../interfaces/generated_client.ClientCapabilitiesDto.md), `id?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `removeUserFromSession` | (`sessionId`: `string`, `userId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `reportSessionEnded` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `reportViewing` | (`itemId`: `string`, `sessionId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `sendFullGeneralCommand` | (`sessionId`: `string`, `generalCommand`: [`GeneralCommand`](../interfaces/generated_client.GeneralCommand.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `sendGeneralCommand` | (`sessionId`: `string`, `command`: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `sendMessageCommand` | (`sessionId`: `string`, `messageCommand`: [`MessageCommand`](../interfaces/generated_client.MessageCommand.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `sendPlaystateCommand` | (`sessionId`: `string`, `command`: [`PlaystateCommand`](../enums/generated_client.PlaystateCommand.md), `seekPositionTicks?`: `number`, `controllingUserId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `sendSystemCommand` | (`sessionId`: `string`, `command`: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/session-api.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L45) - -___ - -### SessionApiFactory - -▸ **SessionApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -SessionApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addUserToSession` | (`sessionId`: `string`, `userId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `displayContent` | (`sessionId`: `string`, `itemType`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md), `itemId`: `string`, `itemName`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getAuthProviders` | (`options?`: `any`) => `AxiosPromise`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\> | -| `getPasswordResetProviders` | (`options?`: `any`) => `AxiosPromise`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\> | -| `getSessions` | (`controllableByUserId?`: `string`, `deviceId?`: `string`, `activeWithinSeconds?`: `number`, `options?`: `any`) => `AxiosPromise`<[`SessionInfo`](../interfaces/generated_client.SessionInfo.md)[]\> | -| `play` | (`sessionId`: `string`, `playCommand`: [`PlayCommand`](../enums/generated_client.PlayCommand.md), `itemIds`: `string`[], `startPositionTicks?`: `number`, `mediaSourceId?`: `string`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `startIndex?`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `postCapabilities` | (`id?`: `string`, `playableMediaTypes?`: `string`[], `supportedCommands?`: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md)[], `supportsMediaControl?`: `boolean`, `supportsSync?`: `boolean`, `supportsPersistentIdentifier?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `postFullCapabilities` | (`clientCapabilitiesDto`: [`ClientCapabilitiesDto`](../interfaces/generated_client.ClientCapabilitiesDto.md), `id?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `removeUserFromSession` | (`sessionId`: `string`, `userId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `reportSessionEnded` | (`options?`: `any`) => `AxiosPromise`<`void`\> | -| `reportViewing` | (`itemId`: `string`, `sessionId?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `sendFullGeneralCommand` | (`sessionId`: `string`, `generalCommand`: [`GeneralCommand`](../interfaces/generated_client.GeneralCommand.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `sendGeneralCommand` | (`sessionId`: `string`, `command`: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `sendMessageCommand` | (`sessionId`: `string`, `messageCommand`: [`MessageCommand`](../interfaces/generated_client.MessageCommand.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `sendPlaystateCommand` | (`sessionId`: `string`, `command`: [`PlaystateCommand`](../enums/generated_client.PlaystateCommand.md), `seekPositionTicks?`: `number`, `controllingUserId?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `sendSystemCommand` | (`sessionId`: `string`, `command`: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md), `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/session-api.ts:999](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L999) - -___ - -### SessionApiFp - -▸ **SessionApiFp**(`configuration?`): `Object` - -SessionApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `addUserToSession` | (`sessionId`: `string`, `userId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `displayContent` | (`sessionId`: `string`, `itemType`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md), `itemId`: `string`, `itemName`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getAuthProviders` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\>\> | -| `getPasswordResetProviders` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\>\> | -| `getSessions` | (`controllableByUserId?`: `string`, `deviceId?`: `string`, `activeWithinSeconds?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`SessionInfo`](../interfaces/generated_client.SessionInfo.md)[]\>\> | -| `play` | (`sessionId`: `string`, `playCommand`: [`PlayCommand`](../enums/generated_client.PlayCommand.md), `itemIds`: `string`[], `startPositionTicks?`: `number`, `mediaSourceId?`: `string`, `audioStreamIndex?`: `number`, `subtitleStreamIndex?`: `number`, `startIndex?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `postCapabilities` | (`id?`: `string`, `playableMediaTypes?`: `string`[], `supportedCommands?`: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md)[], `supportsMediaControl?`: `boolean`, `supportsSync?`: `boolean`, `supportsPersistentIdentifier?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `postFullCapabilities` | (`clientCapabilitiesDto`: [`ClientCapabilitiesDto`](../interfaces/generated_client.ClientCapabilitiesDto.md), `id?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `removeUserFromSession` | (`sessionId`: `string`, `userId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `reportSessionEnded` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `reportViewing` | (`itemId`: `string`, `sessionId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `sendFullGeneralCommand` | (`sessionId`: `string`, `generalCommand`: [`GeneralCommand`](../interfaces/generated_client.GeneralCommand.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `sendGeneralCommand` | (`sessionId`: `string`, `command`: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `sendMessageCommand` | (`sessionId`: `string`, `messageCommand`: [`MessageCommand`](../interfaces/generated_client.MessageCommand.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `sendPlaystateCommand` | (`sessionId`: `string`, `command`: [`PlaystateCommand`](../enums/generated_client.PlaystateCommand.md), `seekPositionTicks?`: `number`, `controllingUserId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `sendSystemCommand` | (`sessionId`: `string`, `command`: [`GeneralCommandType`](../enums/generated_client.GeneralCommandType.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/session-api.ts:788](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L788) - -___ - -### StartupApiAxiosParamCreator - -▸ **StartupApiAxiosParamCreator**(`configuration?`): `Object` - -StartupApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `completeWizard` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getFirstUser` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getFirstUser2` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getStartupConfiguration` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `setRemoteAccess` | (`startupRemoteAccessDto`: [`StartupRemoteAccessDto`](../interfaces/generated_client.StartupRemoteAccessDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateInitialConfiguration` | (`startupConfigurationDto`: [`StartupConfigurationDto`](../interfaces/generated_client.StartupConfigurationDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateStartupUser` | (`startupUserDto?`: [`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/startup-api.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L33) - -___ - -### StartupApiFactory - -▸ **StartupApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -StartupApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `completeWizard` | (`options?`: `any`) => `AxiosPromise`<`void`\> | -| `getFirstUser` | (`options?`: `any`) => `AxiosPromise`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md)\> | -| `getFirstUser2` | (`options?`: `any`) => `AxiosPromise`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md)\> | -| `getStartupConfiguration` | (`options?`: `any`) => `AxiosPromise`<[`StartupConfigurationDto`](../interfaces/generated_client.StartupConfigurationDto.md)\> | -| `setRemoteAccess` | (`startupRemoteAccessDto`: [`StartupRemoteAccessDto`](../interfaces/generated_client.StartupRemoteAccessDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateInitialConfiguration` | (`startupConfigurationDto`: [`StartupConfigurationDto`](../interfaces/generated_client.StartupConfigurationDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateStartupUser` | (`startupUserDto?`: [`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/startup-api.ts:372](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L372) - -___ - -### StartupApiFp - -▸ **StartupApiFp**(`configuration?`): `Object` - -StartupApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `completeWizard` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getFirstUser` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md)\>\> | -| `getFirstUser2` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md)\>\> | -| `getStartupConfiguration` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`StartupConfigurationDto`](../interfaces/generated_client.StartupConfigurationDto.md)\>\> | -| `setRemoteAccess` | (`startupRemoteAccessDto`: [`StartupRemoteAccessDto`](../interfaces/generated_client.StartupRemoteAccessDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateInitialConfiguration` | (`startupConfigurationDto`: [`StartupConfigurationDto`](../interfaces/generated_client.StartupConfigurationDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateStartupUser` | (`startupUserDto?`: [`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/startup-api.ts:289](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L289) - -___ - -### StudiosApiAxiosParamCreator - -▸ **StudiosApiAxiosParamCreator**(`configuration?`): `Object` - -StudiosApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getStudio` | (`name`: `string`, `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getStudios` | (`startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isFavorite?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/studios-api.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L37) - -___ - -### StudiosApiFactory - -▸ **StudiosApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -StudiosApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getStudio` | (`name`: `string`, `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\> | -| `getStudios` | (`startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isFavorite?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/studios-api.ts:255](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L255) - -___ - -### StudiosApiFp - -▸ **StudiosApiFp**(`configuration?`): `Object` - -StudiosApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getStudio` | (`name`: `string`, `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\> | -| `getStudios` | (`startIndex?`: `number`, `limit?`: `number`, `searchTerm?`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isFavorite?`: `boolean`, `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `userId?`: `string`, `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `enableImages?`: `boolean`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/studios-api.ts:206](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L206) - -___ - -### SubtitleApiAxiosParamCreator - -▸ **SubtitleApiAxiosParamCreator**(`configuration?`): `Object` - -SubtitleApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteSubtitle` | (`itemId`: `string`, `index`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `downloadRemoteSubtitles` | (`itemId`: `string`, `subtitleId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getFallbackFont` | (`name`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getFallbackFontList` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRemoteSubtitles` | (`id`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSubtitle` | (`routeItemId`: `string`, `routeMediaSourceId`: `string`, `routeIndex`: `number`, `routeFormat`: `string`, `itemId?`: `string`, `mediaSourceId?`: `string`, `index?`: `number`, `format?`: `string`, `endPositionTicks?`: `number`, `copyTimestamps?`: `boolean`, `addVttTimeMap?`: `boolean`, `startPositionTicks?`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSubtitlePlaylist` | (`itemId`: `string`, `index`: `number`, `mediaSourceId`: `string`, `segmentLength`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSubtitleWithTicks` | (`routeItemId`: `string`, `routeMediaSourceId`: `string`, `routeIndex`: `number`, `routeStartPositionTicks`: `number`, `routeFormat`: `string`, `itemId?`: `string`, `mediaSourceId?`: `string`, `index?`: `number`, `startPositionTicks?`: `number`, `format?`: `string`, `endPositionTicks?`: `number`, `copyTimestamps?`: `boolean`, `addVttTimeMap?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `searchRemoteSubtitles` | (`itemId`: `string`, `language`: `string`, `isPerfectMatch?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `uploadSubtitle` | (`itemId`: `string`, `uploadSubtitleDto`: [`UploadSubtitleDto`](../interfaces/generated_client.UploadSubtitleDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/subtitle-api.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L35) - -___ - -### SubtitleApiFactory - -▸ **SubtitleApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -SubtitleApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteSubtitle` | (`itemId`: `string`, `index`: `number`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `downloadRemoteSubtitles` | (`itemId`: `string`, `subtitleId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getFallbackFont` | (`name`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getFallbackFontList` | (`options?`: `any`) => `AxiosPromise`<[`FontFile`](../interfaces/generated_client.FontFile.md)[]\> | -| `getRemoteSubtitles` | (`id`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getSubtitle` | (`routeItemId`: `string`, `routeMediaSourceId`: `string`, `routeIndex`: `number`, `routeFormat`: `string`, `itemId?`: `string`, `mediaSourceId?`: `string`, `index?`: `number`, `format?`: `string`, `endPositionTicks?`: `number`, `copyTimestamps?`: `boolean`, `addVttTimeMap?`: `boolean`, `startPositionTicks?`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getSubtitlePlaylist` | (`itemId`: `string`, `index`: `number`, `mediaSourceId`: `string`, `segmentLength`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getSubtitleWithTicks` | (`routeItemId`: `string`, `routeMediaSourceId`: `string`, `routeIndex`: `number`, `routeStartPositionTicks`: `number`, `routeFormat`: `string`, `itemId?`: `string`, `mediaSourceId?`: `string`, `index?`: `number`, `startPositionTicks?`: `number`, `format?`: `string`, `endPositionTicks?`: `number`, `copyTimestamps?`: `boolean`, `addVttTimeMap?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `searchRemoteSubtitles` | (`itemId`: `string`, `language`: `string`, `isPerfectMatch?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`RemoteSubtitleInfo`](../interfaces/generated_client.RemoteSubtitleInfo.md)[]\> | -| `uploadSubtitle` | (`itemId`: `string`, `uploadSubtitleDto`: [`UploadSubtitleDto`](../interfaces/generated_client.UploadSubtitleDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/subtitle-api.ts:700](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L700) - -___ - -### SubtitleApiFp - -▸ **SubtitleApiFp**(`configuration?`): `Object` - -SubtitleApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteSubtitle` | (`itemId`: `string`, `index`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `downloadRemoteSubtitles` | (`itemId`: `string`, `subtitleId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getFallbackFont` | (`name`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getFallbackFontList` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`FontFile`](../interfaces/generated_client.FontFile.md)[]\>\> | -| `getRemoteSubtitles` | (`id`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getSubtitle` | (`routeItemId`: `string`, `routeMediaSourceId`: `string`, `routeIndex`: `number`, `routeFormat`: `string`, `itemId?`: `string`, `mediaSourceId?`: `string`, `index?`: `number`, `format?`: `string`, `endPositionTicks?`: `number`, `copyTimestamps?`: `boolean`, `addVttTimeMap?`: `boolean`, `startPositionTicks?`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getSubtitlePlaylist` | (`itemId`: `string`, `index`: `number`, `mediaSourceId`: `string`, `segmentLength`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getSubtitleWithTicks` | (`routeItemId`: `string`, `routeMediaSourceId`: `string`, `routeIndex`: `number`, `routeStartPositionTicks`: `number`, `routeFormat`: `string`, `itemId?`: `string`, `mediaSourceId?`: `string`, `index?`: `number`, `startPositionTicks?`: `number`, `format?`: `string`, `endPositionTicks?`: `number`, `copyTimestamps?`: `boolean`, `addVttTimeMap?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `searchRemoteSubtitles` | (`itemId`: `string`, `language`: `string`, `isPerfectMatch?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`RemoteSubtitleInfo`](../interfaces/generated_client.RemoteSubtitleInfo.md)[]\>\> | -| `uploadSubtitle` | (`itemId`: `string`, `uploadSubtitleDto`: [`UploadSubtitleDto`](../interfaces/generated_client.UploadSubtitleDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/subtitle-api.ts:550](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L550) - -___ - -### SuggestionsApiAxiosParamCreator - -▸ **SuggestionsApiAxiosParamCreator**(`configuration?`): `Object` - -SuggestionsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getSuggestions` | (`userId`: `string`, `mediaType?`: `string`[], `type?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `startIndex?`: `number`, `limit?`: `number`, `enableTotalRecordCount?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/suggestions-api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/suggestions-api.ts#L31) - -___ - -### SuggestionsApiFactory - -▸ **SuggestionsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -SuggestionsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getSuggestions` | (`userId`: `string`, `mediaType?`: `string`[], `type?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `startIndex?`: `number`, `limit?`: `number`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/suggestions-api.ts:128](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/suggestions-api.ts#L128) - -___ - -### SuggestionsApiFp - -▸ **SuggestionsApiFp**(`configuration?`): `Object` - -SuggestionsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getSuggestions` | (`userId`: `string`, `mediaType?`: `string`[], `type?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `startIndex?`: `number`, `limit?`: `number`, `enableTotalRecordCount?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/suggestions-api.ts:102](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/suggestions-api.ts#L102) - -___ - -### SyncPlayApiAxiosParamCreator - -▸ **SyncPlayApiAxiosParamCreator**(`configuration?`): `Object` - -SyncPlayApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `syncPlayBuffering` | (`bufferRequestDto`: [`BufferRequestDto`](../interfaces/generated_client.BufferRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayCreateGroup` | (`newGroupRequestDto`: [`NewGroupRequestDto`](../interfaces/generated_client.NewGroupRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayGetGroups` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayJoinGroup` | (`joinGroupRequestDto`: [`JoinGroupRequestDto`](../interfaces/generated_client.JoinGroupRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayLeaveGroup` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayMovePlaylistItem` | (`movePlaylistItemRequestDto`: [`MovePlaylistItemRequestDto`](../interfaces/generated_client.MovePlaylistItemRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayNextItem` | (`nextItemRequestDto`: [`NextItemRequestDto`](../interfaces/generated_client.NextItemRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayPause` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayPing` | (`pingRequestDto`: [`PingRequestDto`](../interfaces/generated_client.PingRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayPreviousItem` | (`previousItemRequestDto`: [`PreviousItemRequestDto`](../interfaces/generated_client.PreviousItemRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayQueue` | (`queueRequestDto`: [`QueueRequestDto`](../interfaces/generated_client.QueueRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayReady` | (`readyRequestDto`: [`ReadyRequestDto`](../interfaces/generated_client.ReadyRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayRemoveFromPlaylist` | (`removeFromPlaylistRequestDto`: [`RemoveFromPlaylistRequestDto`](../interfaces/generated_client.RemoveFromPlaylistRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlaySeek` | (`seekRequestDto`: [`SeekRequestDto`](../interfaces/generated_client.SeekRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlaySetIgnoreWait` | (`ignoreWaitRequestDto`: [`IgnoreWaitRequestDto`](../interfaces/generated_client.IgnoreWaitRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlaySetNewQueue` | (`playRequestDto`: [`PlayRequestDto`](../interfaces/generated_client.PlayRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlaySetPlaylistItem` | (`setPlaylistItemRequestDto`: [`SetPlaylistItemRequestDto`](../interfaces/generated_client.SetPlaylistItemRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlaySetRepeatMode` | (`setRepeatModeRequestDto`: [`SetRepeatModeRequestDto`](../interfaces/generated_client.SetRepeatModeRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlaySetShuffleMode` | (`setShuffleModeRequestDto`: [`SetShuffleModeRequestDto`](../interfaces/generated_client.SetShuffleModeRequestDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayStop` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `syncPlayUnpause` | (`options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/sync-play-api.ts:61](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L61) - -___ - -### SyncPlayApiFactory - -▸ **SyncPlayApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -SyncPlayApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `syncPlayBuffering` | (`bufferRequestDto`: [`BufferRequestDto`](../interfaces/generated_client.BufferRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayCreateGroup` | (`newGroupRequestDto`: [`NewGroupRequestDto`](../interfaces/generated_client.NewGroupRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayGetGroups` | (`options?`: `any`) => `AxiosPromise`<[`GroupInfoDto`](../interfaces/generated_client.GroupInfoDto.md)[]\> | -| `syncPlayJoinGroup` | (`joinGroupRequestDto`: [`JoinGroupRequestDto`](../interfaces/generated_client.JoinGroupRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayLeaveGroup` | (`options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayMovePlaylistItem` | (`movePlaylistItemRequestDto`: [`MovePlaylistItemRequestDto`](../interfaces/generated_client.MovePlaylistItemRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayNextItem` | (`nextItemRequestDto`: [`NextItemRequestDto`](../interfaces/generated_client.NextItemRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayPause` | (`options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayPing` | (`pingRequestDto`: [`PingRequestDto`](../interfaces/generated_client.PingRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayPreviousItem` | (`previousItemRequestDto`: [`PreviousItemRequestDto`](../interfaces/generated_client.PreviousItemRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayQueue` | (`queueRequestDto`: [`QueueRequestDto`](../interfaces/generated_client.QueueRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayReady` | (`readyRequestDto`: [`ReadyRequestDto`](../interfaces/generated_client.ReadyRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayRemoveFromPlaylist` | (`removeFromPlaylistRequestDto`: [`RemoveFromPlaylistRequestDto`](../interfaces/generated_client.RemoveFromPlaylistRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlaySeek` | (`seekRequestDto`: [`SeekRequestDto`](../interfaces/generated_client.SeekRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlaySetIgnoreWait` | (`ignoreWaitRequestDto`: [`IgnoreWaitRequestDto`](../interfaces/generated_client.IgnoreWaitRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlaySetNewQueue` | (`playRequestDto`: [`PlayRequestDto`](../interfaces/generated_client.PlayRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlaySetPlaylistItem` | (`setPlaylistItemRequestDto`: [`SetPlaylistItemRequestDto`](../interfaces/generated_client.SetPlaylistItemRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlaySetRepeatMode` | (`setRepeatModeRequestDto`: [`SetRepeatModeRequestDto`](../interfaces/generated_client.SetRepeatModeRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlaySetShuffleMode` | (`setShuffleModeRequestDto`: [`SetShuffleModeRequestDto`](../interfaces/generated_client.SetShuffleModeRequestDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayStop` | (`options?`: `any`) => `AxiosPromise`<`void`\> | -| `syncPlayUnpause` | (`options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/sync-play-api.ts:1095](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1095) - -___ - -### SyncPlayApiFp - -▸ **SyncPlayApiFp**(`configuration?`): `Object` - -SyncPlayApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `syncPlayBuffering` | (`bufferRequestDto`: [`BufferRequestDto`](../interfaces/generated_client.BufferRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayCreateGroup` | (`newGroupRequestDto`: [`NewGroupRequestDto`](../interfaces/generated_client.NewGroupRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayGetGroups` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GroupInfoDto`](../interfaces/generated_client.GroupInfoDto.md)[]\>\> | -| `syncPlayJoinGroup` | (`joinGroupRequestDto`: [`JoinGroupRequestDto`](../interfaces/generated_client.JoinGroupRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayLeaveGroup` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayMovePlaylistItem` | (`movePlaylistItemRequestDto`: [`MovePlaylistItemRequestDto`](../interfaces/generated_client.MovePlaylistItemRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayNextItem` | (`nextItemRequestDto`: [`NextItemRequestDto`](../interfaces/generated_client.NextItemRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayPause` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayPing` | (`pingRequestDto`: [`PingRequestDto`](../interfaces/generated_client.PingRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayPreviousItem` | (`previousItemRequestDto`: [`PreviousItemRequestDto`](../interfaces/generated_client.PreviousItemRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayQueue` | (`queueRequestDto`: [`QueueRequestDto`](../interfaces/generated_client.QueueRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayReady` | (`readyRequestDto`: [`ReadyRequestDto`](../interfaces/generated_client.ReadyRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayRemoveFromPlaylist` | (`removeFromPlaylistRequestDto`: [`RemoveFromPlaylistRequestDto`](../interfaces/generated_client.RemoveFromPlaylistRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlaySeek` | (`seekRequestDto`: [`SeekRequestDto`](../interfaces/generated_client.SeekRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlaySetIgnoreWait` | (`ignoreWaitRequestDto`: [`IgnoreWaitRequestDto`](../interfaces/generated_client.IgnoreWaitRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlaySetNewQueue` | (`playRequestDto`: [`PlayRequestDto`](../interfaces/generated_client.PlayRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlaySetPlaylistItem` | (`setPlaylistItemRequestDto`: [`SetPlaylistItemRequestDto`](../interfaces/generated_client.SetPlaylistItemRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlaySetRepeatMode` | (`setRepeatModeRequestDto`: [`SetRepeatModeRequestDto`](../interfaces/generated_client.SetRepeatModeRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlaySetShuffleMode` | (`setShuffleModeRequestDto`: [`SetShuffleModeRequestDto`](../interfaces/generated_client.SetShuffleModeRequestDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayStop` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `syncPlayUnpause` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/sync-play-api.ts:859](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L859) - -___ - -### SystemApiAxiosParamCreator - -▸ **SystemApiAxiosParamCreator**(`configuration?`): `Object` - -SystemApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getEndpointInfo` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLogFile` | (`name`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPingSystem` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPublicSystemInfo` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getServerLogs` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSystemInfo` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getWakeOnLanInfo` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `postPingSystem` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `restartApplication` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `shutdownApplication` | (`options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/system-api.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L37) - -___ - -### SystemApiFactory - -▸ **SystemApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -SystemApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getEndpointInfo` | (`options?`: `any`) => `AxiosPromise`<[`EndPointInfo`](../interfaces/generated_client.EndPointInfo.md)\> | -| `getLogFile` | (`name`: `string`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getPingSystem` | (`options?`: `any`) => `AxiosPromise`<`string`\> | -| `getPublicSystemInfo` | (`options?`: `any`) => `AxiosPromise`<[`PublicSystemInfo`](../interfaces/generated_client.PublicSystemInfo.md)\> | -| `getServerLogs` | (`options?`: `any`) => `AxiosPromise`<[`LogFile`](../interfaces/generated_client.LogFile.md)[]\> | -| `getSystemInfo` | (`options?`: `any`) => `AxiosPromise`<[`SystemInfo`](../interfaces/generated_client.SystemInfo.md)\> | -| `getWakeOnLanInfo` | (`options?`: `any`) => `AxiosPromise`<[`WakeOnLanInfo`](../interfaces/generated_client.WakeOnLanInfo.md)[]\> | -| `postPingSystem` | (`options?`: `any`) => `AxiosPromise`<`string`\> | -| `restartApplication` | (`options?`: `any`) => `AxiosPromise`<`void`\> | -| `shutdownApplication` | (`options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/system-api.ts:487](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L487) - -___ - -### SystemApiFp - -▸ **SystemApiFp**(`configuration?`): `Object` - -SystemApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getEndpointInfo` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`EndPointInfo`](../interfaces/generated_client.EndPointInfo.md)\>\> | -| `getLogFile` | (`name`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getPingSystem` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`\>\> | -| `getPublicSystemInfo` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PublicSystemInfo`](../interfaces/generated_client.PublicSystemInfo.md)\>\> | -| `getServerLogs` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`LogFile`](../interfaces/generated_client.LogFile.md)[]\>\> | -| `getSystemInfo` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`SystemInfo`](../interfaces/generated_client.SystemInfo.md)\>\> | -| `getWakeOnLanInfo` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`WakeOnLanInfo`](../interfaces/generated_client.WakeOnLanInfo.md)[]\>\> | -| `postPingSystem` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`\>\> | -| `restartApplication` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `shutdownApplication` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/system-api.ts:375](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L375) - -___ - -### TimeSyncApiAxiosParamCreator - -▸ **TimeSyncApiAxiosParamCreator**(`configuration?`): `Object` - -TimeSyncApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getUtcTime` | (`options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/time-sync-api.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/time-sync-api.ts#L29) - -___ - -### TimeSyncApiFactory - -▸ **TimeSyncApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -TimeSyncApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getUtcTime` | (`options?`: `any`) => `AxiosPromise`<[`UtcTimeResponse`](../interfaces/generated_client.UtcTimeResponse.md)\> | - -#### Defined in - -[generated-client/api/time-sync-api.ts:88](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/time-sync-api.ts#L88) - -___ - -### TimeSyncApiFp - -▸ **TimeSyncApiFp**(`configuration?`): `Object` - -TimeSyncApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getUtcTime` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UtcTimeResponse`](../interfaces/generated_client.UtcTimeResponse.md)\>\> | - -#### Defined in - -[generated-client/api/time-sync-api.ts:68](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/time-sync-api.ts#L68) - -___ - -### TmdbApiAxiosParamCreator - -▸ **TmdbApiAxiosParamCreator**(`configuration?`): `Object` - -TmdbApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `tmdbClientConfiguration` | (`options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/tmdb-api.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tmdb-api.ts#L29) - -___ - -### TmdbApiFactory - -▸ **TmdbApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -TmdbApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `tmdbClientConfiguration` | (`options?`: `any`) => `AxiosPromise`<[`ConfigImageTypes`](../interfaces/generated_client.ConfigImageTypes.md)\> | - -#### Defined in - -[generated-client/api/tmdb-api.ts:91](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tmdb-api.ts#L91) - -___ - -### TmdbApiFp - -▸ **TmdbApiFp**(`configuration?`): `Object` - -TmdbApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `tmdbClientConfiguration` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ConfigImageTypes`](../interfaces/generated_client.ConfigImageTypes.md)\>\> | - -#### Defined in - -[generated-client/api/tmdb-api.ts:71](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tmdb-api.ts#L71) - -___ - -### TrailersApiAxiosParamCreator - -▸ **TrailersApiAxiosParamCreator**(`configuration?`): `Object` - -TrailersApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getTrailers` | (`userId?`: `string`, `maxOfficialRating?`: `string`, `hasThemeSong?`: `boolean`, `hasThemeVideo?`: `boolean`, `hasSubtitles?`: `boolean`, `hasSpecialFeature?`: `boolean`, `hasTrailer?`: `boolean`, `adjacentTo?`: `string`, `parentIndexNumber?`: `number`, `hasParentalRating?`: `boolean`, `isHd?`: `boolean`, `is4K?`: `boolean`, `locationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `excludeLocationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `isMissing?`: `boolean`, `isUnaired?`: `boolean`, `minCommunityRating?`: `number`, `minCriticRating?`: `number`, `minPremiereDate?`: `string`, `minDateLastSaved?`: `string`, `minDateLastSavedForUser?`: `string`, `maxPremiereDate?`: `string`, `hasOverview?`: `boolean`, `hasImdbId?`: `boolean`, `hasTmdbId?`: `boolean`, `hasTvdbId?`: `boolean`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `excludeItemIds?`: `string`[], `startIndex?`: `number`, `limit?`: `number`, `recursive?`: `boolean`, `searchTerm?`: `string`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `imageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `sortBy?`: `string`[], `isPlayed?`: `boolean`, `genres?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `artists?`: `string`[], `excludeArtistIds?`: `string`[], `artistIds?`: `string`[], `albumArtistIds?`: `string`[], `contributingArtistIds?`: `string`[], `albums?`: `string`[], `albumIds?`: `string`[], `ids?`: `string`[], `videoTypes?`: [`VideoType`](../enums/generated_client.VideoType.md)[], `minOfficialRating?`: `string`, `isLocked?`: `boolean`, `isPlaceHolder?`: `boolean`, `hasOfficialRating?`: `boolean`, `collapseBoxSetItems?`: `boolean`, `minWidth?`: `number`, `minHeight?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `is3D?`: `boolean`, `seriesStatus?`: [`SeriesStatus`](../enums/generated_client.SeriesStatus.md)[], `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `studioIds?`: `string`[], `genreIds?`: `string`[], `enableTotalRecordCount?`: `boolean`, `enableImages?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/trailers-api.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L45) - -___ - -### TrailersApiFactory - -▸ **TrailersApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -TrailersApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getTrailers` | (`userId?`: `string`, `maxOfficialRating?`: `string`, `hasThemeSong?`: `boolean`, `hasThemeVideo?`: `boolean`, `hasSubtitles?`: `boolean`, `hasSpecialFeature?`: `boolean`, `hasTrailer?`: `boolean`, `adjacentTo?`: `string`, `parentIndexNumber?`: `number`, `hasParentalRating?`: `boolean`, `isHd?`: `boolean`, `is4K?`: `boolean`, `locationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `excludeLocationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `isMissing?`: `boolean`, `isUnaired?`: `boolean`, `minCommunityRating?`: `number`, `minCriticRating?`: `number`, `minPremiereDate?`: `string`, `minDateLastSaved?`: `string`, `minDateLastSavedForUser?`: `string`, `maxPremiereDate?`: `string`, `hasOverview?`: `boolean`, `hasImdbId?`: `boolean`, `hasTmdbId?`: `boolean`, `hasTvdbId?`: `boolean`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `excludeItemIds?`: `string`[], `startIndex?`: `number`, `limit?`: `number`, `recursive?`: `boolean`, `searchTerm?`: `string`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `imageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `sortBy?`: `string`[], `isPlayed?`: `boolean`, `genres?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `artists?`: `string`[], `excludeArtistIds?`: `string`[], `artistIds?`: `string`[], `albumArtistIds?`: `string`[], `contributingArtistIds?`: `string`[], `albums?`: `string`[], `albumIds?`: `string`[], `ids?`: `string`[], `videoTypes?`: [`VideoType`](../enums/generated_client.VideoType.md)[], `minOfficialRating?`: `string`, `isLocked?`: `boolean`, `isPlaceHolder?`: `boolean`, `hasOfficialRating?`: `boolean`, `collapseBoxSetItems?`: `boolean`, `minWidth?`: `number`, `minHeight?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `is3D?`: `boolean`, `seriesStatus?`: [`SeriesStatus`](../enums/generated_client.SeriesStatus.md)[], `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `studioIds?`: `string`[], `genreIds?`: `string`[], `enableTotalRecordCount?`: `boolean`, `enableImages?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/trailers-api.ts:619](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L619) - -___ - -### TrailersApiFp - -▸ **TrailersApiFp**(`configuration?`): `Object` - -TrailersApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getTrailers` | (`userId?`: `string`, `maxOfficialRating?`: `string`, `hasThemeSong?`: `boolean`, `hasThemeVideo?`: `boolean`, `hasSubtitles?`: `boolean`, `hasSpecialFeature?`: `boolean`, `hasTrailer?`: `boolean`, `adjacentTo?`: `string`, `parentIndexNumber?`: `number`, `hasParentalRating?`: `boolean`, `isHd?`: `boolean`, `is4K?`: `boolean`, `locationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `excludeLocationTypes?`: [`LocationType`](../enums/generated_client.LocationType.md)[], `isMissing?`: `boolean`, `isUnaired?`: `boolean`, `minCommunityRating?`: `number`, `minCriticRating?`: `number`, `minPremiereDate?`: `string`, `minDateLastSaved?`: `string`, `minDateLastSavedForUser?`: `string`, `maxPremiereDate?`: `string`, `hasOverview?`: `boolean`, `hasImdbId?`: `boolean`, `hasTmdbId?`: `boolean`, `hasTvdbId?`: `boolean`, `isMovie?`: `boolean`, `isSeries?`: `boolean`, `isNews?`: `boolean`, `isKids?`: `boolean`, `isSports?`: `boolean`, `excludeItemIds?`: `string`[], `startIndex?`: `number`, `limit?`: `number`, `recursive?`: `boolean`, `searchTerm?`: `string`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `filters?`: [`ItemFilter`](../enums/generated_client.ItemFilter.md)[], `isFavorite?`: `boolean`, `mediaTypes?`: `string`[], `imageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `sortBy?`: `string`[], `isPlayed?`: `boolean`, `genres?`: `string`[], `officialRatings?`: `string`[], `tags?`: `string`[], `years?`: `number`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `person?`: `string`, `personIds?`: `string`[], `personTypes?`: `string`[], `studios?`: `string`[], `artists?`: `string`[], `excludeArtistIds?`: `string`[], `artistIds?`: `string`[], `albumArtistIds?`: `string`[], `contributingArtistIds?`: `string`[], `albums?`: `string`[], `albumIds?`: `string`[], `ids?`: `string`[], `videoTypes?`: [`VideoType`](../enums/generated_client.VideoType.md)[], `minOfficialRating?`: `string`, `isLocked?`: `boolean`, `isPlaceHolder?`: `boolean`, `hasOfficialRating?`: `boolean`, `collapseBoxSetItems?`: `boolean`, `minWidth?`: `number`, `minHeight?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `is3D?`: `boolean`, `seriesStatus?`: [`SeriesStatus`](../enums/generated_client.SeriesStatus.md)[], `nameStartsWithOrGreater?`: `string`, `nameStartsWith?`: `string`, `nameLessThan?`: `string`, `studioIds?`: `string`[], `genreIds?`: `string`[], `enableTotalRecordCount?`: `boolean`, `enableImages?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/trailers-api.ts:515](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L515) - -___ - -### TvShowsApiAxiosParamCreator - -▸ **TvShowsApiAxiosParamCreator**(`configuration?`): `Object` - -TvShowsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getEpisodes` | (`seriesId`: `string`, `userId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `season?`: `number`, `seasonId?`: `string`, `isMissing?`: `boolean`, `adjacentTo?`: `string`, `startItemId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `sortBy?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getNextUp` | (`userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `seriesId?`: `string`, `parentId?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `nextUpDateCutoff?`: `string`, `enableTotalRecordCount?`: `boolean`, `disableFirstEpisode?`: `boolean`, `enableRewatching?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSeasons` | (`seriesId`: `string`, `userId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `isSpecialSeason?`: `boolean`, `isMissing?`: `boolean`, `adjacentTo?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getUpcomingEpisodes` | (`userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `parentId?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/tv-shows-api.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L35) - -___ - -### TvShowsApiFactory - -▸ **TvShowsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -TvShowsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getEpisodes` | (`seriesId`: `string`, `userId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `season?`: `number`, `seasonId?`: `string`, `isMissing?`: `boolean`, `adjacentTo?`: `string`, `startItemId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `sortBy?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getNextUp` | (`userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `seriesId?`: `string`, `parentId?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `nextUpDateCutoff?`: `string`, `enableTotalRecordCount?`: `boolean`, `disableFirstEpisode?`: `boolean`, `enableRewatching?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getSeasons` | (`seriesId`: `string`, `userId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `isSpecialSeason?`: `boolean`, `isMissing?`: `boolean`, `adjacentTo?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getUpcomingEpisodes` | (`userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `parentId?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/tv-shows-api.ts:514](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L514) - -___ - -### TvShowsApiFp - -▸ **TvShowsApiFp**(`configuration?`): `Object` - -TvShowsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getEpisodes` | (`seriesId`: `string`, `userId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `season?`: `number`, `seasonId?`: `string`, `isMissing?`: `boolean`, `adjacentTo?`: `string`, `startItemId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `sortBy?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getNextUp` | (`userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `seriesId?`: `string`, `parentId?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `nextUpDateCutoff?`: `string`, `enableTotalRecordCount?`: `boolean`, `disableFirstEpisode?`: `boolean`, `enableRewatching?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getSeasons` | (`seriesId`: `string`, `userId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `isSpecialSeason?`: `boolean`, `isMissing?`: `boolean`, `adjacentTo?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getUpcomingEpisodes` | (`userId?`: `string`, `startIndex?`: `number`, `limit?`: `number`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `parentId?`: `string`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/tv-shows-api.ts:416](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L416) - -___ - -### UniversalAudioApiAxiosParamCreator - -▸ **UniversalAudioApiAxiosParamCreator**(`configuration?`): `Object` - -UniversalAudioApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getUniversalAudioStream` | (`itemId`: `string`, `container?`: `string`[], `mediaSourceId?`: `string`, `deviceId?`: `string`, `userId?`: `string`, `audioCodec?`: `string`, `maxAudioChannels?`: `number`, `transcodingAudioChannels?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `startTimeTicks?`: `number`, `transcodingContainer?`: `string`, `transcodingProtocol?`: `string`, `maxAudioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `enableRemoteMedia?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `enableRedirection?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headUniversalAudioStream` | (`itemId`: `string`, `container?`: `string`[], `mediaSourceId?`: `string`, `deviceId?`: `string`, `userId?`: `string`, `audioCodec?`: `string`, `maxAudioChannels?`: `number`, `transcodingAudioChannels?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `startTimeTicks?`: `number`, `transcodingContainer?`: `string`, `transcodingProtocol?`: `string`, `maxAudioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `enableRemoteMedia?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `enableRedirection?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/universal-audio-api.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L27) - -___ - -### UniversalAudioApiFactory - -▸ **UniversalAudioApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -UniversalAudioApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getUniversalAudioStream` | (`itemId`: `string`, `container?`: `string`[], `mediaSourceId?`: `string`, `deviceId?`: `string`, `userId?`: `string`, `audioCodec?`: `string`, `maxAudioChannels?`: `number`, `transcodingAudioChannels?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `startTimeTicks?`: `number`, `transcodingContainer?`: `string`, `transcodingProtocol?`: `string`, `maxAudioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `enableRemoteMedia?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `enableRedirection?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headUniversalAudioStream` | (`itemId`: `string`, `container?`: `string`[], `mediaSourceId?`: `string`, `deviceId?`: `string`, `userId?`: `string`, `audioCodec?`: `string`, `maxAudioChannels?`: `number`, `transcodingAudioChannels?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `startTimeTicks?`: `number`, `transcodingContainer?`: `string`, `transcodingProtocol?`: `string`, `maxAudioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `enableRemoteMedia?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `enableRedirection?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`any`\> | - -#### Defined in - -[generated-client/api/universal-audio-api.ts:346](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L346) - -___ - -### UniversalAudioApiFp - -▸ **UniversalAudioApiFp**(`configuration?`): `Object` - -UniversalAudioApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getUniversalAudioStream` | (`itemId`: `string`, `container?`: `string`[], `mediaSourceId?`: `string`, `deviceId?`: `string`, `userId?`: `string`, `audioCodec?`: `string`, `maxAudioChannels?`: `number`, `transcodingAudioChannels?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `startTimeTicks?`: `number`, `transcodingContainer?`: `string`, `transcodingProtocol?`: `string`, `maxAudioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `enableRemoteMedia?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `enableRedirection?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headUniversalAudioStream` | (`itemId`: `string`, `container?`: `string`[], `mediaSourceId?`: `string`, `deviceId?`: `string`, `userId?`: `string`, `audioCodec?`: `string`, `maxAudioChannels?`: `number`, `transcodingAudioChannels?`: `number`, `maxStreamingBitrate?`: `number`, `audioBitRate?`: `number`, `startTimeTicks?`: `number`, `transcodingContainer?`: `string`, `transcodingProtocol?`: `string`, `maxAudioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `enableRemoteMedia?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `enableRedirection?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | - -#### Defined in - -[generated-client/api/universal-audio-api.ts:280](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L280) - -___ - -### UserApiAxiosParamCreator - -▸ **UserApiAxiosParamCreator**(`configuration?`): `Object` - -UserApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `authenticateUser` | (`userId`: `string`, `pw`: `string`, `password?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `authenticateUserByName` | (`authenticateUserByName`: [`AuthenticateUserByName`](../interfaces/generated_client.AuthenticateUserByName.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `authenticateWithQuickConnect` | (`quickConnectDto`: [`QuickConnectDto`](../interfaces/generated_client.QuickConnectDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `createUserByName` | (`createUserByName`: [`CreateUserByName`](../interfaces/generated_client.CreateUserByName.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `deleteUser` | (`userId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `forgotPassword` | (`forgotPasswordDto`: [`ForgotPasswordDto`](../interfaces/generated_client.ForgotPasswordDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `forgotPasswordPin` | (`forgotPasswordPinDto`: [`ForgotPasswordPinDto`](../interfaces/generated_client.ForgotPasswordPinDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getCurrentUser` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getPublicUsers` | (`options`: `any`) => `Promise`<`RequestArgs`\> | -| `getUserById` | (`userId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getUsers` | (`isHidden?`: `boolean`, `isDisabled?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateUser` | (`userId`: `string`, `userDto`: [`UserDto`](../interfaces/generated_client.UserDto.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateUserConfiguration` | (`userId`: `string`, `userConfiguration`: [`UserConfiguration`](../interfaces/generated_client.UserConfiguration.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateUserEasyPassword` | (`userId`: `string`, `updateUserEasyPassword`: [`UpdateUserEasyPassword`](../interfaces/generated_client.UpdateUserEasyPassword.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateUserPassword` | (`userId`: `string`, `updateUserPassword`: [`UpdateUserPassword`](../interfaces/generated_client.UpdateUserPassword.md), `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateUserPolicy` | (`userId`: `string`, `userPolicy`: [`UserPolicy`](../interfaces/generated_client.UserPolicy.md), `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/user-api.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L55) - -___ - -### UserApiFactory - -▸ **UserApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -UserApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `authenticateUser` | (`userId`: `string`, `pw`: `string`, `password?`: `string`, `options?`: `any`) => `AxiosPromise`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md)\> | -| `authenticateUserByName` | (`authenticateUserByName`: [`AuthenticateUserByName`](../interfaces/generated_client.AuthenticateUserByName.md), `options?`: `any`) => `AxiosPromise`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md)\> | -| `authenticateWithQuickConnect` | (`quickConnectDto`: [`QuickConnectDto`](../interfaces/generated_client.QuickConnectDto.md), `options?`: `any`) => `AxiosPromise`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md)\> | -| `createUserByName` | (`createUserByName`: [`CreateUserByName`](../interfaces/generated_client.CreateUserByName.md), `options?`: `any`) => `AxiosPromise`<[`UserDto`](../interfaces/generated_client.UserDto.md)\> | -| `deleteUser` | (`userId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `forgotPassword` | (`forgotPasswordDto`: [`ForgotPasswordDto`](../interfaces/generated_client.ForgotPasswordDto.md), `options?`: `any`) => `AxiosPromise`<[`ForgotPasswordResult`](../interfaces/generated_client.ForgotPasswordResult.md)\> | -| `forgotPasswordPin` | (`forgotPasswordPinDto`: [`ForgotPasswordPinDto`](../interfaces/generated_client.ForgotPasswordPinDto.md), `options?`: `any`) => `AxiosPromise`<[`PinRedeemResult`](../interfaces/generated_client.PinRedeemResult.md)\> | -| `getCurrentUser` | (`options?`: `any`) => `AxiosPromise`<[`UserDto`](../interfaces/generated_client.UserDto.md)\> | -| `getPublicUsers` | (`options?`: `any`) => `AxiosPromise`<[`UserDto`](../interfaces/generated_client.UserDto.md)[]\> | -| `getUserById` | (`userId`: `string`, `options?`: `any`) => `AxiosPromise`<[`UserDto`](../interfaces/generated_client.UserDto.md)\> | -| `getUsers` | (`isHidden?`: `boolean`, `isDisabled?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`UserDto`](../interfaces/generated_client.UserDto.md)[]\> | -| `updateUser` | (`userId`: `string`, `userDto`: [`UserDto`](../interfaces/generated_client.UserDto.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateUserConfiguration` | (`userId`: `string`, `userConfiguration`: [`UserConfiguration`](../interfaces/generated_client.UserConfiguration.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateUserEasyPassword` | (`userId`: `string`, `updateUserEasyPassword`: [`UpdateUserEasyPassword`](../interfaces/generated_client.UpdateUserEasyPassword.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateUserPassword` | (`userId`: `string`, `updateUserPassword`: [`UpdateUserPassword`](../interfaces/generated_client.UpdateUserPassword.md), `options?`: `any`) => `AxiosPromise`<`void`\> | -| `updateUserPolicy` | (`userId`: `string`, `userPolicy`: [`UserPolicy`](../interfaces/generated_client.UserPolicy.md), `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/user-api.ts:880](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L880) - -___ - -### UserApiFp - -▸ **UserApiFp**(`configuration?`): `Object` - -UserApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `authenticateUser` | (`userId`: `string`, `pw`: `string`, `password?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md)\>\> | -| `authenticateUserByName` | (`authenticateUserByName`: [`AuthenticateUserByName`](../interfaces/generated_client.AuthenticateUserByName.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md)\>\> | -| `authenticateWithQuickConnect` | (`quickConnectDto`: [`QuickConnectDto`](../interfaces/generated_client.QuickConnectDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md)\>\> | -| `createUserByName` | (`createUserByName`: [`CreateUserByName`](../interfaces/generated_client.CreateUserByName.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserDto`](../interfaces/generated_client.UserDto.md)\>\> | -| `deleteUser` | (`userId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `forgotPassword` | (`forgotPasswordDto`: [`ForgotPasswordDto`](../interfaces/generated_client.ForgotPasswordDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`ForgotPasswordResult`](../interfaces/generated_client.ForgotPasswordResult.md)\>\> | -| `forgotPasswordPin` | (`forgotPasswordPinDto`: [`ForgotPasswordPinDto`](../interfaces/generated_client.ForgotPasswordPinDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PinRedeemResult`](../interfaces/generated_client.PinRedeemResult.md)\>\> | -| `getCurrentUser` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserDto`](../interfaces/generated_client.UserDto.md)\>\> | -| `getPublicUsers` | (`options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserDto`](../interfaces/generated_client.UserDto.md)[]\>\> | -| `getUserById` | (`userId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserDto`](../interfaces/generated_client.UserDto.md)\>\> | -| `getUsers` | (`isHidden?`: `boolean`, `isDisabled?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserDto`](../interfaces/generated_client.UserDto.md)[]\>\> | -| `updateUser` | (`userId`: `string`, `userDto`: [`UserDto`](../interfaces/generated_client.UserDto.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateUserConfiguration` | (`userId`: `string`, `userConfiguration`: [`UserConfiguration`](../interfaces/generated_client.UserConfiguration.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateUserEasyPassword` | (`userId`: `string`, `updateUserEasyPassword`: [`UpdateUserEasyPassword`](../interfaces/generated_client.UpdateUserEasyPassword.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateUserPassword` | (`userId`: `string`, `updateUserPassword`: [`UpdateUserPassword`](../interfaces/generated_client.UpdateUserPassword.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `updateUserPolicy` | (`userId`: `string`, `userPolicy`: [`UserPolicy`](../interfaces/generated_client.UserPolicy.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/user-api.ts:688](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L688) - -___ - -### UserLibraryApiAxiosParamCreator - -▸ **UserLibraryApiAxiosParamCreator**(`configuration?`): `Object` - -UserLibraryApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteUserItemRating` | (`userId`: `string`, `itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getIntros` | (`userId`: `string`, `itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getItem` | (`userId`: `string`, `itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLatestMedia` | (`userId`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isPlayed?`: `boolean`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `limit?`: `number`, `groupItems?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getLocalTrailers` | (`userId`: `string`, `itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getRootFolder` | (`userId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getSpecialFeatures` | (`userId`: `string`, `itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `markFavoriteItem` | (`userId`: `string`, `itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `unmarkFavoriteItem` | (`userId`: `string`, `itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `updateUserItemRating` | (`userId`: `string`, `itemId`: `string`, `likes?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/user-library-api.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L39) - -___ - -### UserLibraryApiFactory - -▸ **UserLibraryApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -UserLibraryApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteUserItemRating` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\> | -| `getIntros` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getItem` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\> | -| `getLatestMedia` | (`userId`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isPlayed?`: `boolean`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `limit?`: `number`, `groupItems?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[]\> | -| `getLocalTrailers` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[]\> | -| `getRootFolder` | (`userId`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\> | -| `getSpecialFeatures` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[]\> | -| `markFavoriteItem` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\> | -| `unmarkFavoriteItem` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `AxiosPromise`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\> | -| `updateUserItemRating` | (`userId`: `string`, `itemId`: `string`, `likes?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\> | - -#### Defined in - -[generated-client/api/user-library-api.ts:644](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L644) - -___ - -### UserLibraryApiFp - -▸ **UserLibraryApiFp**(`configuration?`): `Object` - -UserLibraryApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteUserItemRating` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\>\> | -| `getIntros` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getItem` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\> | -| `getLatestMedia` | (`userId`: `string`, `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `isPlayed?`: `boolean`, `enableImages?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `enableUserData?`: `boolean`, `limit?`: `number`, `groupItems?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[]\>\> | -| `getLocalTrailers` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[]\>\> | -| `getRootFolder` | (`userId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\> | -| `getSpecialFeatures` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[]\>\> | -| `markFavoriteItem` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\>\> | -| `unmarkFavoriteItem` | (`userId`: `string`, `itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\>\> | -| `updateUserItemRating` | (`userId`: `string`, `itemId`: `string`, `likes?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\>\> | - -#### Defined in - -[generated-client/api/user-library-api.ts:505](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L505) - -___ - -### UserViewsApiAxiosParamCreator - -▸ **UserViewsApiAxiosParamCreator**(`configuration?`): `Object` - -UserViewsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getGroupingOptions` | (`userId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getUserViews` | (`userId`: `string`, `includeExternalContent?`: `boolean`, `presetViews?`: `string`[], `includeHidden?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/user-views-api.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-views-api.ts#L33) - -___ - -### UserViewsApiFactory - -▸ **UserViewsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -UserViewsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getGroupingOptions` | (`userId`: `string`, `options?`: `any`) => `AxiosPromise`<[`SpecialViewOptionDto`](../interfaces/generated_client.SpecialViewOptionDto.md)[]\> | -| `getUserViews` | (`userId`: `string`, `includeExternalContent?`: `boolean`, `presetViews?`: `string`[], `includeHidden?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/user-views-api.ts:166](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-views-api.ts#L166) - -___ - -### UserViewsApiFp - -▸ **UserViewsApiFp**(`configuration?`): `Object` - -UserViewsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getGroupingOptions` | (`userId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`SpecialViewOptionDto`](../interfaces/generated_client.SpecialViewOptionDto.md)[]\>\> | -| `getUserViews` | (`userId`: `string`, `includeExternalContent?`: `boolean`, `presetViews?`: `string`[], `includeHidden?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/user-views-api.ts:131](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-views-api.ts#L131) - -___ - -### VideoAttachmentsApiAxiosParamCreator - -▸ **VideoAttachmentsApiAxiosParamCreator**(`configuration?`): `Object` - -VideoAttachmentsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getAttachment` | (`videoId`: `string`, `mediaSourceId`: `string`, `index`: `number`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/video-attachments-api.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/video-attachments-api.ts#L29) - -___ - -### VideoAttachmentsApiFactory - -▸ **VideoAttachmentsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -VideoAttachmentsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getAttachment` | (`videoId`: `string`, `mediaSourceId`: `string`, `index`: `number`, `options?`: `any`) => `AxiosPromise`<`any`\> | - -#### Defined in - -[generated-client/api/video-attachments-api.ts:103](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/video-attachments-api.ts#L103) - -___ - -### VideoAttachmentsApiFp - -▸ **VideoAttachmentsApiFp**(`configuration?`): `Object` - -VideoAttachmentsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getAttachment` | (`videoId`: `string`, `mediaSourceId`: `string`, `index`: `number`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | - -#### Defined in - -[generated-client/api/video-attachments-api.ts:80](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/video-attachments-api.ts#L80) - -___ - -### VideosApiAxiosParamCreator - -▸ **VideosApiAxiosParamCreator**(`configuration?`): `Object` - -VideosApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteAlternateSources` | (`itemId`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getAdditionalPart` | (`itemId`: `string`, `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getVideoStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getVideoStreamByContainer` | (`itemId`: `string`, `container`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headVideoStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `headVideoStreamByContainer` | (`itemId`: `string`, `container`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `mergeVersions` | (`ids`: `string`[], `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/videos-api.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L35) - -___ - -### VideosApiFactory - -▸ **VideosApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -VideosApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteAlternateSources` | (`itemId`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `getAdditionalPart` | (`itemId`: `string`, `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | -| `getVideoStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `getVideoStreamByContainer` | (`itemId`: `string`, `container`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headVideoStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `headVideoStreamByContainer` | (`itemId`: `string`, `container`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `AxiosPromise`<`any`\> | -| `mergeVersions` | (`ids`: `string`[], `options?`: `any`) => `AxiosPromise`<`void`\> | - -#### Defined in - -[generated-client/api/videos-api.ts:1585](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1585) - -___ - -### VideosApiFp - -▸ **VideosApiFp**(`configuration?`): `Object` - -VideosApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `deleteAlternateSources` | (`itemId`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `getAdditionalPart` | (`itemId`: `string`, `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | -| `getVideoStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `getVideoStreamByContainer` | (`itemId`: `string`, `container`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headVideoStream` | (`itemId`: `string`, `container?`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `headVideoStreamByContainer` | (`itemId`: `string`, `container`: `string`, `_static?`: `boolean`, `params?`: `string`, `tag?`: `string`, `deviceProfileId?`: `string`, `playSessionId?`: `string`, `segmentContainer?`: `string`, `segmentLength?`: `number`, `minSegments?`: `number`, `mediaSourceId?`: `string`, `deviceId?`: `string`, `audioCodec?`: `string`, `enableAutoStreamCopy?`: `boolean`, `allowVideoStreamCopy?`: `boolean`, `allowAudioStreamCopy?`: `boolean`, `breakOnNonKeyFrames?`: `boolean`, `audioSampleRate?`: `number`, `maxAudioBitDepth?`: `number`, `audioBitRate?`: `number`, `audioChannels?`: `number`, `maxAudioChannels?`: `number`, `profile?`: `string`, `level?`: `string`, `framerate?`: `number`, `maxFramerate?`: `number`, `copyTimestamps?`: `boolean`, `startTimeTicks?`: `number`, `width?`: `number`, `height?`: `number`, `maxWidth?`: `number`, `maxHeight?`: `number`, `videoBitRate?`: `number`, `subtitleStreamIndex?`: `number`, `subtitleMethod?`: [`SubtitleDeliveryMethod`](../enums/generated_client.SubtitleDeliveryMethod.md), `maxRefFrames?`: `number`, `maxVideoBitDepth?`: `number`, `requireAvc?`: `boolean`, `deInterlace?`: `boolean`, `requireNonAnamorphic?`: `boolean`, `transcodingMaxAudioChannels?`: `number`, `cpuCoreLimit?`: `number`, `liveStreamId?`: `string`, `enableMpegtsM2TsMode?`: `boolean`, `videoCodec?`: `string`, `subtitleCodec?`: `string`, `transcodeReasons?`: `string`, `audioStreamIndex?`: `number`, `videoStreamIndex?`: `number`, `context?`: [`EncodingContext`](../enums/generated_client.EncodingContext.md), `streamOptions?`: { `[key: string]`: `string`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`any`\>\> | -| `mergeVersions` | (`ids`: `string`[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | - -#### Defined in - -[generated-client/api/videos-api.ts:1297](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L1297) - -___ - -### YearsApiAxiosParamCreator - -▸ **YearsApiAxiosParamCreator**(`configuration?`): `Object` - -YearsApi - axios parameter creator - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getYear` | (`year`: `number`, `userId?`: `string`, `options`: `any`) => `Promise`<`RequestArgs`\> | -| `getYears` | (`startIndex?`: `number`, `limit?`: `number`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `mediaTypes?`: `string`[], `sortBy?`: `string`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `userId?`: `string`, `recursive?`: `boolean`, `enableImages?`: `boolean`, `options`: `any`) => `Promise`<`RequestArgs`\> | - -#### Defined in - -[generated-client/api/years-api.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L41) - -___ - -### YearsApiFactory - -▸ **YearsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -YearsApi - factory interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getYear` | (`year`: `number`, `userId?`: `string`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\> | -| `getYears` | (`startIndex?`: `number`, `limit?`: `number`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `mediaTypes?`: `string`[], `sortBy?`: `string`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `userId?`: `string`, `recursive?`: `boolean`, `enableImages?`: `boolean`, `options?`: `any`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\> | - -#### Defined in - -[generated-client/api/years-api.ts:247](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L247) - -___ - -### YearsApiFp - -▸ **YearsApiFp**(`configuration?`): `Object` - -YearsApi - functional programming interface - -**`export`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](../classes/generated_client.Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `getYear` | (`year`: `number`, `userId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\> | -| `getYears` | (`startIndex?`: `number`, `limit?`: `number`, `sortOrder?`: [`SortOrder`](../enums/generated_client.SortOrder.md)[], `parentId?`: `string`, `fields?`: [`ItemFields`](../enums/generated_client.ItemFields.md)[], `excludeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `includeItemTypes?`: [`BaseItemKind`](../enums/generated_client.BaseItemKind.md)[], `mediaTypes?`: `string`[], `sortBy?`: `string`[], `enableUserData?`: `boolean`, `imageTypeLimit?`: `number`, `enableImageTypes?`: [`ImageType`](../enums/generated_client.ImageType.md)[], `userId?`: `string`, `recursive?`: `boolean`, `enableImages?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\> | - -#### Defined in - -[generated-client/api/years-api.ts:200](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L200) diff --git a/docs/modules/index.discovery.md b/docs/modules/index.discovery.md deleted file mode 100644 index 064a55abe..000000000 --- a/docs/modules/index.discovery.md +++ /dev/null @@ -1,16 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](index.md) / discovery - -# Namespace: discovery - -[index](index.md).discovery - -This Source Code Form is subject to the terms of the Mozilla Public -License, v. 2.0. If a copy of the MPL was not distributed with this -file, You can obtain one at http://mozilla.org/MPL/2.0/. - -## Table of contents - -### Classes - -- [DiscoveryService](../classes/index.discovery.DiscoveryService.md) -- [RecommendedServerDiscovery](../classes/index.discovery.RecommendedServerDiscovery.md) diff --git a/docs/modules/index.md b/docs/modules/index.md deleted file mode 100644 index 8c846e89b..000000000 --- a/docs/modules/index.md +++ /dev/null @@ -1,75 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / index - -# Module: index - -## Table of contents - -### Namespaces - -- [discovery](index.discovery.md) -- [utils](index.utils.md) - -### Enumerations - -- [RecommendedServerInfoScore](../enums/index.RecommendedServerInfoScore.md) - -### Classes - -- [Api](../classes/index.Api.md) -- [Jellyfin](../classes/index.Jellyfin.md) -- [ProductNameIssue](../classes/index.ProductNameIssue.md) -- [RecommendedServerIssue](../classes/index.RecommendedServerIssue.md) -- [SlowResponseIssue](../classes/index.SlowResponseIssue.md) -- [SystemInfoIssue](../classes/index.SystemInfoIssue.md) -- [VersionMissingIssue](../classes/index.VersionMissingIssue.md) -- [VersionOutdatedIssue](../classes/index.VersionOutdatedIssue.md) -- [VersionUnsupportedIssue](../classes/index.VersionUnsupportedIssue.md) - -### Interfaces - -- [ClientInfo](../interfaces/index.ClientInfo.md) -- [DeviceInfo](../interfaces/index.DeviceInfo.md) -- [JellyfinParameters](../interfaces/index.JellyfinParameters.md) -- [RecommendedServerInfo](../interfaces/index.RecommendedServerInfo.md) - -### Variables - -- [API\_VERSION](index.md#api_version) -- [AUTHORIZATION\_HEADER](index.md#authorization_header) -- [MINIMUM\_VERSION](index.md#minimum_version) - -## Variables - -### API\_VERSION - -• `Const` **API\_VERSION**: ``"10.8.1"`` - -The current API version of the generated client. - -#### Defined in - -[jellyfin.ts:21](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L21) - -___ - -### AUTHORIZATION\_HEADER - -• `Const` **AUTHORIZATION\_HEADER**: ``"Authorization"`` - -The authorization header field name. - -#### Defined in - -[api.ts:23](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L23) - -___ - -### MINIMUM\_VERSION - -• `Const` **MINIMUM\_VERSION**: ``"10.8.0"`` - -The minimum supported server version. - -#### Defined in - -[jellyfin.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L24) diff --git a/docs/modules/index.utils.md b/docs/modules/index.utils.md deleted file mode 100644 index 9ac18d963..000000000 --- a/docs/modules/index.utils.md +++ /dev/null @@ -1,249 +0,0 @@ -[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](index.md) / utils - -# Namespace: utils - -[index](index.md).utils - -## Table of contents - -### Interfaces - -- [DeviceProfileGeneratorOptions](../interfaces/index.utils.DeviceProfileGeneratorOptions.md) - -### Variables - -- [HTTPS\_PORT](index.utils.md#https_port) -- [HTTPS\_PROTOCOL](index.utils.md#https_protocol) -- [HTTP\_PORT](index.utils.md#http_port) -- [HTTP\_PROTOCOL](index.utils.md#http_protocol) -- [JF\_HTTPS\_PORT](index.utils.md#jf_https_port) -- [JF\_HTTP\_PORT](index.utils.md#jf_http_port) - -### Functions - -- [copyUrl](index.utils.md#copyurl) -- [getAddressCandidates](index.utils.md#getaddresscandidates) -- [getAuthorizationHeader](index.utils.md#getauthorizationheader) -- [getBrowserDeviceProfile](index.utils.md#getbrowserdeviceprofile) -- [getDefaultPort](index.utils.md#getdefaultport) -- [parseUrl](index.utils.md#parseurl) - -## Variables - -### HTTPS\_PORT - -• `Const` **HTTPS\_PORT**: ``443`` - -The default port for the https protocol. - -#### Defined in - -[utils/url.ts:19](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/url.ts#L19) - -___ - -### HTTPS\_PROTOCOL - -• `Const` **HTTPS\_PROTOCOL**: ``"https:"`` - -The https protocol string. - -#### Defined in - -[utils/url.ts:13](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/url.ts#L13) - -___ - -### HTTP\_PORT - -• `Const` **HTTP\_PORT**: ``80`` - -The default port for the http protocol. - -#### Defined in - -[utils/url.ts:16](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/url.ts#L16) - -___ - -### HTTP\_PROTOCOL - -• `Const` **HTTP\_PROTOCOL**: ``"http:"`` - -The http protocol string. - -#### Defined in - -[utils/url.ts:10](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/url.ts#L10) - -___ - -### JF\_HTTPS\_PORT - -• `Const` **JF\_HTTPS\_PORT**: ``8920`` - -The default https port for Jellyfin servers. - -#### Defined in - -[utils/address-candidates.ts:13](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/address-candidates.ts#L13) - -___ - -### JF\_HTTP\_PORT - -• `Const` **JF\_HTTP\_PORT**: ``8096`` - -The default http port for Jellyfin servers. - -#### Defined in - -[utils/address-candidates.ts:10](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/address-candidates.ts#L10) - -## Functions - -### copyUrl - -▸ **copyUrl**(`original`): `URL` - -Copies a URL instance. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `original` | `URL` | The original URL. | - -#### Returns - -`URL` - -A copy of the original URL. - -#### Defined in - -[utils/url.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/url.ts#L26) - -___ - -### getAddressCandidates - -▸ **getAddressCandidates**(`input`): `string`[] - -Gets a list of address candidates url strings -from a provided url address string. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `input` | `string` | A server url address string. | - -#### Returns - -`string`[] - -A list of potential server addresses. - -#### Defined in - -[utils/address-candidates.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/address-candidates.ts#L52) - -___ - -### getAuthorizationHeader - -▸ **getAuthorizationHeader**(`clientInfo`, `deviceInfo`, `accessToken?`): `string` - -Returns a valid authorization header string. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `clientInfo` | [`ClientInfo`](../interfaces/index.ClientInfo.md) | `undefined` | -| `deviceInfo` | [`DeviceInfo`](../interfaces/index.DeviceInfo.md) | `undefined` | -| `accessToken` | `string` | `''` | - -#### Returns - -`string` - -#### Defined in - -[utils/authentication.ts:11](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/authentication.ts#L11) - -___ - -### getBrowserDeviceProfile - -▸ **getBrowserDeviceProfile**(`options?`, `videoElement?`): [`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md) - -Generates a device profile based on a few options and the current browser capabilites - -**`exports`** - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | [`DeviceProfileGeneratorOptions`](../interfaces/index.utils.DeviceProfileGeneratorOptions.md) | Options to pass to the different profiles generators | -| `videoElement?` | `HTMLVideoElement` | Optionnal HTML video element to use, else it'll create one | - -#### Returns - -[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md) - -A detected device profile - -#### Defined in - -[utils/browser-profiles.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/browser-profiles.ts#L58) - -___ - -### getDefaultPort - -▸ **getDefaultPort**(`protocol`): `number` - -Returns the default port number for a given protocol. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `protocol` | `string` | The protocol string. | - -#### Returns - -`number` - -The default port number of the protocol. - -#### Defined in - -[utils/url.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/url.ts#L35) - -___ - -### parseUrl - -▸ **parseUrl**(`input`): `URL` - -Parses a string to a Url object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `input` | `string` | A string representing a url. | - -#### Returns - -`URL` - -The Url object. - -#### Defined in - -[utils/url.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/utils/url.ts#L46) diff --git a/package-lock.json b/package-lock.json index 1e03cfc81..6c8e9547d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -26,7 +26,6 @@ "jest-runner-groups": "2.2.0", "ts-jest": "27.1.5", "typedoc": "0.23.14", - "typedoc-plugin-markdown": "3.11.0", "typescript": "4.8.2" } }, @@ -4085,27 +4084,6 @@ "integrity": "sha512-bzh50DW9kTPM00T8y4o8vQg89Di9oLJVLW/KaOGIXJWP/iqCN6WKYkbNOF04vFLJhwcpYUh9ydh/+5vpOqV4YQ==", "dev": true }, - "node_modules/handlebars": { - "version": "4.7.7", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", - "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", - "dev": true, - "dependencies": { - "minimist": "^1.2.5", - "neo-async": "^2.6.0", - "source-map": "^0.6.1", - "wordwrap": "^1.0.0" - }, - "bin": { - "handlebars": "bin/handlebars" - }, - "engines": { - "node": ">=0.4.7" - }, - "optionalDependencies": { - "uglify-js": "^3.1.4" - } - }, "node_modules/has": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", @@ -6451,12 +6429,6 @@ "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", "dev": true }, - "node_modules/neo-async": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", - "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", - "dev": true - }, "node_modules/node-fetch": { "version": "2.6.7", "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", @@ -7812,18 +7784,6 @@ "typescript": "4.6.x || 4.7.x || 4.8.x" } }, - "node_modules/typedoc-plugin-markdown": { - "version": "3.11.0", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.11.0.tgz", - "integrity": "sha512-zewcbzOlMV9nbhLsJhKBpoRW4J32LgbfdqwYfEfzzeE+wGOaOfsM6g7QH+ZKj8n+knH4sLCtk6XMN1TI/a1UuQ==", - "dev": true, - "dependencies": { - "handlebars": "^4.7.7" - }, - "peerDependencies": { - "typedoc": ">=0.22.0" - } - }, "node_modules/typedoc/node_modules/brace-expansion": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", @@ -7858,19 +7818,6 @@ "node": ">=4.2.0" } }, - "node_modules/uglify-js": { - "version": "3.17.0", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.0.tgz", - "integrity": "sha512-aTeNPVmgIMPpm1cxXr2Q/nEbvkmV8yq66F3om7X3P/cvOXQ0TMQ64Wk63iyT1gPlmdmGzjGpyLh1f3y8MZWXGg==", - "dev": true, - "optional": true, - "bin": { - "uglifyjs": "bin/uglifyjs" - }, - "engines": { - "node": ">=0.8.0" - } - }, "node_modules/unbox-primitive": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz", @@ -8107,12 +8054,6 @@ "node": ">=0.10.0" } }, - "node_modules/wordwrap": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", - "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==", - "dev": true - }, "node_modules/wrap-ansi": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", diff --git a/package.json b/package.json index bf5c03ab7..36c4dc580 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,6 @@ "jest-runner-groups": "2.2.0", "ts-jest": "27.1.5", "typedoc": "0.23.14", - "typedoc-plugin-markdown": "3.11.0", "typescript": "4.8.2" }, "dependencies": { From 1a362dddcf0fbabcc8a416a39680ccb272e2ff4c Mon Sep 17 00:00:00 2001 From: Bill Thornton Date: Thu, 15 Sep 2022 11:13:51 -0400 Subject: [PATCH 2/2] Add docs publish workflow --- .github/workflows/sdk-docs.yaml | 42 +++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/workflows/sdk-docs.yaml diff --git a/.github/workflows/sdk-docs.yaml b/.github/workflows/sdk-docs.yaml new file mode 100644 index 000000000..5a8e1918d --- /dev/null +++ b/.github/workflows/sdk-docs.yaml @@ -0,0 +1,42 @@ +name: SDK Documentation Publish + +on: + push: + branches: [master] + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +jobs: + build: + name: Build Documentation + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3.0.2 + - uses: actions/setup-node@2fddd8803e2f5c9604345a0b591c3020ee971a93 # tag=v3.4.1 + with: + node-version: 16 + - uses: actions/configure-pages@45efe609374726fd94570f0e5a4c32f41675e823 # tag=v2 + - name: Run build + run: | + npm ci --no-audit + npm run docs + - name: Upload artifact + uses: actions/upload-pages-artifact@a597aecd27af1cf14095ccaa29169358e3d91e28 # tag=v1 + with: + path: ./docs + + deploy: + name: Deploy to GitHub Pages + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@c2379ec5e719a934ec613038d081879b58c9d7df # tag=v1