jellyfin-model/org.jellyfin.sdk.model.api/BaseItemDto

BaseItemDto

data class BaseItemDto(val name: String? = null, val originalTitle: String? = null, val serverId: String? = null, val id: UUID, val etag: String? = null, val sourceType: String? = null, val playlistItemId: String? = null, val dateCreated: DateTime? = null, val dateLastMediaAdded: DateTime? = null, val extraType: ExtraType? = null, val airsBeforeSeasonNumber: Int? = null, val airsAfterSeasonNumber: Int? = null, val airsBeforeEpisodeNumber: Int? = null, val canDelete: Boolean? = null, val canDownload: Boolean? = null, val hasLyrics: Boolean? = null, val hasSubtitles: Boolean? = null, val preferredMetadataLanguage: String? = null, val preferredMetadataCountryCode: String? = null, val container: String? = null, val sortName: String? = null, val forcedSortName: String? = null, val video3dFormat: Video3dFormat? = null, val premiereDate: DateTime? = null, val externalUrls: List<ExternalUrl>? = null, val mediaSources: List<MediaSourceInfo>? = null, val criticRating: Float? = null, val productionLocations: List<String>? = null, val path: String? = null, val enableMediaSourceDisplay: Boolean? = null, val officialRating: String? = null, val customRating: String? = null, val channelId: UUID? = null, val channelName: String? = null, val overview: String? = null, val taglines: List<String>? = null, val genres: List<String>? = null, val communityRating: Float? = null, val cumulativeRunTimeTicks: Long? = null, val runTimeTicks: Long? = null, val playAccess: PlayAccess? = null, val aspectRatio: String? = null, val productionYear: Int? = null, val isPlaceHolder: Boolean? = null, val number: String? = null, val channelNumber: String? = null, val indexNumber: Int? = null, val indexNumberEnd: Int? = null, val parentIndexNumber: Int? = null, val remoteTrailers: List<MediaUrl>? = null, val providerIds: Map<String, String?>? = null, val isHd: Boolean? = null, val isFolder: Boolean? = null, val parentId: UUID? = null, val type: BaseItemKind, val people: List<BaseItemPerson>? = null, val studios: List<NameGuidPair>? = null, val genreItems: List<NameGuidPair>? = null, val parentLogoItemId: UUID? = null, val parentBackdropItemId: UUID? = null, val parentBackdropImageTags: List<String>? = null, val localTrailerCount: Int? = null, val userData: UserItemDataDto? = null, val recursiveItemCount: Int? = null, val childCount: Int? = null, val seriesName: String? = null, val seriesId: UUID? = null, val seasonId: UUID? = null, val specialFeatureCount: Int? = null, val displayPreferencesId: String? = null, val status: String? = null, val airTime: String? = null, val airDays: List<DayOfWeek>? = null, val tags: List<String>? = null, val primaryImageAspectRatio: Double? = null, val artists: List<String>? = null, val artistItems: List<NameGuidPair>? = null, val album: String? = null, val collectionType: CollectionType? = null, val displayOrder: String? = null, val albumId: UUID? = null, val albumPrimaryImageTag: String? = null, val seriesPrimaryImageTag: String? = null, val albumArtist: String? = null, val albumArtists: List<NameGuidPair>? = null, val seasonName: String? = null, val mediaStreams: List<MediaStream>? = null, val videoType: VideoType? = null, val partCount: Int? = null, val mediaSourceCount: Int? = null, val imageTags: Map<ImageType, String>? = null, val backdropImageTags: List<String>? = null, val screenshotImageTags: List<String>? = null, val parentLogoImageTag: String? = null, val parentArtItemId: UUID? = null, val parentArtImageTag: String? = null, val seriesThumbImageTag: String? = null, val imageBlurHashes: Map<ImageType, Map<String, String>>? = null, val seriesStudio: String? = null, val parentThumbItemId: UUID? = null, val parentThumbImageTag: String? = null, val parentPrimaryImageItemId: String? = null, val parentPrimaryImageTag: String? = null, val chapters: List<ChapterInfo>? = null, val trickplay: Map<String, Map<String, TrickplayInfo>>? = null, val locationType: LocationType? = null, val isoType: IsoType? = null, val mediaType: MediaType, val endDate: DateTime? = null, val lockedFields: List<MetadataField>? = null, val trailerCount: Int? = null, val movieCount: Int? = null, val seriesCount: Int? = null, val programCount: Int? = null, val episodeCount: Int? = null, val songCount: Int? = null, val albumCount: Int? = null, val artistCount: Int? = null, val musicVideoCount: Int? = null, val lockData: Boolean? = null, val width: Int? = null, val height: Int? = null, val cameraMake: String? = null, val cameraModel: String? = null, val software: String? = null, val exposureTime: Double? = null, val focalLength: Double? = null, val imageOrientation: ImageOrientation? = null, val aperture: Double? = null, val shutterSpeed: Double? = null, val latitude: Double? = null, val longitude: Double? = null, val altitude: Double? = null, val isoSpeedRating: Int? = null, val seriesTimerId: String? = null, val programId: String? = null, val channelPrimaryImageTag: String? = null, val startDate: DateTime? = null, val completionPercentage: Double? = null, val isRepeat: Boolean? = null, val episodeTitle: String? = null, val channelType: ChannelType? = null, val audio: ProgramAudio? = null, val isMovie: Boolean? = null, val isSports: Boolean? = null, val isSeries: Boolean? = null, val isLive: Boolean? = null, val isNews: Boolean? = null, val isKids: Boolean? = null, val isPremiere: Boolean? = null, val timerId: String? = null, val normalizationGain: Float? = null, val currentProgram: BaseItemDto? = null)

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.

Constructors

Link copied to clipboard
constructor(name: String? = null, originalTitle: String? = null, serverId: String? = null, id: UUID, etag: String? = null, sourceType: String? = null, playlistItemId: String? = null, dateCreated: DateTime? = null, dateLastMediaAdded: DateTime? = null, extraType: ExtraType? = null, airsBeforeSeasonNumber: Int? = null, airsAfterSeasonNumber: Int? = null, airsBeforeEpisodeNumber: Int? = null, canDelete: Boolean? = null, canDownload: Boolean? = null, hasLyrics: Boolean? = null, hasSubtitles: Boolean? = null, preferredMetadataLanguage: String? = null, preferredMetadataCountryCode: String? = null, container: String? = null, sortName: String? = null, forcedSortName: String? = null, video3dFormat: Video3dFormat? = null, premiereDate: DateTime? = null, externalUrls: List<ExternalUrl>? = null, mediaSources: List<MediaSourceInfo>? = null, criticRating: Float? = null, productionLocations: List<String>? = null, path: String? = null, enableMediaSourceDisplay: Boolean? = null, officialRating: String? = null, customRating: String? = null, channelId: UUID? = null, channelName: String? = null, overview: String? = null, taglines: List<String>? = null, genres: List<String>? = null, communityRating: Float? = null, cumulativeRunTimeTicks: Long? = null, runTimeTicks: Long? = null, playAccess: PlayAccess? = null, aspectRatio: String? = null, productionYear: Int? = null, isPlaceHolder: Boolean? = null, number: String? = null, channelNumber: String? = null, indexNumber: Int? = null, indexNumberEnd: Int? = null, parentIndexNumber: Int? = null, remoteTrailers: List<MediaUrl>? = null, providerIds: Map<String, String?>? = null, isHd: Boolean? = null, isFolder: Boolean? = null, parentId: UUID? = null, type: BaseItemKind, people: List<BaseItemPerson>? = null, studios: List<NameGuidPair>? = null, genreItems: List<NameGuidPair>? = null, parentLogoItemId: UUID? = null, parentBackdropItemId: UUID? = null, parentBackdropImageTags: List<String>? = null, localTrailerCount: Int? = null, userData: UserItemDataDto? = null, recursiveItemCount: Int? = null, childCount: Int? = null, seriesName: String? = null, seriesId: UUID? = null, seasonId: UUID? = null, specialFeatureCount: Int? = null, displayPreferencesId: String? = null, status: String? = null, airTime: String? = null, airDays: List<DayOfWeek>? = null, tags: List<String>? = null, primaryImageAspectRatio: Double? = null, artists: List<String>? = null, artistItems: List<NameGuidPair>? = null, album: String? = null, collectionType: CollectionType? = null, displayOrder: String? = null, albumId: UUID? = null, albumPrimaryImageTag: String? = null, seriesPrimaryImageTag: String? = null, albumArtist: String? = null, albumArtists: List<NameGuidPair>? = null, seasonName: String? = null, mediaStreams: List<MediaStream>? = null, videoType: VideoType? = null, partCount: Int? = null, mediaSourceCount: Int? = null, imageTags: Map<ImageType, String>? = null, backdropImageTags: List<String>? = null, screenshotImageTags: List<String>? = null, parentLogoImageTag: String? = null, parentArtItemId: UUID? = null, parentArtImageTag: String? = null, seriesThumbImageTag: String? = null, imageBlurHashes: Map<ImageType, Map<String, String>>? = null, seriesStudio: String? = null, parentThumbItemId: UUID? = null, parentThumbImageTag: String? = null, parentPrimaryImageItemId: String? = null, parentPrimaryImageTag: String? = null, chapters: List<ChapterInfo>? = null, trickplay: Map<String, Map<String, TrickplayInfo>>? = null, locationType: LocationType? = null, isoType: IsoType? = null, mediaType: MediaType, endDate: DateTime? = null, lockedFields: List<MetadataField>? = null, trailerCount: Int? = null, movieCount: Int? = null, seriesCount: Int? = null, programCount: Int? = null, episodeCount: Int? = null, songCount: Int? = null, albumCount: Int? = null, artistCount: Int? = null, musicVideoCount: Int? = null, lockData: Boolean? = null, width: Int? = null, height: Int? = null, cameraMake: String? = null, cameraModel: String? = null, software: String? = null, exposureTime: Double? = null, focalLength: Double? = null, imageOrientation: ImageOrientation? = null, aperture: Double? = null, shutterSpeed: Double? = null, latitude: Double? = null, longitude: Double? = null, altitude: Double? = null, isoSpeedRating: Int? = null, seriesTimerId: String? = null, programId: String? = null, channelPrimaryImageTag: String? = null, startDate: DateTime? = null, completionPercentage: Double? = null, isRepeat: Boolean? = null, episodeTitle: String? = null, channelType: ChannelType? = null, audio: ProgramAudio? = null, isMovie: Boolean? = null, isSports: Boolean? = null, isSeries: Boolean? = null, isLive: Boolean? = null, isNews: Boolean? = null, isKids: Boolean? = null, isPremiere: Boolean? = null, timerId: String? = null, normalizationGain: Float? = null, currentProgram: BaseItemDto? = null)

Properties

Link copied to clipboard
val airDays: List<DayOfWeek>? = null

The air days.

Link copied to clipboard
val airsAfterSeasonNumber: Int? = null
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val airTime: String? = null

The air time.

Link copied to clipboard
val album: String? = null

The album.

Link copied to clipboard
val albumArtist: String? = null

The album artist.

Link copied to clipboard
val albumArtists: List<NameGuidPair>? = null

The album artists.

Link copied to clipboard
val albumCount: Int? = null

The album count.

Link copied to clipboard
val albumId: UUID? = null

The album id.

Link copied to clipboard
val albumPrimaryImageTag: String? = null

The album image tag.

Link copied to clipboard
val altitude: Double? = null
Link copied to clipboard
val aperture: Double? = null
Link copied to clipboard
val artistCount: Int? = null
Link copied to clipboard
val artistItems: List<NameGuidPair>? = null

The artist items.

Link copied to clipboard
val artists: List<String>? = null

The artists.

Link copied to clipboard
val aspectRatio: String? = null

The aspect ratio.

Link copied to clipboard
val audio: ProgramAudio? = null

The audio.

Link copied to clipboard
val backdropImageTags: List<String>? = null

The backdrop image tags.

Link copied to clipboard
val cameraMake: String? = null
Link copied to clipboard
val cameraModel: String? = null
Link copied to clipboard
val canDelete: Boolean? = null
Link copied to clipboard
val canDownload: Boolean? = null
Link copied to clipboard
val channelId: UUID? = null

The channel identifier.

Link copied to clipboard
val channelName: String? = null
Link copied to clipboard
val channelNumber: String? = null
Link copied to clipboard
val channelPrimaryImageTag: String? = null

The channel primary image tag.

Link copied to clipboard
val channelType: ChannelType? = null

The type of the channel.

Link copied to clipboard
val chapters: List<ChapterInfo>? = null

The chapters.

Link copied to clipboard
val childCount: Int? = null

The child count.

Link copied to clipboard
val collectionType: CollectionType? = null

The type of the collection.

Link copied to clipboard
val communityRating: Float? = null

The community rating.

Link copied to clipboard
val completionPercentage: Double? = null

The completion percentage.

Link copied to clipboard
val container: String? = null
Link copied to clipboard
val criticRating: Float? = null

The critic rating.

Link copied to clipboard
val cumulativeRunTimeTicks: Long? = null

The cumulative run time ticks.

Link copied to clipboard
val currentProgram: BaseItemDto? = null

The current program.

Link copied to clipboard
val customRating: String? = null

The custom rating.

Link copied to clipboard
val dateCreated: DateTime? = null

The date created.

Link copied to clipboard
Link copied to clipboard
val displayOrder: String? = null

The display order.

Link copied to clipboard
val displayPreferencesId: String? = null

The display preferences id.

Link copied to clipboard
Link copied to clipboard
val endDate: DateTime? = null

The end date.

Link copied to clipboard
val episodeCount: Int? = null

The episode count.

Link copied to clipboard
val episodeTitle: String? = null

The episode title.

Link copied to clipboard
val etag: String? = null

The etag.

Link copied to clipboard
val exposureTime: Double? = null
Link copied to clipboard
val externalUrls: List<ExternalUrl>? = null

The external urls.

Link copied to clipboard
val extraType: ExtraType? = null
Link copied to clipboard
val focalLength: Double? = null
Link copied to clipboard
val forcedSortName: String? = null
Link copied to clipboard
val genreItems: List<NameGuidPair>? = null
Link copied to clipboard
val genres: List<String>? = null

The genres.

Link copied to clipboard
val hasLyrics: Boolean? = null
Link copied to clipboard
val hasSubtitles: Boolean? = null
Link copied to clipboard
val height: Int? = null
Link copied to clipboard
val id: UUID

The id.

Link copied to clipboard
val imageBlurHashes: Map<ImageType, Map<String, String>>? = null

Gets or sets the blurhashes for the image tags. Maps image type to dictionary mapping image tag to blurhash value.

Link copied to clipboard
Link copied to clipboard
val imageTags: Map<ImageType, String>? = null

The image tags.

Link copied to clipboard
val indexNumber: Int? = null

The index number.

Link copied to clipboard
val indexNumberEnd: Int? = null

The index number end.

Link copied to clipboard
val isFolder: Boolean? = null

A value indicating whether this instance is folder.

Link copied to clipboard
val isHd: Boolean? = null

A value indicating whether this instance is HD.

Link copied to clipboard
val isKids: Boolean? = null

A value indicating whether this instance is kids.

Link copied to clipboard
val isLive: Boolean? = null

A value indicating whether this instance is live.

Link copied to clipboard
val isMovie: Boolean? = null

A value indicating whether this instance is movie.

Link copied to clipboard
val isNews: Boolean? = null

A value indicating whether this instance is news.

Link copied to clipboard
val isoSpeedRating: Int? = null
Link copied to clipboard
val isoType: IsoType? = null

The type of the iso.

Link copied to clipboard
val isPlaceHolder: Boolean? = null

A value indicating whether this instance is place holder.

Link copied to clipboard
val isPremiere: Boolean? = null

A value indicating whether this instance is premiere.

Link copied to clipboard
val isRepeat: Boolean? = null

A value indicating whether this instance is repeat.

Link copied to clipboard
val isSeries: Boolean? = null

A value indicating whether this instance is series.

Link copied to clipboard
val isSports: Boolean? = null

A value indicating whether this instance is sports.

Link copied to clipboard
val latitude: Double? = null
Link copied to clipboard
val localTrailerCount: Int? = null

The local trailer count.

Link copied to clipboard
val locationType: LocationType? = null

The type of the location.

Link copied to clipboard
val lockData: Boolean? = null

A value indicating whether enable internet providers.

Link copied to clipboard
val lockedFields: List<MetadataField>? = null

The locked fields.

Link copied to clipboard
val longitude: Double? = null
Link copied to clipboard
val mediaSourceCount: Int? = null
Link copied to clipboard
val mediaSources: List<MediaSourceInfo>? = null

The media versions.

Link copied to clipboard
val mediaStreams: List<MediaStream>? = null

The media streams.

Link copied to clipboard
val mediaType: MediaType

Media types.

Link copied to clipboard
val movieCount: Int? = null

The movie count.

Link copied to clipboard
val musicVideoCount: Int? = null

The music video count.

Link copied to clipboard
val name: String? = null

The name.

Link copied to clipboard
val normalizationGain: Float? = null

The gain required for audio normalization.

Link copied to clipboard
val number: String? = null

The number.

Link copied to clipboard
val officialRating: String? = null

The official rating.

Link copied to clipboard
val originalTitle: String? = null
Link copied to clipboard
val overview: String? = null

The overview.

Link copied to clipboard
val parentArtImageTag: String? = null

The parent art image tag.

Link copied to clipboard
val parentArtItemId: UUID? = null

Whether the item has fan art, this will hold the Id of the Parent that has one.

Link copied to clipboard
val parentBackdropImageTags: List<String>? = null

The parent backdrop image tags.

Link copied to clipboard
val parentBackdropItemId: UUID? = null

Whether the item has any backdrops, this will hold the Id of the Parent that has one.

Link copied to clipboard
val parentId: UUID? = null

The parent id.

Link copied to clipboard
val parentIndexNumber: Int? = null

The parent index number.

Link copied to clipboard
val parentLogoImageTag: String? = null

The parent logo image tag.

Link copied to clipboard
val parentLogoItemId: UUID? = null

Whether the item has a logo, this will hold the Id of the Parent that has one.

Link copied to clipboard
val parentPrimaryImageItemId: String? = null

The parent primary image item identifier.

Link copied to clipboard
val parentPrimaryImageTag: String? = null

The parent primary image tag.

Link copied to clipboard
val parentThumbImageTag: String? = null

The parent thumb image tag.

Link copied to clipboard
val parentThumbItemId: UUID? = null

The parent thumb item id.

Link copied to clipboard
val partCount: Int? = null

The part count.

Link copied to clipboard
val path: String? = null

The path.

Link copied to clipboard
val people: List<BaseItemPerson>? = null

The people.

Link copied to clipboard
val playAccess: PlayAccess? = null

The play access.

Link copied to clipboard
val playlistItemId: String? = null

The playlist item identifier.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val premiereDate: DateTime? = null

The premiere date.

Link copied to clipboard
val primaryImageAspectRatio: Double? = null

The primary image aspect ratio, after image enhancements.

Link copied to clipboard
Link copied to clipboard
val productionYear: Int? = null

The production year.

Link copied to clipboard
val programCount: Int? = null
Link copied to clipboard
val programId: String? = null

The program identifier.

Link copied to clipboard
val providerIds: Map<String, String?>? = null

The provider ids.

Link copied to clipboard
val recursiveItemCount: Int? = null

The recursive item count.

Link copied to clipboard
val remoteTrailers: List<MediaUrl>? = null

The trailer urls.

Link copied to clipboard
val runTimeTicks: Long? = null

The run time ticks.

Link copied to clipboard
val screenshotImageTags: List<String>? = null

The screenshot image tags.

Link copied to clipboard
val seasonId: UUID? = null

The season identifier.

Link copied to clipboard
val seasonName: String? = null

The name of the season.

Link copied to clipboard
val seriesCount: Int? = null

The series count.

Link copied to clipboard
val seriesId: UUID? = null

The series id.

Link copied to clipboard
val seriesName: String? = null

The name of the series.

Link copied to clipboard
val seriesPrimaryImageTag: String? = null

The series primary image tag.

Link copied to clipboard
val seriesStudio: String? = null

The series studio.

Link copied to clipboard
val seriesThumbImageTag: String? = null

The series thumb image tag.

Link copied to clipboard
val seriesTimerId: String? = null

The series timer identifier.

Link copied to clipboard
val serverId: String? = null

The server identifier.

Link copied to clipboard
val shutterSpeed: Double? = null
Link copied to clipboard
val software: String? = null
Link copied to clipboard
val songCount: Int? = null

The song count.

Link copied to clipboard
val sortName: String? = null

The name of the sort.

Link copied to clipboard
val sourceType: String? = null

The type of the source.

Link copied to clipboard
val specialFeatureCount: Int? = null

The special feature count.

Link copied to clipboard
val startDate: DateTime? = null

The start date of the recording, in UTC.

Link copied to clipboard
val status: String? = null

The status.

Link copied to clipboard
val studios: List<NameGuidPair>? = null

The studios.

Link copied to clipboard
val taglines: List<String>? = null

The taglines.

Link copied to clipboard
val tags: List<String>? = null

The tags.

Link copied to clipboard
val timerId: String? = null

The timer identifier.

Link copied to clipboard
val trailerCount: Int? = null

The trailer count.

Link copied to clipboard
val trickplay: Map<String, Map<String, TrickplayInfo>>? = null

The trickplay manifest.

Link copied to clipboard
val type: BaseItemKind

The base item kind.

Link copied to clipboard
val userData: UserItemDataDto? = null

The user data for this item based on the user it's being requested for.

Link copied to clipboard
val video3dFormat: Video3dFormat? = null

The video3 D format.

Link copied to clipboard
val videoType: VideoType? = null

The type of the video.

Link copied to clipboard
val width: Int? = null