jellyfin-sdk-swift/docs/BaseItemDto.md

BaseItemDto

Properties

Name	Type	Description	Notes
name	String	Gets or sets the name.	[optional]
originalTitle	String		[optional]
serverId	String	Gets or sets the server identifier.	[optional]
id	String	Gets or sets the id.	[optional]
etag	String	Gets or sets the etag.	[optional]
sourceType	String	Gets or sets the type of the source.	[optional]
playlistItemId	String	Gets or sets the playlist item identifier.	[optional]
dateCreated	Date	Gets or sets the date created.	[optional]
dateLastMediaAdded	Date		[optional]
extraType	String		[optional]
airsBeforeSeasonNumber	Int		[optional]
airsAfterSeasonNumber	Int		[optional]
airsBeforeEpisodeNumber	Int		[optional]
canDelete	Bool		[optional]
canDownload	Bool		[optional]
hasSubtitles	Bool		[optional]
preferredMetadataLanguage	String		[optional]
preferredMetadataCountryCode	String		[optional]
supportsSync	Bool	Gets or sets a value indicating whether [supports synchronize].	[optional]
container	String		[optional]
sortName	String	Gets or sets the name of the sort.	[optional]
forcedSortName	String		[optional]
video3DFormat	Video3DFormat		[optional]
premiereDate	Date	Gets or sets the premiere date.	[optional]
externalUrls	[ExternalUrl]	Gets or sets the external urls.	[optional]
mediaSources	[MediaSourceInfo]	Gets or sets the media versions.	[optional]
criticRating	Float	Gets or sets the critic rating.	[optional]
productionLocations	[String]		[optional]
path	String	Gets or sets the path.	[optional]
enableMediaSourceDisplay	Bool		[optional]
officialRating	String	Gets or sets the official rating.	[optional]
customRating	String	Gets or sets the custom rating.	[optional]
channelId	String	Gets or sets the channel identifier.	[optional]
channelName	String		[optional]
overview	String	Gets or sets the overview.	[optional]
taglines	[String]	Gets or sets the taglines.	[optional]
genres	[String]	Gets or sets the genres.	[optional]
communityRating	Float	Gets or sets the community rating.	[optional]
cumulativeRunTimeTicks	Int64	Gets or sets the cumulative run time ticks.	[optional]
runTimeTicks	Int64	Gets or sets the run time ticks.	[optional]
playAccess	PlayAccess		[optional]
aspectRatio	String	Gets or sets the aspect ratio.	[optional]
productionYear	Int	Gets or sets the production year.	[optional]
isPlaceHolder	Bool	Gets or sets a value indicating whether this instance is place holder.	[optional]
number	String	Gets or sets the number.	[optional]
channelNumber	String		[optional]
indexNumber	Int	Gets or sets the index number.	[optional]
indexNumberEnd	Int	Gets or sets the index number end.	[optional]
parentIndexNumber	Int	Gets or sets the parent index number.	[optional]
remoteTrailers	[MediaUrl]	Gets or sets the trailer urls.	[optional]
providerIds	[String: String]	Gets or sets the provider ids.	[optional]
isHD	Bool	Gets or sets a value indicating whether this instance is HD.	[optional]
isFolder	Bool	Gets or sets a value indicating whether this instance is folder.	[optional]
parentId	String	Gets or sets the parent id.	[optional]
type	String	Gets or sets the type.	[optional]
people	[BaseItemPerson]	Gets or sets the people.	[optional]
studios	[NameGuidPair]	Gets or sets the studios.	[optional]
genreItems	[NameGuidPair]		[optional]
parentLogoItemId	String	If the item does not have a logo, this will hold the Id of the Parent that has one.	[optional]
parentBackdropItemId	String	If the item does not have any backdrops, this will hold the Id of the Parent that has one.	[optional]
parentBackdropImageTags	[String]	Gets or sets the parent backdrop image tags.	[optional]
localTrailerCount	Int	Gets or sets the local trailer count.	[optional]
userData	UserItemDataDto		[optional]
recursiveItemCount	Int	Gets or sets the recursive item count.	[optional]
childCount	Int	Gets or sets the child count.	[optional]
seriesName	String	Gets or sets the name of the series.	[optional]
seriesId	String	Gets or sets the series id.	[optional]
seasonId	String	Gets or sets the season identifier.	[optional]
specialFeatureCount	Int	Gets or sets the special feature count.	[optional]
displayPreferencesId	String	Gets or sets the display preferences id.	[optional]
status	String	Gets or sets the status.	[optional]
airTime	String	Gets or sets the air time.	[optional]
airDays	[DayOfWeek]	Gets or sets the air days.	[optional]
tags	[String]	Gets or sets the tags.	[optional]
primaryImageAspectRatio	Double	Gets or sets the primary image aspect ratio, after image enhancements.	[optional]
artists	[String]	Gets or sets the artists.	[optional]
artistItems	[NameGuidPair]	Gets or sets the artist items.	[optional]
album	String	Gets or sets the album.	[optional]
collectionType	String	Gets or sets the type of the collection.	[optional]
displayOrder	String	Gets or sets the display order.	[optional]
albumId	String	Gets or sets the album id.	[optional]
albumPrimaryImageTag	String	Gets or sets the album image tag.	[optional]
seriesPrimaryImageTag	String	Gets or sets the series primary image tag.	[optional]
albumArtist	String	Gets or sets the album artist.	[optional]
albumArtists	[NameGuidPair]	Gets or sets the album artists.	[optional]
seasonName	String	Gets or sets the name of the season.	[optional]
mediaStreams	[MediaStream]	Gets or sets the media streams.	[optional]
videoType	VideoType		[optional]
partCount	Int	Gets or sets the part count.	[optional]
mediaSourceCount	Int		[optional]
imageTags	[String: String]	Gets or sets the image tags.	[optional]
backdropImageTags	[String]	Gets or sets the backdrop image tags.	[optional]
screenshotImageTags	[String]	Gets or sets the screenshot image tags.	[optional]
parentLogoImageTag	String	Gets or sets the parent logo image tag.	[optional]
parentArtItemId	String	If the item does not have a art, this will hold the Id of the Parent that has one.	[optional]
parentArtImageTag	String	Gets or sets the parent art image tag.	[optional]
seriesThumbImageTag	String	Gets or sets the series thumb image tag.	[optional]
imageBlurHashes	BaseItemDtoImageBlurHashes		[optional]
seriesStudio	String	Gets or sets the series studio.	[optional]
parentThumbItemId	String	Gets or sets the parent thumb item id.	[optional]
parentThumbImageTag	String	Gets or sets the parent thumb image tag.	[optional]
parentPrimaryImageItemId	String	Gets or sets the parent primary image item identifier.	[optional]
parentPrimaryImageTag	String	Gets or sets the parent primary image tag.	[optional]
chapters	[ChapterInfo]	Gets or sets the chapters.	[optional]
locationType	LocationType		[optional]
isoType	IsoType		[optional]
mediaType	String	Gets or sets the type of the media.	[optional]
endDate	Date	Gets or sets the end date.	[optional]
lockedFields	[MetadataField]	Gets or sets the locked fields.	[optional]
trailerCount	Int	Gets or sets the trailer count.	[optional]
movieCount	Int	Gets or sets the movie count.	[optional]
seriesCount	Int	Gets or sets the series count.	[optional]
programCount	Int		[optional]
episodeCount	Int	Gets or sets the episode count.	[optional]
songCount	Int	Gets or sets the song count.	[optional]
albumCount	Int	Gets or sets the album count.	[optional]
artistCount	Int		[optional]
musicVideoCount	Int	Gets or sets the music video count.	[optional]
lockData	Bool	Gets or sets a value indicating whether [enable internet providers].	[optional]
width	Int		[optional]
height	Int		[optional]
cameraMake	String		[optional]
cameraModel	String		[optional]
software	String		[optional]
exposureTime	Double		[optional]
focalLength	Double		[optional]
imageOrientation	ImageOrientation		[optional]
aperture	Double		[optional]
shutterSpeed	Double		[optional]
latitude	Double		[optional]
longitude	Double		[optional]
altitude	Double		[optional]
isoSpeedRating	Int		[optional]
seriesTimerId	String	Gets or sets the series timer identifier.	[optional]
programId	String	Gets or sets the program identifier.	[optional]
channelPrimaryImageTag	String	Gets or sets the channel primary image tag.	[optional]
startDate	Date	The start date of the recording, in UTC.	[optional]
completionPercentage	Double	Gets or sets the completion percentage.	[optional]
isRepeat	Bool	Gets or sets a value indicating whether this instance is repeat.	[optional]
episodeTitle	String	Gets or sets the episode title.	[optional]
channelType	ChannelType		[optional]
audio	ProgramAudio		[optional]
isMovie	Bool	Gets or sets a value indicating whether this instance is movie.	[optional]
isSports	Bool	Gets or sets a value indicating whether this instance is sports.	[optional]
isSeries	Bool	Gets or sets a value indicating whether this instance is series.	[optional]
isLive	Bool	Gets or sets a value indicating whether this instance is live.	[optional]
isNews	Bool	Gets or sets a value indicating whether this instance is news.	[optional]
isKids	Bool	Gets or sets a value indicating whether this instance is kids.	[optional]
isPremiere	Bool	Gets or sets a value indicating whether this instance is premiere.	[optional]
timerId	String	Gets or sets the timer identifier.	[optional]

[Back to Model list] [Back to API list] [Back to README]