LiveTvService.cs 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847
  1. using MediaBrowser.Common.Configuration;
  2. using MediaBrowser.Common.Net;
  3. using MediaBrowser.Controller.Dto;
  4. using MediaBrowser.Controller.Library;
  5. using MediaBrowser.Controller.LiveTv;
  6. using MediaBrowser.Controller.Net;
  7. using MediaBrowser.Model.Dto;
  8. using MediaBrowser.Model.Entities;
  9. using MediaBrowser.Model.LiveTv;
  10. using MediaBrowser.Model.Querying;
  11. using ServiceStack;
  12. using System;
  13. using System.Collections.Generic;
  14. using System.Globalization;
  15. using System.Linq;
  16. using System.Threading;
  17. using System.Threading.Tasks;
  18. namespace MediaBrowser.Api.LiveTv
  19. {
  20. /// <summary>
  21. /// This is insecure right now to avoid windows phone refactoring
  22. /// </summary>
  23. [Route("/LiveTv/Info", "GET", Summary = "Gets available live tv services.")]
  24. [Authenticated]
  25. public class GetLiveTvInfo : IReturn<LiveTvInfo>
  26. {
  27. }
  28. [Route("/LiveTv/Channels", "GET", Summary = "Gets available live tv channels.")]
  29. [Authenticated]
  30. public class GetChannels : IReturn<QueryResult<ChannelInfoDto>>, IHasDtoOptions
  31. {
  32. [ApiMember(Name = "Type", Description = "Optional filter by channel type.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  33. public ChannelType? Type { get; set; }
  34. [ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  35. public string UserId { get; set; }
  36. /// <summary>
  37. /// Skips over a given number of items within the results. Use for paging.
  38. /// </summary>
  39. /// <value>The start index.</value>
  40. [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  41. public int? StartIndex { get; set; }
  42. /// <summary>
  43. /// The maximum number of items to return
  44. /// </summary>
  45. /// <value>The limit.</value>
  46. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  47. public int? Limit { get; set; }
  48. [ApiMember(Name = "IsFavorite", Description = "Filter by channels that are favorites, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  49. public bool? IsFavorite { get; set; }
  50. [ApiMember(Name = "IsLiked", Description = "Filter by channels that are liked, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  51. public bool? IsLiked { get; set; }
  52. [ApiMember(Name = "IsDisliked", Description = "Filter by channels that are disliked, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  53. public bool? IsDisliked { get; set; }
  54. [ApiMember(Name = "EnableFavoriteSorting", Description = "Incorporate favorite and like status into channel sorting.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  55. public bool EnableFavoriteSorting { get; set; }
  56. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  57. public bool? EnableImages { get; set; }
  58. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  59. public int? ImageTypeLimit { get; set; }
  60. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  61. public string EnableImageTypes { get; set; }
  62. /// <summary>
  63. /// Fields to return within the items, in addition to basic information
  64. /// </summary>
  65. /// <value>The fields.</value>
  66. [ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  67. public string Fields { get; set; }
  68. }
  69. [Route("/LiveTv/Channels/{Id}", "GET", Summary = "Gets a live tv channel")]
  70. [Authenticated]
  71. public class GetChannel : IReturn<ChannelInfoDto>
  72. {
  73. /// <summary>
  74. /// Gets or sets the id.
  75. /// </summary>
  76. /// <value>The id.</value>
  77. [ApiMember(Name = "Id", Description = "Channel Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  78. public string Id { get; set; }
  79. [ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  80. public string UserId { get; set; }
  81. }
  82. [Route("/LiveTv/Recordings", "GET", Summary = "Gets live tv recordings")]
  83. [Authenticated]
  84. public class GetRecordings : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
  85. {
  86. [ApiMember(Name = "ChannelId", Description = "Optional filter by channel id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  87. public string ChannelId { get; set; }
  88. [ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  89. public string UserId { get; set; }
  90. [ApiMember(Name = "GroupId", Description = "Optional filter by recording group.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  91. public string GroupId { get; set; }
  92. [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  93. public int? StartIndex { get; set; }
  94. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  95. public int? Limit { get; set; }
  96. [ApiMember(Name = "Status", Description = "Optional filter by recording status.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  97. public RecordingStatus? Status { get; set; }
  98. [ApiMember(Name = "Status", Description = "Optional filter by recordings that are in progress, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  99. public bool? IsInProgress { get; set; }
  100. [ApiMember(Name = "SeriesTimerId", Description = "Optional filter by recordings belonging to a series timer", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  101. public string SeriesTimerId { get; set; }
  102. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  103. public bool? EnableImages { get; set; }
  104. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  105. public int? ImageTypeLimit { get; set; }
  106. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  107. public string EnableImageTypes { get; set; }
  108. /// <summary>
  109. /// Fields to return within the items, in addition to basic information
  110. /// </summary>
  111. /// <value>The fields.</value>
  112. [ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  113. public string Fields { get; set; }
  114. }
  115. [Route("/LiveTv/Recordings/Groups", "GET", Summary = "Gets live tv recording groups")]
  116. [Authenticated]
  117. public class GetRecordingGroups : IReturn<QueryResult<BaseItemDto>>
  118. {
  119. [ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  120. public string UserId { get; set; }
  121. }
  122. [Route("/LiveTv/Recordings/{Id}", "GET", Summary = "Gets a live tv recording")]
  123. [Authenticated]
  124. public class GetRecording : IReturn<BaseItemDto>
  125. {
  126. [ApiMember(Name = "Id", Description = "Recording Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  127. public string Id { get; set; }
  128. [ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  129. public string UserId { get; set; }
  130. }
  131. [Route("/LiveTv/Tuners/{Id}/Reset", "POST", Summary = "Resets a tv tuner")]
  132. [Authenticated]
  133. public class ResetTuner : IReturnVoid
  134. {
  135. [ApiMember(Name = "Id", Description = "Tuner Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  136. public string Id { get; set; }
  137. }
  138. [Route("/LiveTv/Timers/{Id}", "GET", Summary = "Gets a live tv timer")]
  139. [Authenticated]
  140. public class GetTimer : IReturn<TimerInfoDto>
  141. {
  142. [ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  143. public string Id { get; set; }
  144. }
  145. [Route("/LiveTv/Timers/Defaults", "GET", Summary = "Gets default values for a new timer")]
  146. [Authenticated]
  147. public class GetDefaultTimer : IReturn<SeriesTimerInfoDto>
  148. {
  149. [ApiMember(Name = "ProgramId", Description = "Optional, to attach default values based on a program.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  150. public string ProgramId { get; set; }
  151. }
  152. [Route("/LiveTv/Timers", "GET", Summary = "Gets live tv timers")]
  153. [Authenticated]
  154. public class GetTimers : IReturn<QueryResult<TimerInfoDto>>
  155. {
  156. [ApiMember(Name = "ChannelId", Description = "Optional filter by channel id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  157. public string ChannelId { get; set; }
  158. [ApiMember(Name = "SeriesTimerId", Description = "Optional filter by timers belonging to a series timer", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  159. public string SeriesTimerId { get; set; }
  160. }
  161. [Route("/LiveTv/Programs", "GET,POST", Summary = "Gets available live tv epgs..")]
  162. [Authenticated]
  163. public class GetPrograms : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
  164. {
  165. [ApiMember(Name = "ChannelIds", Description = "The channels to return guide information for.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  166. public string ChannelIds { get; set; }
  167. [ApiMember(Name = "UserId", Description = "Optional filter by user id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  168. public string UserId { get; set; }
  169. [ApiMember(Name = "MinStartDate", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  170. public string MinStartDate { get; set; }
  171. [ApiMember(Name = "HasAired", Description = "Optional. Filter by programs that have completed airing, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  172. public bool? HasAired { get; set; }
  173. [ApiMember(Name = "MaxStartDate", Description = "Optional. The maximum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  174. public string MaxStartDate { get; set; }
  175. [ApiMember(Name = "MinEndDate", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  176. public string MinEndDate { get; set; }
  177. [ApiMember(Name = "MaxEndDate", Description = "Optional. The maximum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  178. public string MaxEndDate { get; set; }
  179. [ApiMember(Name = "IsMovie", Description = "Optional filter for movies.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
  180. public bool? IsMovie { get; set; }
  181. [ApiMember(Name = "IsKids", Description = "Optional filter for kids.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
  182. public bool? IsKids { get; set; }
  183. [ApiMember(Name = "IsSports", Description = "Optional filter for sports.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
  184. public bool? IsSports { get; set; }
  185. [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  186. public int? StartIndex { get; set; }
  187. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  188. public int? Limit { get; set; }
  189. [ApiMember(Name = "SortBy", Description = "Optional. Specify one or more sort orders, comma delimeted. Options: Name, StartDate", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  190. public string SortBy { get; set; }
  191. [ApiMember(Name = "SortOrder", Description = "Sort Order - Ascending,Descending", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  192. public SortOrder? SortOrder { get; set; }
  193. [ApiMember(Name = "Genres", Description = "The genres to return guide information for.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  194. public string Genres { get; set; }
  195. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  196. public bool? EnableImages { get; set; }
  197. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  198. public int? ImageTypeLimit { get; set; }
  199. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  200. public string EnableImageTypes { get; set; }
  201. /// <summary>
  202. /// Fields to return within the items, in addition to basic information
  203. /// </summary>
  204. /// <value>The fields.</value>
  205. [ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  206. public string Fields { get; set; }
  207. }
  208. [Route("/LiveTv/Programs/Recommended", "GET", Summary = "Gets available live tv epgs..")]
  209. [Authenticated]
  210. public class GetRecommendedPrograms : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
  211. {
  212. [ApiMember(Name = "UserId", Description = "Optional filter by user id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  213. public string UserId { get; set; }
  214. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  215. public int? Limit { get; set; }
  216. [ApiMember(Name = "IsAiring", Description = "Optional. Filter by programs that are currently airing, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  217. public bool? IsAiring { get; set; }
  218. [ApiMember(Name = "HasAired", Description = "Optional. Filter by programs that have completed airing, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  219. public bool? HasAired { get; set; }
  220. [ApiMember(Name = "IsSports", Description = "Optional filter for sports.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
  221. public bool? IsSports { get; set; }
  222. [ApiMember(Name = "IsMovie", Description = "Optional filter for movies.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  223. public bool? IsMovie { get; set; }
  224. [ApiMember(Name = "IsKids", Description = "Optional filter for kids.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  225. public bool? IsKids { get; set; }
  226. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  227. public bool? EnableImages { get; set; }
  228. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  229. public int? ImageTypeLimit { get; set; }
  230. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  231. public string EnableImageTypes { get; set; }
  232. /// <summary>
  233. /// Fields to return within the items, in addition to basic information
  234. /// </summary>
  235. /// <value>The fields.</value>
  236. [ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  237. public string Fields { get; set; }
  238. }
  239. [Route("/LiveTv/Programs/{Id}", "GET", Summary = "Gets a live tv program")]
  240. [Authenticated]
  241. public class GetProgram : IReturn<BaseItemDto>
  242. {
  243. [ApiMember(Name = "Id", Description = "Program Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  244. public string Id { get; set; }
  245. [ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  246. public string UserId { get; set; }
  247. }
  248. [Route("/LiveTv/Recordings/{Id}", "DELETE", Summary = "Deletes a live tv recording")]
  249. [Authenticated]
  250. public class DeleteRecording : IReturnVoid
  251. {
  252. [ApiMember(Name = "Id", Description = "Recording Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  253. public string Id { get; set; }
  254. }
  255. [Route("/LiveTv/Timers/{Id}", "DELETE", Summary = "Cancels a live tv timer")]
  256. [Authenticated]
  257. public class CancelTimer : IReturnVoid
  258. {
  259. [ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  260. public string Id { get; set; }
  261. }
  262. [Route("/LiveTv/Timers/{Id}", "POST", Summary = "Updates a live tv timer")]
  263. [Authenticated]
  264. public class UpdateTimer : TimerInfoDto, IReturnVoid
  265. {
  266. }
  267. [Route("/LiveTv/Timers", "POST", Summary = "Creates a live tv timer")]
  268. [Authenticated]
  269. public class CreateTimer : TimerInfoDto, IReturnVoid
  270. {
  271. }
  272. [Route("/LiveTv/SeriesTimers/{Id}", "GET", Summary = "Gets a live tv series timer")]
  273. [Authenticated]
  274. public class GetSeriesTimer : IReturn<TimerInfoDto>
  275. {
  276. [ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  277. public string Id { get; set; }
  278. }
  279. [Route("/LiveTv/SeriesTimers", "GET", Summary = "Gets live tv series timers")]
  280. [Authenticated]
  281. public class GetSeriesTimers : IReturn<QueryResult<SeriesTimerInfoDto>>
  282. {
  283. [ApiMember(Name = "SortBy", Description = "Optional. Sort by SortName or Priority", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  284. public string SortBy { get; set; }
  285. [ApiMember(Name = "SortOrder", Description = "Optional. Sort in Ascending or Descending order", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  286. public SortOrder SortOrder { get; set; }
  287. }
  288. [Route("/LiveTv/SeriesTimers/{Id}", "DELETE", Summary = "Cancels a live tv series timer")]
  289. [Authenticated]
  290. public class CancelSeriesTimer : IReturnVoid
  291. {
  292. [ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  293. public string Id { get; set; }
  294. }
  295. [Route("/LiveTv/SeriesTimers/{Id}", "POST", Summary = "Updates a live tv series timer")]
  296. [Authenticated]
  297. public class UpdateSeriesTimer : SeriesTimerInfoDto, IReturnVoid
  298. {
  299. }
  300. [Route("/LiveTv/SeriesTimers", "POST", Summary = "Creates a live tv series timer")]
  301. [Authenticated]
  302. public class CreateSeriesTimer : SeriesTimerInfoDto, IReturnVoid
  303. {
  304. }
  305. [Route("/LiveTv/Recordings/Groups/{Id}", "GET", Summary = "Gets a recording group")]
  306. [Authenticated]
  307. public class GetRecordingGroup : IReturn<BaseItemDto>
  308. {
  309. [ApiMember(Name = "Id", Description = "Recording group Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  310. public string Id { get; set; }
  311. }
  312. [Route("/LiveTv/GuideInfo", "GET", Summary = "Gets guide info")]
  313. [Authenticated]
  314. public class GetGuideInfo : IReturn<GuideInfo>
  315. {
  316. }
  317. [Route("/LiveTv/Folder", "GET", Summary = "Gets the users live tv folder, along with configured images")]
  318. [Authenticated]
  319. public class GetLiveTvFolder : IReturn<BaseItemDto>
  320. {
  321. [ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  322. public string UserId { get; set; }
  323. }
  324. [Route("/LiveTv/TunerHosts", "POST", Summary = "Adds a tuner host")]
  325. [Authenticated]
  326. public class AddTunerHost : TunerHostInfo, IReturn<TunerHostInfo>
  327. {
  328. }
  329. [Route("/LiveTv/TunerHosts", "DELETE", Summary = "Deletes a tuner host")]
  330. [Authenticated]
  331. public class DeleteTunerHost : IReturnVoid
  332. {
  333. [ApiMember(Name = "Id", Description = "Tuner host id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "DELETE")]
  334. public string Id { get; set; }
  335. }
  336. [Route("/LiveTv/ListingProviders", "POST", Summary = "Adds a listing provider")]
  337. [Authenticated]
  338. public class AddListingProvider : ListingsProviderInfo, IReturn<ListingsProviderInfo>
  339. {
  340. public bool ValidateLogin { get; set; }
  341. public bool ValidateListings { get; set; }
  342. }
  343. [Route("/LiveTv/ListingProviders", "DELETE", Summary = "Deletes a listing provider")]
  344. [Authenticated]
  345. public class DeleteListingProvider : IReturnVoid
  346. {
  347. [ApiMember(Name = "Id", Description = "Provider id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "DELETE")]
  348. public string Id { get; set; }
  349. }
  350. [Route("/LiveTv/ListingProviders/Lineups", "GET", Summary = "Gets available lineups")]
  351. [Authenticated]
  352. public class GetLineups : IReturn<List<NameIdPair>>
  353. {
  354. [ApiMember(Name = "Id", Description = "Provider id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  355. public string Id { get; set; }
  356. [ApiMember(Name = "Type", Description = "Provider Type", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  357. public string Type { get; set; }
  358. [ApiMember(Name = "Location", Description = "Location", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  359. public string Location { get; set; }
  360. [ApiMember(Name = "Country", Description = "Country", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  361. public string Country { get; set; }
  362. }
  363. [Route("/LiveTv/ListingProviders/SchedulesDirect/Countries", "GET", Summary = "Gets available lineups")]
  364. [Authenticated]
  365. public class GetSchedulesDirectCountries
  366. {
  367. }
  368. public class LiveTvService : BaseApiService
  369. {
  370. private readonly ILiveTvManager _liveTvManager;
  371. private readonly IUserManager _userManager;
  372. private readonly IConfigurationManager _config;
  373. private readonly IHttpClient _httpClient;
  374. public LiveTvService(ILiveTvManager liveTvManager, IUserManager userManager, IConfigurationManager config, IHttpClient httpClient)
  375. {
  376. _liveTvManager = liveTvManager;
  377. _userManager = userManager;
  378. _config = config;
  379. _httpClient = httpClient;
  380. }
  381. public async Task<object> Get(GetSchedulesDirectCountries request)
  382. {
  383. // https://json.schedulesdirect.org/20141201/available/countries
  384. var response = await _httpClient.Get(new HttpRequestOptions
  385. {
  386. Url = "https://json.schedulesdirect.org/20141201/available/countries",
  387. CacheLength = TimeSpan.FromDays(1),
  388. CacheMode = CacheMode.Unconditional
  389. }).ConfigureAwait(false);
  390. return ResultFactory.GetResult(response, "application/json");
  391. }
  392. private void AssertUserCanManageLiveTv()
  393. {
  394. var user = SessionContext.GetUser(Request).Result;
  395. if (user == null)
  396. {
  397. throw new UnauthorizedAccessException("Anonymous live tv management is not allowed.");
  398. }
  399. if (!user.Policy.EnableLiveTvManagement)
  400. {
  401. throw new UnauthorizedAccessException("The current user does not have permission to manage live tv.");
  402. }
  403. }
  404. public async Task<object> Post(AddListingProvider request)
  405. {
  406. var result = await _liveTvManager.SaveListingProvider(request, request.ValidateLogin, request.ValidateListings).ConfigureAwait(false);
  407. return ToOptimizedResult(result);
  408. }
  409. public void Delete(DeleteListingProvider request)
  410. {
  411. var config = GetConfiguration();
  412. config.ListingProviders = config.ListingProviders.Where(i => !string.Equals(request.Id, i.Id, StringComparison.OrdinalIgnoreCase)).ToList();
  413. _config.SaveConfiguration("livetv", config);
  414. }
  415. public async Task<object> Post(AddTunerHost request)
  416. {
  417. var result = await _liveTvManager.SaveTunerHost(request).ConfigureAwait(false);
  418. return ToOptimizedResult(result);
  419. }
  420. public void Delete(DeleteTunerHost request)
  421. {
  422. var config = GetConfiguration();
  423. config.TunerHosts = config.TunerHosts.Where(i => !string.Equals(request.Id, i.Id, StringComparison.OrdinalIgnoreCase)).ToList();
  424. _config.SaveConfiguration("livetv", config);
  425. }
  426. private LiveTvOptions GetConfiguration()
  427. {
  428. return _config.GetConfiguration<LiveTvOptions>("livetv");
  429. }
  430. public async Task<object> Get(GetLineups request)
  431. {
  432. var info = await _liveTvManager.GetLineups(request.Type, request.Id, request.Country, request.Location).ConfigureAwait(false);
  433. return ToOptimizedSerializedResultUsingCache(info);
  434. }
  435. public async Task<object> Get(GetLiveTvInfo request)
  436. {
  437. var info = await _liveTvManager.GetLiveTvInfo(CancellationToken.None).ConfigureAwait(false);
  438. return ToOptimizedSerializedResultUsingCache(info);
  439. }
  440. public async Task<object> Get(GetChannels request)
  441. {
  442. var result = await _liveTvManager.GetChannels(new LiveTvChannelQuery
  443. {
  444. ChannelType = request.Type,
  445. UserId = request.UserId,
  446. StartIndex = request.StartIndex,
  447. Limit = request.Limit,
  448. IsFavorite = request.IsFavorite,
  449. IsLiked = request.IsLiked,
  450. IsDisliked = request.IsDisliked,
  451. EnableFavoriteSorting = request.EnableFavoriteSorting
  452. }, GetDtoOptions(request), CancellationToken.None).ConfigureAwait(false);
  453. return ToOptimizedSerializedResultUsingCache(result);
  454. }
  455. public async Task<object> Get(GetChannel request)
  456. {
  457. var user = string.IsNullOrEmpty(request.UserId) ? null : _userManager.GetUserById(request.UserId);
  458. var result = await _liveTvManager.GetChannel(request.Id, CancellationToken.None, user).ConfigureAwait(false);
  459. return ToOptimizedSerializedResultUsingCache(result);
  460. }
  461. public async Task<object> Get(GetLiveTvFolder request)
  462. {
  463. return ToOptimizedResult(await _liveTvManager.GetLiveTvFolder(request.UserId, CancellationToken.None).ConfigureAwait(false));
  464. }
  465. public async Task<object> Get(GetPrograms request)
  466. {
  467. var query = new ProgramQuery
  468. {
  469. ChannelIds = (request.ChannelIds ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).ToArray(),
  470. UserId = request.UserId,
  471. HasAired = request.HasAired
  472. };
  473. if (!string.IsNullOrEmpty(request.MinStartDate))
  474. {
  475. query.MinStartDate = DateTime.Parse(request.MinStartDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  476. }
  477. if (!string.IsNullOrEmpty(request.MinEndDate))
  478. {
  479. query.MinEndDate = DateTime.Parse(request.MinEndDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  480. }
  481. if (!string.IsNullOrEmpty(request.MaxStartDate))
  482. {
  483. query.MaxStartDate = DateTime.Parse(request.MaxStartDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  484. }
  485. if (!string.IsNullOrEmpty(request.MaxEndDate))
  486. {
  487. query.MaxEndDate = DateTime.Parse(request.MaxEndDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  488. }
  489. query.StartIndex = request.StartIndex;
  490. query.Limit = request.Limit;
  491. query.SortBy = (request.SortBy ?? String.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  492. query.SortOrder = request.SortOrder;
  493. query.IsMovie = request.IsMovie;
  494. query.IsKids = request.IsKids;
  495. query.IsSports = request.IsSports;
  496. query.Genres = (request.Genres ?? String.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  497. var result = await _liveTvManager.GetPrograms(query, GetDtoOptions(request), CancellationToken.None).ConfigureAwait(false);
  498. return ToOptimizedResult(result);
  499. }
  500. public async Task<object> Get(GetRecommendedPrograms request)
  501. {
  502. var query = new RecommendedProgramQuery
  503. {
  504. UserId = request.UserId,
  505. IsAiring = request.IsAiring,
  506. Limit = request.Limit,
  507. HasAired = request.HasAired,
  508. IsMovie = request.IsMovie,
  509. IsKids = request.IsKids,
  510. IsSports = request.IsSports
  511. };
  512. var result = await _liveTvManager.GetRecommendedPrograms(query, GetDtoOptions(request), CancellationToken.None).ConfigureAwait(false);
  513. return ToOptimizedResult(result);
  514. }
  515. public object Post(GetPrograms request)
  516. {
  517. return Get(request);
  518. }
  519. public async Task<object> Get(GetRecordings request)
  520. {
  521. var options = GetDtoOptions(request);
  522. options.DeviceId = AuthorizationContext.GetAuthorizationInfo(Request).DeviceId;
  523. var result = await _liveTvManager.GetRecordings(new RecordingQuery
  524. {
  525. ChannelId = request.ChannelId,
  526. UserId = request.UserId,
  527. GroupId = request.GroupId,
  528. StartIndex = request.StartIndex,
  529. Limit = request.Limit,
  530. Status = request.Status,
  531. SeriesTimerId = request.SeriesTimerId,
  532. IsInProgress = request.IsInProgress
  533. }, options, CancellationToken.None).ConfigureAwait(false);
  534. return ToOptimizedResult(result);
  535. }
  536. public async Task<object> Get(GetRecording request)
  537. {
  538. var user = string.IsNullOrEmpty(request.UserId) ? null : _userManager.GetUserById(request.UserId);
  539. var options = new DtoOptions();
  540. options.DeviceId = AuthorizationContext.GetAuthorizationInfo(Request).DeviceId;
  541. var result = await _liveTvManager.GetRecording(request.Id, options, CancellationToken.None, user).ConfigureAwait(false);
  542. return ToOptimizedSerializedResultUsingCache(result);
  543. }
  544. public async Task<object> Get(GetTimer request)
  545. {
  546. var result = await _liveTvManager.GetTimer(request.Id, CancellationToken.None).ConfigureAwait(false);
  547. return ToOptimizedSerializedResultUsingCache(result);
  548. }
  549. public async Task<object> Get(GetTimers request)
  550. {
  551. var result = await _liveTvManager.GetTimers(new TimerQuery
  552. {
  553. ChannelId = request.ChannelId,
  554. SeriesTimerId = request.SeriesTimerId
  555. }, CancellationToken.None).ConfigureAwait(false);
  556. return ToOptimizedSerializedResultUsingCache(result);
  557. }
  558. public void Delete(DeleteRecording request)
  559. {
  560. AssertUserCanManageLiveTv();
  561. var task = _liveTvManager.DeleteRecording(request.Id);
  562. Task.WaitAll(task);
  563. }
  564. public void Delete(CancelTimer request)
  565. {
  566. AssertUserCanManageLiveTv();
  567. var task = _liveTvManager.CancelTimer(request.Id);
  568. Task.WaitAll(task);
  569. }
  570. public void Post(UpdateTimer request)
  571. {
  572. AssertUserCanManageLiveTv();
  573. var task = _liveTvManager.UpdateTimer(request, CancellationToken.None);
  574. Task.WaitAll(task);
  575. }
  576. public async Task<object> Get(GetSeriesTimers request)
  577. {
  578. var result = await _liveTvManager.GetSeriesTimers(new SeriesTimerQuery
  579. {
  580. SortOrder = request.SortOrder,
  581. SortBy = request.SortBy
  582. }, CancellationToken.None).ConfigureAwait(false);
  583. return ToOptimizedSerializedResultUsingCache(result);
  584. }
  585. public async Task<object> Get(GetSeriesTimer request)
  586. {
  587. var result = await _liveTvManager.GetSeriesTimer(request.Id, CancellationToken.None).ConfigureAwait(false);
  588. return ToOptimizedSerializedResultUsingCache(result);
  589. }
  590. public void Delete(CancelSeriesTimer request)
  591. {
  592. AssertUserCanManageLiveTv();
  593. var task = _liveTvManager.CancelSeriesTimer(request.Id);
  594. Task.WaitAll(task);
  595. }
  596. public void Post(UpdateSeriesTimer request)
  597. {
  598. AssertUserCanManageLiveTv();
  599. var task = _liveTvManager.UpdateSeriesTimer(request, CancellationToken.None);
  600. Task.WaitAll(task);
  601. }
  602. public async Task<object> Get(GetDefaultTimer request)
  603. {
  604. if (string.IsNullOrEmpty(request.ProgramId))
  605. {
  606. var result = await _liveTvManager.GetNewTimerDefaults(CancellationToken.None).ConfigureAwait(false);
  607. return ToOptimizedSerializedResultUsingCache(result);
  608. }
  609. else
  610. {
  611. var result = await _liveTvManager.GetNewTimerDefaults(request.ProgramId, CancellationToken.None).ConfigureAwait(false);
  612. return ToOptimizedSerializedResultUsingCache(result);
  613. }
  614. }
  615. public async Task<object> Get(GetProgram request)
  616. {
  617. var user = string.IsNullOrEmpty(request.UserId) ? null : _userManager.GetUserById(request.UserId);
  618. var result = await _liveTvManager.GetProgram(request.Id, CancellationToken.None, user).ConfigureAwait(false);
  619. return ToOptimizedSerializedResultUsingCache(result);
  620. }
  621. public void Post(CreateSeriesTimer request)
  622. {
  623. AssertUserCanManageLiveTv();
  624. var task = _liveTvManager.CreateSeriesTimer(request, CancellationToken.None);
  625. Task.WaitAll(task);
  626. }
  627. public void Post(CreateTimer request)
  628. {
  629. AssertUserCanManageLiveTv();
  630. var task = _liveTvManager.CreateTimer(request, CancellationToken.None);
  631. Task.WaitAll(task);
  632. }
  633. public async Task<object> Get(GetRecordingGroups request)
  634. {
  635. var result = await _liveTvManager.GetRecordingGroups(new RecordingGroupQuery
  636. {
  637. UserId = request.UserId
  638. }, CancellationToken.None).ConfigureAwait(false);
  639. return ToOptimizedSerializedResultUsingCache(result);
  640. }
  641. public async Task<object> Get(GetRecordingGroup request)
  642. {
  643. var result = await _liveTvManager.GetRecordingGroups(new RecordingGroupQuery
  644. {
  645. }, CancellationToken.None).ConfigureAwait(false);
  646. var group = result.Items.FirstOrDefault(i => string.Equals(i.Id, request.Id, StringComparison.OrdinalIgnoreCase));
  647. return ToOptimizedSerializedResultUsingCache(group);
  648. }
  649. public object Get(GetGuideInfo request)
  650. {
  651. return ToOptimizedResult(_liveTvManager.GetGuideInfo());
  652. }
  653. public void Post(ResetTuner request)
  654. {
  655. AssertUserCanManageLiveTv();
  656. var task = _liveTvManager.ResetTuner(request.Id, CancellationToken.None);
  657. Task.WaitAll(task);
  658. }
  659. }
  660. }