BaseItemDto.cs 41 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223
  1. using MediaBrowser.Model.Drawing;
  2. using MediaBrowser.Model.Entities;
  3. using MediaBrowser.Model.Extensions;
  4. using MediaBrowser.Model.Library;
  5. using MediaBrowser.Model.LiveTv;
  6. using MediaBrowser.Model.Providers;
  7. using MediaBrowser.Model.Sync;
  8. using System;
  9. using System.Collections.Generic;
  10. using System.Diagnostics;
  11. using System.Runtime.Serialization;
  12. namespace MediaBrowser.Model.Dto
  13. {
  14. /// <summary>
  15. /// This is strictly used as a data transfer object from the api layer.
  16. /// This holds information about a BaseItem in a format that is convenient for the client.
  17. /// </summary>
  18. [DebuggerDisplay("Name = {Name}, ID = {Id}, Type = {Type}")]
  19. public class BaseItemDto : IHasProviderIds, IItemDto, IHasServerId, IHasSyncInfo
  20. {
  21. /// <summary>
  22. /// Gets or sets the name.
  23. /// </summary>
  24. /// <value>The name.</value>
  25. public string Name { get; set; }
  26. public string OriginalTitle { get; set; }
  27. /// <summary>
  28. /// Gets or sets the server identifier.
  29. /// </summary>
  30. /// <value>The server identifier.</value>
  31. public string ServerId { get; set; }
  32. /// <summary>
  33. /// Gets or sets the id.
  34. /// </summary>
  35. /// <value>The id.</value>
  36. public string Id { get; set; }
  37. /// <summary>
  38. /// Gets or sets the etag.
  39. /// </summary>
  40. /// <value>The etag.</value>
  41. public string Etag { get; set; }
  42. /// <summary>
  43. /// Gets or sets the type of the source.
  44. /// </summary>
  45. /// <value>The type of the source.</value>
  46. public string SourceType { get; set; }
  47. /// <summary>
  48. /// Gets or sets the playlist item identifier.
  49. /// </summary>
  50. /// <value>The playlist item identifier.</value>
  51. public string PlaylistItemId { get; set; }
  52. /// <summary>
  53. /// Gets or sets the date created.
  54. /// </summary>
  55. /// <value>The date created.</value>
  56. public DateTime? DateCreated { get; set; }
  57. public DateTime? DateLastMediaAdded { get; set; }
  58. public ExtraType? ExtraType { get; set; }
  59. public int? AirsBeforeSeasonNumber { get; set; }
  60. public int? AirsAfterSeasonNumber { get; set; }
  61. public int? AirsBeforeEpisodeNumber { get; set; }
  62. public int? AbsoluteEpisodeNumber { get; set; }
  63. public bool? DisplaySpecialsWithSeasons { get; set; }
  64. public bool? CanDelete { get; set; }
  65. public bool? CanDownload { get; set; }
  66. public bool? HasSubtitles { get; set; }
  67. public string PreferredMetadataLanguage { get; set; }
  68. public string PreferredMetadataCountryCode { get; set; }
  69. public string AwardSummary { get; set; }
  70. public string ShareUrl { get; set; }
  71. public float? Metascore { get; set; }
  72. public bool? HasDynamicCategories { get; set; }
  73. public int? AnimeSeriesIndex { get; set; }
  74. /// <summary>
  75. /// Gets or sets a value indicating whether [supports synchronize].
  76. /// </summary>
  77. /// <value><c>null</c> if [supports synchronize] contains no value, <c>true</c> if [supports synchronize]; otherwise, <c>false</c>.</value>
  78. public bool? SupportsSync { get; set; }
  79. /// <summary>
  80. /// Gets or sets a value indicating whether this instance has synchronize job.
  81. /// </summary>
  82. /// <value><c>null</c> if [has synchronize job] contains no value, <c>true</c> if [has synchronize job]; otherwise, <c>false</c>.</value>
  83. public bool? HasSyncJob { get; set; }
  84. /// <summary>
  85. /// Gets or sets a value indicating whether this instance is synced.
  86. /// </summary>
  87. /// <value><c>null</c> if [is synced] contains no value, <c>true</c> if [is synced]; otherwise, <c>false</c>.</value>
  88. public bool? IsSynced { get; set; }
  89. /// <summary>
  90. /// Gets or sets the synchronize status.
  91. /// </summary>
  92. /// <value>The synchronize status.</value>
  93. public SyncJobItemStatus? SyncStatus { get; set; }
  94. /// <summary>
  95. /// Gets or sets the synchronize percent.
  96. /// </summary>
  97. /// <value>The synchronize percent.</value>
  98. public double? SyncPercent { get; set; }
  99. public string Container { get; set; }
  100. /// <summary>
  101. /// Gets or sets the DVD season number.
  102. /// </summary>
  103. /// <value>The DVD season number.</value>
  104. public int? DvdSeasonNumber { get; set; }
  105. /// <summary>
  106. /// Gets or sets the DVD episode number.
  107. /// </summary>
  108. /// <value>The DVD episode number.</value>
  109. public float? DvdEpisodeNumber { get; set; }
  110. /// <summary>
  111. /// Gets or sets the name of the sort.
  112. /// </summary>
  113. /// <value>The name of the sort.</value>
  114. public string SortName { get; set; }
  115. public string ForcedSortName { get; set; }
  116. /// <summary>
  117. /// Gets or sets the video3 D format.
  118. /// </summary>
  119. /// <value>The video3 D format.</value>
  120. public Video3DFormat? Video3DFormat { get; set; }
  121. /// <summary>
  122. /// Gets or sets the premiere date.
  123. /// </summary>
  124. /// <value>The premiere date.</value>
  125. public DateTime? PremiereDate { get; set; }
  126. /// <summary>
  127. /// Gets or sets the external urls.
  128. /// </summary>
  129. /// <value>The external urls.</value>
  130. public ExternalUrl[] ExternalUrls { get; set; }
  131. /// <summary>
  132. /// Gets or sets the media versions.
  133. /// </summary>
  134. /// <value>The media versions.</value>
  135. public List<MediaSourceInfo> MediaSources { get; set; }
  136. /// <summary>
  137. /// Gets or sets the critic rating.
  138. /// </summary>
  139. /// <value>The critic rating.</value>
  140. public float? CriticRating { get; set; }
  141. /// <summary>
  142. /// Gets or sets the game system.
  143. /// </summary>
  144. /// <value>The game system.</value>
  145. public string GameSystem { get; set; }
  146. /// <summary>
  147. /// Gets or sets the critic rating summary.
  148. /// </summary>
  149. /// <value>The critic rating summary.</value>
  150. public string CriticRatingSummary { get; set; }
  151. public List<string> MultiPartGameFiles { get; set; }
  152. /// <summary>
  153. /// Gets or sets the path.
  154. /// </summary>
  155. /// <value>The path.</value>
  156. public string Path { get; set; }
  157. /// <summary>
  158. /// Gets or sets the official rating.
  159. /// </summary>
  160. /// <value>The official rating.</value>
  161. public string OfficialRating { get; set; }
  162. /// <summary>
  163. /// Gets or sets the custom rating.
  164. /// </summary>
  165. /// <value>The custom rating.</value>
  166. public string CustomRating { get; set; }
  167. /// <summary>
  168. /// Gets or sets the channel identifier.
  169. /// </summary>
  170. /// <value>The channel identifier.</value>
  171. public string ChannelId { get; set; }
  172. public string ChannelName { get; set; }
  173. public string ServiceName { get; set; }
  174. /// <summary>
  175. /// Gets or sets the overview.
  176. /// </summary>
  177. /// <value>The overview.</value>
  178. public string Overview { get; set; }
  179. /// <summary>
  180. /// Gets or sets the short overview.
  181. /// </summary>
  182. /// <value>The short overview.</value>
  183. public string ShortOverview { get; set; }
  184. /// <summary>
  185. /// Gets or sets the taglines.
  186. /// </summary>
  187. /// <value>The taglines.</value>
  188. public List<string> Taglines { get; set; }
  189. /// <summary>
  190. /// Gets or sets the genres.
  191. /// </summary>
  192. /// <value>The genres.</value>
  193. public List<string> Genres { get; set; }
  194. /// <summary>
  195. /// Gets or sets the series genres.
  196. /// </summary>
  197. /// <value>The series genres.</value>
  198. public List<string> SeriesGenres { get; set; }
  199. /// <summary>
  200. /// Gets or sets the community rating.
  201. /// </summary>
  202. /// <value>The community rating.</value>
  203. public float? CommunityRating { get; set; }
  204. /// <summary>
  205. /// Gets or sets the vote count.
  206. /// </summary>
  207. /// <value>The vote count.</value>
  208. public int? VoteCount { get; set; }
  209. /// <summary>
  210. /// Gets or sets the cumulative run time ticks.
  211. /// </summary>
  212. /// <value>The cumulative run time ticks.</value>
  213. public long? CumulativeRunTimeTicks { get; set; }
  214. /// <summary>
  215. /// Gets or sets the original run time ticks.
  216. /// </summary>
  217. /// <value>The original run time ticks.</value>
  218. public long? OriginalRunTimeTicks { get; set; }
  219. /// <summary>
  220. /// Gets or sets the run time ticks.
  221. /// </summary>
  222. /// <value>The run time ticks.</value>
  223. public long? RunTimeTicks { get; set; }
  224. /// <summary>
  225. /// Gets or sets the play access.
  226. /// </summary>
  227. /// <value>The play access.</value>
  228. public PlayAccess PlayAccess { get; set; }
  229. /// <summary>
  230. /// Gets or sets the aspect ratio.
  231. /// </summary>
  232. /// <value>The aspect ratio.</value>
  233. public string AspectRatio { get; set; }
  234. /// <summary>
  235. /// Gets or sets the production year.
  236. /// </summary>
  237. /// <value>The production year.</value>
  238. public int? ProductionYear { get; set; }
  239. /// <summary>
  240. /// Gets or sets the players supported by a game.
  241. /// </summary>
  242. /// <value>The players.</value>
  243. public int? Players { get; set; }
  244. /// <summary>
  245. /// Gets or sets a value indicating whether this instance is place holder.
  246. /// </summary>
  247. /// <value><c>null</c> if [is place holder] contains no value, <c>true</c> if [is place holder]; otherwise, <c>false</c>.</value>
  248. public bool? IsPlaceHolder { get; set; }
  249. /// <summary>
  250. /// Gets or sets the number.
  251. /// </summary>
  252. /// <value>The number.</value>
  253. public string Number { get; set; }
  254. public string ChannelNumber { get; set; }
  255. /// <summary>
  256. /// Gets or sets the index number.
  257. /// </summary>
  258. /// <value>The index number.</value>
  259. public int? IndexNumber { get; set; }
  260. /// <summary>
  261. /// Gets or sets the index number end.
  262. /// </summary>
  263. /// <value>The index number end.</value>
  264. public int? IndexNumberEnd { get; set; }
  265. /// <summary>
  266. /// Gets or sets the parent index number.
  267. /// </summary>
  268. /// <value>The parent index number.</value>
  269. public int? ParentIndexNumber { get; set; }
  270. /// <summary>
  271. /// Gets or sets the trailer urls.
  272. /// </summary>
  273. /// <value>The trailer urls.</value>
  274. public List<MediaUrl> RemoteTrailers { get; set; }
  275. /// <summary>
  276. /// Gets or sets the soundtrack ids.
  277. /// </summary>
  278. /// <value>The soundtrack ids.</value>
  279. public string[] SoundtrackIds { get; set; }
  280. /// <summary>
  281. /// Gets or sets the provider ids.
  282. /// </summary>
  283. /// <value>The provider ids.</value>
  284. public Dictionary<string, string> ProviderIds { get; set; }
  285. /// <summary>
  286. /// Gets or sets a value indicating whether this instance is HD.
  287. /// </summary>
  288. /// <value><c>null</c> if [is HD] contains no value, <c>true</c> if [is HD]; otherwise, <c>false</c>.</value>
  289. public bool? IsHD { get; set; }
  290. /// <summary>
  291. /// Gets or sets a value indicating whether this instance is folder.
  292. /// </summary>
  293. /// <value><c>true</c> if this instance is folder; otherwise, <c>false</c>.</value>
  294. public bool? IsFolder { get; set; }
  295. [IgnoreDataMember]
  296. public bool IsFolderItem
  297. {
  298. get
  299. {
  300. return IsFolder ?? false;
  301. }
  302. }
  303. /// <summary>
  304. /// Gets or sets the parent id.
  305. /// </summary>
  306. /// <value>The parent id.</value>
  307. public string ParentId { get; set; }
  308. /// <summary>
  309. /// Gets or sets the type.
  310. /// </summary>
  311. /// <value>The type.</value>
  312. public string Type { get; set; }
  313. /// <summary>
  314. /// Gets or sets the people.
  315. /// </summary>
  316. /// <value>The people.</value>
  317. public BaseItemPerson[] People { get; set; }
  318. /// <summary>
  319. /// Gets or sets the studios.
  320. /// </summary>
  321. /// <value>The studios.</value>
  322. public StudioDto[] Studios { get; set; }
  323. /// <summary>
  324. /// If the item does not have a logo, this will hold the Id of the Parent that has one.
  325. /// </summary>
  326. /// <value>The parent logo item id.</value>
  327. public string ParentLogoItemId { get; set; }
  328. /// <summary>
  329. /// If the item does not have any backdrops, this will hold the Id of the Parent that has one.
  330. /// </summary>
  331. /// <value>The parent backdrop item id.</value>
  332. public string ParentBackdropItemId { get; set; }
  333. /// <summary>
  334. /// Gets or sets the parent backdrop image tags.
  335. /// </summary>
  336. /// <value>The parent backdrop image tags.</value>
  337. public List<string> ParentBackdropImageTags { get; set; }
  338. /// <summary>
  339. /// Gets or sets the local trailer count.
  340. /// </summary>
  341. /// <value>The local trailer count.</value>
  342. public int? LocalTrailerCount { get; set; }
  343. /// <summary>
  344. /// User data for this item based on the user it's being requested for
  345. /// </summary>
  346. /// <value>The user data.</value>
  347. public UserItemDataDto UserData { get; set; }
  348. /// <summary>
  349. /// Gets or sets the season user data.
  350. /// </summary>
  351. /// <value>The season user data.</value>
  352. public UserItemDataDto SeasonUserData { get; set; }
  353. /// <summary>
  354. /// Gets or sets the recursive item count.
  355. /// </summary>
  356. /// <value>The recursive item count.</value>
  357. public int? RecursiveItemCount { get; set; }
  358. /// <summary>
  359. /// Gets or sets the child count.
  360. /// </summary>
  361. /// <value>The child count.</value>
  362. public int? ChildCount { get; set; }
  363. /// <summary>
  364. /// Gets or sets the name of the series.
  365. /// </summary>
  366. /// <value>The name of the series.</value>
  367. public string SeriesName { get; set; }
  368. /// <summary>
  369. /// Gets or sets the series id.
  370. /// </summary>
  371. /// <value>The series id.</value>
  372. public string SeriesId { get; set; }
  373. /// <summary>
  374. /// Gets or sets the season identifier.
  375. /// </summary>
  376. /// <value>The season identifier.</value>
  377. public string SeasonId { get; set; }
  378. /// <summary>
  379. /// Gets or sets the special feature count.
  380. /// </summary>
  381. /// <value>The special feature count.</value>
  382. public int? SpecialFeatureCount { get; set; }
  383. /// <summary>
  384. /// Gets or sets the display preferences id.
  385. /// </summary>
  386. /// <value>The display preferences id.</value>
  387. public string DisplayPreferencesId { get; set; }
  388. /// <summary>
  389. /// Gets or sets the status.
  390. /// </summary>
  391. /// <value>The status.</value>
  392. public string Status { get; set; }
  393. [IgnoreDataMember]
  394. public SeriesStatus? SeriesStatus
  395. {
  396. get
  397. {
  398. if (string.IsNullOrEmpty(Status))
  399. {
  400. return null;
  401. }
  402. return (SeriesStatus)Enum.Parse(typeof(SeriesStatus), Status, true);
  403. }
  404. set
  405. {
  406. if (value == null)
  407. {
  408. Status = null;
  409. }
  410. else
  411. {
  412. Status = value.Value.ToString();
  413. }
  414. }
  415. }
  416. [IgnoreDataMember]
  417. public RecordingStatus? RecordingStatus
  418. {
  419. get
  420. {
  421. if (string.IsNullOrEmpty(Status))
  422. {
  423. return null;
  424. }
  425. return (RecordingStatus)Enum.Parse(typeof(RecordingStatus), Status, true);
  426. }
  427. set
  428. {
  429. if (value == null)
  430. {
  431. Status = null;
  432. }
  433. else
  434. {
  435. Status = value.Value.ToString();
  436. }
  437. }
  438. }
  439. /// <summary>
  440. /// Gets or sets the air time.
  441. /// </summary>
  442. /// <value>The air time.</value>
  443. public string AirTime { get; set; }
  444. /// <summary>
  445. /// Gets or sets the air days.
  446. /// </summary>
  447. /// <value>The air days.</value>
  448. public List<DayOfWeek> AirDays { get; set; }
  449. /// <summary>
  450. /// Gets or sets the index options.
  451. /// </summary>
  452. /// <value>The index options.</value>
  453. public string[] IndexOptions { get; set; }
  454. /// <summary>
  455. /// Gets or sets the tags.
  456. /// </summary>
  457. /// <value>The tags.</value>
  458. public List<string> Tags { get; set; }
  459. /// <summary>
  460. /// Gets or sets the keywords.
  461. /// </summary>
  462. /// <value>The keywords.</value>
  463. public List<string> Keywords { get; set; }
  464. /// <summary>
  465. /// Gets or sets the primary image aspect ratio, after image enhancements.
  466. /// </summary>
  467. /// <value>The primary image aspect ratio.</value>
  468. public double? PrimaryImageAspectRatio { get; set; }
  469. /// <summary>
  470. /// Gets or sets the artists.
  471. /// </summary>
  472. /// <value>The artists.</value>
  473. public List<string> Artists { get; set; }
  474. /// <summary>
  475. /// Gets or sets the artist items.
  476. /// </summary>
  477. /// <value>The artist items.</value>
  478. public List<NameIdPair> ArtistItems { get; set; }
  479. /// <summary>
  480. /// Gets or sets the album.
  481. /// </summary>
  482. /// <value>The album.</value>
  483. public string Album { get; set; }
  484. /// <summary>
  485. /// Gets or sets the type of the collection.
  486. /// </summary>
  487. /// <value>The type of the collection.</value>
  488. public string CollectionType { get; set; }
  489. /// <summary>
  490. /// Gets or sets the type of the original collection.
  491. /// </summary>
  492. /// <value>The type of the original collection.</value>
  493. public string OriginalCollectionType { get; set; }
  494. /// <summary>
  495. /// Gets or sets the display order.
  496. /// </summary>
  497. /// <value>The display order.</value>
  498. public string DisplayOrder { get; set; }
  499. /// <summary>
  500. /// Gets or sets the album id.
  501. /// </summary>
  502. /// <value>The album id.</value>
  503. public string AlbumId { get; set; }
  504. /// <summary>
  505. /// Gets or sets the album image tag.
  506. /// </summary>
  507. /// <value>The album image tag.</value>
  508. public string AlbumPrimaryImageTag { get; set; }
  509. /// <summary>
  510. /// Gets or sets the series primary image tag.
  511. /// </summary>
  512. /// <value>The series primary image tag.</value>
  513. public string SeriesPrimaryImageTag { get; set; }
  514. /// <summary>
  515. /// Gets or sets the album artist.
  516. /// </summary>
  517. /// <value>The album artist.</value>
  518. public string AlbumArtist { get; set; }
  519. /// <summary>
  520. /// Gets or sets the album artists.
  521. /// </summary>
  522. /// <value>The album artists.</value>
  523. public List<NameIdPair> AlbumArtists { get; set; }
  524. /// <summary>
  525. /// Gets or sets the name of the season.
  526. /// </summary>
  527. /// <value>The name of the season.</value>
  528. public string SeasonName { get; set; }
  529. /// <summary>
  530. /// Gets or sets the media streams.
  531. /// </summary>
  532. /// <value>The media streams.</value>
  533. public List<MediaStream> MediaStreams { get; set; }
  534. /// <summary>
  535. /// Gets or sets the type of the video.
  536. /// </summary>
  537. /// <value>The type of the video.</value>
  538. public VideoType? VideoType { get; set; }
  539. /// <summary>
  540. /// Gets or sets the display type of the media.
  541. /// </summary>
  542. /// <value>The display type of the media.</value>
  543. public string DisplayMediaType { get; set; }
  544. /// <summary>
  545. /// Gets or sets the part count.
  546. /// </summary>
  547. /// <value>The part count.</value>
  548. public int? PartCount { get; set; }
  549. public int? MediaSourceCount { get; set; }
  550. /// <summary>
  551. /// Determines whether the specified type is type.
  552. /// </summary>
  553. /// <param name="type">The type.</param>
  554. /// <returns><c>true</c> if the specified type is type; otherwise, <c>false</c>.</returns>
  555. public bool IsType(Type type)
  556. {
  557. return IsType(type.Name);
  558. }
  559. /// <summary>
  560. /// Gets or sets a value indicating whether [supports playlists].
  561. /// </summary>
  562. /// <value><c>true</c> if [supports playlists]; otherwise, <c>false</c>.</value>
  563. [IgnoreDataMember]
  564. public bool SupportsPlaylists
  565. {
  566. get
  567. {
  568. return RunTimeTicks.HasValue || IsFolderItem || IsGenre || IsMusicGenre || IsArtist;
  569. }
  570. }
  571. /// <summary>
  572. /// Determines whether the specified type is type.
  573. /// </summary>
  574. /// <param name="type">The type.</param>
  575. /// <returns><c>true</c> if the specified type is type; otherwise, <c>false</c>.</returns>
  576. public bool IsType(string type)
  577. {
  578. return StringHelper.EqualsIgnoreCase(Type, type);
  579. }
  580. /// <summary>
  581. /// Gets or sets the image tags.
  582. /// </summary>
  583. /// <value>The image tags.</value>
  584. public Dictionary<ImageType, string> ImageTags { get; set; }
  585. /// <summary>
  586. /// Gets or sets the backdrop image tags.
  587. /// </summary>
  588. /// <value>The backdrop image tags.</value>
  589. public List<string> BackdropImageTags { get; set; }
  590. /// <summary>
  591. /// Gets or sets the screenshot image tags.
  592. /// </summary>
  593. /// <value>The screenshot image tags.</value>
  594. public List<string> ScreenshotImageTags { get; set; }
  595. /// <summary>
  596. /// Gets or sets the parent logo image tag.
  597. /// </summary>
  598. /// <value>The parent logo image tag.</value>
  599. public string ParentLogoImageTag { get; set; }
  600. /// <summary>
  601. /// If the item does not have a art, this will hold the Id of the Parent that has one.
  602. /// </summary>
  603. /// <value>The parent art item id.</value>
  604. public string ParentArtItemId { get; set; }
  605. /// <summary>
  606. /// Gets or sets the parent art image tag.
  607. /// </summary>
  608. /// <value>The parent art image tag.</value>
  609. public string ParentArtImageTag { get; set; }
  610. /// <summary>
  611. /// Gets or sets the series thumb image tag.
  612. /// </summary>
  613. /// <value>The series thumb image tag.</value>
  614. public string SeriesThumbImageTag { get; set; }
  615. /// <summary>
  616. /// Gets or sets the series studio.
  617. /// </summary>
  618. /// <value>The series studio.</value>
  619. public string SeriesStudio { get; set; }
  620. /// <summary>
  621. /// Gets or sets the parent thumb item id.
  622. /// </summary>
  623. /// <value>The parent thumb item id.</value>
  624. public string ParentThumbItemId { get; set; }
  625. /// <summary>
  626. /// Gets or sets the parent thumb image tag.
  627. /// </summary>
  628. /// <value>The parent thumb image tag.</value>
  629. public string ParentThumbImageTag { get; set; }
  630. /// <summary>
  631. /// Gets or sets the parent primary image item identifier.
  632. /// </summary>
  633. /// <value>The parent primary image item identifier.</value>
  634. public string ParentPrimaryImageItemId { get; set; }
  635. /// <summary>
  636. /// Gets or sets the parent primary image tag.
  637. /// </summary>
  638. /// <value>The parent primary image tag.</value>
  639. public string ParentPrimaryImageTag { get; set; }
  640. /// <summary>
  641. /// Gets or sets the chapters.
  642. /// </summary>
  643. /// <value>The chapters.</value>
  644. public List<ChapterInfoDto> Chapters { get; set; }
  645. /// <summary>
  646. /// Gets or sets the type of the location.
  647. /// </summary>
  648. /// <value>The type of the location.</value>
  649. public LocationType LocationType { get; set; }
  650. /// <summary>
  651. /// Gets or sets the type of the iso.
  652. /// </summary>
  653. /// <value>The type of the iso.</value>
  654. public IsoType? IsoType { get; set; }
  655. /// <summary>
  656. /// Gets or sets the type of the media.
  657. /// </summary>
  658. /// <value>The type of the media.</value>
  659. public string MediaType { get; set; }
  660. /// <summary>
  661. /// Gets or sets the end date.
  662. /// </summary>
  663. /// <value>The end date.</value>
  664. public DateTime? EndDate { get; set; }
  665. /// <summary>
  666. /// Gets or sets the home page URL.
  667. /// </summary>
  668. /// <value>The home page URL.</value>
  669. public string HomePageUrl { get; set; }
  670. /// <summary>
  671. /// Gets or sets the production locations.
  672. /// </summary>
  673. /// <value>The production locations.</value>
  674. public List<string> ProductionLocations { get; set; }
  675. /// <summary>
  676. /// Gets or sets the budget.
  677. /// </summary>
  678. /// <value>The budget.</value>
  679. public double? Budget { get; set; }
  680. /// <summary>
  681. /// Gets or sets the revenue.
  682. /// </summary>
  683. /// <value>The revenue.</value>
  684. public double? Revenue { get; set; }
  685. /// <summary>
  686. /// Gets or sets the locked fields.
  687. /// </summary>
  688. /// <value>The locked fields.</value>
  689. public List<MetadataFields> LockedFields { get; set; }
  690. /// <summary>
  691. /// Gets or sets the trailer count.
  692. /// </summary>
  693. /// <value>The trailer count.</value>
  694. public int? TrailerCount { get; set; }
  695. /// <summary>
  696. /// Gets or sets the movie count.
  697. /// </summary>
  698. /// <value>The movie count.</value>
  699. public int? MovieCount { get; set; }
  700. /// <summary>
  701. /// Gets or sets the series count.
  702. /// </summary>
  703. /// <value>The series count.</value>
  704. public int? SeriesCount { get; set; }
  705. /// <summary>
  706. /// Gets or sets the episode count.
  707. /// </summary>
  708. /// <value>The episode count.</value>
  709. public int? EpisodeCount { get; set; }
  710. /// <summary>
  711. /// Gets or sets the game count.
  712. /// </summary>
  713. /// <value>The game count.</value>
  714. public int? GameCount { get; set; }
  715. /// <summary>
  716. /// Gets or sets the song count.
  717. /// </summary>
  718. /// <value>The song count.</value>
  719. public int? SongCount { get; set; }
  720. /// <summary>
  721. /// Gets or sets the album count.
  722. /// </summary>
  723. /// <value>The album count.</value>
  724. public int? AlbumCount { get; set; }
  725. public int? ArtistCount { get; set; }
  726. /// <summary>
  727. /// Gets or sets the music video count.
  728. /// </summary>
  729. /// <value>The music video count.</value>
  730. public int? MusicVideoCount { get; set; }
  731. /// <summary>
  732. /// Gets or sets a value indicating whether [enable internet providers].
  733. /// </summary>
  734. /// <value><c>true</c> if [enable internet providers]; otherwise, <c>false</c>.</value>
  735. public bool? LockData { get; set; }
  736. public int? Width { get; set; }
  737. public int? Height { get; set; }
  738. public string CameraMake { get; set; }
  739. public string CameraModel { get; set; }
  740. public string Software { get; set; }
  741. public double? ExposureTime { get; set; }
  742. public double? FocalLength { get; set; }
  743. public ImageOrientation? ImageOrientation { get; set; }
  744. public double? Aperture { get; set; }
  745. public double? ShutterSpeed { get; set; }
  746. public double? Latitude { get; set; }
  747. public double? Longitude { get; set; }
  748. public double? Altitude { get; set; }
  749. public int? IsoSpeedRating { get; set; }
  750. /// <summary>
  751. /// Used by RecordingGroup
  752. /// </summary>
  753. public int? RecordingCount { get; set; }
  754. /// <summary>
  755. /// Gets or sets the series timer identifier.
  756. /// </summary>
  757. /// <value>The series timer identifier.</value>
  758. public string SeriesTimerId { get; set; }
  759. /// <summary>
  760. /// Gets a value indicating whether this instance can resume.
  761. /// </summary>
  762. /// <value><c>true</c> if this instance can resume; otherwise, <c>false</c>.</value>
  763. [IgnoreDataMember]
  764. public bool CanResume
  765. {
  766. get { return UserData != null && UserData.PlaybackPositionTicks > 0; }
  767. }
  768. /// <summary>
  769. /// Gets the resume position ticks.
  770. /// </summary>
  771. /// <value>The resume position ticks.</value>
  772. [IgnoreDataMember]
  773. public long ResumePositionTicks
  774. {
  775. get { return UserData == null ? 0 : UserData.PlaybackPositionTicks; }
  776. }
  777. /// <summary>
  778. /// Gets the backdrop count.
  779. /// </summary>
  780. /// <value>The backdrop count.</value>
  781. [IgnoreDataMember]
  782. public int BackdropCount
  783. {
  784. get { return BackdropImageTags == null ? 0 : BackdropImageTags.Count; }
  785. }
  786. /// <summary>
  787. /// Gets the screenshot count.
  788. /// </summary>
  789. /// <value>The screenshot count.</value>
  790. [IgnoreDataMember]
  791. public int ScreenshotCount
  792. {
  793. get { return ScreenshotImageTags == null ? 0 : ScreenshotImageTags.Count; }
  794. }
  795. /// <summary>
  796. /// Gets a value indicating whether this instance has banner.
  797. /// </summary>
  798. /// <value><c>true</c> if this instance has banner; otherwise, <c>false</c>.</value>
  799. [IgnoreDataMember]
  800. public bool HasBanner
  801. {
  802. get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Banner); }
  803. }
  804. /// <summary>
  805. /// Gets a value indicating whether this instance has art.
  806. /// </summary>
  807. /// <value><c>true</c> if this instance has art; otherwise, <c>false</c>.</value>
  808. [IgnoreDataMember]
  809. public bool HasArtImage
  810. {
  811. get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Art); }
  812. }
  813. /// <summary>
  814. /// Gets a value indicating whether this instance has logo.
  815. /// </summary>
  816. /// <value><c>true</c> if this instance has logo; otherwise, <c>false</c>.</value>
  817. [IgnoreDataMember]
  818. public bool HasLogo
  819. {
  820. get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Logo); }
  821. }
  822. /// <summary>
  823. /// Gets a value indicating whether this instance has thumb.
  824. /// </summary>
  825. /// <value><c>true</c> if this instance has thumb; otherwise, <c>false</c>.</value>
  826. [IgnoreDataMember]
  827. public bool HasThumb
  828. {
  829. get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Thumb); }
  830. }
  831. /// <summary>
  832. /// Gets a value indicating whether this instance has thumb.
  833. /// </summary>
  834. /// <value><c>true</c> if this instance has thumb; otherwise, <c>false</c>.</value>
  835. [IgnoreDataMember]
  836. public bool HasBackdrop
  837. {
  838. get { return (BackdropImageTags != null && BackdropImageTags.Count > 0) || (ParentBackdropImageTags != null && ParentBackdropImageTags.Count > 0); }
  839. }
  840. /// <summary>
  841. /// Gets a value indicating whether this instance has primary image.
  842. /// </summary>
  843. /// <value><c>true</c> if this instance has primary image; otherwise, <c>false</c>.</value>
  844. [IgnoreDataMember]
  845. public bool HasPrimaryImage
  846. {
  847. get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Primary); }
  848. }
  849. /// <summary>
  850. /// Gets a value indicating whether this instance has disc image.
  851. /// </summary>
  852. /// <value><c>true</c> if this instance has disc image; otherwise, <c>false</c>.</value>
  853. [IgnoreDataMember]
  854. public bool HasDiscImage
  855. {
  856. get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Disc); }
  857. }
  858. /// <summary>
  859. /// Gets a value indicating whether this instance has box image.
  860. /// </summary>
  861. /// <value><c>true</c> if this instance has box image; otherwise, <c>false</c>.</value>
  862. [IgnoreDataMember]
  863. public bool HasBoxImage
  864. {
  865. get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Box); }
  866. }
  867. /// <summary>
  868. /// Gets a value indicating whether this instance has box image.
  869. /// </summary>
  870. /// <value><c>true</c> if this instance has box image; otherwise, <c>false</c>.</value>
  871. [IgnoreDataMember]
  872. public bool HasBoxRearImage
  873. {
  874. get { return ImageTags != null && ImageTags.ContainsKey(ImageType.BoxRear); }
  875. }
  876. /// <summary>
  877. /// Gets a value indicating whether this instance has menu image.
  878. /// </summary>
  879. /// <value><c>true</c> if this instance has menu image; otherwise, <c>false</c>.</value>
  880. [IgnoreDataMember]
  881. public bool HasMenuImage
  882. {
  883. get { return ImageTags != null && ImageTags.ContainsKey(ImageType.Menu); }
  884. }
  885. /// <summary>
  886. /// Gets a value indicating whether this instance is video.
  887. /// </summary>
  888. /// <value><c>true</c> if this instance is video; otherwise, <c>false</c>.</value>
  889. [IgnoreDataMember]
  890. public bool IsVideo
  891. {
  892. get { return StringHelper.EqualsIgnoreCase(MediaType, Entities.MediaType.Video); }
  893. }
  894. /// <summary>
  895. /// Gets a value indicating whether this instance is audio.
  896. /// </summary>
  897. /// <value><c>true</c> if this instance is audio; otherwise, <c>false</c>.</value>
  898. [IgnoreDataMember]
  899. public bool IsAudio
  900. {
  901. get { return StringHelper.EqualsIgnoreCase(MediaType, Entities.MediaType.Audio); }
  902. }
  903. /// <summary>
  904. /// Gets a value indicating whether this instance is game.
  905. /// </summary>
  906. /// <value><c>true</c> if this instance is game; otherwise, <c>false</c>.</value>
  907. [IgnoreDataMember]
  908. public bool IsGame
  909. {
  910. get { return StringHelper.EqualsIgnoreCase(MediaType, Entities.MediaType.Game); }
  911. }
  912. /// <summary>
  913. /// Gets a value indicating whether this instance is person.
  914. /// </summary>
  915. /// <value><c>true</c> if this instance is person; otherwise, <c>false</c>.</value>
  916. [IgnoreDataMember]
  917. public bool IsPerson
  918. {
  919. get { return StringHelper.EqualsIgnoreCase(Type, "Person"); }
  920. }
  921. /// <summary>
  922. /// Gets a value indicating whether this instance is root.
  923. /// </summary>
  924. /// <value><c>true</c> if this instance is root; otherwise, <c>false</c>.</value>
  925. [IgnoreDataMember]
  926. public bool IsRoot
  927. {
  928. get { return StringHelper.EqualsIgnoreCase(Type, "AggregateFolder"); }
  929. }
  930. [IgnoreDataMember]
  931. public bool IsMusicGenre
  932. {
  933. get { return StringHelper.EqualsIgnoreCase(Type, "MusicGenre"); }
  934. }
  935. [IgnoreDataMember]
  936. public bool IsGameGenre
  937. {
  938. get { return StringHelper.EqualsIgnoreCase(Type, "GameGenre"); }
  939. }
  940. [IgnoreDataMember]
  941. public bool IsGenre
  942. {
  943. get { return StringHelper.EqualsIgnoreCase(Type, "Genre"); }
  944. }
  945. [IgnoreDataMember]
  946. public bool IsArtist
  947. {
  948. get { return StringHelper.EqualsIgnoreCase(Type, "MusicArtist"); }
  949. }
  950. [IgnoreDataMember]
  951. public bool IsAlbum
  952. {
  953. get { return StringHelper.EqualsIgnoreCase(Type, "MusicAlbum"); }
  954. }
  955. [IgnoreDataMember]
  956. public bool IsStudio
  957. {
  958. get { return StringHelper.EqualsIgnoreCase(Type, "Studio"); }
  959. }
  960. [IgnoreDataMember]
  961. public bool SupportsSimilarItems
  962. {
  963. get
  964. {
  965. return IsType("Movie") || IsType("Series") || IsType("MusicAlbum") || IsType("MusicArtist") || IsType("Program") || IsType("Recording") || IsType("ChannelVideoItem") || IsType("Game");
  966. }
  967. }
  968. /// <summary>
  969. /// Gets or sets the program identifier.
  970. /// </summary>
  971. /// <value>The program identifier.</value>
  972. public string ProgramId { get; set; }
  973. /// <summary>
  974. /// Gets or sets the channel primary image tag.
  975. /// </summary>
  976. /// <value>The channel primary image tag.</value>
  977. public string ChannelPrimaryImageTag { get; set; }
  978. /// <summary>
  979. /// The start date of the recording, in UTC.
  980. /// </summary>
  981. public DateTime? StartDate { get; set; }
  982. /// <summary>
  983. /// Gets or sets the completion percentage.
  984. /// </summary>
  985. /// <value>The completion percentage.</value>
  986. public double? CompletionPercentage { get; set; }
  987. /// <summary>
  988. /// Gets or sets a value indicating whether this instance is repeat.
  989. /// </summary>
  990. /// <value><c>true</c> if this instance is repeat; otherwise, <c>false</c>.</value>
  991. public bool? IsRepeat { get; set; }
  992. /// <summary>
  993. /// Gets or sets the episode title.
  994. /// </summary>
  995. /// <value>The episode title.</value>
  996. public string EpisodeTitle { get; set; }
  997. /// <summary>
  998. /// Gets or sets the type of the channel.
  999. /// </summary>
  1000. /// <value>The type of the channel.</value>
  1001. public ChannelType? ChannelType { get; set; }
  1002. /// <summary>
  1003. /// Gets or sets the audio.
  1004. /// </summary>
  1005. /// <value>The audio.</value>
  1006. public ProgramAudio? Audio { get; set; }
  1007. /// <summary>
  1008. /// Gets or sets a value indicating whether this instance is movie.
  1009. /// </summary>
  1010. /// <value><c>true</c> if this instance is movie; otherwise, <c>false</c>.</value>
  1011. public bool? IsMovie { get; set; }
  1012. /// <summary>
  1013. /// Gets or sets a value indicating whether this instance is sports.
  1014. /// </summary>
  1015. /// <value><c>true</c> if this instance is sports; otherwise, <c>false</c>.</value>
  1016. public bool? IsSports { get; set; }
  1017. /// <summary>
  1018. /// Gets or sets a value indicating whether this instance is series.
  1019. /// </summary>
  1020. /// <value><c>true</c> if this instance is series; otherwise, <c>false</c>.</value>
  1021. public bool? IsSeries { get; set; }
  1022. /// <summary>
  1023. /// Gets or sets a value indicating whether this instance is live.
  1024. /// </summary>
  1025. /// <value><c>true</c> if this instance is live; otherwise, <c>false</c>.</value>
  1026. public bool? IsLive { get; set; }
  1027. /// <summary>
  1028. /// Gets or sets a value indicating whether this instance is news.
  1029. /// </summary>
  1030. /// <value><c>true</c> if this instance is news; otherwise, <c>false</c>.</value>
  1031. public bool? IsNews { get; set; }
  1032. /// <summary>
  1033. /// Gets or sets a value indicating whether this instance is kids.
  1034. /// </summary>
  1035. /// <value><c>true</c> if this instance is kids; otherwise, <c>false</c>.</value>
  1036. public bool? IsKids { get; set; }
  1037. /// <summary>
  1038. /// Gets or sets a value indicating whether this instance is premiere.
  1039. /// </summary>
  1040. /// <value><c>true</c> if this instance is premiere; otherwise, <c>false</c>.</value>
  1041. public bool? IsPremiere { get; set; }
  1042. /// <summary>
  1043. /// Gets or sets the timer identifier.
  1044. /// </summary>
  1045. /// <value>The timer identifier.</value>
  1046. public string TimerId { get; set; }
  1047. /// <summary>
  1048. /// Gets or sets the current program.
  1049. /// </summary>
  1050. /// <value>The current program.</value>
  1051. public BaseItemDto CurrentProgram { get; set; }
  1052. }
  1053. }