Class Photo

Inheritance

System.Object

BaseItem

Photo

Implements

IHasProviderIds

IHasLookupInfo<ItemLookupInfo>

IHasAlbum

Inherited Members

BaseItem.PlayCount

BaseItem.LastPlayedDate

BaseItem.Played

BaseItem.AudioStreamIndex

BaseItem.SubtitleStreamIndex

BaseItem.UserDataKey

BaseItem.IsFavorite

BaseItem.UserRating

BaseItem.PlayedPercentage

BaseItem.PlaybackPositionTicks

BaseItem.UserDataSet

BaseItem.InternalId

BaseItem.RemoteTrailers

BaseItem.ListItemEntryId

BaseItem.IsSecondaryMergedItemInSameFolder

BaseItem.IsPublic

BaseItem.CollectionFolders

BaseItem.LibraryOptions

BaseItem.MediaStreams

BaseItem.ChildCount

BaseItem.UnplayedItemCount

BaseItem.AdditionalPartCount

BaseItem.LocalTrailerCount

BaseItem.SpecialFeatureCount

BaseItem.RecursiveItemCount

BaseItem.SupportedImageExtensions

BaseItem.TrailerFolderName

BaseItem.ThemeSongsFolderName

BaseItem.ThemeSongFilename

BaseItem.ThemeVideosFolderName

BaseItem.ExtrasSubFolders

BaseItem.IsResolvedToFolder

BaseItem.SupportsUserData

BaseItem.IsPlaceHolder

BaseItem.SupportsExtras

BaseItem.SupportsAdditionalParts

BaseItem.IsCompleteMedia

BaseItem.DisplayExtraTypes

BaseItem.GetDisplayExtraIds()

BaseItem.ThemeSongIds

BaseItem.ThemeVideoIds

BaseItem.LocalTrailerIds

BaseItem.AllowRecursiveCounts

BaseItem.RecursiveChildCountEqualsChildCount

BaseItem.GetRecursiveChildCount(User, IDataContext, CancellationToken)

BaseItem.GetChildCount(User, IDataContext, CancellationToken)

BaseItem.HasPlaceholderMatadata()

BaseItem.SupportsManageAccess()

BaseItem.CanManageAccess(User, UserItemShareLevel)

BaseItem.SupportsMakePublicOrPrivate()

BaseItem.AssertHasMinimumShareLevel(User, UserItemShareLevel, CancellationToken)

BaseItem.GetShareLevel(User, CancellationToken)

BaseItem.CanLeaveSharedContent(User, UserItemShareLevel)

BaseItem.CanMakePublic(User)

BaseItem.CanMakePrivate(User)

BaseItem.CanMakePublic(UserItemShareLevel)

BaseItem.CanMakePrivate(UserItemShareLevel)

BaseItem.GetExtraGuids(ExtraType[])

BaseItem.GetAdditionalParts(DtoOptions, User)

BaseItem.GetAdditionalPartIds()

BaseItem.GetExtraTypes(ExtraType[], CancellationToken)

BaseItem.GetExtraIds(ExtraType[])

BaseItem.GetExtras(ExtraType[])

BaseItem.GetExtras(ExtraType[], DtoOptions)

BaseItem.GetExtras(ExtraType[], DtoOptions, CancellationToken)

BaseItem.GetExtras(Int64, String, ExtraType[], DtoOptions, CancellationToken)

BaseItem.GetExtras(Int64, ExtraType[], DtoOptions, CancellationToken)

BaseItem.GetThemeSongs(DtoOptions, CancellationToken)

BaseItem.GetThemeVideos(DtoOptions, CancellationToken)

BaseItem.GetRunTimeTicksForPlayState()

BaseItem.PreferredMetadataCountryCode

BaseItem.PreferredMetadataLanguage

BaseItem.Size

BaseItem.Prefix

BaseItem.ShareLevel

BaseItem.SyncStatus

BaseItem.Container

BaseItem.MediaContainer

BaseItem.Tagline

BaseItem.ImageInfos

BaseItem.IsVirtualItem

BaseItem.InternalAlbumId

BaseItem.AlbumId

BaseItem.SeriesId

BaseItem.Album

BaseItem.AlbumItem

BaseItem.GetAlbumItem(IDataContext)

BaseItem.SetAlbumItem(BaseItem)

BaseItem.SetSeriesItem(BaseItem)

BaseItem.SupportsEditingAlbum

BaseItem.GetStandaloneDisplayName()

BaseItem.GetStandaloneDisplayName(String, String, Nullable<Int32>, Nullable<Int32>)

BaseItem.IsInMixedFolder

BaseItem.OwnsFolder

BaseItem.OriginalParsedName

BaseItem.IsNameParsedFromFolder

BaseItem.ToLinkedItemInfo()

BaseItem.SupportsPlayedStatus()

BaseItem.GetDisplayOrderIntValue()

BaseItem.SetDisplayOrder(String)

BaseItem.GetMediaContainingFolderPath(LibraryOptions)

BaseItem.GetMediaContainingFolderPath(LibraryOptions, CancellationToken)

BaseItem.GetSupportsPositionTicksResume(LibraryOptions)

BaseItem.SupportsRemoteImageDownloading

BaseItem.Name

BaseItem.IsShortcut

BaseItem.IsFileShortcut(String)

BaseItem.IsUnaired

BaseItem.TotalBitrate

BaseItem.ExtraType

BaseItem.IsThemeMedia

BaseItem.OriginalTitle

BaseItem.Id

BaseItem.MediaSourceIdPrefix

BaseItem.GetDefaultMediaSourceId()

BaseItem.IsHD

BaseItem.Width

BaseItem.Height

BaseItem.DisplayPreferencesId

BaseItem.Path

BaseItem.ContainingFolderPath

BaseItem.ExternalId

BaseItem.SeriesPresentationUniqueKey

BaseItem.IsHidden

BaseItem.LocationType

BaseItem.PathProtocol

BaseItem.IsPathProtocol(MediaProtocol)

BaseItem.IsFileProtocol

BaseItem.HasPathProtocol

BaseItem.FileNameWithoutExtension

BaseItem.FileName

BaseItem.EnableAlphaNumericSorting

BaseItem.PrimaryImagePath

BaseItem.IsMetadataFetcherEnabled(LibraryOptions, String)

BaseItem.IsImageFetcherEnabled(LibraryOptions, String)

BaseItem.CanDelete()

BaseItem.IsAuthorizedToDelete(User, UserItemShareLevel, Folder[])

BaseItem.CanDelete(User, Folder[])

BaseItem.CanDelete(User, UserItemShareLevel, Folder[])

BaseItem.IsAuthorizedToDownload(User)

BaseItem.CanDownload(User)

BaseItem.CanDownloadAsSingleMedia()

BaseItem.CanDownloadAsFolder()

BaseItem.DateCreated

BaseItem.DateModified

BaseItem.HasDateModifiedChanged(DateTimeOffset)

BaseItem.HasDateChanged(DateTimeOffset, DateTimeOffset)

BaseItem.HasDateChanged(Nullable<DateTimeOffset>, DateTimeOffset)

BaseItem.HasDateChanged(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>)

BaseItem.DateLastSaved

BaseItem.DateLastRefreshed

BaseItem.IsGreaterThanDateLastSaved(DateTimeOffset)

BaseItem.Logger

BaseItem.LibraryManager

BaseItem.LiveTvManager

BaseItem.FeatureManager

BaseItem.UserManager

BaseItem.ConfigurationManager

BaseItem.ProviderManager

BaseItem.LocalizationManager

BaseItem.ItemRepository

BaseItem.FileSystem

BaseItem.UserDataManager

BaseItem.ChannelManager

BaseItem.MediaSourceManager

BaseItem.NetworkManager

BaseItem.ApplicationHost

BaseItem.ToString()

BaseItem.IsLocked

BaseItem.LockedFields

BaseItem.SortName

BaseItem.SetSortNameDirect(String)

BaseItem.IsFieldLocked(MetadataFields)

BaseItem.AddProviderIdsToName(String, String[])

BaseItem.GetInternalMetadataPath()

BaseItem.GetInternalMetadataPath(String)

BaseItem.GetInternalMetadataPath(Guid, String)

BaseItem.CreateSortName()

BaseItem.CreateSortName(ReadOnlySpan<Char>)

BaseItem.ParentId

BaseItem.Parent

BaseItem.SetParent(BaseItem)

BaseItem.GetCachedParent()

BaseItem.SetCachedParent(BaseItem)

BaseItem.GetParent()

BaseItem.GetParent(IDataContext)

BaseItem.GetParents()

BaseItem.GetParents(IDataContext)

BaseItem.Closest<T>()

BaseItem.FindParent<T>()

BaseItem.FindParent<T>(IDataContext)

BaseItem.DisplayParentId

BaseItem.ImageDisplayParentId

BaseItem.DisplayParent

BaseItem.PremiereDate

BaseItem.EndDate

BaseItem.OfficialRating

BaseItem.CriticRating

BaseItem.CustomRating

BaseItem.Overview

BaseItem.Studios

BaseItem.StudioItems

BaseItem.Genres

BaseItem.GenreItems

BaseItem.Tags

BaseItem.TagItems

BaseItem.SetTagItemsDirect(LinkedItemInfo[])

BaseItem.Collections

BaseItem.ImportedCollections

BaseItem.GetImportedCollections(CancellationToken)

BaseItem.GetAllKnownCollections()

BaseItem.GetAllKnownCollections(CancellationToken)

BaseItem.AddImportedCollections(LinkedItemInfo[])

BaseItem.ContainsTag(String)

BaseItem.SetTags(IEnumerable<String>)

BaseItem.SetCollections(IEnumerable<String>)

BaseItem.SetGenres(IEnumerable<String>)

BaseItem.ProductionLocations

BaseItem.CommunityRating

BaseItem.RunTimeTicks

BaseItem.ProductionYear

BaseItem.IndexNumber

BaseItem.ParentIndexNumber

BaseItem.OfficialRatingForComparison

BaseItem.CustomRatingForComparison

BaseItem.GetMediaStreams()

BaseItem.GetMediaStreams(CancellationToken)

BaseItem.MarkTaggedItemsLoaded()

BaseItem.EnsureTaggedItemsLoaded()

BaseItem.EnsureTaggedItemsLoaded(IDataContext)

BaseItem.GetSupportedItemLinkTypes()

BaseItem.FillItemLinks(List<(T1, T2, T3)<ItemLinkType, String, Int64>>)

BaseItem.IsActiveRecording()

BaseItem.GetMediaSources(Boolean, Boolean, LibraryOptions)

BaseItem.GetMediaSources(User, Boolean, Boolean, Boolean, Boolean, BaseItem[], LibraryOptions, CancellationToken)

BaseItem.GetAllItemsForMediaSources(User, Boolean)

BaseItem.RefreshMetadata(BaseItem[], LibraryOptions, CancellationToken)

BaseItem.RefreshMetadata(CancellationToken)

BaseItem.TriggerOnRefreshStart()

BaseItem.TriggerOnRefreshComplete()

BaseItem.EnableInternalIdsExternally

BaseItem.GetClientId()

BaseItem.RefreshMetadata(MetadataRefreshOptions, CancellationToken)

BaseItem.RefreshMetadata(MetadataRefreshOptions, BaseItem[], LibraryOptions, CancellationToken)

BaseItem.SupportsOwnedItems

BaseItem.SupportsPeople

BaseItem.SupportsStudios

BaseItem.SupportsTags

BaseItem.SupportsCollections

BaseItem.SupportsThemeMedia

BaseItem.SupportsLocalTrailers

BaseItem.GetFileSystemChildren(IDirectoryService)

BaseItem.GetUniquelyIdentifiableProviderIds()

BaseItem.ProviderIds

BaseItem.LatestItemsContainerId

BaseItem.CreatePresentationUniqueKey(IDataContext, CancellationToken)

BaseItem.CreatePresentationUniqueKey(BaseItem[], LibraryOptions, IDataContext, CancellationToken)

BaseItem.GetDefaultPresentationUniqueKey()

BaseItem.PresentationUniqueKey

BaseItem.ResolvedPresentationUniqueKey

BaseItem.GetPresentationUniqueKey()

BaseItem.GetPresentationUniqueKey(BaseItem[], LibraryOptions, IDataContext, CancellationToken)

BaseItem.GetUserDataKey(IDataContext)

BaseItem.GetUserDataKeyInternal(IDataContext)

BaseItem.AfterMetadataRefresh()

BaseItem.GetPreferredMetadataLanguage()

BaseItem.GetPreferredMetadataLanguage(LibraryOptions)

BaseItem.GetPreferredMetadataLanguage(LibraryOptions, IDataContext)

BaseItem.GetPreferredImageLanguage(LibraryOptions)

BaseItem.GetPreferredMetadataCountryCode()

BaseItem.GetPreferredMetadataCountryCode(LibraryOptions)

BaseItem.IsLocalMetadataReaderEnabled(LibraryOptions, String)

BaseItem.IsSaveLocalImagesEnabled(LibraryOptions)

BaseItem.GetParentalRatingValue()

BaseItem.GetInheritedParentalRatingValue()

BaseItem.IsVisible(User)

BaseItem.IsVisibleStandalone(User)

BaseItem.IsFolder

BaseItem.IsDisplayedAsFolder

BaseItem.GetClientTypeName()

BaseItem.EnableRememberingTrackSelections

BaseItem.AddStudio(String)

BaseItem.SetStudios(IEnumerable<String>)

BaseItem.AddLinkedItem(LinkedItemInfo[], LinkedItemInfo, LinkedItemInfo, Boolean)

BaseItem.AddLinkedItem(LinkedItemInfo[], String, LinkedItemInfo, Boolean)

BaseItem.AddLinkedItem(LinkedItemInfo[], LinkedItemInfo)

BaseItem.AddLinkedItem(LinkedItemInfo[], String)

BaseItem.RemoveLinkedItem(LinkedItemInfo[], LinkedItemInfo)

BaseItem.RemoveLinkedItem(LinkedItemInfo[], String)

BaseItem.AddGenre(String)

BaseItem.AddCollection(String)

BaseItem.AddCollection(LinkedItemInfo)

BaseItem.AddCollectionInfo(LinkedItemInfo)

BaseItem.AddCollection(BoxSet)

BaseItem.RemoveCollection(Int64)

BaseItem.MarkPlayed(User, Nullable<DateTimeOffset>, Boolean)

BaseItem.MarkPlayed(User, BaseItem[], Nullable<DateTimeOffset>, Boolean)

BaseItem.UpdateHideFromResume(User, UserItemData, Boolean)

BaseItem.UpdateHideFromResume(User, UserItemData, BaseItem[], Boolean)

BaseItem.MarkUnplayed(User)

BaseItem.HasImage(ImageType, Int32)

BaseItem.SetImage(ItemImageInfo, Int32)

BaseItem.SetImage(ItemImageInfo, Int32, Boolean)

BaseItem.AddImage(FileSystemMetadata, ImageType)

BaseItem.DeleteImage(ImageType, Int32)

BaseItem.RemoveImage(ImageType, String)

BaseItem.RemoveImage(ItemImageInfo)

BaseItem.RemoveImages(List<ItemImageInfo>)

BaseItem.UpdateToRepository(ItemUpdateType)

BaseItem.UpdateToRepository(ItemUpdateType, BaseItem)

BaseItem.UpdateToRepository(ItemUpdateType, MetadataRefreshOptions)

BaseItem.UpdateToRepository(ItemUpdateType, BaseItem, MetadataRefreshOptions)

BaseItem.GetImagePath(ImageType, Int32)

BaseItem.GetImageInfo(ImageType, Int32)

BaseItem.GetImages(ImageType)

BaseItem.AddImages(ImageType, List<FileSystemMetadata>, Boolean)

BaseItem.GetDeletePaths(Boolean, BaseItem[])

BaseItem.AllowsMultipleImages(ImageType)

BaseItem.ReorderImage(ImageType, Int32, Int32)

BaseItem.MoveFiles(String[], String[])

BaseItem.IsPlayed(User)

BaseItem.IsFavoriteOrLiked(User)

BaseItem.IsUnplayed(User)

BaseItem.IHasLookupInfo<ItemLookupInfo>.GetLookupInfo(LibraryOptions)

BaseItem.GetItemLookupInfo<T>(LibraryOptions)

BaseItem.GetItemsForAncestorIdsQuery(User, IDataContext, CancellationToken)

BaseItem.GetIdsForAncestorIdsQuery(User, IDataContext, CancellationToken)

BaseItem.GetNameForMetadataLookup()

BaseItem.BeforeMetadataRefresh(Boolean)

BaseItem.GetMappedPath(String, Nullable<MediaProtocol>, LibraryOptions)

BaseItem.FillUserDataDtoValues(UserItemDataDto, User, DtoOptions, LibraryOptions, CancellationToken)

BaseItem.FillUserDataValues(User, DtoOptions, LibraryOptions, IDataContext, CancellationToken)

BaseItem.GetEtag(User)

BaseItem.GetEtagValues(User)

BaseItem.GetTopParent()

BaseItem.IsTopParent

BaseItem.SupportsAncestors

BaseItem.GetRelatedUrls()

BaseItem.GetRefreshProgress()

BaseItem.UpdateRatingToItems(BaseItem[])

BaseItem.AllowEditingField(MetadataFields)

BaseItem.SupportsResetMetadata

BaseItem.ResetMetadata()

BaseItem.ResetMetadataInternal()

BaseItem.GetChildrenForValidationSorted(CancellationToken)

BaseItem.GetChildrenForValidation(CancellationToken)

BaseItem.GetNonCachedChildren(IDirectoryService, BaseItem[], LibraryOptions)

BaseItem.ValidatesChildren

BaseItem.ValidateChildren(IProgress<Double>, CancellationToken, MetadataRefreshOptions, Boolean)

BaseItem.ResolvedExtras

BaseItem.ValidateChildrenInternal(IProgress<Double>, CancellationToken, Boolean, Boolean, BaseItem[], LibraryOptions, Dictionary<Int64, Boolean>, MetadataRefreshOptions, IDirectoryService)

BaseItem.SortChildrenForValidation(BaseItem[])

BaseItem.EnableImageCaching(LibraryOptions)

BaseItem.GetApiImageUrl(ItemImageInfo, Int32, ApiImageOptions, String)

BaseItem.GetLocalApiImageUrl(ItemImageInfo, Int32, ApiImageOptions, CancellationToken)

BaseItem.GetRemoteApiImageUrl(ItemImageInfo, Int32, ApiImageOptions)

BaseItem.SetAutoSortingIfNeeded(InternalItemsQuery)

BaseItem.SetAutoSorting(InternalItemsQuery, List<(T1, T2)<String, SortOrder>>)

Namespace: MediaBrowser.Controller.Entities

Assembly: MediaBrowser.Controller.dll

Syntax

public sealed class Photo : BaseItem, IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IHasAlbum

Properties

AlbumEntity

Declaration

[IgnoreDataMember]
public PhotoAlbum AlbumEntity { get; }

Property Value

Type	Description
PhotoAlbum

Altitude

Declaration

public double? Altitude { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

Aperture

Declaration

public double? Aperture { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

CameraMake

Declaration

public string CameraMake { get; set; }

Property Value

Type	Description
System.String

CameraModel

Declaration

public string CameraModel { get; set; }

Property Value

Type	Description
System.String

ExposureTime

Declaration

public double? ExposureTime { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

FocalLength

Declaration

public double? FocalLength { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

ForceDefaultAspectRatio

Declaration

[IgnoreDataMember]
public override bool ForceDefaultAspectRatio { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.ForceDefaultAspectRatio

IsMedia

Declaration

[IgnoreDataMember]
public override bool IsMedia { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.IsMedia

IsoSpeedRating

Declaration

public int? IsoSpeedRating { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Latitude

Declaration

public double? Latitude { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

Longitude

Declaration

public double? Longitude { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

MediaType

Declaration

[IgnoreDataMember]
public override string MediaType { get; }

Property Value

Type	Description
System.String

Overrides

BaseItem.MediaType

Orientation

Declaration

public ImageOrientation? Orientation { get; set; }

Property Value

Type	Description
System.Nullable<ImageOrientation>

ShutterSpeed

Declaration

public double? ShutterSpeed { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

Software

Declaration

public string Software { get; set; }

Property Value

Type	Description
System.String

SupportsExternalTransfer

Declaration

[IgnoreDataMember]
public override bool SupportsExternalTransfer { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.SupportsExternalTransfer

SupportsGenres

Declaration

[IgnoreDataMember]
public override bool SupportsGenres { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.SupportsGenres

SupportsInheritedParentImages

Declaration

[IgnoreDataMember]
public override bool SupportsInheritedParentImages { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.SupportsInheritedParentImages

Methods

CanDownload()

Declaration

public override bool CanDownload()

Returns

Type	Description
System.Boolean

Overrides

BaseItem.CanDownload()

GetDefaultPrimaryImageAspectRatio()

Declaration

public override double GetDefaultPrimaryImageAspectRatio()

Returns

Type	Description
System.Double

Overrides

BaseItem.GetDefaultPrimaryImageAspectRatio()

Implements

IHasProviderIds

IHasLookupInfo<TLookupInfoType>

IHasAlbum

Extension Methods

BaseItemExtensions.GetImagePath(BaseItem, ImageType)

BaseItemExtensions.HasImage(BaseItem, ImageType)

Extensions.AddTrailerUrl(BaseItem, String)

TagExtensions.AddTag(BaseItem, String)

TagExtensions.RemoveTag(BaseItem, String)

Extensions.JsonClone<T>(T, IJsonSerializer)