jellyfin-server/MediaBrowser.Model/Dto/BaseItemDto.cs

1214 lines
40 KiB
C#
Raw Normal View History

using MediaBrowser.Model.Drawing;
using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Extensions;
2014-02-21 18:48:15 +00:00
using MediaBrowser.Model.Library;
2015-05-31 18:22:51 +00:00
using MediaBrowser.Model.LiveTv;
2014-08-22 02:24:38 +00:00
using MediaBrowser.Model.Providers;
2015-04-12 18:58:21 +00:00
using MediaBrowser.Model.Sync;
2013-02-21 01:33:05 +00:00
using System;
using System.Collections.Generic;
2014-01-15 05:01:58 +00:00
using System.Diagnostics;
2013-02-21 01:33:05 +00:00
using System.Runtime.Serialization;
namespace MediaBrowser.Model.Dto
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// 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.
/// </summary>
[DebuggerDisplay("Name = {Name}, ID = {Id}, Type = {Type}")]
2016-07-15 19:53:28 +00:00
public class BaseItemDto : IHasProviderIds, IItemDto, IHasServerId, IHasSyncInfo
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string Name { get; set; }
2016-04-20 05:21:40 +00:00
public string OriginalTitle { get; set; }
2014-10-24 04:54:35 +00:00
/// <summary>
/// Gets or sets the server identifier.
/// </summary>
/// <value>The server identifier.</value>
public string ServerId { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
public string Id { get; set; }
2015-04-04 02:16:42 +00:00
2015-04-14 03:45:17 +00:00
/// <summary>
/// Gets or sets the etag.
/// </summary>
/// <value>The etag.</value>
public string Etag { get; set; }
2016-03-19 19:32:37 +00:00
/// <summary>
/// Gets or sets the type of the source.
/// </summary>
/// <value>The type of the source.</value>
public string SourceType { get; set; }
2015-04-14 03:45:17 +00:00
2014-08-11 23:41:11 +00:00
/// <summary>
/// Gets or sets the playlist item identifier.
/// </summary>
/// <value>The playlist item identifier.</value>
public string PlaylistItemId { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the date created.
/// </summary>
/// <value>The date created.</value>
public DateTime? DateCreated { get; set; }
2014-02-10 18:39:41 +00:00
public DateTime? DateLastMediaAdded { get; set; }
2014-10-20 20:23:40 +00:00
public ExtraType? ExtraType { get; set; }
2015-04-04 02:16:42 +00:00
public int? AirsBeforeSeasonNumber { get; set; }
public int? AirsAfterSeasonNumber { get; set; }
public int? AirsBeforeEpisodeNumber { get; set; }
public int? AbsoluteEpisodeNumber { get; set; }
public bool? DisplaySpecialsWithSeasons { get; set; }
2015-02-06 05:39:07 +00:00
public bool? CanDelete { get; set; }
public bool? CanDownload { get; set; }
2015-10-24 15:33:22 +00:00
public bool? HasSubtitles { get; set; }
2013-12-28 16:58:13 +00:00
public string PreferredMetadataLanguage { get; set; }
public string PreferredMetadataCountryCode { get; set; }
2014-01-15 05:01:58 +00:00
public string AwardSummary { get; set; }
2015-04-10 14:01:16 +00:00
public string ShareUrl { get; set; }
2014-01-15 05:01:58 +00:00
public float? Metascore { get; set; }
public bool? HasDynamicCategories { get; set; }
public int? AnimeSeriesIndex { get; set; }
2014-07-22 16:36:34 +00:00
2015-04-04 02:16:42 +00:00
/// <summary>
/// Gets or sets a value indicating whether [supports synchronize].
/// </summary>
/// <value><c>null</c> if [supports synchronize] contains no value, <c>true</c> if [supports synchronize]; otherwise, <c>false</c>.</value>
2014-07-22 16:36:34 +00:00
public bool? SupportsSync { get; set; }
2015-04-04 02:16:42 +00:00
/// <summary>
/// Gets or sets a value indicating whether this instance has synchronize job.
/// </summary>
/// <value><c>null</c> if [has synchronize job] contains no value, <c>true</c> if [has synchronize job]; otherwise, <c>false</c>.</value>
2015-01-24 19:03:55 +00:00
public bool? HasSyncJob { get; set; }
2015-04-04 02:16:42 +00:00
/// <summary>
/// Gets or sets a value indicating whether this instance is synced.
/// </summary>
/// <value><c>null</c> if [is synced] contains no value, <c>true</c> if [is synced]; otherwise, <c>false</c>.</value>
public bool? IsSynced { get; set; }
2015-04-12 18:58:21 +00:00
/// <summary>
/// Gets or sets the synchronize status.
/// </summary>
/// <value>The synchronize status.</value>
public SyncJobItemStatus? SyncStatus { get; set; }
2015-06-02 17:46:44 +00:00
/// <summary>
/// Gets or sets the synchronize percent.
/// </summary>
/// <value>The synchronize percent.</value>
public double? SyncPercent { get; set; }
2015-01-24 19:03:55 +00:00
2016-07-17 16:59:50 +00:00
public string Container { get; set; }
/// <summary>
/// Gets or sets the DVD season number.
/// </summary>
/// <value>The DVD season number.</value>
public int? DvdSeasonNumber { get; set; }
2013-11-15 21:31:33 +00:00
/// <summary>
/// Gets or sets the DVD episode number.
2013-11-15 21:31:33 +00:00
/// </summary>
/// <value>The DVD episode number.</value>
public float? DvdEpisodeNumber { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the name of the sort.
/// </summary>
/// <value>The name of the sort.</value>
public string SortName { get; set; }
2014-03-24 17:54:45 +00:00
public string ForcedSortName { get; set; }
2013-02-21 01:33:05 +00:00
2013-06-25 18:10:39 +00:00
/// <summary>
/// Gets or sets the video3 D format.
/// </summary>
/// <value>The video3 D format.</value>
public Video3DFormat? Video3DFormat { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the premiere date.
/// </summary>
/// <value>The premiere date.</value>
public DateTime? PremiereDate { get; set; }
2014-02-21 18:48:15 +00:00
/// <summary>
/// Gets or sets the external urls.
/// </summary>
/// <value>The external urls.</value>
public ExternalUrl[] ExternalUrls { get; set; }
2014-03-20 15:55:22 +00:00
/// <summary>
/// Gets or sets the media versions.
/// </summary>
/// <value>The media versions.</value>
2014-03-22 16:16:43 +00:00
public List<MediaSourceInfo> MediaSources { get; set; }
2015-04-04 02:16:42 +00:00
2013-05-06 02:23:19 +00:00
/// <summary>
/// Gets or sets the critic rating.
/// </summary>
/// <value>The critic rating.</value>
public float? CriticRating { get; set; }
2013-06-22 18:15:31 +00:00
/// <summary>
/// Gets or sets the game system.
/// </summary>
/// <value>The game system.</value>
public string GameSystem { get; set; }
2015-04-04 02:16:42 +00:00
2013-05-06 02:23:19 +00:00
/// <summary>
/// Gets or sets the critic rating summary.
/// </summary>
/// <value>The critic rating summary.</value>
public string CriticRatingSummary { get; set; }
2014-04-27 03:42:05 +00:00
public List<string> MultiPartGameFiles { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the path.
/// </summary>
/// <value>The path.</value>
public string Path { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the official rating.
/// </summary>
/// <value>The official rating.</value>
public string OfficialRating { get; set; }
2013-05-28 02:36:51 +00:00
/// <summary>
/// Gets or sets the custom rating.
/// </summary>
/// <value>The custom rating.</value>
public string CustomRating { get; set; }
2014-05-17 21:23:48 +00:00
/// <summary>
/// Gets or sets the channel identifier.
/// </summary>
/// <value>The channel identifier.</value>
public string ChannelId { get; set; }
public string ChannelName { get; set; }
2016-02-12 18:29:28 +00:00
public string ServiceName { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the overview.
/// </summary>
/// <value>The overview.</value>
public string Overview { get; set; }
2014-06-24 04:18:02 +00:00
/// <summary>
/// Gets or sets the short overview.
/// </summary>
/// <value>The short overview.</value>
public string ShortOverview { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the taglines.
/// </summary>
/// <value>The taglines.</value>
public List<string> Taglines { get; set; }
/// <summary>
/// Gets or sets the genres.
/// </summary>
/// <value>The genres.</value>
public List<string> Genres { get; set; }
2014-12-13 03:56:30 +00:00
/// <summary>
/// Gets or sets the series genres.
/// </summary>
/// <value>The series genres.</value>
public List<string> SeriesGenres { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the community rating.
/// </summary>
/// <value>The community rating.</value>
public float? CommunityRating { get; set; }
/// <summary>
/// Gets or sets the vote count.
/// </summary>
/// <value>The vote count.</value>
public int? VoteCount { get; set; }
2013-07-25 19:17:44 +00:00
/// <summary>
/// Gets or sets the cumulative run time ticks.
/// </summary>
/// <value>The cumulative run time ticks.</value>
public long? CumulativeRunTimeTicks { get; set; }
2014-02-21 05:35:56 +00:00
/// <summary>
/// Gets or sets the original run time ticks.
/// </summary>
/// <value>The original run time ticks.</value>
public long? OriginalRunTimeTicks { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the run time ticks.
/// </summary>
/// <value>The run time ticks.</value>
public long? RunTimeTicks { get; set; }
2014-02-21 05:35:56 +00:00
/// <summary>
/// Gets or sets the play access.
/// </summary>
/// <value>The play access.</value>
public PlayAccess PlayAccess { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the aspect ratio.
/// </summary>
/// <value>The aspect ratio.</value>
public string AspectRatio { get; set; }
/// <summary>
/// Gets or sets the production year.
/// </summary>
/// <value>The production year.</value>
public int? ProductionYear { get; set; }
2013-04-24 22:34:38 +00:00
/// <summary>
/// Gets or sets the players supported by a game.
/// </summary>
/// <value>The players.</value>
public int? Players { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is place holder.
/// </summary>
/// <value><c>null</c> if [is place holder] contains no value, <c>true</c> if [is place holder]; otherwise, <c>false</c>.</value>
public bool? IsPlaceHolder { get; set; }
2015-04-04 02:16:42 +00:00
2016-03-24 02:59:44 +00:00
/// <summary>
/// Gets or sets the number.
/// </summary>
/// <value>The number.</value>
public string Number { get; set; }
2016-05-11 17:46:44 +00:00
public string ChannelNumber { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the index number.
/// </summary>
/// <value>The index number.</value>
public int? IndexNumber { get; set; }
2013-05-24 04:02:42 +00:00
/// <summary>
/// Gets or sets the index number end.
/// </summary>
/// <value>The index number end.</value>
public int? IndexNumberEnd { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the parent index number.
/// </summary>
/// <value>The parent index number.</value>
public int? ParentIndexNumber { get; set; }
/// <summary>
/// Gets or sets the trailer urls.
/// </summary>
/// <value>The trailer urls.</value>
public List<MediaUrl> RemoteTrailers { get; set; }
2013-02-21 01:33:05 +00:00
2013-07-16 16:03:28 +00:00
/// <summary>
/// Gets or sets the soundtrack ids.
/// </summary>
/// <value>The soundtrack ids.</value>
public string[] SoundtrackIds { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the provider ids.
/// </summary>
/// <value>The provider ids.</value>
public Dictionary<string, string> ProviderIds { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is HD.
/// </summary>
/// <value><c>null</c> if [is HD] contains no value, <c>true</c> if [is HD]; otherwise, <c>false</c>.</value>
public bool? IsHD { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets a value indicating whether this instance is folder.
/// </summary>
/// <value><c>true</c> if this instance is folder; otherwise, <c>false</c>.</value>
public bool IsFolder { get; set; }
/// <summary>
/// Gets or sets the parent id.
/// </summary>
/// <value>The parent id.</value>
public string ParentId { get; set; }
/// <summary>
/// Gets or sets the type.
/// </summary>
/// <value>The type.</value>
public string Type { get; set; }
/// <summary>
/// Gets or sets the people.
/// </summary>
/// <value>The people.</value>
public BaseItemPerson[] People { get; set; }
/// <summary>
/// Gets or sets the studios.
/// </summary>
/// <value>The studios.</value>
2013-05-04 03:13:28 +00:00
public StudioDto[] Studios { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// If the item does not have a logo, this will hold the Id of the Parent that has one.
/// </summary>
/// <value>The parent logo item id.</value>
public string ParentLogoItemId { get; set; }
/// <summary>
/// If the item does not have any backdrops, this will hold the Id of the Parent that has one.
/// </summary>
/// <value>The parent backdrop item id.</value>
public string ParentBackdropItemId { get; set; }
/// <summary>
/// Gets or sets the parent backdrop image tags.
/// </summary>
/// <value>The parent backdrop image tags.</value>
2014-05-08 20:09:53 +00:00
public List<string> ParentBackdropImageTags { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the local trailer count.
/// </summary>
/// <value>The local trailer count.</value>
public int? LocalTrailerCount { get; set; }
/// <summary>
/// User data for this item based on the user it's being requested for
/// </summary>
/// <value>The user data.</value>
public UserItemDataDto UserData { get; set; }
2014-12-27 05:08:39 +00:00
/// <summary>
/// Gets or sets the season user data.
/// </summary>
/// <value>The season user data.</value>
public UserItemDataDto SeasonUserData { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the recursive item count.
/// </summary>
/// <value>The recursive item count.</value>
public int? RecursiveItemCount { get; set; }
/// <summary>
/// Gets or sets the child count.
/// </summary>
/// <value>The child count.</value>
public int? ChildCount { get; set; }
/// <summary>
/// Gets or sets the name of the series.
/// </summary>
/// <value>The name of the series.</value>
public string SeriesName { get; set; }
/// <summary>
/// Gets or sets the series id.
/// </summary>
/// <value>The series id.</value>
public string SeriesId { get; set; }
/// <summary>
/// Gets or sets the season identifier.
/// </summary>
/// <value>The season identifier.</value>
public string SeasonId { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the special feature count.
/// </summary>
/// <value>The special feature count.</value>
public int? SpecialFeatureCount { get; set; }
/// <summary>
/// Gets or sets the display preferences id.
2013-02-21 01:33:05 +00:00
/// </summary>
/// <value>The display preferences id.</value>
public string DisplayPreferencesId { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the status.
/// </summary>
/// <value>The status.</value>
2015-05-31 18:22:51 +00:00
public string Status { get; set; }
[IgnoreDataMember]
public SeriesStatus? SeriesStatus
{
get
{
if (string.IsNullOrEmpty(Status))
{
return null;
}
return (SeriesStatus)Enum.Parse(typeof(SeriesStatus), Status, true);
}
set
{
if (value == null)
{
Status = null;
}
else
{
Status = value.Value.ToString();
}
}
}
[IgnoreDataMember]
public RecordingStatus? RecordingStatus
{
get
{
if (string.IsNullOrEmpty(Status))
{
return null;
}
return (RecordingStatus)Enum.Parse(typeof(RecordingStatus), Status, true);
}
set
{
if (value == null)
{
Status = null;
}
else
{
Status = value.Value.ToString();
}
}
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the air time.
/// </summary>
/// <value>The air time.</value>
public string AirTime { get; set; }
/// <summary>
/// Gets or sets the air days.
/// </summary>
/// <value>The air days.</value>
public List<DayOfWeek> AirDays { get; set; }
/// <summary>
/// Gets or sets the index options.
/// </summary>
/// <value>The index options.</value>
public string[] IndexOptions { get; set; }
2013-05-07 03:00:24 +00:00
/// <summary>
/// Gets or sets the tags.
/// </summary>
/// <value>The tags.</value>
public List<string> Tags { get; set; }
2014-01-14 15:50:39 +00:00
/// <summary>
/// Gets or sets the keywords.
/// </summary>
/// <value>The keywords.</value>
public List<string> Keywords { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
2013-06-05 12:35:18 +00:00
/// Gets or sets the primary image aspect ratio, after image enhancements.
2013-02-21 01:33:05 +00:00
/// </summary>
/// <value>The primary image aspect ratio.</value>
public double? PrimaryImageAspectRatio { get; set; }
/// <summary>
2013-04-26 03:31:10 +00:00
/// Gets or sets the artists.
2013-02-21 01:33:05 +00:00
/// </summary>
2013-04-26 03:31:10 +00:00
/// <value>The artists.</value>
2013-09-11 17:54:59 +00:00
public List<string> Artists { get; set; }
2013-02-21 01:33:05 +00:00
2015-03-13 17:25:28 +00:00
/// <summary>
/// Gets or sets the artist items.
/// </summary>
/// <value>The artist items.</value>
public List<NameIdPair> ArtistItems { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the album.
/// </summary>
/// <value>The album.</value>
public string Album { get; set; }
/// <summary>
/// Gets or sets the type of the collection.
/// </summary>
/// <value>The type of the collection.</value>
public string CollectionType { get; set; }
2015-04-04 02:16:42 +00:00
2015-11-19 05:19:54 +00:00
/// <summary>
/// Gets or sets the type of the original collection.
/// </summary>
/// <value>The type of the original collection.</value>
public string OriginalCollectionType { get; set; }
/// <summary>
/// Gets or sets the display order.
/// </summary>
/// <value>The display order.</value>
public string DisplayOrder { get; set; }
2015-04-04 02:16:42 +00:00
2013-07-16 19:10:57 +00:00
/// <summary>
/// Gets or sets the album id.
/// </summary>
/// <value>The album id.</value>
public string AlbumId { get; set; }
/// <summary>
/// Gets or sets the album image tag.
/// </summary>
/// <value>The album image tag.</value>
2014-05-08 20:09:53 +00:00
public string AlbumPrimaryImageTag { get; set; }
2013-07-16 19:10:57 +00:00
/// <summary>
/// Gets or sets the series primary image tag.
/// </summary>
/// <value>The series primary image tag.</value>
2014-05-08 20:09:53 +00:00
public string SeriesPrimaryImageTag { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the album artist.
/// </summary>
/// <value>The album artist.</value>
public string AlbumArtist { get; set; }
2014-09-17 01:38:50 +00:00
/// <summary>
2015-03-13 15:54:20 +00:00
/// Gets or sets the album artists.
/// </summary>
/// <value>The album artists.</value>
public List<NameIdPair> AlbumArtists { get; set; }
2015-04-04 02:16:42 +00:00
2015-03-13 15:54:20 +00:00
/// <summary>
2014-09-17 01:38:50 +00:00
/// Gets or sets the name of the season.
/// </summary>
/// <value>The name of the season.</value>
public string SeasonName { get; set; }
2015-04-04 02:16:42 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the media streams.
/// </summary>
/// <value>The media streams.</value>
public List<MediaStream> MediaStreams { get; set; }
/// <summary>
/// Gets or sets the type of the video.
/// </summary>
/// <value>The type of the video.</value>
public VideoType? VideoType { get; set; }
/// <summary>
/// Gets or sets the display type of the media.
/// </summary>
/// <value>The display type of the media.</value>
public string DisplayMediaType { get; set; }
/// <summary>
/// Gets or sets the part count.
/// </summary>
/// <value>The part count.</value>
public int? PartCount { get; set; }
2014-03-22 16:16:43 +00:00
public int? MediaSourceCount { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Determines whether the specified type is type.
/// </summary>
/// <param name="type">The type.</param>
/// <returns><c>true</c> if the specified type is type; otherwise, <c>false</c>.</returns>
public bool IsType(Type type)
{
return IsType(type.Name);
}
/// <summary>
/// Gets or sets a value indicating whether [supports playlists].
/// </summary>
/// <value><c>true</c> if [supports playlists]; otherwise, <c>false</c>.</value>
2015-08-04 14:26:36 +00:00
[IgnoreDataMember]
2014-12-19 04:20:07 +00:00
public bool SupportsPlaylists
{
get
{
return RunTimeTicks.HasValue || IsFolder || IsGenre || IsMusicGenre || IsArtist;
}
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Determines whether the specified type is type.
/// </summary>
/// <param name="type">The type.</param>
/// <returns><c>true</c> if the specified type is type; otherwise, <c>false</c>.</returns>
public bool IsType(string type)
{
return StringHelper.EqualsIgnoreCase(Type, type);
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets or sets the image tags.
/// </summary>
/// <value>The image tags.</value>
2014-05-08 20:09:53 +00:00
public Dictionary<ImageType, string> ImageTags { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the backdrop image tags.
/// </summary>
/// <value>The backdrop image tags.</value>
2014-05-08 20:09:53 +00:00
public List<string> BackdropImageTags { get; set; }
2013-02-21 01:33:05 +00:00
2013-05-05 04:49:49 +00:00
/// <summary>
/// Gets or sets the screenshot image tags.
/// </summary>
/// <value>The screenshot image tags.</value>
2014-05-08 20:09:53 +00:00
public List<string> ScreenshotImageTags { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the parent logo image tag.
/// </summary>
/// <value>The parent logo image tag.</value>
2014-05-08 20:09:53 +00:00
public string ParentLogoImageTag { get; set; }
2013-02-21 01:33:05 +00:00
2013-07-08 19:31:45 +00:00
/// <summary>
/// If the item does not have a art, this will hold the Id of the Parent that has one.
/// </summary>
/// <value>The parent art item id.</value>
public string ParentArtItemId { get; set; }
/// <summary>
/// Gets or sets the parent art image tag.
/// </summary>
/// <value>The parent art image tag.</value>
2014-05-08 20:09:53 +00:00
public string ParentArtImageTag { get; set; }
2013-10-24 17:49:24 +00:00
/// <summary>
/// Gets or sets the series thumb image tag.
/// </summary>
/// <value>The series thumb image tag.</value>
2014-05-08 20:09:53 +00:00
public string SeriesThumbImageTag { get; set; }
2013-10-24 17:49:24 +00:00
/// <summary>
/// Gets or sets the series studio.
/// </summary>
/// <value>The series studio.</value>
public string SeriesStudio { get; set; }
2015-04-04 02:16:42 +00:00
2013-10-24 17:49:24 +00:00
/// <summary>
/// Gets or sets the parent thumb item id.
/// </summary>
/// <value>The parent thumb item id.</value>
public string ParentThumbItemId { get; set; }
/// <summary>
/// Gets or sets the parent thumb image tag.
/// </summary>
/// <value>The parent thumb image tag.</value>
2014-05-08 20:09:53 +00:00
public string ParentThumbImageTag { get; set; }
/// <summary>
/// Gets or sets the parent primary image item identifier.
/// </summary>
/// <value>The parent primary image item identifier.</value>
public string ParentPrimaryImageItemId { get; set; }
/// <summary>
/// Gets or sets the parent primary image tag.
/// </summary>
/// <value>The parent primary image tag.</value>
public string ParentPrimaryImageTag { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the chapters.
/// </summary>
/// <value>The chapters.</value>
public List<ChapterInfoDto> Chapters { get; set; }
/// <summary>
/// Gets or sets the type of the location.
/// </summary>
/// <value>The type of the location.</value>
public LocationType LocationType { get; set; }
/// <summary>
/// Gets or sets the type of the iso.
/// </summary>
/// <value>The type of the iso.</value>
public IsoType? IsoType { get; set; }
/// <summary>
/// Gets or sets the type of the media.
/// </summary>
/// <value>The type of the media.</value>
public string MediaType { get; set; }
/// <summary>
/// Gets or sets the end date.
/// </summary>
/// <value>The end date.</value>
public DateTime? EndDate { get; set; }
/// <summary>
/// Gets or sets the home page URL.
/// </summary>
/// <value>The home page URL.</value>
public string HomePageUrl { get; set; }
/// <summary>
/// Gets or sets the production locations.
/// </summary>
/// <value>The production locations.</value>
public List<string> ProductionLocations { get; set; }
/// <summary>
/// Gets or sets the budget.
/// </summary>
/// <value>The budget.</value>
public double? Budget { get; set; }
/// <summary>
/// Gets or sets the revenue.
/// </summary>
/// <value>The revenue.</value>
public double? Revenue { get; set; }
2013-04-23 03:56:11 +00:00
2013-06-09 14:15:59 +00:00
/// <summary>
/// Gets or sets the locked fields.
/// </summary>
/// <value>The locked fields.</value>
public List<MetadataFields> LockedFields { get; set; }
2016-03-19 21:55:42 +00:00
/// <summary>
/// Gets or sets the trailer count.
/// </summary>
/// <value>The trailer count.</value>
public int? TrailerCount { get; set; }
/// <summary>
/// Gets or sets the movie count.
/// </summary>
/// <value>The movie count.</value>
public int? MovieCount { get; set; }
/// <summary>
/// Gets or sets the series count.
/// </summary>
/// <value>The series count.</value>
public int? SeriesCount { get; set; }
/// <summary>
/// Gets or sets the episode count.
/// </summary>
/// <value>The episode count.</value>
public int? EpisodeCount { get; set; }
/// <summary>
/// Gets or sets the game count.
/// </summary>
/// <value>The game count.</value>
public int? GameCount { get; set; }
/// <summary>
/// Gets or sets the song count.
/// </summary>
/// <value>The song count.</value>
public int? SongCount { get; set; }
/// <summary>
/// Gets or sets the album count.
/// </summary>
/// <value>The album count.</value>
public int? AlbumCount { get; set; }
/// <summary>
/// Gets or sets the music video count.
/// </summary>
/// <value>The music video count.</value>
public int? MusicVideoCount { get; set; }
2015-04-04 02:16:42 +00:00
/// <summary>
/// Gets or sets a value indicating whether [enable internet providers].
/// </summary>
/// <value><c>true</c> if [enable internet providers]; otherwise, <c>false</c>.</value>
2014-02-19 05:21:03 +00:00
public bool? LockData { get; set; }
public int? Width { get; set; }
public int? Height { get; set; }
public string CameraMake { get; set; }
public string CameraModel { get; set; }
public string Software { get; set; }
public double? ExposureTime { get; set; }
public double? FocalLength { get; set; }
public ImageOrientation? ImageOrientation { get; set; }
public double? Aperture { get; set; }
public double? ShutterSpeed { get; set; }
2014-08-30 14:26:29 +00:00
public double? Latitude { get; set; }
public double? Longitude { get; set; }
public double? Altitude { get; set; }
public int? IsoSpeedRating { get; set; }
2015-05-31 18:22:51 +00:00
/// <summary>
/// Used by RecordingGroup
/// </summary>
public int? RecordingCount { get; set; }
/// <summary>
/// Gets or sets the series timer identifier.
/// </summary>
/// <value>The series timer identifier.</value>
public string SeriesTimerId { get; set; }
/// <summary>
/// Gets a value indicating whether this instance can resume.
/// </summary>
/// <value><c>true</c> if this instance can resume; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool CanResume
{
get { return UserData != null && UserData.PlaybackPositionTicks > 0; }
}
/// <summary>
/// Gets the resume position ticks.
/// </summary>
/// <value>The resume position ticks.</value>
[IgnoreDataMember]
public long ResumePositionTicks
{
get { return UserData == null ? 0 : UserData.PlaybackPositionTicks; }
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the backdrop count.
/// </summary>
/// <value>The backdrop count.</value>
[IgnoreDataMember]
public int BackdropCount
{
get { return BackdropImageTags == null ? 0 : BackdropImageTags.Count; }
}
2013-05-05 04:49:49 +00:00
/// <summary>
/// Gets the screenshot count.
/// </summary>
/// <value>The screenshot count.</value>
[IgnoreDataMember]
public int ScreenshotCount
{
get { return ScreenshotImageTags == null ? 0 : ScreenshotImageTags.Count; }
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets a value indicating whether this instance has banner.
/// </summary>
/// <value><c>true</c> if this instance has banner; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool HasBanner
{
get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Banner); }
}
/// <summary>
/// Gets a value indicating whether this instance has art.
/// </summary>
/// <value><c>true</c> if this instance has art; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool HasArtImage
{
get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Art); }
}
/// <summary>
/// Gets a value indicating whether this instance has logo.
/// </summary>
/// <value><c>true</c> if this instance has logo; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool HasLogo
{
get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Logo); }
}
/// <summary>
/// Gets a value indicating whether this instance has thumb.
/// </summary>
/// <value><c>true</c> if this instance has thumb; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool HasThumb
{
get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Thumb); }
}
2016-07-05 05:40:18 +00:00
/// <summary>
/// Gets a value indicating whether this instance has thumb.
/// </summary>
/// <value><c>true</c> if this instance has thumb; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool HasBackdrop
{
get { return (BackdropImageTags != null && BackdropImageTags.Count > 0) || (ParentBackdropImageTags != null && ParentBackdropImageTags.Count > 0); }
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets a value indicating whether this instance has primary image.
/// </summary>
/// <value><c>true</c> if this instance has primary image; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool HasPrimaryImage
{
get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Primary); }
}
/// <summary>
/// Gets a value indicating whether this instance has disc image.
/// </summary>
/// <value><c>true</c> if this instance has disc image; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool HasDiscImage
{
get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Disc); }
}
/// <summary>
/// Gets a value indicating whether this instance has box image.
/// </summary>
/// <value><c>true</c> if this instance has box image; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool HasBoxImage
{
get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Box); }
}
2013-07-10 12:37:14 +00:00
/// <summary>
/// Gets a value indicating whether this instance has box image.
/// </summary>
/// <value><c>true</c> if this instance has box image; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool HasBoxRearImage
{
get { return ImageTags != null && ImageTags.ContainsKey(ImageType.BoxRear); }
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets a value indicating whether this instance has menu image.
/// </summary>
/// <value><c>true</c> if this instance has menu image; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
2013-02-21 01:33:05 +00:00
public bool HasMenuImage
{
get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Menu); }
}
/// <summary>
/// Gets a value indicating whether this instance is video.
/// </summary>
/// <value><c>true</c> if this instance is video; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool IsVideo
{
2014-12-15 05:16:23 +00:00
get { return StringHelper.EqualsIgnoreCase(MediaType, Entities.MediaType.Video); }
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets a value indicating whether this instance is audio.
/// </summary>
/// <value><c>true</c> if this instance is audio; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool IsAudio
{
2014-12-15 05:16:23 +00:00
get { return StringHelper.EqualsIgnoreCase(MediaType, Entities.MediaType.Audio); }
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets a value indicating whether this instance is game.
/// </summary>
/// <value><c>true</c> if this instance is game; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool IsGame
{
2014-12-15 05:16:23 +00:00
get { return StringHelper.EqualsIgnoreCase(MediaType, Entities.MediaType.Game); }
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets a value indicating whether this instance is person.
/// </summary>
/// <value><c>true</c> if this instance is person; otherwise, <c>false</c>.</value>
2013-03-02 07:16:52 +00:00
[IgnoreDataMember]
public bool IsPerson
{
get { return StringHelper.EqualsIgnoreCase(Type, "Person"); }
2013-03-02 07:16:52 +00:00
}
/// <summary>
/// Gets a value indicating whether this instance is root.
/// </summary>
/// <value><c>true</c> if this instance is root; otherwise, <c>false</c>.</value>
[IgnoreDataMember]
public bool IsRoot
{
get { return StringHelper.EqualsIgnoreCase(Type, "AggregateFolder"); }
}
2013-07-27 17:18:10 +00:00
[IgnoreDataMember]
public bool IsMusicGenre
{
get { return StringHelper.EqualsIgnoreCase(Type, "MusicGenre"); }
2013-07-27 17:18:10 +00:00
}
[IgnoreDataMember]
public bool IsGameGenre
{
get { return StringHelper.EqualsIgnoreCase(Type, "GameGenre"); }
2013-07-27 17:18:10 +00:00
}
[IgnoreDataMember]
public bool IsGenre
{
get { return StringHelper.EqualsIgnoreCase(Type, "Genre"); }
2013-07-27 17:18:10 +00:00
}
[IgnoreDataMember]
public bool IsArtist
{
2014-12-15 05:16:23 +00:00
get { return StringHelper.EqualsIgnoreCase(Type, "MusicArtist"); }
}
[IgnoreDataMember]
public bool IsAlbum
{
get { return StringHelper.EqualsIgnoreCase(Type, "MusicAlbum"); }
2013-07-27 17:18:10 +00:00
}
[IgnoreDataMember]
public bool IsStudio
{
get { return StringHelper.EqualsIgnoreCase(Type, "Studio"); }
2013-07-27 17:18:10 +00:00
}
2015-08-21 02:36:30 +00:00
[IgnoreDataMember]
public bool SupportsSimilarItems
{
get
{
return IsType("Movie") || IsType("Series") || IsType("MusicAlbum") || IsType("MusicArtist") || IsType("Program") || IsType("Recording") || IsType("ChannelVideoItem") || IsType("Game");
}
}
2015-05-31 18:22:51 +00:00
/// <summary>
/// Gets or sets the program identifier.
/// </summary>
/// <value>The program identifier.</value>
public string ProgramId { get; set; }
/// <summary>
/// Gets or sets the channel primary image tag.
/// </summary>
/// <value>The channel primary image tag.</value>
public string ChannelPrimaryImageTag { get; set; }
/// <summary>
/// The start date of the recording, in UTC.
/// </summary>
public DateTime? StartDate { get; set; }
/// <summary>
/// Gets or sets the completion percentage.
/// </summary>
/// <value>The completion percentage.</value>
public double? CompletionPercentage { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is repeat.
/// </summary>
/// <value><c>true</c> if this instance is repeat; otherwise, <c>false</c>.</value>
public bool? IsRepeat { get; set; }
/// <summary>
/// Gets or sets the episode title.
/// </summary>
/// <value>The episode title.</value>
public string EpisodeTitle { get; set; }
/// <summary>
/// Gets or sets the type of the channel.
/// </summary>
/// <value>The type of the channel.</value>
public ChannelType? ChannelType { get; set; }
/// <summary>
/// Gets or sets the audio.
/// </summary>
/// <value>The audio.</value>
public ProgramAudio? Audio { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is movie.
/// </summary>
/// <value><c>true</c> if this instance is movie; otherwise, <c>false</c>.</value>
public bool? IsMovie { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is sports.
/// </summary>
/// <value><c>true</c> if this instance is sports; otherwise, <c>false</c>.</value>
public bool? IsSports { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is series.
/// </summary>
/// <value><c>true</c> if this instance is series; otherwise, <c>false</c>.</value>
public bool? IsSeries { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is live.
/// </summary>
/// <value><c>true</c> if this instance is live; otherwise, <c>false</c>.</value>
public bool? IsLive { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is news.
/// </summary>
/// <value><c>true</c> if this instance is news; otherwise, <c>false</c>.</value>
public bool? IsNews { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is kids.
/// </summary>
/// <value><c>true</c> if this instance is kids; otherwise, <c>false</c>.</value>
public bool? IsKids { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is premiere.
/// </summary>
/// <value><c>true</c> if this instance is premiere; otherwise, <c>false</c>.</value>
public bool? IsPremiere { get; set; }
2015-05-31 19:12:58 +00:00
/// <summary>
/// Gets or sets the timer identifier.
/// </summary>
/// <value>The timer identifier.</value>
public string TimerId { get; set; }
/// <summary>
/// Gets or sets the current program.
/// </summary>
/// <value>The current program.</value>
public BaseItemDto CurrentProgram { get; set; }
2013-02-21 01:33:05 +00:00
}
}