Package-level declarations
Types
Link copied to clipboard
data class GetAlbumArtistsRequest(val minCommunityRating: Double? = null, val startIndex: Int? = null, val limit: Int? = null, val searchTerm: String? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val filters: Collection<ItemFilter>? = null, val isFavorite: Boolean? = null, val mediaTypes: Collection<MediaType>? = null, val genres: Collection<String>? = null, val genreIds: Collection<UUID>? = null, val officialRatings: Collection<String>? = null, val tags: Collection<String>? = null, val years: Collection<Int>? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val person: String? = null, val personIds: Collection<UUID>? = null, val personTypes: Collection<String>? = null, val studios: Collection<String>? = null, val studioIds: Collection<UUID>? = null, val userId: UUID? = null, val nameStartsWithOrGreater: String? = null, val nameStartsWith: String? = null, val nameLessThan: String? = null, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null, val enableImages: Boolean? = true, val enableTotalRecordCount: Boolean? = true)
All album artists from a given item, folder, or the entire library.
Link copied to clipboard
data class GetArtistImageRequest(val name: String, val imageType: ImageType, val imageIndex: Int, val tag: String? = null, val format: ImageFormat? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null)
Get artist image by name.
Link copied to clipboard
data class GetArtistsRequest(val minCommunityRating: Double? = null, val startIndex: Int? = null, val limit: Int? = null, val searchTerm: String? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val filters: Collection<ItemFilter>? = null, val isFavorite: Boolean? = null, val mediaTypes: Collection<MediaType>? = null, val genres: Collection<String>? = null, val genreIds: Collection<UUID>? = null, val officialRatings: Collection<String>? = null, val tags: Collection<String>? = null, val years: Collection<Int>? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val person: String? = null, val personIds: Collection<UUID>? = null, val personTypes: Collection<String>? = null, val studios: Collection<String>? = null, val studioIds: Collection<UUID>? = null, val userId: UUID? = null, val nameStartsWithOrGreater: String? = null, val nameStartsWith: String? = null, val nameLessThan: String? = null, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null, val enableImages: Boolean? = true, val enableTotalRecordCount: Boolean? = true)
All artists from a given item, folder, or the entire library.
Link copied to clipboard
data class GetAudioStreamByContainerDeprecatedRequest(val itemId: UUID, val container: String, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val deviceProfileId: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true)
An audio stream.
Link copied to clipboard
data class GetAudioStreamByContainerRequest(val itemId: UUID, val container: String, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true)
An audio stream.
Link copied to clipboard
data class GetAudioStreamDeprecatedRequest(val itemId: UUID, val container: String? = null, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val deviceProfileId: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true)
An audio stream.
Link copied to clipboard
data class GetAudioStreamRequest(val itemId: UUID, val container: String? = null, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true)
An audio stream.
Link copied to clipboard
data class GetChannelItemsRequest(val channelId: UUID, val folderId: UUID? = null, val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val sortOrder: Collection<SortOrder>? = null, val filters: Collection<ItemFilter>? = null, val sortBy: Collection<ItemSortBy>? = null, val fields: Collection<ItemFields>? = null)
Get channel items.
Link copied to clipboard
Link copied to clipboard
data class GetEpisodesRequest(val seriesId: UUID, val userId: UUID? = null, val fields: Collection<ItemFields>? = null, val season: Int? = null, val seasonId: UUID? = null, val isMissing: Boolean? = null, val adjacentTo: UUID? = null, val startItemId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null, val sortBy: ItemSortBy? = null)
Episodes for a tv season.
Link copied to clipboard
data class GetGenreImageByIndexRequest(val name: String, val imageType: ImageType, val imageIndex: Int, val tag: String? = null, val format: ImageFormat? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null)
Get genre image by name.
Link copied to clipboard
data class GetGenreImageRequest(val name: String, val imageType: ImageType, val tag: String? = null, val format: ImageFormat? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null, val imageIndex: Int? = null)
Get genre image by name.
Link copied to clipboard
data class GetGenresRequest(val startIndex: Int? = null, val limit: Int? = null, val searchTerm: String? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val isFavorite: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val userId: UUID? = null, val nameStartsWithOrGreater: String? = null, val nameStartsWith: String? = null, val nameLessThan: String? = null, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null, val enableImages: Boolean? = true, val enableTotalRecordCount: Boolean? = true)
All genres from a given item, folder, or the entire library.
Link copied to clipboard
data class GetHlsAudioSegmentDeprecatedRequest(val itemId: UUID, val playlistId: String, val segmentId: Int, val container: String, val runtimeTicks: Long, val actualSegmentLengthTicks: Long, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val deviceProfileId: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val maxStreamingBitrate: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true)
A video stream using HTTP live streaming.
Link copied to clipboard
data class GetHlsAudioSegmentRequest(val itemId: UUID, val playlistId: String, val segmentId: Int, val container: String, val runtimeTicks: Long, val actualSegmentLengthTicks: Long, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val maxStreamingBitrate: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true)
A video stream using HTTP live streaming.
Link copied to clipboard
data class GetHlsVideoSegmentDeprecatedRequest(val itemId: UUID, val playlistId: String, val segmentId: Int, val container: String, val runtimeTicks: Long, val actualSegmentLengthTicks: Long, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val deviceProfileId: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true, val alwaysBurnInSubtitleWhenTranscoding: Boolean? = false)
A video stream using HTTP live streaming.
Link copied to clipboard
data class GetHlsVideoSegmentRequest(val itemId: UUID, val playlistId: String, val segmentId: Int, val container: String, val runtimeTicks: Long, val actualSegmentLengthTicks: Long, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true, val alwaysBurnInSubtitleWhenTranscoding: Boolean? = false)
A video stream using HTTP live streaming.
Link copied to clipboard
data class GetInstantMixFromAlbumRequest(val itemId: UUID, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val enableImages: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null)
Creates an instant playlist based on a given album.
Link copied to clipboard
data class GetInstantMixFromArtists2Request(val id: UUID, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val enableImages: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null)
Creates an instant playlist based on a given artist.
Link copied to clipboard
data class GetInstantMixFromArtistsRequest(val itemId: UUID, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val enableImages: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null)
Creates an instant playlist based on a given artist.
Link copied to clipboard
data class GetInstantMixFromItemRequest(val itemId: UUID, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val enableImages: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null)
Creates an instant playlist based on a given item.
Link copied to clipboard
data class GetInstantMixFromMusicGenreByIdRequest(val id: UUID, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val enableImages: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null)
Creates an instant playlist based on a given genre.
Link copied to clipboard
data class GetInstantMixFromMusicGenreByNameRequest(val name: String, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val enableImages: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null)
Creates an instant playlist based on a given genre.
Link copied to clipboard
data class GetInstantMixFromPlaylistRequest(val itemId: UUID, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val enableImages: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null)
Creates an instant playlist based on a given playlist.
Link copied to clipboard
data class GetInstantMixFromSongRequest(val itemId: UUID, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val enableImages: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null)
Creates an instant playlist based on a given song.
Link copied to clipboard
data class GetItemImage2Request(val itemId: UUID, val imageType: ImageType, val maxWidth: Int, val maxHeight: Int, val tag: String, val format: ImageFormat, val percentPlayed: Double, val unplayedCount: Int, val imageIndex: Int, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null)
The item's image.
Link copied to clipboard
data class GetItemImageByIndexRequest(val itemId: UUID, val imageType: ImageType, val imageIndex: Int, val maxWidth: Int? = null, val maxHeight: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val tag: String? = null, val format: ImageFormat? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null)
The item's image.
Link copied to clipboard
data class GetItemImageRequest(val itemId: UUID, val imageType: ImageType, val maxWidth: Int? = null, val maxHeight: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val tag: String? = null, val format: ImageFormat? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null, val imageIndex: Int? = null)
The item's image.
Link copied to clipboard
data class GetItemsRequest(val userId: UUID? = null, val maxOfficialRating: String? = null, val hasThemeSong: Boolean? = null, val hasThemeVideo: Boolean? = null, val hasSubtitles: Boolean? = null, val hasSpecialFeature: Boolean? = null, val hasTrailer: Boolean? = null, val adjacentTo: UUID? = null, val indexNumber: Int? = null, val parentIndexNumber: Int? = null, val hasParentalRating: Boolean? = null, val isHd: Boolean? = null, val is4k: Boolean? = null, val locationTypes: Collection<LocationType>? = null, val excludeLocationTypes: Collection<LocationType>? = null, val isMissing: Boolean? = null, val isUnaired: Boolean? = null, val minCommunityRating: Double? = null, val minCriticRating: Double? = null, val minPremiereDate: DateTime? = null, val minDateLastSaved: DateTime? = null, val minDateLastSavedForUser: DateTime? = null, val maxPremiereDate: DateTime? = null, val hasOverview: Boolean? = null, val hasImdbId: Boolean? = null, val hasTmdbId: Boolean? = null, val hasTvdbId: Boolean? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val excludeItemIds: Collection<UUID>? = null, val startIndex: Int? = null, val limit: Int? = null, val recursive: Boolean? = null, val searchTerm: String? = null, val sortOrder: Collection<SortOrder>? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val filters: Collection<ItemFilter>? = null, val isFavorite: Boolean? = null, val mediaTypes: Collection<MediaType>? = null, val imageTypes: Collection<ImageType>? = null, val sortBy: Collection<ItemSortBy>? = null, val isPlayed: Boolean? = null, val genres: Collection<String>? = null, val officialRatings: Collection<String>? = null, val tags: Collection<String>? = null, val years: Collection<Int>? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val person: String? = null, val personIds: Collection<UUID>? = null, val personTypes: Collection<String>? = null, val studios: Collection<String>? = null, val artists: Collection<String>? = null, val excludeArtistIds: Collection<UUID>? = null, val artistIds: Collection<UUID>? = null, val albumArtistIds: Collection<UUID>? = null, val contributingArtistIds: Collection<UUID>? = null, val albums: Collection<String>? = null, val albumIds: Collection<UUID>? = null, val ids: Collection<UUID>? = null, val videoTypes: Collection<VideoType>? = null, val minOfficialRating: String? = null, val isLocked: Boolean? = null, val isPlaceHolder: Boolean? = null, val hasOfficialRating: Boolean? = null, val collapseBoxSetItems: Boolean? = null, val minWidth: Int? = null, val minHeight: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val is3d: Boolean? = null, val seriesStatus: Collection<SeriesStatus>? = null, val nameStartsWithOrGreater: String? = null, val nameStartsWith: String? = null, val nameLessThan: String? = null, val studioIds: Collection<UUID>? = null, val genreIds: Collection<UUID>? = null, val enableTotalRecordCount: Boolean? = true, val enableImages: Boolean? = true)
Items based on a query.
Link copied to clipboard
data class GetLatestChannelItemsRequest(val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val filters: Collection<ItemFilter>? = null, val fields: Collection<ItemFields>? = null, val channelIds: Collection<UUID>? = null)
Latest channel items.
Link copied to clipboard
data class GetLatestMediaRequest(val userId: UUID? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val isPlayed: Boolean? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null, val limit: Int? = 20, val groupItems: Boolean? = true)
Latest media.
Link copied to clipboard
data class GetLiveHlsStreamDeprecatedRequest(val itemId: UUID, val container: String? = null, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val deviceProfileId: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val enableSubtitlesInManifest: Boolean? = null, val enableAudioVbrEncoding: Boolean? = true, val alwaysBurnInSubtitleWhenTranscoding: Boolean? = false)
A hls live stream.
Link copied to clipboard
data class GetLiveHlsStreamRequest(val itemId: UUID, val container: String? = null, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val enableSubtitlesInManifest: Boolean? = null, val enableAudioVbrEncoding: Boolean? = true, val alwaysBurnInSubtitleWhenTranscoding: Boolean? = false)
A hls live stream.
Link copied to clipboard
data class GetLiveTvChannelsRequest(val type: ChannelType? = null, val userId: UUID? = null, val startIndex: Int? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val limit: Int? = null, val isFavorite: Boolean? = null, val isLiked: Boolean? = null, val isDisliked: Boolean? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val fields: Collection<ItemFields>? = null, val enableUserData: Boolean? = null, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: SortOrder? = null, val enableFavoriteSorting: Boolean? = false, val addCurrentProgram: Boolean? = true)
Available live tv channels.
Link copied to clipboard
data class GetLiveTvProgramsRequest(val channelIds: Collection<UUID>? = null, val userId: UUID? = null, val minStartDate: DateTime? = null, val hasAired: Boolean? = null, val isAiring: Boolean? = null, val maxStartDate: DateTime? = null, val minEndDate: DateTime? = null, val maxEndDate: DateTime? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val startIndex: Int? = null, val limit: Int? = null, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null, val genres: Collection<String>? = null, val genreIds: Collection<UUID>? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null, val seriesTimerId: String? = null, val librarySeriesId: UUID? = null, val fields: Collection<ItemFields>? = null, val enableTotalRecordCount: Boolean? = true)
Available live tv epgs.
Link copied to clipboard
data class GetMasterHlsAudioPlaylistDeprecatedRequest(val itemId: UUID, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val deviceProfileId: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val maxStreamingBitrate: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAdaptiveBitrateStreaming: Boolean? = true, val enableAudioVbrEncoding: Boolean? = true)
An audio hls playlist stream.
Link copied to clipboard
data class GetMasterHlsAudioPlaylistRequest(val itemId: UUID, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val maxStreamingBitrate: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAdaptiveBitrateStreaming: Boolean? = true, val enableAudioVbrEncoding: Boolean? = true)
An audio hls playlist stream.
Link copied to clipboard
data class GetMasterHlsVideoPlaylistDeprecatedRequest(val itemId: UUID, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val deviceProfileId: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAdaptiveBitrateStreaming: Boolean? = true, val enableTrickplay: Boolean? = true, val enableAudioVbrEncoding: Boolean? = true, val alwaysBurnInSubtitleWhenTranscoding: Boolean? = false)
A video hls playlist stream.
Link copied to clipboard
data class GetMasterHlsVideoPlaylistRequest(val itemId: UUID, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAdaptiveBitrateStreaming: Boolean? = true, val enableTrickplay: Boolean? = true, val enableAudioVbrEncoding: Boolean? = true, val alwaysBurnInSubtitleWhenTranscoding: Boolean? = false)
A video hls playlist stream.
Link copied to clipboard
data class GetMovieRecommendationsRequest(val userId: UUID? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val categoryLimit: Int? = 5, val itemLimit: Int? = 8)
Movie recommendations.
Link copied to clipboard
data class GetMusicGenreImageByIndexRequest(val name: String, val imageType: ImageType, val imageIndex: Int, val tag: String? = null, val format: ImageFormat? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null)
Get music genre image by name.
Link copied to clipboard
data class GetMusicGenreImageRequest(val name: String, val imageType: ImageType, val tag: String? = null, val format: ImageFormat? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null, val imageIndex: Int? = null)
Get music genre image by name.
Link copied to clipboard
data class GetMusicGenresRequest(val startIndex: Int? = null, val limit: Int? = null, val searchTerm: String? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val isFavorite: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val userId: UUID? = null, val nameStartsWithOrGreater: String? = null, val nameStartsWith: String? = null, val nameLessThan: String? = null, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null, val enableImages: Boolean? = true, val enableTotalRecordCount: Boolean? = true)
All music genres from a given item, folder, or the entire library.
Link copied to clipboard
data class GetNextUpRequest(val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val seriesId: UUID? = null, val parentId: UUID? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null, val nextUpDateCutoff: DateTime? = null, val enableTotalRecordCount: Boolean? = true, val disableFirstEpisode: Boolean? = false, val enableResumable: Boolean? = true, val enableRewatching: Boolean? = false)
A list of next up episodes.
Link copied to clipboard
data class GetPersonImageByIndexRequest(val name: String, val imageType: ImageType, val imageIndex: Int, val tag: String? = null, val format: ImageFormat? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null)
Get person image by name.
Link copied to clipboard
data class GetPersonImageRequest(val name: String, val imageType: ImageType, val tag: String? = null, val format: ImageFormat? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null, val imageIndex: Int? = null)
Get person image by name.
Link copied to clipboard
data class GetPersonsRequest(val limit: Int? = null, val searchTerm: String? = null, val fields: Collection<ItemFields>? = null, val filters: Collection<ItemFilter>? = null, val isFavorite: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val excludePersonTypes: Collection<String>? = null, val personTypes: Collection<String>? = null, val appearsInItemId: UUID? = null, val userId: UUID? = null, val enableImages: Boolean? = true)
All persons.
Link copied to clipboard
data class GetPlaylistItemsRequest(val playlistId: UUID, val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val enableImages: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null)
The original items of a playlist.
Link copied to clipboard
data class GetPostedPlaybackInfoDeprecatedRequest(val itemId: UUID, val userId: UUID? = null, val maxStreamingBitrate: Int? = null, val startTimeTicks: Long? = null, val audioStreamIndex: Int? = null, val subtitleStreamIndex: Int? = null, val maxAudioChannels: Int? = null, val mediaSourceId: String? = null, val liveStreamId: String? = null, val autoOpenLiveStream: Boolean? = null, val enableDirectPlay: Boolean? = null, val enableDirectStream: Boolean? = null, val enableTranscoding: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null)
For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.
Link copied to clipboard
data class GetQueryFiltersRequest(val userId: UUID? = null, val parentId: UUID? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val isAiring: Boolean? = null, val isMovie: Boolean? = null, val isSports: Boolean? = null, val isKids: Boolean? = null, val isNews: Boolean? = null, val isSeries: Boolean? = null, val recursive: Boolean? = null)
Query filters.
Link copied to clipboard
data class GetRecommendedProgramsRequest(val userId: UUID? = null, val limit: Int? = null, val isAiring: Boolean? = null, val hasAired: Boolean? = null, val isSeries: Boolean? = null, val isMovie: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val genreIds: Collection<UUID>? = null, val fields: Collection<ItemFields>? = null, val enableUserData: Boolean? = null, val enableTotalRecordCount: Boolean? = true)
Recommended live tv epgs.
Link copied to clipboard
data class GetRecordingsRequest(val channelId: String? = null, val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val status: RecordingStatus? = null, val isInProgress: Boolean? = null, val seriesTimerId: String? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val fields: Collection<ItemFields>? = null, val enableUserData: Boolean? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val isNews: Boolean? = null, val isLibraryItem: Boolean? = null, val enableTotalRecordCount: Boolean? = true)
Live tv recordings.
Link copied to clipboard
data class GetRecordingsSeriesRequest(val channelId: String? = null, val userId: UUID? = null, val groupId: String? = null, val startIndex: Int? = null, val limit: Int? = null, val status: RecordingStatus? = null, val isInProgress: Boolean? = null, val seriesTimerId: String? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val fields: Collection<ItemFields>? = null, val enableUserData: Boolean? = null, val enableTotalRecordCount: Boolean? = true)
Live tv recording series.
Link copied to clipboard
Link copied to clipboard
data class GetResumeItemsRequest(val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val searchTerm: String? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val mediaTypes: Collection<MediaType>? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val enableTotalRecordCount: Boolean? = true, val enableImages: Boolean? = true, val excludeActiveSessions: Boolean? = false)
Items based on a query.
Link copied to clipboard
data class GetSearchHintsRequest(val startIndex: Int? = null, val limit: Int? = null, val userId: UUID? = null, val searchTerm: String, val includeItemTypes: Collection<BaseItemKind>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val mediaTypes: Collection<MediaType>? = null, val parentId: UUID? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val includePeople: Boolean? = true, val includeMedia: Boolean? = true, val includeGenres: Boolean? = true, val includeStudios: Boolean? = true, val includeArtists: Boolean? = true)
The search hint result.
Link copied to clipboard
data class GetSeasonsRequest(val seriesId: UUID, val userId: UUID? = null, val fields: Collection<ItemFields>? = null, val isSpecialSeason: Boolean? = null, val isMissing: Boolean? = null, val adjacentTo: UUID? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null)
Seasons for a tv series.
Link copied to clipboard
data class GetSimilarAlbumsRequest(val itemId: UUID, val excludeArtistIds: Collection<UUID>? = null, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null)
Similar items.
Link copied to clipboard
data class GetSimilarArtistsRequest(val itemId: UUID, val excludeArtistIds: Collection<UUID>? = null, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null)
Similar items.
Link copied to clipboard
data class GetSimilarItemsRequest(val itemId: UUID, val excludeArtistIds: Collection<UUID>? = null, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null)
Similar items.
Link copied to clipboard
data class GetSimilarMoviesRequest(val itemId: UUID, val excludeArtistIds: Collection<UUID>? = null, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null)
Similar items.
Link copied to clipboard
data class GetSimilarShowsRequest(val itemId: UUID, val excludeArtistIds: Collection<UUID>? = null, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null)
Similar items.
Link copied to clipboard
data class GetSimilarTrailersRequest(val itemId: UUID, val excludeArtistIds: Collection<UUID>? = null, val userId: UUID? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null)
Similar items.
Link copied to clipboard
data class GetSplashscreenRequest(val tag: String? = null, val format: ImageFormat? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val width: Int? = null, val height: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null, val quality: Int? = 90)
Generates or gets the splashscreen.
Link copied to clipboard
data class GetStudioImageByIndexRequest(val name: String, val imageType: ImageType, val imageIndex: Int, val tag: String? = null, val format: ImageFormat? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null)
Get studio image by name.
Link copied to clipboard
data class GetStudioImageRequest(val name: String, val imageType: ImageType, val tag: String? = null, val format: ImageFormat? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null, val imageIndex: Int? = null)
Get studio image by name.
Link copied to clipboard
data class GetStudiosRequest(val startIndex: Int? = null, val limit: Int? = null, val searchTerm: String? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val isFavorite: Boolean? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val userId: UUID? = null, val nameStartsWithOrGreater: String? = null, val nameStartsWith: String? = null, val nameLessThan: String? = null, val enableImages: Boolean? = true, val enableTotalRecordCount: Boolean? = true)
All studios from a given item, folder, or the entire library.
Link copied to clipboard
data class GetSubtitleDeprecatedRequest(val routeItemId: UUID, val routeMediaSourceId: String, val routeIndex: Int, val routeFormat: String, val itemId: UUID? = null, val mediaSourceId: String? = null, val index: Int? = null, val format: String? = null, val endPositionTicks: Long? = null, val copyTimestamps: Boolean? = false, val addVttTimeMap: Boolean? = false, val startPositionTicks: Long? = 0)
Subtitles in a specified format.
Link copied to clipboard
data class GetSubtitleRequest(val routeItemId: UUID, val routeMediaSourceId: String, val routeIndex: Int, val routeFormat: String, val endPositionTicks: Long? = null, val copyTimestamps: Boolean? = false, val addVttTimeMap: Boolean? = false, val startPositionTicks: Long? = 0)
Subtitles in a specified format.
Link copied to clipboard
data class GetSubtitleWithTicksDeprecatedRequest(val routeItemId: UUID, val routeMediaSourceId: String, val routeIndex: Int, val routeStartPositionTicks: Long, val routeFormat: String, val itemId: UUID? = null, val mediaSourceId: String? = null, val index: Int? = null, val startPositionTicks: Long? = null, val format: String? = null, val endPositionTicks: Long? = null, val copyTimestamps: Boolean? = false, val addVttTimeMap: Boolean? = false)
Subtitles in a specified format.
Link copied to clipboard
data class GetSubtitleWithTicksRequest(val routeItemId: UUID, val routeMediaSourceId: String, val routeIndex: Int, val routeStartPositionTicks: Long, val routeFormat: String, val endPositionTicks: Long? = null, val copyTimestamps: Boolean? = false, val addVttTimeMap: Boolean? = false)
Subtitles in a specified format.
Link copied to clipboard
data class GetSuggestionsRequest(val userId: UUID? = null, val mediaType: Collection<MediaType>? = null, val type: Collection<BaseItemKind>? = null, val startIndex: Int? = null, val limit: Int? = null, val enableTotalRecordCount: Boolean? = false)
Suggestions.
Link copied to clipboard
data class GetThemeMediaRequest(val itemId: UUID, val userId: UUID? = null, val inheritFromParent: Boolean? = false, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null)
Get theme songs and videos for an item.
Link copied to clipboard
data class GetThemeSongsRequest(val itemId: UUID, val userId: UUID? = null, val inheritFromParent: Boolean? = false, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null)
Get theme songs for an item.
Link copied to clipboard
data class GetThemeVideosRequest(val itemId: UUID, val userId: UUID? = null, val inheritFromParent: Boolean? = false, val sortBy: Collection<ItemSortBy>? = null, val sortOrder: Collection<SortOrder>? = null)
Get theme videos for an item.
Link copied to clipboard
data class GetTrailersRequest(val userId: UUID? = null, val maxOfficialRating: String? = null, val hasThemeSong: Boolean? = null, val hasThemeVideo: Boolean? = null, val hasSubtitles: Boolean? = null, val hasSpecialFeature: Boolean? = null, val hasTrailer: Boolean? = null, val adjacentTo: UUID? = null, val parentIndexNumber: Int? = null, val hasParentalRating: Boolean? = null, val isHd: Boolean? = null, val is4k: Boolean? = null, val locationTypes: Collection<LocationType>? = null, val excludeLocationTypes: Collection<LocationType>? = null, val isMissing: Boolean? = null, val isUnaired: Boolean? = null, val minCommunityRating: Double? = null, val minCriticRating: Double? = null, val minPremiereDate: DateTime? = null, val minDateLastSaved: DateTime? = null, val minDateLastSavedForUser: DateTime? = null, val maxPremiereDate: DateTime? = null, val hasOverview: Boolean? = null, val hasImdbId: Boolean? = null, val hasTmdbId: Boolean? = null, val hasTvdbId: Boolean? = null, val isMovie: Boolean? = null, val isSeries: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isSports: Boolean? = null, val excludeItemIds: Collection<UUID>? = null, val startIndex: Int? = null, val limit: Int? = null, val recursive: Boolean? = null, val searchTerm: String? = null, val sortOrder: Collection<SortOrder>? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val filters: Collection<ItemFilter>? = null, val isFavorite: Boolean? = null, val mediaTypes: Collection<MediaType>? = null, val imageTypes: Collection<ImageType>? = null, val sortBy: Collection<ItemSortBy>? = null, val isPlayed: Boolean? = null, val genres: Collection<String>? = null, val officialRatings: Collection<String>? = null, val tags: Collection<String>? = null, val years: Collection<Int>? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val person: String? = null, val personIds: Collection<UUID>? = null, val personTypes: Collection<String>? = null, val studios: Collection<String>? = null, val artists: Collection<String>? = null, val excludeArtistIds: Collection<UUID>? = null, val artistIds: Collection<UUID>? = null, val albumArtistIds: Collection<UUID>? = null, val contributingArtistIds: Collection<UUID>? = null, val albums: Collection<String>? = null, val albumIds: Collection<UUID>? = null, val ids: Collection<UUID>? = null, val videoTypes: Collection<VideoType>? = null, val minOfficialRating: String? = null, val isLocked: Boolean? = null, val isPlaceHolder: Boolean? = null, val hasOfficialRating: Boolean? = null, val collapseBoxSetItems: Boolean? = null, val minWidth: Int? = null, val minHeight: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val is3d: Boolean? = null, val seriesStatus: Collection<SeriesStatus>? = null, val nameStartsWithOrGreater: String? = null, val nameStartsWith: String? = null, val nameLessThan: String? = null, val studioIds: Collection<UUID>? = null, val genreIds: Collection<UUID>? = null, val enableTotalRecordCount: Boolean? = true, val enableImages: Boolean? = true)
Finds movies and trailers similar to a given trailer.
Link copied to clipboard
data class GetUniversalAudioStreamRequest(val itemId: UUID, val container: Collection<String>? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val userId: UUID? = null, val audioCodec: String? = null, val maxAudioChannels: Int? = null, val transcodingAudioChannels: Int? = null, val maxStreamingBitrate: Int? = null, val audioBitRate: Int? = null, val startTimeTicks: Long? = null, val transcodingContainer: String? = null, val transcodingProtocol: MediaStreamProtocol? = null, val maxAudioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val enableRemoteMedia: Boolean? = null, val enableAudioVbrEncoding: Boolean? = true, val breakOnNonKeyFrames: Boolean? = false, val enableRedirection: Boolean? = true)
An audio stream.
Link copied to clipboard
data class GetUpcomingEpisodesRequest(val userId: UUID? = null, val startIndex: Int? = null, val limit: Int? = null, val fields: Collection<ItemFields>? = null, val parentId: UUID? = null, val enableImages: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val enableUserData: Boolean? = null)
A list of upcoming episodes.
Link copied to clipboard
data class GetUserImageRequest(val userId: UUID? = null, val tag: String? = null, val format: ImageFormat? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val percentPlayed: Double? = null, val unplayedCount: Int? = null, val width: Int? = null, val height: Int? = null, val quality: Int? = null, val fillWidth: Int? = null, val fillHeight: Int? = null, val blur: Int? = null, val backgroundColor: String? = null, val foregroundLayer: String? = null, val imageIndex: Int? = null)
Get user profile image.
Link copied to clipboard
data class GetVariantHlsAudioPlaylistDeprecatedRequest(val itemId: UUID, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val deviceProfileId: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val maxStreamingBitrate: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true)
An audio stream using HTTP live streaming.
Link copied to clipboard
data class GetVariantHlsAudioPlaylistRequest(val itemId: UUID, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val maxStreamingBitrate: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true)
An audio stream using HTTP live streaming.
Link copied to clipboard
data class GetVariantHlsVideoPlaylistDeprecatedRequest(val itemId: UUID, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val deviceProfileId: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true, val alwaysBurnInSubtitleWhenTranscoding: Boolean? = false)
A video stream using HTTP live streaming.
Link copied to clipboard
data class GetVariantHlsVideoPlaylistRequest(val itemId: UUID, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true, val alwaysBurnInSubtitleWhenTranscoding: Boolean? = false)
A video stream using HTTP live streaming.
Link copied to clipboard
data class GetVideoStreamByContainerRequest(val itemId: UUID, val container: String, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val deviceProfileId: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true)
A video stream.
Link copied to clipboard
data class GetVideoStreamDeprecatedRequest(val itemId: UUID, val container: String? = null, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val deviceProfileId: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true)
A video stream.
Link copied to clipboard
data class GetVideoStreamRequest(val itemId: UUID, val container: String? = null, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val playSessionId: String? = null, val segmentContainer: String? = null, val segmentLength: Int? = null, val minSegments: Int? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val audioCodec: String? = null, val enableAutoStreamCopy: Boolean? = null, val allowVideoStreamCopy: Boolean? = null, val allowAudioStreamCopy: Boolean? = null, val breakOnNonKeyFrames: Boolean? = null, val audioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val audioBitRate: Int? = null, val audioChannels: Int? = null, val maxAudioChannels: Int? = null, val profile: String? = null, val level: String? = null, val framerate: Float? = null, val maxFramerate: Float? = null, val copyTimestamps: Boolean? = null, val startTimeTicks: Long? = null, val width: Int? = null, val height: Int? = null, val maxWidth: Int? = null, val maxHeight: Int? = null, val videoBitRate: Int? = null, val subtitleStreamIndex: Int? = null, val subtitleMethod: SubtitleDeliveryMethod? = null, val maxRefFrames: Int? = null, val maxVideoBitDepth: Int? = null, val requireAvc: Boolean? = null, val deInterlace: Boolean? = null, val requireNonAnamorphic: Boolean? = null, val transcodingMaxAudioChannels: Int? = null, val cpuCoreLimit: Int? = null, val liveStreamId: String? = null, val enableMpegtsM2TsMode: Boolean? = null, val videoCodec: String? = null, val subtitleCodec: String? = null, val transcodeReasons: String? = null, val audioStreamIndex: Int? = null, val videoStreamIndex: Int? = null, val context: EncodingContext? = null, val streamOptions: Map<String, String?>? = null, val enableAudioVbrEncoding: Boolean? = true)
A video stream.
Link copied to clipboard
data class GetYearsRequest(val startIndex: Int? = null, val limit: Int? = null, val sortOrder: Collection<SortOrder>? = null, val parentId: UUID? = null, val fields: Collection<ItemFields>? = null, val excludeItemTypes: Collection<BaseItemKind>? = null, val includeItemTypes: Collection<BaseItemKind>? = null, val mediaTypes: Collection<MediaType>? = null, val sortBy: Collection<ItemSortBy>? = null, val enableUserData: Boolean? = null, val imageTypeLimit: Int? = null, val enableImageTypes: Collection<ImageType>? = null, val userId: UUID? = null, val recursive: Boolean? = true, val enableImages: Boolean? = true)
Get years.
Link copied to clipboard
data class OnPlaybackProgressRequest(val itemId: UUID, val mediaSourceId: String? = null, val positionTicks: Long? = null, val audioStreamIndex: Int? = null, val subtitleStreamIndex: Int? = null, val volumeLevel: Int? = null, val playMethod: PlayMethod? = null, val liveStreamId: String? = null, val playSessionId: String? = null, val repeatMode: RepeatMode? = null, val isPaused: Boolean? = false, val isMuted: Boolean? = false)
Reports a session's playback progress.
Link copied to clipboard
data class OnPlaybackStartRequest(val itemId: UUID, val mediaSourceId: String? = null, val audioStreamIndex: Int? = null, val subtitleStreamIndex: Int? = null, val playMethod: PlayMethod? = null, val liveStreamId: String? = null, val playSessionId: String? = null, val canSeek: Boolean? = false)
Reports that a session has begun playing an item.
Link copied to clipboard
Link copied to clipboard
data class OpenLiveStreamRequest(val openToken: String? = null, val userId: UUID? = null, val playSessionId: String? = null, val maxStreamingBitrate: Int? = null, val startTimeTicks: Long? = null, val audioStreamIndex: Int? = null, val subtitleStreamIndex: Int? = null, val maxAudioChannels: Int? = null, val itemId: UUID? = null, val enableDirectPlay: Boolean? = null, val enableDirectStream: Boolean? = null, val alwaysBurnInSubtitleWhenTranscoding: Boolean? = null)
Opens a media source.
Link copied to clipboard
data class PlayRequest(val sessionId: String, val playCommand: PlayCommand, val itemIds: Collection<UUID>, val startPositionTicks: Long? = null, val mediaSourceId: String? = null, val audioStreamIndex: Int? = null, val subtitleStreamIndex: Int? = null, val startIndex: Int? = null)
Instructs a session to play an item.
Link copied to clipboard
data class PostCapabilitiesRequest(val id: String? = null, val playableMediaTypes: Collection<MediaType>? = null, val supportedCommands: Collection<GeneralCommandType>? = null, val supportsMediaControl: Boolean? = false, val supportsPersistentIdentifier: Boolean? = true)
Updates capabilities for a device.
Link copied to clipboard
data class RefreshItemRequest(val itemId: UUID, val metadataRefreshMode: MetadataRefreshMode? = MetadataRefreshMode.NONE, val imageRefreshMode: MetadataRefreshMode? = MetadataRefreshMode.NONE, val replaceAllMetadata: Boolean? = false, val replaceAllImages: Boolean? = false, val regenerateTrickplay: Boolean? = false)
Refreshes metadata for an item.