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: UUID? = null, val parentPrimaryImageTag: String? = null, val chapters: List<ChapterInfo>? = null, val trickplay: Map<String, Map<String, TrickplayInfoDto>>? = null, val locationType: LocationType? = null, val isoType: IsoType? = null, val mediaType: MediaType = MediaType.UNKNOWN, 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

BaseItemDto

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: UUID? = null, parentPrimaryImageTag: String? = null, chapters: List<ChapterInfo>? = null, trickplay: Map<String, Map<String, TrickplayInfoDto>>? = null, locationType: LocationType? = null, isoType: IsoType? = null, mediaType: MediaType = MediaType.UNKNOWN, 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

airDays

val airDays: List<DayOfWeek>?

The air days.

airsAfterSeasonNumber

val airsAfterSeasonNumber: Int?

airsBeforeEpisodeNumber

val airsBeforeEpisodeNumber: Int?

airsBeforeSeasonNumber

val airsBeforeSeasonNumber: Int?

airTime

val airTime: String?

The air time.

album

val album: String?

The album.

albumArtist

val albumArtist: String?

The album artist.

albumArtists

val albumArtists: List<NameGuidPair>?

The album artists.

albumCount

val albumCount: Int?

The album count.

albumId

val albumId: UUID?

The album id.

albumPrimaryImageTag

val albumPrimaryImageTag: String?

The album image tag.

altitude

val altitude: Double?

aperture

val aperture: Double?

artistCount

val artistCount: Int?

artistItems

val artistItems: List<NameGuidPair>?

The artist items.

artists

val artists: List<String>?

The artists.

aspectRatio

val aspectRatio: String?

The aspect ratio.

audio

val audio: ProgramAudio?

The audio.

backdropImageTags

val backdropImageTags: List<String>?

The backdrop image tags.

cameraMake

val cameraMake: String?

cameraModel

val cameraModel: String?

canDelete

val canDelete: Boolean?

canDownload

val canDownload: Boolean?

channelId

val channelId: UUID?

The channel identifier.

channelName

val channelName: String?

channelNumber

val channelNumber: String?

channelPrimaryImageTag

val channelPrimaryImageTag: String?

The channel primary image tag.

channelType

val channelType: ChannelType?

The type of the channel.

chapters

val chapters: List<ChapterInfo>?

The chapters.

childCount

val childCount: Int?

The child count.

collectionType

val collectionType: CollectionType?

The type of the collection.

communityRating

val communityRating: Float?

The community rating.

completionPercentage

val completionPercentage: Double?

The completion percentage.

container

val container: String?

criticRating

val criticRating: Float?

The critic rating.

cumulativeRunTimeTicks

val cumulativeRunTimeTicks: Long?

The cumulative run time ticks.

currentProgram

val currentProgram: BaseItemDto?

The current program.

customRating

val customRating: String?

The custom rating.

dateCreated

val dateCreated: DateTime?

The date created.

dateLastMediaAdded

val dateLastMediaAdded: DateTime?

displayOrder

val displayOrder: String?

The display order.

displayPreferencesId

val displayPreferencesId: String?

The display preferences id.

enableMediaSourceDisplay

val enableMediaSourceDisplay: Boolean?

endDate

val endDate: DateTime?

The end date.

episodeCount

val episodeCount: Int?

The episode count.

episodeTitle

val episodeTitle: String?

The episode title.

etag

val etag: String?

The etag.

exposureTime

val exposureTime: Double?

externalUrls

val externalUrls: List<ExternalUrl>?

The external urls.

extraType

val extraType: ExtraType?

focalLength

val focalLength: Double?

forcedSortName

val forcedSortName: String?

genreItems

val genreItems: List<NameGuidPair>?

genres

val genres: List<String>?

The genres.

hasLyrics

val hasLyrics: Boolean?

hasSubtitles

val hasSubtitles: Boolean?

height

val height: Int?

val id: UUID

The id.

imageBlurHashes

val imageBlurHashes: Map<ImageType, Map<String, String>>?

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

imageOrientation

val imageOrientation: ImageOrientation?

imageTags

val imageTags: Map<ImageType, String>?

The image tags.

indexNumber

val indexNumber: Int?

The index number.

indexNumberEnd

val indexNumberEnd: Int?

The index number end.

isFolder

val isFolder: Boolean?

A value indicating whether this instance is folder.

isHd

val isHd: Boolean?

A value indicating whether this instance is HD.

isKids

val isKids: Boolean?

A value indicating whether this instance is kids.

isLive

val isLive: Boolean?

A value indicating whether this instance is live.

isMovie

val isMovie: Boolean?

A value indicating whether this instance is movie.

isNews

val isNews: Boolean?

A value indicating whether this instance is news.

isoSpeedRating

val isoSpeedRating: Int?

isoType

val isoType: IsoType?

The type of the iso.

isPlaceHolder

val isPlaceHolder: Boolean?

A value indicating whether this instance is place holder.

isPremiere

val isPremiere: Boolean?

A value indicating whether this instance is premiere.

isRepeat

val isRepeat: Boolean?

A value indicating whether this instance is repeat.

isSeries

val isSeries: Boolean?

A value indicating whether this instance is series.

isSports

val isSports: Boolean?

A value indicating whether this instance is sports.

latitude

val latitude: Double?

localTrailerCount

val localTrailerCount: Int?

The local trailer count.

locationType

val locationType: LocationType?

The type of the location.

lockData

val lockData: Boolean?

A value indicating whether enable internet providers.

lockedFields

val lockedFields: List<MetadataField>?

The locked fields.

longitude

val longitude: Double?

mediaSourceCount

val mediaSourceCount: Int?

mediaSources

val mediaSources: List<MediaSourceInfo>?

The media versions.

mediaStreams

val mediaStreams: List<MediaStream>?

The media streams.

mediaType

val mediaType: MediaType

The type of the media.

movieCount

val movieCount: Int?

The movie count.

musicVideoCount

val musicVideoCount: Int?

The music video count.

name

val name: String?

The name.

normalizationGain

val normalizationGain: Float?

The gain required for audio normalization.

number

val number: String?

The number.

officialRating

val officialRating: String?

The official rating.

originalTitle

val originalTitle: String?

overview

val overview: String?

The overview.

parentArtImageTag

val parentArtImageTag: String?

The parent art image tag.

parentArtItemId

val parentArtItemId: UUID?

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

parentBackdropImageTags

val parentBackdropImageTags: List<String>?

The parent backdrop image tags.

parentBackdropItemId

val parentBackdropItemId: UUID?

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

parentId

val parentId: UUID?

The parent id.

parentIndexNumber

val parentIndexNumber: Int?

The parent index number.

parentLogoImageTag

val parentLogoImageTag: String?

The parent logo image tag.

parentLogoItemId

val parentLogoItemId: UUID?

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

parentPrimaryImageItemId

val parentPrimaryImageItemId: UUID?

The parent primary image item identifier.

parentPrimaryImageTag

val parentPrimaryImageTag: String?

The parent primary image tag.

parentThumbImageTag

val parentThumbImageTag: String?

The parent thumb image tag.

parentThumbItemId

val parentThumbItemId: UUID?

The parent thumb item id.

partCount

val partCount: Int?

The part count.

path

val path: String?

The path.

people

val people: List<BaseItemPerson>?

The people.

playAccess

val playAccess: PlayAccess?

The play access.

playlistItemId

val playlistItemId: String?

The playlist item identifier.

preferredMetadataCountryCode

val preferredMetadataCountryCode: String?

preferredMetadataLanguage

val preferredMetadataLanguage: String?

premiereDate

val premiereDate: DateTime?

The premiere date.

primaryImageAspectRatio

val primaryImageAspectRatio: Double?

The primary image aspect ratio, after image enhancements.

productionLocations

val productionLocations: List<String>?

productionYear

val productionYear: Int?

The production year.

programCount

val programCount: Int?

programId

val programId: String?

The program identifier.

providerIds

val providerIds: Map<String, String?>?

The provider ids.

recursiveItemCount

val recursiveItemCount: Int?

The recursive item count.

remoteTrailers

val remoteTrailers: List<MediaUrl>?

The trailer urls.

runTimeTicks

val runTimeTicks: Long?

The run time ticks.

screenshotImageTags

val screenshotImageTags: List<String>?

The screenshot image tags.

seasonId

val seasonId: UUID?

The season identifier.

seasonName

val seasonName: String?

The name of the season.

seriesCount

val seriesCount: Int?

The series count.

seriesId

val seriesId: UUID?

The series id.

seriesName

val seriesName: String?

The name of the series.

seriesPrimaryImageTag

val seriesPrimaryImageTag: String?

The series primary image tag.

seriesStudio

val seriesStudio: String?

The series studio.

seriesThumbImageTag

val seriesThumbImageTag: String?

The series thumb image tag.

seriesTimerId

val seriesTimerId: String?

The series timer identifier.

serverId

val serverId: String?

The server identifier.

shutterSpeed

val shutterSpeed: Double?

software

val software: String?

songCount

val songCount: Int?

The song count.

sortName

val sortName: String?

The name of the sort.

sourceType

val sourceType: String?

The type of the source.

specialFeatureCount

val specialFeatureCount: Int?

The special feature count.

startDate

val startDate: DateTime?

The start date of the recording, in UTC.

status

val status: String?

The status.

studios

val studios: List<NameGuidPair>?

The studios.

taglines

val taglines: List<String>?

The taglines.