Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
Jellyfin::Model::Item Class Reference

#include <item.h>

Inheritance diagram for Jellyfin::Model::Item:
Jellyfin::DTO::BaseItemDto

Public Types

using UserDataChangedCallback = std::function<void(DTO::UserItemDataDto)>

Signals

void userDataChanged (const DTO::UserItemDataDto &newUserData)

Public Member Functions

 Item (ApiClient *apiClient=nullptr, QObject *parent=nullptr)
 Constructor that creates an empty item.
 Item (const DTO::BaseItemDto &data, ApiClient *apiClient=nullptr, QObject *parent=nullptr)
 Copies the data from the DTO into this model and attaches an ApiClient.
bool sameAs (const DTO::BaseItemDto &other)
 sameAs Returns true if this item represents the same item as other
void setApiClient (ApiClient *apiClient)
QSharedPointer< UserItemDataDtouserData () const
Public Member Functions inherited from Jellyfin::DTO::BaseItemDto
 BaseItemDto (QString jellyfinId, ExtraType extraType, Video3DFormat video3DFormat, PlayAccess playAccess, BaseItemKind type, QSharedPointer< UserItemDataDto > userData, CollectionType collectionType, VideoType videoType, LocationType locationType, IsoType isoType, MediaType mediaType, ImageOrientation imageOrientation, ChannelType channelType, ProgramAudio audio, QSharedPointer< BaseItemDto > currentProgram)
 BaseItemDto (const BaseItemDto &other)
void replaceData (BaseItemDto &other)
void setFromJson (QJsonObject source)
QJsonObject toJson () const
QString name () const
 Gets or sets the name.
void setName (QString newName)
 Gets or sets the name.
bool nameNull () const
void setNameNull ()
QString originalTitle () const
void setOriginalTitle (QString newOriginalTitle)
bool originalTitleNull () const
void setOriginalTitleNull ()
QString serverId () const
 Gets or sets the server identifier.
void setServerId (QString newServerId)
 Gets or sets the server identifier.
bool serverIdNull () const
void setServerIdNull ()
QString jellyfinId () const
 Gets or sets the id.
void setJellyfinId (QString newJellyfinId)
 Gets or sets the id.
QString etag () const
 Gets or sets the etag.
void setEtag (QString newEtag)
 Gets or sets the etag.
bool etagNull () const
void setEtagNull ()
QString sourceType () const
 Gets or sets the type of the source.
void setSourceType (QString newSourceType)
 Gets or sets the type of the source.
bool sourceTypeNull () const
void setSourceTypeNull ()
QString playlistItemId () const
 Gets or sets the playlist item identifier.
void setPlaylistItemId (QString newPlaylistItemId)
 Gets or sets the playlist item identifier.
bool playlistItemIdNull () const
void setPlaylistItemIdNull ()
QDateTime dateCreated () const
 Gets or sets the date created.
void setDateCreated (QDateTime newDateCreated)
 Gets or sets the date created.
bool dateCreatedNull () const
void setDateCreatedNull ()
QDateTime dateLastMediaAdded () const
void setDateLastMediaAdded (QDateTime newDateLastMediaAdded)
bool dateLastMediaAddedNull () const
void setDateLastMediaAddedNull ()
ExtraType extraType () const
void setExtraType (ExtraType newExtraType)
std::optional< qint32 > airsBeforeSeasonNumber () const
void setAirsBeforeSeasonNumber (std::optional< qint32 > newAirsBeforeSeasonNumber)
bool airsBeforeSeasonNumberNull () const
void setAirsBeforeSeasonNumberNull ()
std::optional< qint32 > airsAfterSeasonNumber () const
void setAirsAfterSeasonNumber (std::optional< qint32 > newAirsAfterSeasonNumber)
bool airsAfterSeasonNumberNull () const
void setAirsAfterSeasonNumberNull ()
std::optional< qint32 > airsBeforeEpisodeNumber () const
void setAirsBeforeEpisodeNumber (std::optional< qint32 > newAirsBeforeEpisodeNumber)
bool airsBeforeEpisodeNumberNull () const
void setAirsBeforeEpisodeNumberNull ()
std::optional< bool > canDelete () const
void setCanDelete (std::optional< bool > newCanDelete)
bool canDeleteNull () const
void setCanDeleteNull ()
std::optional< bool > canDownload () const
void setCanDownload (std::optional< bool > newCanDownload)
bool canDownloadNull () const
void setCanDownloadNull ()
std::optional< bool > hasLyrics () const
void setHasLyrics (std::optional< bool > newHasLyrics)
bool hasLyricsNull () const
void setHasLyricsNull ()
std::optional< bool > hasSubtitles () const
void setHasSubtitles (std::optional< bool > newHasSubtitles)
bool hasSubtitlesNull () const
void setHasSubtitlesNull ()
QString preferredMetadataLanguage () const
void setPreferredMetadataLanguage (QString newPreferredMetadataLanguage)
bool preferredMetadataLanguageNull () const
void setPreferredMetadataLanguageNull ()
QString preferredMetadataCountryCode () const
void setPreferredMetadataCountryCode (QString newPreferredMetadataCountryCode)
bool preferredMetadataCountryCodeNull () const
void setPreferredMetadataCountryCodeNull ()
QString container () const
void setContainer (QString newContainer)
bool containerNull () const
void setContainerNull ()
QString sortName () const
 Gets or sets the name of the sort.
void setSortName (QString newSortName)
 Gets or sets the name of the sort.
bool sortNameNull () const
void setSortNameNull ()
QString forcedSortName () const
void setForcedSortName (QString newForcedSortName)
bool forcedSortNameNull () const
void setForcedSortNameNull ()
Video3DFormat video3DFormat () const
void setVideo3DFormat (Video3DFormat newVideo3DFormat)
QDateTime premiereDate () const
 Gets or sets the premiere date.
void setPremiereDate (QDateTime newPremiereDate)
 Gets or sets the premiere date.
bool premiereDateNull () const
void setPremiereDateNull ()
QList< ExternalUrlexternalUrls () const
 Gets or sets the external urls.
void setExternalUrls (QList< ExternalUrl > newExternalUrls)
 Gets or sets the external urls.
bool externalUrlsNull () const
void setExternalUrlsNull ()
QList< MediaSourceInfomediaSources () const
 Gets or sets the media versions.
void setMediaSources (QList< MediaSourceInfo > newMediaSources)
 Gets or sets the media versions.
bool mediaSourcesNull () const
void setMediaSourcesNull ()
std::optional< float > criticRating () const
 Gets or sets the critic rating.
void setCriticRating (std::optional< float > newCriticRating)
 Gets or sets the critic rating.
bool criticRatingNull () const
void setCriticRatingNull ()
QStringList productionLocations () const
void setProductionLocations (QStringList newProductionLocations)
bool productionLocationsNull () const
void setProductionLocationsNull ()
QString path () const
 Gets or sets the path.
void setPath (QString newPath)
 Gets or sets the path.
bool pathNull () const
void setPathNull ()
std::optional< bool > enableMediaSourceDisplay () const
void setEnableMediaSourceDisplay (std::optional< bool > newEnableMediaSourceDisplay)
bool enableMediaSourceDisplayNull () const
void setEnableMediaSourceDisplayNull ()
QString officialRating () const
 Gets or sets the official rating.
void setOfficialRating (QString newOfficialRating)
 Gets or sets the official rating.
bool officialRatingNull () const
void setOfficialRatingNull ()
QString customRating () const
 Gets or sets the custom rating.
void setCustomRating (QString newCustomRating)
 Gets or sets the custom rating.
bool customRatingNull () const
void setCustomRatingNull ()
QString channelId () const
 Gets or sets the channel identifier.
void setChannelId (QString newChannelId)
 Gets or sets the channel identifier.
bool channelIdNull () const
void setChannelIdNull ()
QString channelName () const
void setChannelName (QString newChannelName)
bool channelNameNull () const
void setChannelNameNull ()
QString overview () const
 Gets or sets the overview.
void setOverview (QString newOverview)
 Gets or sets the overview.
bool overviewNull () const
void setOverviewNull ()
QStringList taglines () const
 Gets or sets the taglines.
void setTaglines (QStringList newTaglines)
 Gets or sets the taglines.
bool taglinesNull () const
void setTaglinesNull ()
QStringList genres () const
 Gets or sets the genres.
void setGenres (QStringList newGenres)
 Gets or sets the genres.
bool genresNull () const
void setGenresNull ()
std::optional< float > communityRating () const
 Gets or sets the community rating.
void setCommunityRating (std::optional< float > newCommunityRating)
 Gets or sets the community rating.
bool communityRatingNull () const
void setCommunityRatingNull ()
std::optional< qint64 > cumulativeRunTimeTicks () const
 Gets or sets the cumulative run time ticks.
void setCumulativeRunTimeTicks (std::optional< qint64 > newCumulativeRunTimeTicks)
 Gets or sets the cumulative run time ticks.
bool cumulativeRunTimeTicksNull () const
void setCumulativeRunTimeTicksNull ()
std::optional< qint64 > runTimeTicks () const
 Gets or sets the run time ticks.
void setRunTimeTicks (std::optional< qint64 > newRunTimeTicks)
 Gets or sets the run time ticks.
bool runTimeTicksNull () const
void setRunTimeTicksNull ()
PlayAccess playAccess () const
void setPlayAccess (PlayAccess newPlayAccess)
QString aspectRatio () const
 Gets or sets the aspect ratio.
void setAspectRatio (QString newAspectRatio)
 Gets or sets the aspect ratio.
bool aspectRatioNull () const
void setAspectRatioNull ()
std::optional< qint32 > productionYear () const
 Gets or sets the production year.
void setProductionYear (std::optional< qint32 > newProductionYear)
 Gets or sets the production year.
bool productionYearNull () const
void setProductionYearNull ()
std::optional< bool > isPlaceHolder () const
 Gets or sets a value indicating whether this instance is place holder.
void setIsPlaceHolder (std::optional< bool > newIsPlaceHolder)
 Gets or sets a value indicating whether this instance is place holder.
bool isPlaceHolderNull () const
void setIsPlaceHolderNull ()
QString number () const
 Gets or sets the number.
void setNumber (QString newNumber)
 Gets or sets the number.
bool numberNull () const
void setNumberNull ()
QString channelNumber () const
void setChannelNumber (QString newChannelNumber)
bool channelNumberNull () const
void setChannelNumberNull ()
std::optional< qint32 > indexNumber () const
 Gets or sets the index number.
void setIndexNumber (std::optional< qint32 > newIndexNumber)
 Gets or sets the index number.
bool indexNumberNull () const
void setIndexNumberNull ()
std::optional< qint32 > indexNumberEnd () const
 Gets or sets the index number end.
void setIndexNumberEnd (std::optional< qint32 > newIndexNumberEnd)
 Gets or sets the index number end.
bool indexNumberEndNull () const
void setIndexNumberEndNull ()
std::optional< qint32 > parentIndexNumber () const
 Gets or sets the parent index number.
void setParentIndexNumber (std::optional< qint32 > newParentIndexNumber)
 Gets or sets the parent index number.
bool parentIndexNumberNull () const
void setParentIndexNumberNull ()
QList< MediaUrlremoteTrailers () const
 Gets or sets the trailer urls.
void setRemoteTrailers (QList< MediaUrl > newRemoteTrailers)
 Gets or sets the trailer urls.
bool remoteTrailersNull () const
void setRemoteTrailersNull ()
QJsonObject providerIds () const
 Gets or sets the provider ids.
void setProviderIds (QJsonObject newProviderIds)
 Gets or sets the provider ids.
bool providerIdsNull () const
void setProviderIdsNull ()
std::optional< bool > isHD () const
 Gets or sets a value indicating whether this instance is HD.
void setIsHD (std::optional< bool > newIsHD)
 Gets or sets a value indicating whether this instance is HD.
bool isHDNull () const
void setIsHDNull ()
std::optional< bool > isFolder () const
 Gets or sets a value indicating whether this instance is folder.
void setIsFolder (std::optional< bool > newIsFolder)
 Gets or sets a value indicating whether this instance is folder.
bool isFolderNull () const
void setIsFolderNull ()
QString parentId () const
 Gets or sets the parent id.
void setParentId (QString newParentId)
 Gets or sets the parent id.
bool parentIdNull () const
void setParentIdNull ()
BaseItemKind type () const
void setType (BaseItemKind newType)
QList< BaseItemPersonpeople () const
 Gets or sets the people.
void setPeople (QList< BaseItemPerson > newPeople)
 Gets or sets the people.
bool peopleNull () const
void setPeopleNull ()
QList< NameGuidPairstudios () const
 Gets or sets the studios.
void setStudios (QList< NameGuidPair > newStudios)
 Gets or sets the studios.
bool studiosNull () const
void setStudiosNull ()
QList< NameGuidPairgenreItems () const
void setGenreItems (QList< NameGuidPair > newGenreItems)
bool genreItemsNull () const
void setGenreItemsNull ()
QString parentLogoItemId () const
 Gets or sets whether the item has a logo, this will hold the Id of the Parent that has one.
void setParentLogoItemId (QString newParentLogoItemId)
 Gets or sets whether the item has a logo, this will hold the Id of the Parent that has one.
bool parentLogoItemIdNull () const
void setParentLogoItemIdNull ()
QString parentBackdropItemId () const
 Gets or sets whether the item has any backdrops, this will hold the Id of the Parent that has one.
void setParentBackdropItemId (QString newParentBackdropItemId)
 Gets or sets whether the item has any backdrops, this will hold the Id of the Parent that has one.
bool parentBackdropItemIdNull () const
void setParentBackdropItemIdNull ()
QStringList parentBackdropImageTags () const
 Gets or sets the parent backdrop image tags.
void setParentBackdropImageTags (QStringList newParentBackdropImageTags)
 Gets or sets the parent backdrop image tags.
bool parentBackdropImageTagsNull () const
void setParentBackdropImageTagsNull ()
std::optional< qint32 > localTrailerCount () const
 Gets or sets the local trailer count.
void setLocalTrailerCount (std::optional< qint32 > newLocalTrailerCount)
 Gets or sets the local trailer count.
bool localTrailerCountNull () const
void setLocalTrailerCountNull ()
QSharedPointer< UserItemDataDtouserData () const
void setUserData (QSharedPointer< UserItemDataDto > newUserData)
std::optional< qint32 > recursiveItemCount () const
 Gets or sets the recursive item count.
void setRecursiveItemCount (std::optional< qint32 > newRecursiveItemCount)
 Gets or sets the recursive item count.
bool recursiveItemCountNull () const
void setRecursiveItemCountNull ()
std::optional< qint32 > childCount () const
 Gets or sets the child count.
void setChildCount (std::optional< qint32 > newChildCount)
 Gets or sets the child count.
bool childCountNull () const
void setChildCountNull ()
QString seriesName () const
 Gets or sets the name of the series.
void setSeriesName (QString newSeriesName)
 Gets or sets the name of the series.
bool seriesNameNull () const
void setSeriesNameNull ()
QString seriesId () const
 Gets or sets the series id.
void setSeriesId (QString newSeriesId)
 Gets or sets the series id.
bool seriesIdNull () const
void setSeriesIdNull ()
QString seasonId () const
 Gets or sets the season identifier.
void setSeasonId (QString newSeasonId)
 Gets or sets the season identifier.
bool seasonIdNull () const
void setSeasonIdNull ()
std::optional< qint32 > specialFeatureCount () const
 Gets or sets the special feature count.
void setSpecialFeatureCount (std::optional< qint32 > newSpecialFeatureCount)
 Gets or sets the special feature count.
bool specialFeatureCountNull () const
void setSpecialFeatureCountNull ()
QString displayPreferencesId () const
 Gets or sets the display preferences id.
void setDisplayPreferencesId (QString newDisplayPreferencesId)
 Gets or sets the display preferences id.
bool displayPreferencesIdNull () const
void setDisplayPreferencesIdNull ()
QString status () const
 Gets or sets the status.
void setStatus (QString newStatus)
 Gets or sets the status.
bool statusNull () const
void setStatusNull ()
QString airTime () const
 Gets or sets the air time.
void setAirTime (QString newAirTime)
 Gets or sets the air time.
bool airTimeNull () const
void setAirTimeNull ()
QList< DayOfWeekairDays () const
 Gets or sets the air days.
void setAirDays (QList< DayOfWeek > newAirDays)
 Gets or sets the air days.
bool airDaysNull () const
void setAirDaysNull ()
QStringList tags () const
 Gets or sets the tags.
void setTags (QStringList newTags)
 Gets or sets the tags.
bool tagsNull () const
void setTagsNull ()
std::optional< double > primaryImageAspectRatio () const
 Gets or sets the primary image aspect ratio, after image enhancements.
void setPrimaryImageAspectRatio (std::optional< double > newPrimaryImageAspectRatio)
 Gets or sets the primary image aspect ratio, after image enhancements.
bool primaryImageAspectRatioNull () const
void setPrimaryImageAspectRatioNull ()
QStringList artists () const
 Gets or sets the artists.
void setArtists (QStringList newArtists)
 Gets or sets the artists.
bool artistsNull () const
void setArtistsNull ()
QList< NameGuidPairartistItems () const
 Gets or sets the artist items.
void setArtistItems (QList< NameGuidPair > newArtistItems)
 Gets or sets the artist items.
bool artistItemsNull () const
void setArtistItemsNull ()
QString album () const
 Gets or sets the album.
void setAlbum (QString newAlbum)
 Gets or sets the album.
bool albumNull () const
void setAlbumNull ()
CollectionType collectionType () const
void setCollectionType (CollectionType newCollectionType)
QString displayOrder () const
 Gets or sets the display order.
void setDisplayOrder (QString newDisplayOrder)
 Gets or sets the display order.
bool displayOrderNull () const
void setDisplayOrderNull ()
QString albumId () const
 Gets or sets the album id.
void setAlbumId (QString newAlbumId)
 Gets or sets the album id.
bool albumIdNull () const
void setAlbumIdNull ()
QString albumPrimaryImageTag () const
 Gets or sets the album image tag.
void setAlbumPrimaryImageTag (QString newAlbumPrimaryImageTag)
 Gets or sets the album image tag.
bool albumPrimaryImageTagNull () const
void setAlbumPrimaryImageTagNull ()
QString seriesPrimaryImageTag () const
 Gets or sets the series primary image tag.
void setSeriesPrimaryImageTag (QString newSeriesPrimaryImageTag)
 Gets or sets the series primary image tag.
bool seriesPrimaryImageTagNull () const
void setSeriesPrimaryImageTagNull ()
QString albumArtist () const
 Gets or sets the album artist.
void setAlbumArtist (QString newAlbumArtist)
 Gets or sets the album artist.
bool albumArtistNull () const
void setAlbumArtistNull ()
QList< NameGuidPairalbumArtists () const
 Gets or sets the album artists.
void setAlbumArtists (QList< NameGuidPair > newAlbumArtists)
 Gets or sets the album artists.
bool albumArtistsNull () const
void setAlbumArtistsNull ()
QString seasonName () const
 Gets or sets the name of the season.
void setSeasonName (QString newSeasonName)
 Gets or sets the name of the season.
bool seasonNameNull () const
void setSeasonNameNull ()
QList< MediaStreammediaStreams () const
 Gets or sets the media streams.
void setMediaStreams (QList< MediaStream > newMediaStreams)
 Gets or sets the media streams.
bool mediaStreamsNull () const
void setMediaStreamsNull ()
VideoType videoType () const
void setVideoType (VideoType newVideoType)
std::optional< qint32 > partCount () const
 Gets or sets the part count.
void setPartCount (std::optional< qint32 > newPartCount)
 Gets or sets the part count.
bool partCountNull () const
void setPartCountNull ()
std::optional< qint32 > mediaSourceCount () const
void setMediaSourceCount (std::optional< qint32 > newMediaSourceCount)
bool mediaSourceCountNull () const
void setMediaSourceCountNull ()
QJsonObject imageTags () const
 Gets or sets the image tags.
void setImageTags (QJsonObject newImageTags)
 Gets or sets the image tags.
bool imageTagsNull () const
void setImageTagsNull ()
QStringList backdropImageTags () const
 Gets or sets the backdrop image tags.
void setBackdropImageTags (QStringList newBackdropImageTags)
 Gets or sets the backdrop image tags.
bool backdropImageTagsNull () const
void setBackdropImageTagsNull ()
QStringList screenshotImageTags () const
 Gets or sets the screenshot image tags.
void setScreenshotImageTags (QStringList newScreenshotImageTags)
 Gets or sets the screenshot image tags.
bool screenshotImageTagsNull () const
void setScreenshotImageTagsNull ()
QString parentLogoImageTag () const
 Gets or sets the parent logo image tag.
void setParentLogoImageTag (QString newParentLogoImageTag)
 Gets or sets the parent logo image tag.
bool parentLogoImageTagNull () const
void setParentLogoImageTagNull ()
QString parentArtItemId () const
 Gets or sets whether the item has fan art, this will hold the Id of the Parent that has one.
void setParentArtItemId (QString newParentArtItemId)
 Gets or sets whether the item has fan art, this will hold the Id of the Parent that has one.
bool parentArtItemIdNull () const
void setParentArtItemIdNull ()
QString parentArtImageTag () const
 Gets or sets the parent art image tag.
void setParentArtImageTag (QString newParentArtImageTag)
 Gets or sets the parent art image tag.
bool parentArtImageTagNull () const
void setParentArtImageTagNull ()
QString seriesThumbImageTag () const
 Gets or sets the series thumb image tag.
void setSeriesThumbImageTag (QString newSeriesThumbImageTag)
 Gets or sets the series thumb image tag.
bool seriesThumbImageTagNull () const
void setSeriesThumbImageTagNull ()
QJsonObject imageBlurHashes () const
void setImageBlurHashes (QJsonObject newImageBlurHashes)
bool imageBlurHashesNull () const
void setImageBlurHashesNull ()
QString seriesStudio () const
 Gets or sets the series studio.
void setSeriesStudio (QString newSeriesStudio)
 Gets or sets the series studio.
bool seriesStudioNull () const
void setSeriesStudioNull ()
QString parentThumbItemId () const
 Gets or sets the parent thumb item id.
void setParentThumbItemId (QString newParentThumbItemId)
 Gets or sets the parent thumb item id.
bool parentThumbItemIdNull () const
void setParentThumbItemIdNull ()
QString parentThumbImageTag () const
 Gets or sets the parent thumb image tag.
void setParentThumbImageTag (QString newParentThumbImageTag)
 Gets or sets the parent thumb image tag.
bool parentThumbImageTagNull () const
void setParentThumbImageTagNull ()
QString parentPrimaryImageItemId () const
 Gets or sets the parent primary image item identifier.
void setParentPrimaryImageItemId (QString newParentPrimaryImageItemId)
 Gets or sets the parent primary image item identifier.
bool parentPrimaryImageItemIdNull () const
void setParentPrimaryImageItemIdNull ()
QString parentPrimaryImageTag () const
 Gets or sets the parent primary image tag.
void setParentPrimaryImageTag (QString newParentPrimaryImageTag)
 Gets or sets the parent primary image tag.
bool parentPrimaryImageTagNull () const
void setParentPrimaryImageTagNull ()
QList< ChapterInfochapters () const
 Gets or sets the chapters.
void setChapters (QList< ChapterInfo > newChapters)
 Gets or sets the chapters.
bool chaptersNull () const
void setChaptersNull ()
QJsonObject trickplay () const
 Gets or sets the trickplay manifest.
void setTrickplay (QJsonObject newTrickplay)
 Gets or sets the trickplay manifest.
bool trickplayNull () const
void setTrickplayNull ()
LocationType locationType () const
void setLocationType (LocationType newLocationType)
IsoType isoType () const
void setIsoType (IsoType newIsoType)
MediaType mediaType () const
void setMediaType (MediaType newMediaType)
QDateTime endDate () const
 Gets or sets the end date.
void setEndDate (QDateTime newEndDate)
 Gets or sets the end date.
bool endDateNull () const
void setEndDateNull ()
QList< MetadataFieldlockedFields () const
 Gets or sets the locked fields.
void setLockedFields (QList< MetadataField > newLockedFields)
 Gets or sets the locked fields.
bool lockedFieldsNull () const
void setLockedFieldsNull ()
std::optional< qint32 > trailerCount () const
 Gets or sets the trailer count.
void setTrailerCount (std::optional< qint32 > newTrailerCount)
 Gets or sets the trailer count.
bool trailerCountNull () const
void setTrailerCountNull ()
std::optional< qint32 > movieCount () const
 Gets or sets the movie count.
void setMovieCount (std::optional< qint32 > newMovieCount)
 Gets or sets the movie count.
bool movieCountNull () const
void setMovieCountNull ()
std::optional< qint32 > seriesCount () const
 Gets or sets the series count.
void setSeriesCount (std::optional< qint32 > newSeriesCount)
 Gets or sets the series count.
bool seriesCountNull () const
void setSeriesCountNull ()
std::optional< qint32 > programCount () const
void setProgramCount (std::optional< qint32 > newProgramCount)
bool programCountNull () const
void setProgramCountNull ()
std::optional< qint32 > episodeCount () const
 Gets or sets the episode count.
void setEpisodeCount (std::optional< qint32 > newEpisodeCount)
 Gets or sets the episode count.
bool episodeCountNull () const
void setEpisodeCountNull ()
std::optional< qint32 > songCount () const
 Gets or sets the song count.
void setSongCount (std::optional< qint32 > newSongCount)
 Gets or sets the song count.
bool songCountNull () const
void setSongCountNull ()
std::optional< qint32 > albumCount () const
 Gets or sets the album count.
void setAlbumCount (std::optional< qint32 > newAlbumCount)
 Gets or sets the album count.
bool albumCountNull () const
void setAlbumCountNull ()
std::optional< qint32 > artistCount () const
void setArtistCount (std::optional< qint32 > newArtistCount)
bool artistCountNull () const
void setArtistCountNull ()
std::optional< qint32 > musicVideoCount () const
 Gets or sets the music video count.
void setMusicVideoCount (std::optional< qint32 > newMusicVideoCount)
 Gets or sets the music video count.
bool musicVideoCountNull () const
void setMusicVideoCountNull ()
std::optional< bool > lockData () const
 Gets or sets a value indicating whether [enable internet providers].
void setLockData (std::optional< bool > newLockData)
 Gets or sets a value indicating whether [enable internet providers].
bool lockDataNull () const
void setLockDataNull ()
std::optional< qint32 > width () const
void setWidth (std::optional< qint32 > newWidth)
bool widthNull () const
void setWidthNull ()
std::optional< qint32 > height () const
void setHeight (std::optional< qint32 > newHeight)
bool heightNull () const
void setHeightNull ()
QString cameraMake () const
void setCameraMake (QString newCameraMake)
bool cameraMakeNull () const
void setCameraMakeNull ()
QString cameraModel () const
void setCameraModel (QString newCameraModel)
bool cameraModelNull () const
void setCameraModelNull ()
QString software () const
void setSoftware (QString newSoftware)
bool softwareNull () const
void setSoftwareNull ()
std::optional< double > exposureTime () const
void setExposureTime (std::optional< double > newExposureTime)
bool exposureTimeNull () const
void setExposureTimeNull ()
std::optional< double > focalLength () const
void setFocalLength (std::optional< double > newFocalLength)
bool focalLengthNull () const
void setFocalLengthNull ()
ImageOrientation imageOrientation () const
void setImageOrientation (ImageOrientation newImageOrientation)
std::optional< double > aperture () const
void setAperture (std::optional< double > newAperture)
bool apertureNull () const
void setApertureNull ()
std::optional< double > shutterSpeed () const
void setShutterSpeed (std::optional< double > newShutterSpeed)
bool shutterSpeedNull () const
void setShutterSpeedNull ()
std::optional< double > latitude () const
void setLatitude (std::optional< double > newLatitude)
bool latitudeNull () const
void setLatitudeNull ()
std::optional< double > longitude () const
void setLongitude (std::optional< double > newLongitude)
bool longitudeNull () const
void setLongitudeNull ()
std::optional< double > altitude () const
void setAltitude (std::optional< double > newAltitude)
bool altitudeNull () const
void setAltitudeNull ()
std::optional< qint32 > isoSpeedRating () const
void setIsoSpeedRating (std::optional< qint32 > newIsoSpeedRating)
bool isoSpeedRatingNull () const
void setIsoSpeedRatingNull ()
QString seriesTimerId () const
 Gets or sets the series timer identifier.
void setSeriesTimerId (QString newSeriesTimerId)
 Gets or sets the series timer identifier.
bool seriesTimerIdNull () const
void setSeriesTimerIdNull ()
QString programId () const
 Gets or sets the program identifier.
void setProgramId (QString newProgramId)
 Gets or sets the program identifier.
bool programIdNull () const
void setProgramIdNull ()
QString channelPrimaryImageTag () const
 Gets or sets the channel primary image tag.
void setChannelPrimaryImageTag (QString newChannelPrimaryImageTag)
 Gets or sets the channel primary image tag.
bool channelPrimaryImageTagNull () const
void setChannelPrimaryImageTagNull ()
QDateTime startDate () const
 Gets or sets the start date of the recording, in UTC.
void setStartDate (QDateTime newStartDate)
 Gets or sets the start date of the recording, in UTC.
bool startDateNull () const
void setStartDateNull ()
std::optional< double > completionPercentage () const
 Gets or sets the completion percentage.
void setCompletionPercentage (std::optional< double > newCompletionPercentage)
 Gets or sets the completion percentage.
bool completionPercentageNull () const
void setCompletionPercentageNull ()
std::optional< bool > isRepeat () const
 Gets or sets a value indicating whether this instance is repeat.
void setIsRepeat (std::optional< bool > newIsRepeat)
 Gets or sets a value indicating whether this instance is repeat.
bool isRepeatNull () const
void setIsRepeatNull ()
QString episodeTitle () const
 Gets or sets the episode title.
void setEpisodeTitle (QString newEpisodeTitle)
 Gets or sets the episode title.
bool episodeTitleNull () const
void setEpisodeTitleNull ()
ChannelType channelType () const
void setChannelType (ChannelType newChannelType)
ProgramAudio audio () const
void setAudio (ProgramAudio newAudio)
std::optional< bool > isMovie () const
 Gets or sets a value indicating whether this instance is movie.
void setIsMovie (std::optional< bool > newIsMovie)
 Gets or sets a value indicating whether this instance is movie.
bool isMovieNull () const
void setIsMovieNull ()
std::optional< bool > isSports () const
 Gets or sets a value indicating whether this instance is sports.
void setIsSports (std::optional< bool > newIsSports)
 Gets or sets a value indicating whether this instance is sports.
bool isSportsNull () const
void setIsSportsNull ()
std::optional< bool > isSeries () const
 Gets or sets a value indicating whether this instance is series.
void setIsSeries (std::optional< bool > newIsSeries)
 Gets or sets a value indicating whether this instance is series.
bool isSeriesNull () const
void setIsSeriesNull ()
std::optional< bool > isLive () const
 Gets or sets a value indicating whether this instance is live.
void setIsLive (std::optional< bool > newIsLive)
 Gets or sets a value indicating whether this instance is live.
bool isLiveNull () const
void setIsLiveNull ()
std::optional< bool > isNews () const
 Gets or sets a value indicating whether this instance is news.
void setIsNews (std::optional< bool > newIsNews)
 Gets or sets a value indicating whether this instance is news.
bool isNewsNull () const
void setIsNewsNull ()
std::optional< bool > isKids () const
 Gets or sets a value indicating whether this instance is kids.
void setIsKids (std::optional< bool > newIsKids)
 Gets or sets a value indicating whether this instance is kids.
bool isKidsNull () const
void setIsKidsNull ()
std::optional< bool > isPremiere () const
 Gets or sets a value indicating whether this instance is premiere.
void setIsPremiere (std::optional< bool > newIsPremiere)
 Gets or sets a value indicating whether this instance is premiere.
bool isPremiereNull () const
void setIsPremiereNull ()
QString timerId () const
 Gets or sets the timer identifier.
void setTimerId (QString newTimerId)
 Gets or sets the timer identifier.
bool timerIdNull () const
void setTimerIdNull ()
std::optional< float > normalizationGain () const
 Gets or sets the gain required for audio normalization.
void setNormalizationGain (std::optional< float > newNormalizationGain)
 Gets or sets the gain required for audio normalization.
bool normalizationGainNull () const
void setNormalizationGainNull ()
QSharedPointer< BaseItemDtocurrentProgram () const
void setCurrentProgram (QSharedPointer< BaseItemDto > newCurrentProgram)

Additional Inherited Members

Static Public Member Functions inherited from Jellyfin::DTO::BaseItemDto
static BaseItemDto fromJson (QJsonObject source)
Protected Attributes inherited from Jellyfin::DTO::BaseItemDto
QString m_name
QString m_originalTitle
QString m_serverId
QString m_jellyfinId
QString m_etag
QString m_sourceType
QString m_playlistItemId
QDateTime m_dateCreated
QDateTime m_dateLastMediaAdded
ExtraType m_extraType
std::optional< qint32 > m_airsBeforeSeasonNumber = std::nullopt
std::optional< qint32 > m_airsAfterSeasonNumber = std::nullopt
std::optional< qint32 > m_airsBeforeEpisodeNumber = std::nullopt
std::optional< bool > m_canDelete = std::nullopt
std::optional< bool > m_canDownload = std::nullopt
std::optional< bool > m_hasLyrics = std::nullopt
std::optional< bool > m_hasSubtitles = std::nullopt
QString m_preferredMetadataLanguage
QString m_preferredMetadataCountryCode
QString m_container
QString m_sortName
QString m_forcedSortName
Video3DFormat m_video3DFormat
QDateTime m_premiereDate
QList< ExternalUrlm_externalUrls
QList< MediaSourceInfom_mediaSources
std::optional< float > m_criticRating = std::nullopt
QStringList m_productionLocations
QString m_path
std::optional< bool > m_enableMediaSourceDisplay = std::nullopt
QString m_officialRating
QString m_customRating
QString m_channelId
QString m_channelName
QString m_overview
QStringList m_taglines
QStringList m_genres
std::optional< float > m_communityRating = std::nullopt
std::optional< qint64 > m_cumulativeRunTimeTicks = std::nullopt
std::optional< qint64 > m_runTimeTicks = std::nullopt
PlayAccess m_playAccess
QString m_aspectRatio
std::optional< qint32 > m_productionYear = std::nullopt
std::optional< bool > m_isPlaceHolder = std::nullopt
QString m_number
QString m_channelNumber
std::optional< qint32 > m_indexNumber = std::nullopt
std::optional< qint32 > m_indexNumberEnd = std::nullopt
std::optional< qint32 > m_parentIndexNumber = std::nullopt
QList< MediaUrlm_remoteTrailers
QJsonObject m_providerIds
std::optional< bool > m_isHD = std::nullopt
std::optional< bool > m_isFolder = std::nullopt
QString m_parentId
BaseItemKind m_type
QList< BaseItemPersonm_people
QList< NameGuidPairm_studios
QList< NameGuidPairm_genreItems
QString m_parentLogoItemId
QString m_parentBackdropItemId
QStringList m_parentBackdropImageTags
std::optional< qint32 > m_localTrailerCount = std::nullopt
QSharedPointer< UserItemDataDtom_userData = QSharedPointer<UserItemDataDto>()
std::optional< qint32 > m_recursiveItemCount = std::nullopt
std::optional< qint32 > m_childCount = std::nullopt
QString m_seriesName
QString m_seriesId
QString m_seasonId
std::optional< qint32 > m_specialFeatureCount = std::nullopt
QString m_displayPreferencesId
QString m_status
QString m_airTime
QList< DayOfWeekm_airDays
QStringList m_tags
std::optional< double > m_primaryImageAspectRatio = std::nullopt
QStringList m_artists
QList< NameGuidPairm_artistItems
QString m_album
CollectionType m_collectionType
QString m_displayOrder
QString m_albumId
QString m_albumPrimaryImageTag
QString m_seriesPrimaryImageTag
QString m_albumArtist
QList< NameGuidPairm_albumArtists
QString m_seasonName
QList< MediaStreamm_mediaStreams
VideoType m_videoType
std::optional< qint32 > m_partCount = std::nullopt
std::optional< qint32 > m_mediaSourceCount = std::nullopt
QJsonObject m_imageTags
QStringList m_backdropImageTags
QStringList m_screenshotImageTags
QString m_parentLogoImageTag
QString m_parentArtItemId
QString m_parentArtImageTag
QString m_seriesThumbImageTag
QJsonObject m_imageBlurHashes
QString m_seriesStudio
QString m_parentThumbItemId
QString m_parentThumbImageTag
QString m_parentPrimaryImageItemId
QString m_parentPrimaryImageTag
QList< ChapterInfom_chapters
QJsonObject m_trickplay
LocationType m_locationType
IsoType m_isoType
MediaType m_mediaType
QDateTime m_endDate
QList< MetadataFieldm_lockedFields
std::optional< qint32 > m_trailerCount = std::nullopt
std::optional< qint32 > m_movieCount = std::nullopt
std::optional< qint32 > m_seriesCount = std::nullopt
std::optional< qint32 > m_programCount = std::nullopt
std::optional< qint32 > m_episodeCount = std::nullopt
std::optional< qint32 > m_songCount = std::nullopt
std::optional< qint32 > m_albumCount = std::nullopt
std::optional< qint32 > m_artistCount = std::nullopt
std::optional< qint32 > m_musicVideoCount = std::nullopt
std::optional< bool > m_lockData = std::nullopt
std::optional< qint32 > m_width = std::nullopt
std::optional< qint32 > m_height = std::nullopt
QString m_cameraMake
QString m_cameraModel
QString m_software
std::optional< double > m_exposureTime = std::nullopt
std::optional< double > m_focalLength = std::nullopt
ImageOrientation m_imageOrientation
std::optional< double > m_aperture = std::nullopt
std::optional< double > m_shutterSpeed = std::nullopt
std::optional< double > m_latitude = std::nullopt
std::optional< double > m_longitude = std::nullopt
std::optional< double > m_altitude = std::nullopt
std::optional< qint32 > m_isoSpeedRating = std::nullopt
QString m_seriesTimerId
QString m_programId
QString m_channelPrimaryImageTag
QDateTime m_startDate
std::optional< double > m_completionPercentage = std::nullopt
std::optional< bool > m_isRepeat = std::nullopt
QString m_episodeTitle
ChannelType m_channelType
ProgramAudio m_audio
std::optional< bool > m_isMovie = std::nullopt
std::optional< bool > m_isSports = std::nullopt
std::optional< bool > m_isSeries = std::nullopt
std::optional< bool > m_isLive = std::nullopt
std::optional< bool > m_isNews = std::nullopt
std::optional< bool > m_isKids = std::nullopt
std::optional< bool > m_isPremiere = std::nullopt
QString m_timerId
std::optional< float > m_normalizationGain = std::nullopt
QSharedPointer< BaseItemDtom_currentProgram = QSharedPointer<BaseItemDto>()

Member Typedef Documentation

◆ UserDataChangedCallback

Constructor & Destructor Documentation

◆ Item() [1/2]

Jellyfin::Model::Item::Item ( ApiClient * apiClient = nullptr,
QObject * parent = nullptr )

Constructor that creates an empty item.

Item(QObject *parent = nullptr); Creates an "empty" item

◆ Item() [2/2]

Jellyfin::Model::Item::Item ( const DTO::BaseItemDto & data,
ApiClient * apiClient = nullptr,
QObject * parent = nullptr )

Copies the data from the DTO into this model and attaches an ApiClient.

Parameters
dataThe DTO to copy information from
apiClientThe ApiClient to attach to, to listen for updates and so on.

Member Function Documentation

◆ sameAs()

bool Jellyfin::Model::Item::sameAs ( const DTO::BaseItemDto & other)

sameAs Returns true if this item represents the same item as other

Note that this does not mean each property is the same, this just mean both of these models represent the same item.

Parameters
otherThe item to compare to
Returns
True if they represent the same item, false otherwise.

◆ setApiClient()

void Jellyfin::Model::Item::setApiClient ( ApiClient * apiClient)

◆ userData()

◆ userDataChanged

void Jellyfin::Model::Item::userDataChanged ( const DTO::UserItemDataDto & newUserData)
signal

The documentation for this class was generated from the following files: